Board List [GET]

Operation

Get a list of all the boards.

GET Single property request

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

GET Multiproperty request

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/board

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.
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.
propertyIdList	Integer List	false	request parameter		Property Id List - Only for Multiproperty Get

Example Single Property request

GET https://publicapi-providers.ulysescloud.com/public/api/v1/con/chain/1/property/1/board

Example Multiproperty request

GET https://publicapi-providers.ulysescloud.com/public/api/v1/con/chain/1/property/board

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:

Field	Type	Required	Description
id	int	true	Unique identifier for the Board.
chainId	int	true	ChainBoard Identifier related to the Board.
code	string	true	Code of the Board.
name	string	true	Name of the Board.
propertyId	int	false	PropertyId of the Board.
serviceList	Array of Service	false	A list of associated Service to this Board.
forecastList	Array of BoardAvailability	false	A list of associated BoardAvailability to this Board. Only apears if we have data.

Example Single Property response

{
  "count": 4,
  "offset": 0,
  "limit": 10,
  "list": [
    {
      "id": 5,
      "code": null,
      "name": "Room Only",
      "serviceList": null
    },
    {
      "id": 6,
      "code": null,
      "name": "Bed And Breakfast",
      "serviceList": [
        {
          "id": 63,
          "code": "BRK",
          "name": "Breakfast"
        }
      ]
    },
    {
      "id": 7,
      "code": null,
      "name": "HalfBoard",
      "serviceList": [
        {
          "id": 63,
          "code": "BRK",
          "name": "Breakfast"
        },
        {
          "id": 68,
          "code": "DINNER",
          "name": "Dinner"
        }
      ]   
    }
  ]
}

Example Multiproperty response

{
  "count": 14,
  "offset": 0,
  "limit": 1000,
  "list": [
           {
             "id": 1,
             "chainBoardId": 1,
             "code": "RO",
             "name": "Room Only",
             "propertyId": 1,
             "serviceList": null
           },
           {
             "id": 15,
             "chainBoardId": 2,
             "code": "BB",
             "name": "Bed and Breakfast",
             "propertyId": 1,
             "serviceList": [
				              {
                			    "id": 22,
			                    "code": "1BRE",
            			        "name": "Breakfast"
                			   }
            				]
        	},
        	{
              "id": 16,
              "chainBoardId": 3,
              "code": "HB",
              "name": "Half Board Dinner",
              "propertyId": 1,
              "serviceList": [
           				      {
                    			"id": 22,
			                    "code": "1BRE",
			                    "name": "Breakfast"
            			      },
			                  {
              			        "id": 24,
			                    "code": "4DIN",
			                    "name": "Dinner"
			                  }
				             ]
	         }
			]
}