Accommodation List [GET]
Operation
Get a list of all the accommodations.
GET
https://{environment}.ulysescloud.com/
public/
api/{version}/con/chain/{chainId}/property/{propertyId}/accommodation
Request
Property | Type | Required | Path parameter | Default value | Description |
---|---|---|---|---|---|
chainId | Integer | true | path parameter | Unique identificator of the chain. | |
propertyId | Integer | true | path parameter | Unique identificator of the property. | |
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/1/accommodation
Response
Property | Type | Required | Description |
---|---|---|---|
Page | Page | true | Description of the response of the success operation |
Entity
The entity returned is a Page with a list of Accommodation's. Description of the Accommodation entity:
Field Type Required Description id Integer true Unique identifier for the Accommodation. name String true Name of the Accommodation. code String false Code of the Accommodation. roomType RoomType false Room type associated to this Accommodation.
Example response
{ "count": 9, "offset": 0, "limit": 3, "list": [{ "id": 752, "name": "Suite", "roomType": { "id": 77, "name": "Suite" } }, { "id": 737, "name": "Junior Suite", "roomType": { "id": 62, "name": "Junior Suite" } }, { "id": 722, "name": "Family", "roomType": { "id": 47, "name": "Family" } }] }