Channel List [GET]
Operation
Information of the operation
GET Single property request
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/channel
GET Multiproperty request
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/channel
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:9797/public/api/v1/con/chain/1/property/1/channel
Example Multiproperty request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/channel
Response
Property | Type | Required | Description |
---|---|---|---|
Page | Page | true | Description of the response of the success operation |
Entity
Field | Type | Required | Description |
---|---|---|---|
id | int | true | Id of the Channel |
code | string | true | Code of the Channel |
name | string | true | Name of the Channel |
propertyId | int | false | Id of the property (Only for multiproperty request) |
Example Single Property response
{ "count": 10, "offset": 0, "limit": 3, "list": [ { "id": 25, "code": "MAIL", "name": "E mail" }, { "id": 26, "code": "TELF", "name": "Phone call" }, { "id": 27, "code": "FRONT", "name": "Front Desk" } ] }
Example Multiproperty response
{ "count": 10, "offset": 0, "limit": 10, "list": [ { "id": 25, "code": "MAIL", "name": "E mail", "propertyId": 3 }, { "id": 26, "code": "TELF", "name": "Phone call", "propertyId": 3 }, { "id": 35, "code": "FRONT", "name": "Front Desk", "propertyId": 4 } ] }