The checkin object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this checkin |
BusinessId: Id required |
CoworkerId: Id optional |
CoworkerTimePassGuid: Guid? optional |
FromTime: DateTime required |
LastActivity: DateTime? optional |
MacAddresses: string optional |
Source: Nexudus.Coworking.Core.Enums.eCheckinSource optional read-only |
TariffAtTheTimeOfCheckin: string optional |
TeamsAtTheTimeOfCheckin: string optional |
ToTime: DateTime? optional |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this checkin |
SystemId: string optional api-only
User defined data about this checkin. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"BusinessId": 12345678,
"CoworkerId": 12345678,
"CoworkerTimePassGuid": ,
"FromTime": 2020-01-01T21:03:54Z,
"LastActivity": ,
"MacAddresses": "null",
"Source": 1,
"TariffAtTheTimeOfCheckin": "false",
"TeamsAtTheTimeOfCheckin": "false",
"ToTime": ,
"UniqueId": "6f79043b-c8c5-4ea8-a0b5-a8f64aff9e66",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a Checkin
This endpoint allows you to GET a list of checkins based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/spaces/checkins?...
π Requires role "Checkin-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=FromTime
Sets the property to use when ordering the results of the search. ?orderby=Id |
dir 'ascending' or 'descending' optional default=SortDirection.Descending
Sets the direction to use when ordering the records. ?sort=ascending |
Search querystring parameters
Lets you search checkin records based on their different properties. |
Id number
?Id=12345678 |
Checkin_Business Business
?Checkin_Business=... |
Checkin_Coworker Coworker
?Checkin_Coworker=... |
Checkin_CoworkerTimePassGuid Guid?
?Checkin_CoworkerTimePassGuid=... |
Checkin_FromTime DateTime
?Checkin_FromTime=... |
Checkin_LastActivity DateTime?
?Checkin_LastActivity=... |
Checkin_MacAddresses string
?Checkin_MacAddresses=... |
Checkin_Source Nexudus.Coworking.Core.Enums.eCheckinSource
?Checkin_Source=... |
Checkin_TariffAtTheTimeOfCheckin string
?Checkin_TariffAtTheTimeOfCheckin=... |
Checkin_TeamsAtTheTimeOfCheckin string
?Checkin_TeamsAtTheTimeOfCheckin=... |
Checkin_ToTime DateTime?
?Checkin_ToTime=... |
Checkin_CoworkerFullName string
?Checkin_CoworkerFullName=... |
Checkin_BusinessName string
?Checkin_BusinessName=... |
Range search querystring parameters
Lets you search checkin records based on a range of date or numeric values. |
To_Checkin_CreatedOn date
?To_Checkin_CreatedOn=2010-01-01T20:32 |
From_Checkin_CreatedOn date
?From_Checkin_CreatedOn=2010-01-01T20:32 |
To_Checkin_UpdatedOn date
?To_Checkin_UpdatedOn=2010-01-01T20:32 |
From_Checkin_UpdatedOn date
?From_Checkin_UpdatedOn=2010-01-01T20:32 |
To_Checkin_FromTime date
?To_Checkin_FromTime=2010-01-01T20:32 |
From_Checkin_FromTime date
?From_Checkin_FromTime=2010-01-01T20:32 |
To_Checkin_ToTime date
?To_Checkin_ToTime=2010-01-01T20:32 |
From_Checkin_ToTime date
?From_Checkin_ToTime=2010-01-01T20:32 |
To_Checkin_LastActivity date
?To_Checkin_LastActivity=2010-01-01T20:32 |
From_Checkin_LastActivity date
?From_Checkin_LastActivity=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/spaces/checkins?Checkin_FromTime=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Coworker": ,
"Business": ,
"Source": 1,
"FromTime": 2020-01-01T21:03:54Z,
"ToTime": ,
"CoworkerTimePassGuid": ,
"LastActivity": ,
"MacAddresses": "null",
"TeamsAtTheTimeOfCheckin": "false",
"TariffAtTheTimeOfCheckin": "false",
"CheckinCoworkerFullName": "...",
"CheckinBusinessName": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "20a94f05-d655-44d7-b84f-23962701a169",
"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 Checkins by IDs
Gets one or more checkin records based on their Id.GET https://spaces.nexudus.com/api/spaces/checkins?Checkin_Id=[:id1,:id2,...]
π Requires role "Checkin-List"
Querystring parameters |
Checkin_Id: array requried
?Checkin_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/spaces/checkins?Checkin_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Coworker": ,
"Business": ,
"Source": 1,
"FromTime": 2020-01-01T21:03:54Z,
"ToTime": ,
"CoworkerTimePassGuid": ,
"LastActivity": ,
"MacAddresses": "null",
"TeamsAtTheTimeOfCheckin": "false",
"TariffAtTheTimeOfCheckin": "false",
"CheckinCoworkerFullName": "...",
"CheckinBusinessName": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "a3c3e9b7-f152-410c-8db3-8104de27c805",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "FromTime",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 1,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 1,
"TotalPages": 1
}
Get single Checkin by Id
Gets one checkin record by its Id.GET https://spaces.nexudus.com/api/spaces/checkins/:Id
π Requires role "Checkin-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/spaces/checkins/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"BusinessId": 12345678,
"CoworkerId": 12345678,
"CoworkerTimePassGuid": ,
"FromTime": 2020-01-01T21:03:54Z,
"LastActivity": ,
"MacAddresses": "null",
"Source": 1,
"TariffAtTheTimeOfCheckin": "false",
"TeamsAtTheTimeOfCheckin": "false",
"ToTime": ,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "6690a61e-032a-4f17-a915-81e52403c2f5",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new Checkin
Creates a new checkin.POST https://spaces.nexudus.com/api/spaces/checkins
π Requires role "Checkin-Create"
Body parameters |
CoworkerId: number optional |
BusinessId: number required |
FromTime: DateTime required |
ToTime: DateTime? optional |
CoworkerTimePassGuid: Guid? optional |
LastActivity: DateTime? optional |
MacAddresses: string optional |
TeamsAtTheTimeOfCheckin: string optional |
TariffAtTheTimeOfCheckin: string optional |
Example request
POST https://spaces.nexudus.com/api/spaces/checkins Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"CoworkerId": 12345678,
"BusinessId": 12345678,
"FromTime": 2020-01-01T21:03:54Z,
"ToTime": ,
"CoworkerTimePassGuid": ,
"LastActivity": ,
"MacAddresses": "null",
"TeamsAtTheTimeOfCheckin": "false",
"TariffAtTheTimeOfCheckin": "false",
}
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 Checkin
Updates an existing checkin.PUT https://spaces.nexudus.com/api/spaces/checkins
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "Checkin-Edit"
Body parameters |
Id: number required
The unique Id of the checkin to update. |
CoworkerId: number cleared if missing |
BusinessId: number cleared if missing |
FromTime: DateTime cleared if missing |
ToTime: DateTime? cleared if missing |
CoworkerTimePassGuid: Guid? cleared if missing |
LastActivity: DateTime? cleared if missing |
MacAddresses: string cleared if missing |
TeamsAtTheTimeOfCheckin: string cleared if missing |
TariffAtTheTimeOfCheckin: string cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/spaces/checkins Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"CoworkerId": 12345678,
"BusinessId": 12345678,
"FromTime": 2020-01-01T21:03:54Z,
"ToTime": ,
"CoworkerTimePassGuid": ,
"LastActivity": ,
"MacAddresses": "null",
"TeamsAtTheTimeOfCheckin": "false",
"TariffAtTheTimeOfCheckin": "false",
}
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 Checkin
Deletes an existing checkin by its Id.DELETE https://spaces.nexudus.com/api/spaces/checkins/:Id
π Requires role "Checkin-Delete"
URL parameters |
Id: number required
The unique Id of the checkin to update. |
Example request
DELETE https://spaces.nexudus.com/api/spaces/checkins/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 checkin 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 checkin records.GET https://spaces.nexudus.com/api/spaces/checkins/commands
Example request
GET https://spaces.nexudus.com/api/spaces/checkins/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 checkin record IDs.POST https://spaces.nexudus.com/api/spaces/checkins/runacommandπ Requires role "Checkin-Edit"
Example request
POST https://spaces.nexudus.com/api/spaces/checkins/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
Source
GET /api/utils/enums?name=eCheckinSource
Comments
Please sign in to leave a comment.