Versions Compared

Version Old Version 7 New Version Current
Changes made by

David Martin

Miquel Galobardes (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

Information of the operation

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.segment


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET Single property request



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

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



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET Multiproperty request



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

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


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

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

Example Multiproperty request

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



Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity


Insert excerpt
Segment
Segment
nopaneltrue

Example Single Property response

Code Block
themeDJango
{
  "count": 10,
  "offset": 0,
  "limit": 103,
  "list": [
    	{
     	 "id" : 220,

     "code" : "CS1HOME",

     "name" : "ChainSegmentHouse 1Account"
    	},
    	{
      "id" : 821,

     "code" : "CS2FREE",

     "name" : "ChainSegmentFree of 2Charge"
    	},
    	{

     "id" : 1422,

     "code" : "CS3LEISU",
      "name" : "ChainSegment 3Leisure"
    	},
    {
   ]
}

Example Multiproperty response

Code Block
themeDJango
{
  "idcount": 2010,
      "codeoffset": "CS4",
   0,
  "namelimit": "ChainSegment 4"
    }3,
  "list": [
	{
	      "id" : 261,
      "code" : "CS5HOME",

     "name" : "ChainSegmentHouse 5Account"
    },
    {
      "id": 32,
      "code": "CS6",
      "name": "ChainSegment 6"
    },
    	 "propertyId" : 1
  	},
	{
      "id" : 382,

     "code" : "CS7FREE",

     "name" : "ChainSegmentFree 7"
    },
    {
      "id": 44,
      "code": "CS8",
      "name": "ChainSegment 8"
    },
    {
of Charge"
	 "propertyId" : 1
  	},
	{
     "id" : 506,

     "code" : "CS9LEISU",
      "name" : "ChainSegment 9Leisure"
    },
    {
      "id": 56,
      "code": "CS10",
      "name": "ChainSegment 10"
    	 "propertyId" : 2
  	}
  ]
}