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


PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
chainRateTypeIdIntegerfalserequest parameter
Unique id of the chainRateType
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

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

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity



FieldTypeRequiredDescription
idinttrueId of the Rate
codestringtrueCode of the Rate
namestringtrueName of the Rate
rateTypeRateTypetrueRateType 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
	        }
    	   ]
}