Segment List [GET]

Operation

Information of the operation

GET Single property request

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

GET Multiproperty request

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

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

Example Multiproperty request

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

Field	Type	Required	Description
id	int	true	Id of the Segment
code	string	true	Code of the Segment
name	string	true	Name of the Segment
propertyId	int	false	Id of the property (Only for multiproperty request)

Example Single Property response

{
  "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

{
  "count": 10,
  "offset": 0,
  "limit": 3,
  "list": [
	{
	 "id" : 1,
     "code" : "HOME",
     "name" : "House Account"
	 "propertyId" : 1
  	},
	{
     "id" : 2,
     "code" : "FREE",
     "name" : "Free of Charge"
	 "propertyId" : 1
  	},
	{
     "id" : 6,
     "code" : "LEISU",
     "name" : "Leisure"
	 "propertyId" : 2
  	}
  ]
}