/
ChainSegment List [GET]

ChainSegment List [GET]

Owned by Miquel Galobardes (Unlicensed)
Last updated: Jun 01, 2022

Operation

Information of the operation

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


Request


PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter0Unique identificator of the chain.
offsetIntegerfalserequest parameter0Offset of the array of results.
limitIntegerfalserequest parameter10Limit of results.
sortstringfalserequest parameteridProperty of the entity to sort by.
sortModestringfalserequest parameterascMode of sorting.

Example request

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


Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity



FieldTypeRequiredDescription
idinttrueId of the ChainSegment
codestringtrueCode of the ChainSegment
namestringtrueName of the ChainSegment
orderinttrueOrder of the ChainSegment
chainSegmentGroupIdinttrueChainSegment Group Id

Example response

{
    "count": 19,
    "offset": 0,
    "limit": 10,
    "list": [
			 {
	 		  "id": 1,
              "code": "HOME",
              "name": "House Account",
              "order": 16,
              "chainSegmentGroupId": 1
        	 },
        	 {
              "id": 2,
              "code": "FREE",
              "name": "Free of Charge",
              "order": 17,
              "chainSegmentGroupId": 2
        	 },
        	 {
              "id": 3,
              "code": "LEISU",
              "name": "Leisure",
              "order": 0,
              "chainSegmentGroupId": null
        	 }
  			]
}

Related content