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


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.
propertyIdListInteger Listfalserequest 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

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity



FieldTypeRequiredDescription
idinttrueId of the Channel
codestringtrueCode of the Channel
namestringtrueName of the Channel
propertyIdintfalseId 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
	        }
  		  ]
}