Reference

Floorplan

The floorplan object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this floorplan
BackgroundScale: int required
BusinessId: Id required
DisplayBackground: bool optional
Name: string required
PositionX: int required
PositionY: int required
Scale: decimal required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this floorplan
SystemId: string optional api-only
User defined data about this floorplan. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BackgroundScale": ,
  "BusinessId": 12345678,
  "DisplayBackground": false,
  "Name": "00001",
  "PositionX": ,
  "PositionY": ,
  "Scale": 1.2,
  "UniqueId": "0fe96cda-9baf-46d9-802c-803877720416",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a FloorPlan

This endpoint allows you to GET a list of floorplans based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/sys/floorplans?...

πŸ”’ Requires role "FloorPlan-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search floorplan records based on their different properties.
Id number
?Id=12345678
FloorPlan_BackgroundScale int
?FloorPlan_BackgroundScale=...
FloorPlan_Business Business
?FloorPlan_Business=...
FloorPlan_DisplayBackground bool
?FloorPlan_DisplayBackground=...
FloorPlan_Name string
?FloorPlan_Name=...
FloorPlan_PositionX int
?FloorPlan_PositionX=...
FloorPlan_PositionY int
?FloorPlan_PositionY=...
FloorPlan_Scale decimal
?FloorPlan_Scale=...
FloorPlan_BusinessName string
?FloorPlan_BusinessName=...
FloorPlan_BusinessCurrency_Code string
?FloorPlan_BusinessCurrency_Code=...

Range search querystring parameters
Lets you search floorplan records based on a range of date or numeric values.
To_FloorPlan_CreatedOn date
?To_FloorPlan_CreatedOn=2010-01-01T20:32
From_FloorPlan_CreatedOn date
?From_FloorPlan_CreatedOn=2010-01-01T20:32
To_FloorPlan_UpdatedOn date
?To_FloorPlan_UpdatedOn=2010-01-01T20:32
From_FloorPlan_UpdatedOn date
?From_FloorPlan_UpdatedOn=2010-01-01T20:32
To_FloorPlan_BackgroundScale number
?To_FloorPlan_BackgroundScale=0
From_FloorPlan_BackgroundScale number
?From_FloorPlan_BackgroundScale=10
To_FloorPlan_PositionX number
?To_FloorPlan_PositionX=0
From_FloorPlan_PositionX number
?From_FloorPlan_PositionX=10
To_FloorPlan_PositionY number
?To_FloorPlan_PositionY=0
From_FloorPlan_PositionY number
?From_FloorPlan_PositionY=10
To_FloorPlan_Scale number
?To_FloorPlan_Scale=0
From_FloorPlan_Scale number
?From_FloorPlan_Scale=10

Example request

GET https://spaces.nexudus.com/api/sys/floorplans?FloorPlan_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "00001",
        "DisplayBackground": false,
        "BackgroundScale": ,
        "PositionX": ,
        "PositionY": ,
        "Scale": 1.2,
        "FloorPlanBusinessName": "...",
        "FloorPlanBusinessCurrency_Code": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "a65fa253-c2b9-42e1-9f34-398227387002",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find FloorPlans by IDs

Gets one or more floorplan records based on their Id.
GET https://spaces.nexudus.com/api/sys/floorplans?FloorPlan_Id=[:id1,:id2,...]

πŸ”’ Requires role "FloorPlan-List"

Querystring parameters
FloorPlan_Id: array requried
?FloorPlan_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/sys/floorplans?FloorPlan_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "00001",
        "DisplayBackground": false,
        "BackgroundScale": ,
        "PositionX": ,
        "PositionY": ,
        "Scale": 1.2,
        "FloorPlanBusinessName": "...",
        "FloorPlanBusinessCurrency_Code": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "f9b2da6a-e023-43e8-b70d-2a5c69c7127c",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single FloorPlan by Id

Gets one floorplan record by its Id.
GET https://spaces.nexudus.com/api/sys/floorplans/:Id

πŸ”’ Requires role "FloorPlan-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/sys/floorplans/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "BackgroundScale": ,
  "BusinessId": 12345678,
  "DisplayBackground": false,
  "Name": "00001",
  "PositionX": ,
  "PositionY": ,
  "Scale": 1.2,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "a872da48-5d84-4caa-954f-4dd5a3d85860",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new FloorPlan

Creates a new floorplan.
POST https://spaces.nexudus.com/api/sys/floorplans

πŸ”’ Requires role "FloorPlan-Create"

Body parameters
BusinessId: number required
Name: string required
DisplayBackground: bool optional
BackgroundScale: int required
PositionX: int required
PositionY: int required
Scale: decimal required

Example request

POST https://spaces.nexudus.com/api/sys/floorplans
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "BusinessId": 12345678,
    "Name": "00001",
    "DisplayBackground": false,
    "BackgroundScale": ,
    "PositionX": ,
    "PositionY": ,
    "Scale": 1.2,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update FloorPlan

Updates an existing floorplan.
PUT https://spaces.nexudus.com/api/sys/floorplans

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "FloorPlan-Edit"

Body parameters
Id: number required
The unique Id of the floorplan to update.
BusinessId: number cleared if missing
Name: string cleared if missing
DisplayBackground: bool cleared if missing
BackgroundScale: int cleared if missing
PositionX: int cleared if missing
PositionY: int cleared if missing
Scale: decimal cleared if missing

Example request

PUT https://spaces.nexudus.com/api/sys/floorplans
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "00001",
    "DisplayBackground": false,
    "BackgroundScale": ,
    "PositionX": ,
    "PositionY": ,
    "Scale": 1.2,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Delete FloorPlan

Deletes an existing floorplan by its Id.
DELETE https://spaces.nexudus.com/api/sys/floorplans/:Id

πŸ”’ Requires role "FloorPlan-Delete"

URL parameters
Id: number required
The unique Id of the floorplan to update.

Example request

DELETE https://spaces.nexudus.com/api/sys/floorplans/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}


Commands

Commands allow to perform actions against one or more floorplan records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for floorplan records.
GET https://spaces.nexudus.com/api/sys/floorplans/commands

Example request

GET https://spaces.nexudus.com/api/sys/floorplans/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more floorplan record IDs.
POST https://spaces.nexudus.com/api/sys/floorplans/runacommand
πŸ”’ Requires role "FloorPlan-Edit"

Example request

POST https://spaces.nexudus.com/api/sys/floorplans/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Binary files

The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.

BackgroundImage

GET https://spaces.nexudus.com/api/sys/floorplans/getbackgroundimage/:id
URL parameters
Id: number required
The id of the FloorPlan to get the backgroundimage for.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.