/
PBXRequestQueue List [GET]

PBXRequestQueue List [GET]

Owned by David Garcerán
Last updated: Aug 21, 2020 by Jordi Artal

Operation

Information of the operation

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


Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
integrationIdIntegertruepath parameter
Unique identificator of the Integration.
offsetIntegerfalserequest parameter0Offset of the array of results.
limitIntegerfalserequest parameter10Limit of results.
sortstringfalserequest parameteridProperty of the entity to sort by.
sortModestringfalserequest parameterAscMode of sorting.

Example request

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


Response

PropertyTypeRequiredDescription
PagePagetruePaged result

Entity


FieldTypeRequiredDescription
idinttrueUnique identifier for the PBXRequestQueue.

pbxRequestType

PBXRequestTypetrueType of request.

space

SpacetrueSpace related to this request.

reservationRoomStay

ReservationRoomStayfalseReservationRoomStay related to this request.

responseStatusCode

ResponseStatusCodetrueStatus 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"
		}
	}]
}

Related content