Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Operation

Information of the operation

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


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.

Example request

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


Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity


FieldTypeRequiredDescription
idinttrueUnique identifier for the Space.
codestringtrueCode of the Space.
namestringtrueName of the Space.

roomSpaceStatusType

RoomSpaceStatusTypetrueStatus of this Space.


Example response

{
	"count": 10,
	"offset": 0,
	"limit": 10,
	"list": [{
			"id": 1,
			"code": "101",
			"name": "M101",
			"roomSpaceStatusType": {
				"id": 2,
				"code": "DI",
				"name": "Dirty"
			}
		},
		{
			"id": 2,
			"code": "102",
			"name": "M102",
			"roomSpaceStatusType": {
				"id": 1,
				"code": "CL",
				"name": "Clean"
			}
		},
		{
			"id": 3,
			"code": "103",
			"name": "M103",
			"roomSpaceStatusType": {
				"id": 1,
				"code": "CL",
				"name": "Clean"
			}
		},
		{
			"id": 4,
			"code": "104",
			"name": "M104",
			"roomSpaceStatusType": {
				"id": 1,
				"code": "CL",
				"name": "Clean"
			}
		},
		{
			"id": 5,
			"code": "105",
			"name": "M105",
			"roomSpaceStatusType": {
				"id": 1,
				"code": "CL",
				"name": "Clean"
			}
		},
		{
			"id": 6,
			"code": "106",
			"name": "M106",
			"roomSpaceStatusType": {
				"id": 1,
				"code": "CL",
				"name": "Clean"
			}
		},
		{
			"id": 7,
			"code": "107",
			"name": "M107",
			"roomSpaceStatusType": {
				"id": 1,
				"code": "CL",
				"name": "Clean"
			}
		},
		{
			"id": 8,
			"code": "108",
			"name": "M108",
			"roomSpaceStatusType": {
				"id": 1,
				"code": "CL",
				"name": "Clean"
			}
		},
		{
			"id": 9,
			"code": "109",
			"name": "M109",
			"roomSpaceStatusType": {
				"id": 1,
				"code": "CL",
				"name": "Clean"
			}
		},
		{
			"id": 10,
			"code": "110",
			"name": "M110",
			"roomSpaceStatusType": {
				"id": 1,
				"code": "CL",
				"name": "Clean"
			}
		}
	]
}
  • No labels