PBXRequestQueue List [GET]

Operation

Information of the operation

GET

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/pbx/{integrationId}/requests

Request

Property	Type	Required	Type parameter	Default value	Description
chainId	Integer	true	path parameter		Unique identificator of the chain.
propertyId	Integer	true	path parameter		Unique identificator of the property.
integrationId	Integer	true	path parameter		Unique identificator of the Integration.
offset	Integer	false	request parameter	0	Offset of the array of results.
limit	Integer	false	request parameter	10	Limit of results.
sort	string	false	request parameter	id	Property of the entity to sort by.
sortMode	string	false	request parameter	Asc	Mode of sorting.

Example request

GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/3/pbx/9/requests

Response

Property	Type	Required	Description
Page	Page	true	Paged result

Entity

Field	Type	Required	Description
id	int	true	Unique identifier for the PBXRequestQueue.
pbxRequestType	PBXRequestType	true	Type of request.
space	Space	true	Space related to this request.
reservationRoomStay	ReservationRoomStay	false	ReservationRoomStay related to this request.
responseStatusCode	ResponseStatusCode	true	Status of this request in the queue.

Example response

{
	"count": 1,
	"offset": 0,
	"limit": 10,
	"list": [{
		"id": 5,
		"pbxRequestType": {
			"id": 1,
			"code": "CI",
			"name": "CheckIn"
		},
		"space": {
			"id": 1,
			"code": "101",
			"name": "S101",
			"roomSpaceStatusType": {
				"id": 1,
				"code": "CL",
				"name": "Clean"
			}
		},
		"reservationRoomStay": null,
		"responseStatusCode": {
			"id": 4,
			"code": "4",
			"name": "Pending"
		}
	}]
}