RoomService

• getRoom
• getRoomsByIds
• getRoomIdsByBuilding
• getRoomIdsByBuildingAndFloor
• getRoomIdsByType
• getRoomIdsByBuildingAndRoomType
• getRoomsByBuildingAndRoomUsageTypes
• getRoomIdsByBuildingAndRoomTypes
• searchForRoomIds
• searchForRooms
• validateRoom
• createRoom
• updateRoom
• deleteRoom
• getBuilding
• getBuildingsByIds
• getBuildingIdsByCampus
• searchForBuildingIds
• searchForBuildings
• validateBuilding
• createBuilding
• updateBuilding
• deleteBuilding
• getRoomResponsibleOrg
• getRoomResponsibleOrgsByIds
• getRoomResponsibleOrgIdsByType
• getRoomResponsibleOrgIdsByRoom
• getRoomResponsibleOrgIdsForBuilding
• searchForRoomResponsibleOrgIds
• searchForRoomResponsibleOrgs
• validateRoomResponsibleOrg
• createRoomResponsibleOrg
• updateRoomResponsibleOrg
• deleteRoomResponsibleOrg

• RoomInfo
• QueryByCriteria
• ValidationResultInfo
• StatusInfo
• BuildingInfo
• RoomResponsibleOrgInfo

Method	getRoom
Description	Retrieves a Room
Parameters	String	roomId	a unique Id of a Room
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	RoomInfo		a Room
Errors	DoesNotExistException		roomId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing roomId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRoomsByIds
Description	Retrieves a list of Rooms corresponding to the given list of Room Ids.
Parameters	StringList	roomIds	list of Rooms to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	RoomInfoList		a list of Rooms
Errors	DoesNotExistException		a roomId in list not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing roomId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRoomIdsByBuilding
Description	Retrieves a list of Rooms corresponding to the given Building id
Parameters	String	buildingId	a unique Id of a Building
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Room Ids
Errors	DoesNotExistException		buildingId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing buildingId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRoomIdsByBuildingAndFloor
Description	Retrieves a list of Rooms corresponding to the given Building id and Floor
Parameters	String	buildingId	a unique Id of a Building
	String	floor	floor
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Room Ids
Errors	DoesNotExistException		buildingId not found
	InvalidParameterException		invalid floor, contextInfo
	MissingParameterException		missing buildingId, floor or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRoomIdsByType
Description	Retrieves a list of Rooms corresponding to the Room Type key
Parameters	String	roomTypeKey	a Room Type key
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Room Ids
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing roomTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRoomIdsByBuildingAndRoomType
Description	Retrieves a list of Rooms corresponding to the given Building id and Room Type key
Parameters	String	buildingId	a unique Id of a Building
	String	roomTypeKey	a Room Type key
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Room Ids
Errors	DoesNotExistException		buildingId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing buildingId, roomTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRoomsByBuildingAndRoomUsageTypes
Description	Retrieves a list of Rooms corresponding to the given Building id and a list of Room Usage Type keys
Parameters	String	buildingId	a unique Id of a Building
	StringList	roomUsageTypeKeys	a list of Room Usage Type keys
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Room Ids
Errors	DoesNotExistException		buildingId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing buildingId, roomUsageTypeKeys or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRoomIdsByBuildingAndRoomTypes
Description	Retrieves a list of Rooms corresponding to the given Building id and a list of Resource Type keys
Parameters	String	buildingId	a unique Id of a Building
	StringList	roomTypeKeys	a list of Room Type keys
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Room Keys
Errors	DoesNotExistException		buildingId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing buildingId, roomTypeKeys or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForRoomIds
Description	Searches for Rooms based on the criteria and returns a list of Room identifiers which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of Room Ids
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForRooms
Description	Searches for Rooms based on the criteria and returns a list of Rooms which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	RoomInfoList		list of Rooms
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateRoom
Description	Validates a Room. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the Process and a record is found for that identifier, the validation checks if the Process can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationTypeKey	the identifier of the extent of validation
	String	buildingId	Id of the building the room is in
	String	roomTypeKey	a Room Type key
	RoomInfo	roomInfo	the Room information to be tested
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		Results from performing the validation
Errors	DoesNotExistException		validationTypeKey, buildingId not found
	InvalidParameterException		invalid roomInfo or contextInfo
	MissingParameterException		missing validationTypeKey, roomInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createRoom
Description	Creates a new Room
Parameters	String	buildingId	Id of the building the room is in
	String	roomTypeKey	a Room Type key
	RoomInfo	roomInfo	the details of Room to be created
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	RoomInfo		the Room just created
Errors	AlreadyExistsException		the Room being created already exists
	DataValidationErrorException		one or more values invalid for this operation
	DoesNotExistException		buildingId does not exist
	InvalidParameterException		invalid roomInfo or contextInfo
	MissingParameterException		missing roomInfo or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		an attempt at supplying information designated as read-only

Back to Operations

Method	updateRoom
Description	Updates an existing Room
Parameters	String	roomId	the Id of Room to be updated
	RoomInfo	roomInfo	the details of updates to Room being updated
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	RoomInfo		the details of Room just updated
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		roomId not found
	InvalidParameterException		invalid roomInfo or contextInfo
	MissingParameterException		missing roomId, roomInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		an attempt at supplying information designated as read-only
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	deleteRoom
Description	Deletes an existing Room
Parameters	String	roomId	the Id of the Room to be deleted
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		roomId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing roomId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getBuilding
Description	Retrieves a Building
Parameters	String	buildingId	a unique Id of a Building
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	BuildingInfo		a Building
Errors	DoesNotExistException		buildingId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing buildingId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getBuildingsByIds
Description	Retrieves a list of Buildings corresponding to the given list of Building Ids.
Parameters	StringList	buildingIds	list of Buildings to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	BuildingInfoList		a list of Buildings
Errors	DoesNotExistException		a buildingId in list not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing buildingId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getBuildingIdsByCampus
Description	Retrieves a list of Buildings corresponding to the Campus id
Parameters	String	campusKey	a unique Id of a Building
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Building Ids
Errors	DoesNotExistException		campusKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing campusKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForBuildingIds
Description	Searches for Buildings based on the criteria and returns a list of Building Ids which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of Building Ids
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForBuildings
Description	Searches for Buildings based on the criteria and returns a list of Buildings which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	BuildingInfoList		list of Buildings
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateBuilding
Description	Validates a Building. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the Process and a record is found for that identifier, the validation checks if the Process can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	buildingTypeKey	Building Type key
	String	validationTypeKey	the identifier of the extent of validation
	BuildingInfo	buildingInfo	the Building information to be tested
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		Results from performing the validation
Errors	DoesNotExistException		buildingTypeKey, validationTypeKey not found
	InvalidParameterException		invalid buildingInfo or contextInfo
	MissingParameterException		missing validationTypeKey, buildingInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createBuilding
Description	Creates a new Building
Parameters	String	buildingTypeKey	Building Type key
	BuildingInfo	buildingInfo	the details of Building to be created
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	BuildingInfo		the Building just created
Errors	AlreadyExistsException		the Building being created already exists
	DataValidationErrorException		one or more values invalid for this operation
	DoesNotExistException		buildingTypeKey does not exist or is not supported
	InvalidParameterException		invalid buildingInfo or contextInfo
	MissingParameterException		missing buildingInfo or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		an attempt at supplying information designated as read-only

Back to Operations

Method	updateBuilding
Description	Updates an existing Building
Parameters	String	buildingId	the Id of Building to be updated
	BuildingInfo	buildingInfo	the details of updates to Building being updated
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	BuildingInfo		the details of Building just updated
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		buildingId not found
	InvalidParameterException		invalid buildingInfo, or contextInfo
	MissingParameterException		missing buildingId, buildingInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		an attempt at supplying information designated as read-only
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	deleteBuilding
Description	Deletes an existing Building
Parameters	String	buildingId	the Id of the Building to be deleted
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		buildingId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing buildingId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRoomResponsibleOrg
Description	Retrieves a Room Responsible Org
Parameters	String	roomResponsibleOrgId	a unique Id of a Room Responsible Org
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	RoomResponsibleOrgInfo		a Room Responsible Org
Errors	DoesNotExistException		roomResponsibleOrgId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing roomResponsibleOrgId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRoomResponsibleOrgsByIds
Description	Retrieves a list of Room Responsible Orgs corresponding to the given list of Room Ids.
Parameters	StringList	roomResponsibleOrgIds	list of Room Responsible Ids
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	RoomResponsibleOrgInfoList		a list of Room Responsible Orgs
Errors	DoesNotExistException		a roomResponsibleOrgId in list not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing roomResponsibleOrgIds or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRoomResponsibleOrgIdsByType
Description	Retrieves a list of Room Responsible Orgs corresponding to the Room Responsible Org Type key
Parameters	String	roomResponsibleOrgTypeKey	a Room Responsible Org Type key
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Room Responsible Org Ids
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing roomResponsibleOrgTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRoomResponsibleOrgIdsByRoom
Description	Retrieves a list of Room Responsible Org Ids corresponding to the Room id
Parameters	String	roomId	a unique Id of a Room
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Room Responsible Org Ids
Errors	DoesNotExistException		roomId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing roomId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRoomResponsibleOrgIdsForBuilding
Description	Retrieves a list of Room Responsible Orgs corresponding to the Building id
Parameters	String	buildingId	a unique Id of a Building
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Room Responsible Org Ids
Errors	DoesNotExistException		buildingId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing buildingId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForRoomResponsibleOrgIds
Description	Searches for Room Responsible Orgs based on the criteria and returns a list of Room Responsible Org identifiers which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of Room Responsible Ids
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForRoomResponsibleOrgs
Description	Searches for Room Responsible Orgs based on the criteria and returns a list of Room Responsible Orgs which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	RoomResponsibleOrgInfoList		list of Room Responsible Orgs
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateRoomResponsibleOrg
Description	Validates a RoomResponsibleOrg. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the Process and a record is found for that identifier, the validation checks if the Process can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationTypeKey	the identifier of the extent of validation
	String	roomId	room Id
	String	orgId	org Id
	String	roomResponsibleOrgTypeKey	Type of Room Responsible Org
	RoomResponsibleOrgInfo	roomResponsibleOrgInfo	the Room Responsible Org information to be tested
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		Results from performing the validation
Errors	DoesNotExistException		roomId, orgId not found
	InvalidParameterException		invalid roomResponsibleOrgInfo or contextInfo
	MissingParameterException		missing validationTypeKey, roomId, orgId, roomResponsibleOrgInfo or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createRoomResponsibleOrg
Description	Creates a new Room Responsible Org
Parameters	String	roomId	room identifier
	String	orgId	org identifier
	String	roomResponsibleOrgTypeKey	Type of Room Responsible Org
	RoomResponsibleOrgInfo	roomResponsibleOrgInfo	the details of Room Responsible Org to be created
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	RoomResponsibleOrgInfo		the Room Responsible Org just created
Errors	AlreadyExistsException		the Room Responsible Org being created already exists
	DataValidationErrorException		one or more values invalid for this operation
	InvalidParameterException		invalid roomResponsibleOrgInfo or contextInfo
	MissingParameterException		missing roomId, orgId, roomResponsibleOrgTypeKey, roomResponsibleOrgInfo or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		an attempt at supplying information designated as read-only

Back to Operations

Method	updateRoomResponsibleOrg
Description	Updates an existing Room Responsible Org
Parameters	String	roomResponsibleOrgId	the Id of Room Responsible Org to be updated
	RoomResponsibleOrgInfo	roomResponsibleOrgInfo	the details of updates to Room Responsible Org being updated
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	RoomResponsibleOrgInfo		the details of Room Responsible Org just updated
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		roomResponsibleOrgId not found
	InvalidParameterException		invalid roomResponsibleOrgInfo or contextInfo
	MissingParameterException		missing roomResponsibleOrgId, roomResponsibleOrgInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		an attempt at supplying information designated as read-only
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	deleteRoomResponsibleOrg
Description	Deletes an existing Room Responsible Org
Parameters	String	roomResponsibleOrgId	the Id of the Room Responsible Org to be deleted
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		roomResponsibleOrgId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing roomResponsibleOrgId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations