Reference

Floorplandesk

The floorplandesk object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this floorplandesk
Area: string optional
Available: bool optional
Capacity: decimal required
CoworkerId: Id optional
FloorPlanId: Id required
ItemType: Nexudus.Coworking.Core.Enums.eFloorPlanItemType optional
Name: string required
Notes: string optional
PositionX: int required
PositionY: int required
PositionZ: int required
Price: decimal required
ResourceId: Id optional
Size: decimal required
TunnelPrivateGroupId: string optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this floorplandesk
SystemId: string optional api-only
User defined data about this floorplandesk. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Area": "00001",
  "Available": false,
  "Capacity": 1.2,
  "CoworkerId": 12345678,
  "FloorPlanId": 12345678,
  "ItemType": 1,
  "Name": "00001",
  "Notes": "00001",
  "PositionX": ,
  "PositionY": ,
  "PositionZ": ,
  "Price": 1.2,
  "ResourceId": 12345678,
  "Size": 1.2,
  "TunnelPrivateGroupId": "Abc123456",
  "UniqueId": "3827e4fe-e59c-425f-8fe5-bd5641f2be20",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a FloorPlanDesk

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

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

πŸ”’ Requires role "FloorPlanDesk-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 floorplandesk records based on their different properties.
Id number
?Id=12345678
FloorPlanDesk_Area string
?FloorPlanDesk_Area=...
FloorPlanDesk_Available bool
?FloorPlanDesk_Available=...
FloorPlanDesk_Capacity decimal
?FloorPlanDesk_Capacity=...
FloorPlanDesk_Coworker Coworker
?FloorPlanDesk_Coworker=...
FloorPlanDesk_FloorPlan FloorPlan
?FloorPlanDesk_FloorPlan=...
FloorPlanDesk_ItemType Nexudus.Coworking.Core.Enums.eFloorPlanItemType
?FloorPlanDesk_ItemType=...
FloorPlanDesk_Name string
?FloorPlanDesk_Name=...
FloorPlanDesk_Notes string
?FloorPlanDesk_Notes=...
FloorPlanDesk_PositionX int
?FloorPlanDesk_PositionX=...
FloorPlanDesk_PositionY int
?FloorPlanDesk_PositionY=...
FloorPlanDesk_PositionZ int
?FloorPlanDesk_PositionZ=...
FloorPlanDesk_Price decimal
?FloorPlanDesk_Price=...
FloorPlanDesk_Resource Resource
?FloorPlanDesk_Resource=...
FloorPlanDesk_Size decimal
?FloorPlanDesk_Size=...
FloorPlanDesk_TunnelPrivateGroupId string
?FloorPlanDesk_TunnelPrivateGroupId=...
FloorPlanDesk_FloorPlanName string
?FloorPlanDesk_FloorPlanName=...
FloorPlanDesk_FloorPlanBusiness_Currency_Code string
?FloorPlanDesk_FloorPlanBusiness_Currency_Code=...
FloorPlanDesk_FloorPlanBusiness_Name string
?FloorPlanDesk_FloorPlanBusiness_Name=...
FloorPlanDesk_CoworkerFullName string
?FloorPlanDesk_CoworkerFullName=...
FloorPlanDesk_ResourceName string
?FloorPlanDesk_ResourceName=...
FloorPlanDesk_ResourceResourceType_Name string
?FloorPlanDesk_ResourceResourceType_Name=...
FloorPlanDesk_ResourceAllocation string
?FloorPlanDesk_ResourceAllocation=...
FloorPlanDesk_ResourceProjector string
?FloorPlanDesk_ResourceProjector=...
FloorPlanDesk_ResourceInternet string
?FloorPlanDesk_ResourceInternet=...
FloorPlanDesk_ResourceConferencePhone string
?FloorPlanDesk_ResourceConferencePhone=...
FloorPlanDesk_ResourceStandardPhone string
?FloorPlanDesk_ResourceStandardPhone=...
FloorPlanDesk_ResourceWhiteBoard string
?FloorPlanDesk_ResourceWhiteBoard=...
FloorPlanDesk_ResourceLargeDisplay string
?FloorPlanDesk_ResourceLargeDisplay=...
FloorPlanDesk_ResourceCatering string
?FloorPlanDesk_ResourceCatering=...
FloorPlanDesk_ResourceTeaAndCoffee string
?FloorPlanDesk_ResourceTeaAndCoffee=...
FloorPlanDesk_ResourceDrinks string
?FloorPlanDesk_ResourceDrinks=...
FloorPlanDesk_ResourceSecurityLock string
?FloorPlanDesk_ResourceSecurityLock=...
FloorPlanDesk_ResourceCCTV string
?FloorPlanDesk_ResourceCCTV=...
FloorPlanDesk_ResourceVoiceRecorder string
?FloorPlanDesk_ResourceVoiceRecorder=...
FloorPlanDesk_ResourceAirConditioning string
?FloorPlanDesk_ResourceAirConditioning=...
FloorPlanDesk_ResourceHeating string
?FloorPlanDesk_ResourceHeating=...
FloorPlanDesk_ResourceNaturalLight string
?FloorPlanDesk_ResourceNaturalLight=...
FloorPlanDesk_ResourceStandingDesk string
?FloorPlanDesk_ResourceStandingDesk=...
FloorPlanDesk_ResourceQuietZone string
?FloorPlanDesk_ResourceQuietZone=...
FloorPlanDesk_ResourceWirelessCharger string
?FloorPlanDesk_ResourceWirelessCharger=...
FloorPlanDesk_ResourcePrivacyScreen string
?FloorPlanDesk_ResourcePrivacyScreen=...
FloorPlanDesk_ResourceSoundproof string
?FloorPlanDesk_ResourceSoundproof=...
FloorPlanDesk_ResourceShifts string
?FloorPlanDesk_ResourceShifts=...

Range search querystring parameters
Lets you search floorplandesk records based on a range of date or numeric values.
To_FloorPlanDesk_CreatedOn date
?To_FloorPlanDesk_CreatedOn=2010-01-01T20:32
From_FloorPlanDesk_CreatedOn date
?From_FloorPlanDesk_CreatedOn=2010-01-01T20:32
To_FloorPlanDesk_UpdatedOn date
?To_FloorPlanDesk_UpdatedOn=2010-01-01T20:32
From_FloorPlanDesk_UpdatedOn date
?From_FloorPlanDesk_UpdatedOn=2010-01-01T20:32
To_FloorPlanDesk_Size number
?To_FloorPlanDesk_Size=0
From_FloorPlanDesk_Size number
?From_FloorPlanDesk_Size=10
To_FloorPlanDesk_Capacity number
?To_FloorPlanDesk_Capacity=0
From_FloorPlanDesk_Capacity number
?From_FloorPlanDesk_Capacity=10
To_FloorPlanDesk_Price number
?To_FloorPlanDesk_Price=0
From_FloorPlanDesk_Price number
?From_FloorPlanDesk_Price=10
To_FloorPlanDesk_PositionX number
?To_FloorPlanDesk_PositionX=0
From_FloorPlanDesk_PositionX number
?From_FloorPlanDesk_PositionX=10
To_FloorPlanDesk_PositionY number
?To_FloorPlanDesk_PositionY=0
From_FloorPlanDesk_PositionY number
?From_FloorPlanDesk_PositionY=10
To_FloorPlanDesk_PositionZ number
?To_FloorPlanDesk_PositionZ=0
From_FloorPlanDesk_PositionZ number
?From_FloorPlanDesk_PositionZ=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "FloorPlan": ,
        "Coworker": ,
        "Name": "00001",
        "ItemType": 1,
        "Resource": ,
        "Size": 1.2,
        "Capacity": 1.2,
        "Price": 1.2,
        "Area": "00001",
        "Notes": "00001",
        "Available": false,
        "PositionX": ,
        "PositionY": ,
        "PositionZ": ,
        "TunnelPrivateGroupId": "Abc123456",
        "FloorPlanDeskFloorPlanName": "...",
        "FloorPlanDeskFloorPlanBusiness_Currency_Code": "...",
        "FloorPlanDeskFloorPlanBusiness_Name": "...",
        "FloorPlanDeskCoworkerFullName": "...",
        "FloorPlanDeskResourceName": "...",
        "FloorPlanDeskResourceResourceType_Name": "...",
        "FloorPlanDeskResourceAllocation": "...",
        "FloorPlanDeskResourceProjector": "...",
        "FloorPlanDeskResourceInternet": "...",
        "FloorPlanDeskResourceConferencePhone": "...",
        "FloorPlanDeskResourceStandardPhone": "...",
        "FloorPlanDeskResourceWhiteBoard": "...",
        "FloorPlanDeskResourceLargeDisplay": "...",
        "FloorPlanDeskResourceCatering": "...",
        "FloorPlanDeskResourceTeaAndCoffee": "...",
        "FloorPlanDeskResourceDrinks": "...",
        "FloorPlanDeskResourceSecurityLock": "...",
        "FloorPlanDeskResourceCCTV": "...",
        "FloorPlanDeskResourceVoiceRecorder": "...",
        "FloorPlanDeskResourceAirConditioning": "...",
        "FloorPlanDeskResourceHeating": "...",
        "FloorPlanDeskResourceNaturalLight": "...",
        "FloorPlanDeskResourceStandingDesk": "...",
        "FloorPlanDeskResourceQuietZone": "...",
        "FloorPlanDeskResourceWirelessCharger": "...",
        "FloorPlanDeskResourcePrivacyScreen": "...",
        "FloorPlanDeskResourceSoundproof": "...",
        "FloorPlanDeskResourceShifts": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "ed1d1f95-f7a2-44bb-bbaa-7ae045e42f71",
        "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 FloorPlanDesks by IDs

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

πŸ”’ Requires role "FloorPlanDesk-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "FloorPlan": ,
        "Coworker": ,
        "Name": "00001",
        "ItemType": 1,
        "Resource": ,
        "Size": 1.2,
        "Capacity": 1.2,
        "Price": 1.2,
        "Area": "00001",
        "Notes": "00001",
        "Available": false,
        "PositionX": ,
        "PositionY": ,
        "PositionZ": ,
        "TunnelPrivateGroupId": "Abc123456",
        "FloorPlanDeskFloorPlanName": "...",
        "FloorPlanDeskFloorPlanBusiness_Currency_Code": "...",
        "FloorPlanDeskFloorPlanBusiness_Name": "...",
        "FloorPlanDeskCoworkerFullName": "...",
        "FloorPlanDeskResourceName": "...",
        "FloorPlanDeskResourceResourceType_Name": "...",
        "FloorPlanDeskResourceAllocation": "...",
        "FloorPlanDeskResourceProjector": "...",
        "FloorPlanDeskResourceInternet": "...",
        "FloorPlanDeskResourceConferencePhone": "...",
        "FloorPlanDeskResourceStandardPhone": "...",
        "FloorPlanDeskResourceWhiteBoard": "...",
        "FloorPlanDeskResourceLargeDisplay": "...",
        "FloorPlanDeskResourceCatering": "...",
        "FloorPlanDeskResourceTeaAndCoffee": "...",
        "FloorPlanDeskResourceDrinks": "...",
        "FloorPlanDeskResourceSecurityLock": "...",
        "FloorPlanDeskResourceCCTV": "...",
        "FloorPlanDeskResourceVoiceRecorder": "...",
        "FloorPlanDeskResourceAirConditioning": "...",
        "FloorPlanDeskResourceHeating": "...",
        "FloorPlanDeskResourceNaturalLight": "...",
        "FloorPlanDeskResourceStandingDesk": "...",
        "FloorPlanDeskResourceQuietZone": "...",
        "FloorPlanDeskResourceWirelessCharger": "...",
        "FloorPlanDeskResourcePrivacyScreen": "...",
        "FloorPlanDeskResourceSoundproof": "...",
        "FloorPlanDeskResourceShifts": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "11976cea-be8e-4d40-abe5-17401cdbaaf5",
        "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 FloorPlanDesk by Id

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

πŸ”’ Requires role "FloorPlanDesk-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "Area": "00001",
  "Available": false,
  "Capacity": 1.2,
  "CoworkerId": 12345678,
  "FloorPlanId": 12345678,
  "ItemType": 1,
  "Name": "00001",
  "Notes": "00001",
  "PositionX": ,
  "PositionY": ,
  "PositionZ": ,
  "Price": 1.2,
  "ResourceId": 12345678,
  "Size": 1.2,
  "TunnelPrivateGroupId": "Abc123456",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "99f921a8-99b7-4d6d-97cd-a9fb0ceb7bdb",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new FloorPlanDesk

Creates a new floorplandesk.
POST https://spaces.nexudus.com/api/sys/floorplandesks

πŸ”’ Requires role "FloorPlanDesk-Create"

Body parameters
FloorPlanId: number required
CoworkerId: number optional
Name: string required
ItemType: Nexudus.Coworking.Core.Enums.eFloorPlanItemType optional
ResourceId: number optional
Size: decimal required
Capacity: decimal required
Price: decimal required
Area: string optional
Notes: string optional
Available: bool optional
PositionX: int required
PositionY: int required
PositionZ: int required
TunnelPrivateGroupId: string optional

Example request

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

{
    "FloorPlanId": 12345678,
    "CoworkerId": 12345678,
    "Name": "00001",
    "ItemType": 1, //(check Enumerated values section below)
    "ResourceId": 12345678,
    "Size": 1.2,
    "Capacity": 1.2,
    "Price": 1.2,
    "Area": "00001",
    "Notes": "00001",
    "Available": false,
    "PositionX": ,
    "PositionY": ,
    "PositionZ": ,
    "TunnelPrivateGroupId": "Abc123456",
}


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 FloorPlanDesk

Updates an existing floorplandesk.
PUT https://spaces.nexudus.com/api/sys/floorplandesks

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

πŸ”’ Requires role "FloorPlanDesk-Edit"

Body parameters
Id: number required
The unique Id of the floorplandesk to update.
FloorPlanId: number cleared if missing
CoworkerId: number cleared if missing
Name: string cleared if missing
ItemType: Nexudus.Coworking.Core.Enums.eFloorPlanItemType cleared if missing
ResourceId: number cleared if missing
Size: decimal cleared if missing
Capacity: decimal cleared if missing
Price: decimal cleared if missing
Area: string cleared if missing
Notes: string cleared if missing
Available: bool cleared if missing
PositionX: int cleared if missing
PositionY: int cleared if missing
PositionZ: int cleared if missing
TunnelPrivateGroupId: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "FloorPlanId": 12345678,
    "CoworkerId": 12345678,
    "Name": "00001",
    "ItemType": 1, //(check Enumerated values section below)
    "ResourceId": 12345678,
    "Size": 1.2,
    "Capacity": 1.2,
    "Price": 1.2,
    "Area": "00001",
    "Notes": "00001",
    "Available": false,
    "PositionX": ,
    "PositionY": ,
    "PositionZ": ,
    "TunnelPrivateGroupId": "Abc123456",
}


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 FloorPlanDesk

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

πŸ”’ Requires role "FloorPlanDesk-Delete"

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

Example request

DELETE https://spaces.nexudus.com/api/sys/floorplandesks/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 floorplandesk 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 floorplandesk records.
GET https://spaces.nexudus.com/api/sys/floorplandesks/commands

Example request

GET https://spaces.nexudus.com/api/sys/floorplandesks/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 floorplandesk record IDs.
POST https://spaces.nexudus.com/api/sys/floorplandesks/runacommand
πŸ”’ Requires role "FloorPlanDesk-Edit"

Example request

POST https://spaces.nexudus.com/api/sys/floorplandesks/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
}


Enumerated values

ItemType

GET /api/utils/enums?name=eFloorPlanItemType

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

Comments

Please sign in to leave a comment.