Operation
Get a list of all the boards.
| Rw ui textbox macro | ||
|---|---|---|
| ||
Only accessible with permission of pms.integration.product |
| Style |
|---|
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
} |
| Div | ||
|---|---|---|
| ||
GET Single property request |
| Div | ||
|---|---|---|
| ||
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/board/forecast |
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. | |
| date | LocalDate | false | request parameter | date of the offset | |
| limit | Integer | false | request parameter | 10 | Limit of results. |
Example Single Property request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET https://publicapi-providers.ulysescloud.com/public/api/v1/con/chain/1/property/1/board/forecast |
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 Board's. Description of the Board entity:
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Example Single Property response
| Code Block | ||
|---|---|---|
| ||
{
"count": 4,
"offset": 0,
"limit": 10,
"list": [
{
"id": 5,
"code": null,
"name": "Room Only",
"serviceList": null,
"forecastList": [
{
"boardId": 2,
"date": "2022-08-25",
"quantityConsumedAdult": 5,
"quantityConsumedJunior": 4,
"quantityConsumedChild": 2,
"quantityConsumedInfant": 1,
}...
]
},
{
"id": 6,
"code": null,
"name": "Bed And Breakfast",
"serviceList": [
{
"id": 63,
"code": "BRK",
"name": "Breakfast"
}
],
"forecastList": [
{
"boardId": 6,
"date": "2022-08-15",
"quantityConsumedAdult": 5,
"quantityConsumedJunior": 4,
"quantityConsumedChild": 2,
"quantityConsumedInfant": 1,
}...
]
},
{
"id": 7,
"code": null,
"name": "HalfBoard",
"serviceList": [
{
"id": 63,
"code": "BRK",
"name": "Breakfast"
},
{
"id": 68,
"code": "DINNER",
"name": "Dinner"
}
],
"forecastList": [
{
"boardId": 27,
"date": "2022-08-25",
"quantityConsumedAdult": 5,
"quantityConsumedJunior": 4,
"quantityConsumedChild": 2,
"quantityConsumedInfant": 1,
}...
]
}
]
} |