Rate List [GET]
Operation
Information of the operation
GET Single property request
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/rate
GET Multiproperty request
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/rate
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. | |
chainRateTypeId | Integer | false | request parameter | Unique id of the chainRateType | |
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/rate
Example Multiproperty request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/rate
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 Rate |
code | string | true | Code of the Rate |
name | string | true | Name of the Rate |
rateType | RateType | true | RateType of the ChainRate that belongs this Rate |
releaseDay | int | true | ReleaseDay of the Offer |
deadLineDay | int | true | DeadLineDay of the Offer |
startDate | LocalDate | true | StartDate of the Offer |
endDate | LocalDate | true | EndDate of the Offer |
startSellDate | LocalDate | false | StartSellDate of the Offer |
endSellDate | LocalDate | false | EndSellDate of the Offer |
propertyId | int | false | Id of the property (Only for multiproperty request) |
Example Single Property response
{ "count": 31, "offset": 0, "limit": 3, "list": [ { "id": 30, "code": "BAR", "name": "BAR SA", "rateType": { "id": 1, "code": "BAR", "name": "BAR Type" } }, { "id": 31, "code": "BARAD", "name": "BAR AD", "rateType": { "id": 1, "code": "BAR", "name": "BAR Type" } }, { "id": 32, "code": "BARHB", "name": "BAR HB", "rateType": { "id": 1, "code": "BAR", "name": "BAR Type" } } ] }
Example Multiproperty response
{ "count": 66, "offset": 0, "limit": 3, "list": [ { "id": 30, "code": "BAR", "name": "BAR SA", "rateType": { "id": 1, "code": "BAR", "name": "BAR Rate type" }, "propertyId": 3 }, { "id": 31, "code": "BARAD", "name": "BAR AD", "rateType": { "id": 1, "code": "BAR", "name": "BAR Rate type" }, "propertyId": 3 }, { "id": 48, "code": "BARHB", "name": "BAR HB", "rateType": { "id": 1, "code": "BAR", "name": "BAR Rate type" }, "propertyId": 4 } ] }