Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Operation

Get the list of services in a paged array.

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


Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
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/1/service/item


Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity

The entity returned is a Page with a list of Service's. Description of the Service entity:


FieldTypeRequiredDescription
idinttrueUnique identifier for the Service.
codeStringtrueCode of the Service.
nameStringtrueName of the Service.
forecastListProductServiceAvailabilityfalseA list of associated ProductServiceAvailability to this Service. Only apears if we have data.

Example response

[
	{
    "id": 55,
    "code": "MB",
    "name": "Minibar",
    "productType": {
      "id": 2,
      "code": "SER",
      "name": "Service",
      "nameI18n": "Service"
    },
    "itemList": [
      {
        "id": 2,
        "code": "AG",
        "name": "AGUA SIN GAS",
        "nameI18n": "AGUA SIN GAS",
        "description": null,
        "descriptionI18n": null,
        "imageURL": null,
        "amountAfterTax": 2.5,
        "active": true,
        "quantity": null
      },
      {
        "id": 3,
        "code": "AGG",
        "name": "AGUA CON GAS",
        "nameI18n": "AGUA CON GAS",
        "description": null,
        "descriptionI18n": null,
        "imageURL": null,
        "amountAfterTax": 2.5,
        "active": true,
        "quantity": null
      } ]
  }
]
  • No labels