Operation
Information of the operation
| Rw ui textbox macro | ||
|---|---|---|
| ||
Only accessible with permission of pms.integration.segment |
| 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}/segment |
| Div | ||
|---|---|---|
| ||
GET Multiproperty request |
| Div | ||
|---|---|---|
| ||
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/segment |
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
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/segment |
Example Multiproperty request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/segment |
Response
| Property | Type | Required | Description |
|---|---|---|---|
| Page | Page | true | Description of the response of the success operation |
Entity
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Example Single Property response
| Code Block | ||
|---|---|---|
| ||
{
"count": 10,
"offset": 0,
"limit": 3,
"list": [
{
"id" : 20,
"code" : "HOME",
"name" : "House Account"
},
{
"id" : 21,
"code" : "FREE",
"name" : "Free of Charge"
},
{
"id" : 22,
"code" : "LEISU",
"name" : "Leisure"
}
]
} |
Example Multiproperty response
| Code Block | ||
|---|---|---|
| ||
{
"count": 10,
"offset": 0,
"limit": 3,
"list": [
{
"id" : 20,
"code" : "HOME",
"name" : "House Account"
},
{
"id" : 21,
"code" : "FREE",
"name" : "Free of Charge"
},
{
"id" : 22,
"code" : "LEISU",
"name" : "Leisure"
}
]
} |