Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

Get a list of all the products of type payment in a given property.

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.product


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}


.separator{
margin: 5px 0;
}



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

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



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
offsetIntegerfalse0request parameter
Offset of the array of results.
limitIntegerfalse10request parameter
Limit of results.
sortstringfalseidrequest parameter
Property of the entity to sort by.
sortModestringfalseAscrequest parameter
Mode of sorting.


Example request

Code Block
languagepowershell
themeDJango
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/payment



Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity

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

Insert excerpt
Payment
Payment
nopaneltrue


Example response

Code Block
themeDJango
{
  "count": 10,
  "offset": 0,
  "limit": 3,
  "list": [
    {
      "id": 1,
      "name": "Cash"
    },
    {
      "id": 2,
      "name": "MasterCard"
    },
    {
      "id": 3,
      "name": "Transfer"
    }
  ]
}