The visitor object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this visitor |
ArrivalDate: DateTime? optional |
Arrived: bool optional |
BusinessId: Id required |
CheckedInAt: string optional |
CompanyName: string optional |
CoworkerId: Id optional |
DepartureDate: DateTime? optional |
Email: string required |
ExpectedArrival: DateTime? required |
FullName: string required |
HasAgreedTerms: bool optional |
IsTour: bool optional |
Notes: string optional |
TourConfirmed: bool optional |
VisitorCode: string optional read-only |
VisitorSource: Nexudus.Coworking.Core.Enums.eVisitorSource optional |
VisitReason: string optional |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this visitor |
SystemId: string optional api-only
User defined data about this visitor. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"ArrivalDate": ,
"Arrived": false,
"BusinessId": 12345678,
"CheckedInAt": "CheckedInAt",
"CompanyName": "CompanyName",
"CoworkerId": 12345678,
"DepartureDate": ,
"Email": "email@email.com",
"ExpectedArrival": ,
"FullName": "Jon Doe",
"HasAgreedTerms": false,
"IsTour": false,
"Notes": "Description",
"TourConfirmed": false,
"VisitorCode": "012345",
"VisitorSource": 1,
"VisitReason": "VisitReason",
"UniqueId": "c488a7d7-e30f-4b61-973e-e0d077b6fbb9",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a Visitor
This endpoint allows you to GET a list of visitors based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/spaces/visitors?...
π Requires role "Visitor-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=ExpectedArrival
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 visitor records based on their different properties. |
Id number
?Id=12345678 |
Visitor_ArrivalDate DateTime?
?Visitor_ArrivalDate=... |
Visitor_Arrived bool
?Visitor_Arrived=... |
Visitor_Business Business
?Visitor_Business=... |
Visitor_CheckedInAt string
?Visitor_CheckedInAt=... |
Visitor_CompanyName string
?Visitor_CompanyName=... |
Visitor_Coworker Coworker
?Visitor_Coworker=... |
Visitor_DepartureDate DateTime?
?Visitor_DepartureDate=... |
Visitor_Email string
?Visitor_Email=... |
Visitor_ExpectedArrival DateTime?
?Visitor_ExpectedArrival=... |
Visitor_FullName string
?Visitor_FullName=... |
Visitor_HasAgreedTerms bool
?Visitor_HasAgreedTerms=... |
Visitor_IsTour bool
?Visitor_IsTour=... |
Visitor_Notes string
?Visitor_Notes=... |
Visitor_TourConfirmed bool
?Visitor_TourConfirmed=... |
Visitor_VisitorCode string
?Visitor_VisitorCode=... |
Visitor_VisitorSource Nexudus.Coworking.Core.Enums.eVisitorSource
?Visitor_VisitorSource=... |
Visitor_VisitReason string
?Visitor_VisitReason=... |
Visitor_CoworkerFullName string
?Visitor_CoworkerFullName=... |
Visitor_CoworkerCompanyName string
?Visitor_CoworkerCompanyName=... |
Visitor_CoworkerBillingName string
?Visitor_CoworkerBillingName=... |
Visitor_CoworkerEmail string
?Visitor_CoworkerEmail=... |
Range search querystring parameters
Lets you search visitor records based on a range of date or numeric values. |
To_Visitor_CreatedOn date
?To_Visitor_CreatedOn=2010-01-01T20:32 |
From_Visitor_CreatedOn date
?From_Visitor_CreatedOn=2010-01-01T20:32 |
To_Visitor_UpdatedOn date
?To_Visitor_UpdatedOn=2010-01-01T20:32 |
From_Visitor_UpdatedOn date
?From_Visitor_UpdatedOn=2010-01-01T20:32 |
To_Visitor_ExpectedArrival date
?To_Visitor_ExpectedArrival=2010-01-01T20:32 |
From_Visitor_ExpectedArrival date
?From_Visitor_ExpectedArrival=2010-01-01T20:32 |
To_Visitor_ArrivalDate date
?To_Visitor_ArrivalDate=2010-01-01T20:32 |
From_Visitor_ArrivalDate date
?From_Visitor_ArrivalDate=2010-01-01T20:32 |
To_Visitor_DepartureDate date
?To_Visitor_DepartureDate=2010-01-01T20:32 |
From_Visitor_DepartureDate date
?From_Visitor_DepartureDate=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/spaces/visitors?Visitor_FullName=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"FullName": "Jon Doe",
"Email": "email@email.com",
"Coworker": ,
"VisitorSource": 1,
"VisitorCode": "012345",
"CheckedInAt": "CheckedInAt",
"Notes": "Description",
"VisitReason": "VisitReason",
"CompanyName": "CompanyName",
"ExpectedArrival": ,
"Arrived": false,
"ArrivalDate": ,
"DepartureDate": ,
"IsTour": false,
"HasAgreedTerms": false,
"TourConfirmed": false,
"VisitorCoworkerFullName": "...",
"VisitorCoworkerCompanyName": "...",
"VisitorCoworkerBillingName": "...",
"VisitorCoworkerEmail": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "936ac32a-822d-47f4-9029-4f6ca3390dd2",
"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 Visitors by IDs
Gets one or more visitor records based on their Id.GET https://spaces.nexudus.com/api/spaces/visitors?Visitor_Id=[:id1,:id2,...]
π Requires role "Visitor-List"
Querystring parameters |
Visitor_Id: array requried
?Visitor_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/spaces/visitors?Visitor_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"FullName": "Jon Doe",
"Email": "email@email.com",
"Coworker": ,
"VisitorSource": 1,
"VisitorCode": "012345",
"CheckedInAt": "CheckedInAt",
"Notes": "Description",
"VisitReason": "VisitReason",
"CompanyName": "CompanyName",
"ExpectedArrival": ,
"Arrived": false,
"ArrivalDate": ,
"DepartureDate": ,
"IsTour": false,
"HasAgreedTerms": false,
"TourConfirmed": false,
"VisitorCoworkerFullName": "...",
"VisitorCoworkerCompanyName": "...",
"VisitorCoworkerBillingName": "...",
"VisitorCoworkerEmail": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "5c852205-4930-4e47-8187-751e42aae6e4",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "ExpectedArrival",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 1,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 1,
"TotalPages": 1
}
Get single Visitor by Id
Gets one visitor record by its Id.GET https://spaces.nexudus.com/api/spaces/visitors/:Id
π Requires role "Visitor-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/spaces/visitors/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"ArrivalDate": ,
"Arrived": false,
"BusinessId": 12345678,
"CheckedInAt": "CheckedInAt",
"CompanyName": "CompanyName",
"CoworkerId": 12345678,
"DepartureDate": ,
"Email": "email@email.com",
"ExpectedArrival": ,
"FullName": "Jon Doe",
"HasAgreedTerms": false,
"IsTour": false,
"Notes": "Description",
"TourConfirmed": false,
"VisitorCode": "012345",
"VisitorSource": 1,
"VisitReason": "VisitReason",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "b2413584-a56b-48d4-ae79-ecfb91c324be",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new Visitor
Creates a new visitor.POST https://spaces.nexudus.com/api/spaces/visitors
π Requires role "Visitor-Create"
Body parameters |
BusinessId: number required |
FullName: string required |
Email: string required |
CoworkerId: number optional |
VisitorSource: Nexudus.Coworking.Core.Enums.eVisitorSource optional |
CheckedInAt: string optional |
Notes: string optional |
VisitReason: string optional |
CompanyName: string optional |
ExpectedArrival: DateTime? required |
IsTour: bool optional |
HasAgreedTerms: bool optional |
TourConfirmed: bool optional |
Example request
POST https://spaces.nexudus.com/api/spaces/visitors Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"BusinessId": 12345678,
"FullName": "Jon Doe",
"Email": "email@email.com",
"CoworkerId": 12345678,
"VisitorSource": 1, //(check Enumerated values section below)
"CheckedInAt": "CheckedInAt",
"Notes": "Description",
"VisitReason": "VisitReason",
"CompanyName": "CompanyName",
"ExpectedArrival": ,
"IsTour": false,
"HasAgreedTerms": false,
"TourConfirmed": 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 Visitor
Updates an existing visitor.PUT https://spaces.nexudus.com/api/spaces/visitors
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "Visitor-Edit"
Body parameters |
Id: number required
The unique Id of the visitor to update. |
BusinessId: number cleared if missing |
FullName: string cleared if missing |
Email: string cleared if missing |
CoworkerId: number cleared if missing |
VisitorSource: Nexudus.Coworking.Core.Enums.eVisitorSource cleared if missing |
CheckedInAt: string cleared if missing |
Notes: string cleared if missing |
VisitReason: string cleared if missing |
CompanyName: string cleared if missing |
ExpectedArrival: DateTime? cleared if missing |
Arrived: bool cleared if missing |
ArrivalDate: DateTime? cleared if missing |
DepartureDate: DateTime? cleared if missing |
IsTour: bool cleared if missing |
HasAgreedTerms: bool cleared if missing |
TourConfirmed: bool cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/spaces/visitors Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"BusinessId": 12345678,
"FullName": "Jon Doe",
"Email": "email@email.com",
"CoworkerId": 12345678,
"VisitorSource": 1, //(check Enumerated values section below)
"CheckedInAt": "CheckedInAt",
"Notes": "Description",
"VisitReason": "VisitReason",
"CompanyName": "CompanyName",
"ExpectedArrival": ,
"IsTour": false,
"HasAgreedTerms": false,
"TourConfirmed": 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 Visitor
Deletes an existing visitor by its Id.DELETE https://spaces.nexudus.com/api/spaces/visitors/:Id
π Requires role "Visitor-Delete"
URL parameters |
Id: number required
The unique Id of the visitor to update. |
Example request
DELETE https://spaces.nexudus.com/api/spaces/visitors/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 visitor 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 visitor records.GET https://spaces.nexudus.com/api/spaces/visitors/commands
Example request
GET https://spaces.nexudus.com/api/spaces/visitors/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 visitor record IDs.POST https://spaces.nexudus.com/api/spaces/visitors/runacommandπ Requires role "Visitor-Edit"
Example request
POST https://spaces.nexudus.com/api/spaces/visitors/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
VisitorSource
GET /api/utils/enums?name=eVisitorSource
Comments
Please sign in to leave a comment.