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

« Previous Version 6 Current »

Operation

Information of the operation

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


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 parameter0Limit of results.
sortstringfalserequest parameter0Property of the entity to sort by.
sortModestringfalserequest parameter0Mode of sorting.

Example request

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


Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity



FieldTypeRequiredDescription
idinttrueId of the Policy
codestringtrueCode of the Policy
namestringtrueName of the Policy
descriptionstringfalse
nonRefundablebooleanfalse
deadLineDayintegerfalse
deadLineHourintegerfalse
policyChargeTypePolicyChargeTypefalse
chargeValuebigDecimalfalse
depositSuggestedAmountbigDecimalfalse
depositSuggestedPercentageAmountbigDecimalfalse

Example response

{
  "count": 6,
  "offset": 0,
  "limit": 10,
  "list": [
    {
      "id": 2,
      "code": "NR",
      "name": "Non Refundable"
    },
    {
      "id": 8,
      "code": "60D",
      "name": "60 Days Before Arrival"
    },
    {
      "id": 14,
      "code": "30D",
      "name": "30 Days Before Arrival"
    },
    {
      "id": 20,
      "code": "15D",
      "name": "15 Days Before Arrival"
    },
    {
      "id": 26,
      "code": "48H",
      "name": "48 Hours Before Arrival"
    },
    {
      "id": 32,
      "code": "24H",
      "name": "24 Hours Before Arrival"
    }
  ]
}
  • No labels