Allotment List [GET]

Operation

Information of the operation

GET

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

Request

Property	Type	Required	Path parameter	Default value	Description

Property	Type	Required	Path 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.

Example request

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

Response

Property	Type	Required	Description

Property	Type	Required	Description
Page	Page	true	Description of the response of the success operation

Entity

Example response

{
	"count": 3,
	"offset": 0,
	"limit": 10,
	"list": [
		{
			"id": 2,
			"code": "TEST1",
			"name": "Allotment Test 1",
			"startDate": "2023-01-01",
			"endDate": "2025-01-01",
			"startSellDate": null,
			"endSellDate": null,
			"releaseDay": 1,
			"deadLineDay": 2,
			"source": {
                "id": 9,
                "code": "COM",
                "name": "Company"
            },
            "segment": {
                "id": 24,
                "code": "DUSE",
                "name": "Day Use"
            },
            "allotmentGuaranteeType": {
                "id": 1,
                "code": "GUA",
                "name": "Guaranteed"
            }
		},
		{
			"id": 17,
			"code": "TEST2",
			"name": "Allotment Test 2",
			"startDate": "2023-01-01",
			"endDate": "2025-01-01",
			"startSellDate": null,
			"endSellDate": null,
			"releaseDay": 0,
			"deadLineDay": 0,
			"source": {
                "id": 9,
                "code": "COM",
                "name": "Company"
            },
            "segment": {
                "id": 24,
                "code": "DUSE",
                "name": "Day Use"
            },
            "allotmentGuaranteeType": {
                "id": 1,
                "code": "GUA",
                "name": "Guaranteed"
            }
		},
		{
			"id": 32,
			"code": "TEST3",
			"name": "Allotment Test 3",
			"startDate": "2023-01-01",
			"endDate": "2025-01-01",
			"startSellDate": null,
			"endSellDate": null,
			"releaseDay": 0,
			"deadLineDay": 0,
			"source": {
                "id": 9,
                "code": "COM",
                "name": "Company"
            },
            "segment": {
                "id": 24,
                "code": "DUSE",
                "name": "Day Use"
            },
            "allotmentGuaranteeType": {
                "id": 1,
                "code": "GUA",
                "name": "Guaranteed"
            }
		}
	]
}

UlysesCloud Open API