POST api/v1/VisitorRequests
Adds a single Visitor Request to the system. Returns Success/Error code plus primary key of Visitor Request added.
Request Information
URI Parameters
None.
Body Parameters
AddUpdateVisitorRequestViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| VisitorRequestId |
Conditional: Represents the PK of an existing Visitor Request in BluSKY if calling an Update method. Not used for Add methods |
globally unique identifier |
None. |
| GuestPersonId |
Conditional: Represents the PK of an existing Visitor Request Guest in BluSKY if calling an Update method. Not used for Add methods |
globally unique identifier |
None. |
| GuestFirstName |
Required: Represents the Guest's first/given name. Max Length = 60 |
string |
Max length: 60 |
| GuestLastName |
Required: Represents the Guest's last name / surname. Max Length = 60 |
string |
Max length: 60 |
| GuestEmail |
Optional: Represents the email address of the Guest |
string |
None. |
| GuestPhone |
Optional: Represents the phone number of the Guest |
string |
None. |
| GuestCompanyName |
Optional: Represents the name of the occupancy or vendor instance that the Guest belongs to |
string |
None. |
| GroupHashTag |
Optional: Represents the group name that the Guest may belong to (if provided) |
string |
None. |
| VisitationPattern |
Required: Represents the visitation pattern that has been requested for the Guest |
string |
None. |
| Message |
Optional: Represents a supplemental message that will be viewable by Security/Reception when the Guest arrives |
string |
None. |
| VisitorTypeId |
Required: Represents a supplemental message that will be viewable by Security/Reception when the Guest arrives. Retrieve possible values from /Visitor/GetAllVisitorTypes |
globally unique identifier |
None. |
| HostPersonId |
Required: Represents the PK of an existing Visitor Request Host in BluSKY. Used for both Add and Update |
globally unique identifier |
None. |
| FacilityId |
Required: Represents the PK of the facility that the Guest is expected at. Retrieve possible values from /Facility/GetAllFacilities |
globally unique identifier |
None. |
| ACSystemId |
Required: Represents the PK of the Access Control System that the Host is located in. Retrieve possible values from /ACSystem/GetAllSystems |
globally unique identifier |
None. |
| Floors |
Optional: Represents the list of floors that the Guest will be allowed to visit if Access Levels are not being used. |
Collection of FloorsViewModel |
None. |
| RequestedAccessLevelId |
Optional: Represents an Access Level assignments requested by the Requestor for the Visitor. Retrieve possible values from /AccessLevel/GetAllAccessLevels |
integer |
None. |
| Deleted |
Required: Represents whether the Visitor Request is deleted or not. Should be false for Add methods. |
boolean |
None. |
Request Formats
application/json, text/json
{
"VisitorRequestId": "9a35b683-54f1-4329-b718-e1e0b2866634",
"GuestPersonId": "3eb0e6b9-b81c-4560-b38f-e50ac48667d4",
"GuestFirstName": "sample string 1",
"GuestLastName": "sample string 2",
"GuestEmail": "sample string 3",
"GuestPhone": "sample string 4",
"GuestCompanyName": "sample string 5",
"GroupHashTag": "sample string 6",
"VisitationPattern": "sample string 7",
"Message": "sample string 8",
"VisitorTypeId": "4aab51c0-c3a6-4e2d-9f0f-f2dca89c88b3",
"HostPersonId": "5a4d50ff-0836-418e-86ea-71670226e421",
"FacilityId": "6c2e1c0f-9fca-4cfb-abc1-6afdc064c5e2",
"ACSystemId": "be9c2298-a77b-448a-8ea7-f7980a361d1a",
"Floors": [
{
"FloorId": "da637ba1-bf14-4113-bd38-fe5d72cdb9a9",
"Name": "sample string 2",
"PhysicalSequence": 3,
"Deleted": true
},
{
"FloorId": "da637ba1-bf14-4113-bd38-fe5d72cdb9a9",
"Name": "sample string 2",
"PhysicalSequence": 3,
"Deleted": true
}
],
"RequestedAccessLevelId": 1,
"Deleted": true
}
application/xml, text/xml
<AddUpdateVisitorRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
<ACSystemId>be9c2298-a77b-448a-8ea7-f7980a361d1a</ACSystemId>
<Deleted>true</Deleted>
<FacilityId>6c2e1c0f-9fca-4cfb-abc1-6afdc064c5e2</FacilityId>
<Floors>
<FloorsViewModel>
<Deleted>true</Deleted>
<FloorId>da637ba1-bf14-4113-bd38-fe5d72cdb9a9</FloorId>
<Name>sample string 2</Name>
<PhysicalSequence>3</PhysicalSequence>
</FloorsViewModel>
<FloorsViewModel>
<Deleted>true</Deleted>
<FloorId>da637ba1-bf14-4113-bd38-fe5d72cdb9a9</FloorId>
<Name>sample string 2</Name>
<PhysicalSequence>3</PhysicalSequence>
</FloorsViewModel>
</Floors>
<GroupHashTag>sample string 6</GroupHashTag>
<GuestCompanyName>sample string 5</GuestCompanyName>
<GuestEmail>sample string 3</GuestEmail>
<GuestFirstName>sample string 1</GuestFirstName>
<GuestLastName>sample string 2</GuestLastName>
<GuestPersonId>3eb0e6b9-b81c-4560-b38f-e50ac48667d4</GuestPersonId>
<GuestPhone>sample string 4</GuestPhone>
<HostPersonId>5a4d50ff-0836-418e-86ea-71670226e421</HostPersonId>
<Message>sample string 8</Message>
<RequestedAccessLevelId>1</RequestedAccessLevelId>
<VisitationPattern>sample string 7</VisitationPattern>
<VisitorRequestId>9a35b683-54f1-4329-b718-e1e0b2866634</VisitorRequestId>
<VisitorTypeId>4aab51c0-c3a6-4e2d-9f0f-f2dca89c88b3</VisitorTypeId>
</AddUpdateVisitorRequestViewModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
AddUpdateVisitorRequestResult| Name | Description | Type | Additional information |
|---|---|---|---|
| GuestPersonId |
Represents a person ID of a visitor |
globally unique identifier |
None. |
| VisitorRequestInstances |
Contains all existing future visitor request instances for a given request |
Collection of VisitorRequestInstanceViewModel |
None. |
| Value |
Represents the PK value that was created as a result of an add |
globally unique identifier |
None. |
| ResultCode |
Represents the result code |
integer |
None. |
| Description |
Represents a description of the result code |
string |
None. |
Response Formats
application/json, text/json
{
"GuestPersonId": "1ecdb667-b3a0-4ea8-938a-73960aab879d",
"VisitorRequestInstances": [
{
"VisitorRequestInstanceId": "d5de4c85-240a-41c9-aef8-421486ad5e57",
"VisitorRequestId": "c882ebe2-3b43-4652-897b-0968ccb05e3f",
"DateExpected": "2026-01-29T21:53:20.3671121+00:00",
"DateTimeArrived": "2026-01-29T21:53:20.3671121+00:00",
"AssignedAccessLevelId": 1,
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleInitial": "sample string 6",
"GuestCompany": "sample string 7",
"HostPersonId": "4e70c16e-33e9-4423-b373-c5ea0d2240e4",
"Message": "sample string 9",
"sVisitorTypeId": "73e76de7-f1a9-43c7-aff7-31efc9c808fc",
"GroupHashTag": "sample string 11",
"VisitorStatus": 0,
"Deleted": true,
"Card": {
"PersonCardId": "f6707726-9bf1-4084-a560-34eb4c693922",
"CardName": "sample string 2",
"CardId": "5e9c8812-761f-42b2-b8ba-18978f103965",
"CardType": 4,
"CardACSystemId": "06107ced-62fe-46f8-b78d-7c9af91e5f6e",
"CardACSystemName": "sample string 6",
"InternalCardNumber": 7,
"ExternalCardNumber": "sample string 8",
"CardSerialNumber": 1,
"FacilityCode": 9,
"IssueCode": 10,
"PIN": "sample string 11",
"Deleted": true,
"HidInvitationCode": "sample string 13",
"InvitationRedeemedDateTime": "2026-01-29T21:53:20.3827373+00:00",
"DateInserted": "2026-01-29T21:53:20.3827373+00:00",
"DateUpdated": "2026-01-29T21:53:20.3827373+00:00",
"CardActivationStartDateTime": "2026-01-29T21:53:20.3827373+00:00",
"CardDeactivationStartDateTime": "2026-01-29T21:53:20.3827373+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "4fa69f1a-ddf7-4480-8236-0ab916ae0b1d",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "4fa69f1a-ddf7-4480-8236-0ab916ae0b1d",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
}
],
"CredentialType": 1
}
},
{
"VisitorRequestInstanceId": "d5de4c85-240a-41c9-aef8-421486ad5e57",
"VisitorRequestId": "c882ebe2-3b43-4652-897b-0968ccb05e3f",
"DateExpected": "2026-01-29T21:53:20.3671121+00:00",
"DateTimeArrived": "2026-01-29T21:53:20.3671121+00:00",
"AssignedAccessLevelId": 1,
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleInitial": "sample string 6",
"GuestCompany": "sample string 7",
"HostPersonId": "4e70c16e-33e9-4423-b373-c5ea0d2240e4",
"Message": "sample string 9",
"sVisitorTypeId": "73e76de7-f1a9-43c7-aff7-31efc9c808fc",
"GroupHashTag": "sample string 11",
"VisitorStatus": 0,
"Deleted": true,
"Card": {
"PersonCardId": "f6707726-9bf1-4084-a560-34eb4c693922",
"CardName": "sample string 2",
"CardId": "5e9c8812-761f-42b2-b8ba-18978f103965",
"CardType": 4,
"CardACSystemId": "06107ced-62fe-46f8-b78d-7c9af91e5f6e",
"CardACSystemName": "sample string 6",
"InternalCardNumber": 7,
"ExternalCardNumber": "sample string 8",
"CardSerialNumber": 1,
"FacilityCode": 9,
"IssueCode": 10,
"PIN": "sample string 11",
"Deleted": true,
"HidInvitationCode": "sample string 13",
"InvitationRedeemedDateTime": "2026-01-29T21:53:20.3827373+00:00",
"DateInserted": "2026-01-29T21:53:20.3827373+00:00",
"DateUpdated": "2026-01-29T21:53:20.3827373+00:00",
"CardActivationStartDateTime": "2026-01-29T21:53:20.3827373+00:00",
"CardDeactivationStartDateTime": "2026-01-29T21:53:20.3827373+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "4fa69f1a-ddf7-4480-8236-0ab916ae0b1d",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "4fa69f1a-ddf7-4480-8236-0ab916ae0b1d",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
}
],
"CredentialType": 1
}
}
],
"Value": "7e853c03-5eb0-4b63-85b5-caef1feb76c1",
"ResultCode": 3,
"Description": "sample string 4"
}
application/xml, text/xml
<AddUpdateVisitorRequestResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
<Description>sample string 4</Description>
<HttpStatusCode>Continue</HttpStatusCode>
<ResultCode>3</ResultCode>
<Value>7e853c03-5eb0-4b63-85b5-caef1feb76c1</Value>
<GuestPersonId>1ecdb667-b3a0-4ea8-938a-73960aab879d</GuestPersonId>
<VisitorRequestInstances>
<VisitorRequestInstanceViewModel>
<AssignedAccessLevelId>1</AssignedAccessLevelId>
<Card>
<CardACSystemId>06107ced-62fe-46f8-b78d-7c9af91e5f6e</CardACSystemId>
<CardACSystemName>sample string 6</CardACSystemName>
<CardActivationStartDateTime>2026-01-29T21:53:20.3827373+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2026-01-29T21:53:20.3827373+00:00</CardDeactivationStartDateTime>
<CardId>5e9c8812-761f-42b2-b8ba-18978f103965</CardId>
<CardName>sample string 2</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>4</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2026-01-29T21:53:20.3827373+00:00</DateInserted>
<DateUpdated>2026-01-29T21:53:20.3827373+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>4fa69f1a-ddf7-4480-8236-0ab916ae0b1d</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>4fa69f1a-ddf7-4480-8236-0ab916ae0b1d</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 8</ExternalCardNumber>
<FacilityCode>9</FacilityCode>
<HidInvitationCode>sample string 13</HidInvitationCode>
<InternalCardNumber>7</InternalCardNumber>
<InvitationRedeemedDateTime>2026-01-29T21:53:20.3827373+00:00</InvitationRedeemedDateTime>
<IssueCode>10</IssueCode>
<PIN>sample string 11</PIN>
<PersonCardId>f6707726-9bf1-4084-a560-34eb4c693922</PersonCardId>
</Card>
<DateExpected>2026-01-29T21:53:20.3671121+00:00</DateExpected>
<DateTimeArrived>2026-01-29T21:53:20.3671121+00:00</DateTimeArrived>
<Deleted>true</Deleted>
<FirstName>sample string 4</FirstName>
<GroupHashTag>sample string 11</GroupHashTag>
<GuestCompany>sample string 7</GuestCompany>
<HostPersonId>4e70c16e-33e9-4423-b373-c5ea0d2240e4</HostPersonId>
<LastName>sample string 5</LastName>
<Message>sample string 9</Message>
<MiddleInitial>sample string 6</MiddleInitial>
<VisitorRequestId>c882ebe2-3b43-4652-897b-0968ccb05e3f</VisitorRequestId>
<VisitorRequestInstanceId>d5de4c85-240a-41c9-aef8-421486ad5e57</VisitorRequestInstanceId>
<VisitorStatus>NotCheckedIn</VisitorStatus>
<sVisitorTypeId>73e76de7-f1a9-43c7-aff7-31efc9c808fc</sVisitorTypeId>
</VisitorRequestInstanceViewModel>
<VisitorRequestInstanceViewModel>
<AssignedAccessLevelId>1</AssignedAccessLevelId>
<Card>
<CardACSystemId>06107ced-62fe-46f8-b78d-7c9af91e5f6e</CardACSystemId>
<CardACSystemName>sample string 6</CardACSystemName>
<CardActivationStartDateTime>2026-01-29T21:53:20.3827373+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2026-01-29T21:53:20.3827373+00:00</CardDeactivationStartDateTime>
<CardId>5e9c8812-761f-42b2-b8ba-18978f103965</CardId>
<CardName>sample string 2</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>4</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2026-01-29T21:53:20.3827373+00:00</DateInserted>
<DateUpdated>2026-01-29T21:53:20.3827373+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>4fa69f1a-ddf7-4480-8236-0ab916ae0b1d</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>4fa69f1a-ddf7-4480-8236-0ab916ae0b1d</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 8</ExternalCardNumber>
<FacilityCode>9</FacilityCode>
<HidInvitationCode>sample string 13</HidInvitationCode>
<InternalCardNumber>7</InternalCardNumber>
<InvitationRedeemedDateTime>2026-01-29T21:53:20.3827373+00:00</InvitationRedeemedDateTime>
<IssueCode>10</IssueCode>
<PIN>sample string 11</PIN>
<PersonCardId>f6707726-9bf1-4084-a560-34eb4c693922</PersonCardId>
</Card>
<DateExpected>2026-01-29T21:53:20.3671121+00:00</DateExpected>
<DateTimeArrived>2026-01-29T21:53:20.3671121+00:00</DateTimeArrived>
<Deleted>true</Deleted>
<FirstName>sample string 4</FirstName>
<GroupHashTag>sample string 11</GroupHashTag>
<GuestCompany>sample string 7</GuestCompany>
<HostPersonId>4e70c16e-33e9-4423-b373-c5ea0d2240e4</HostPersonId>
<LastName>sample string 5</LastName>
<Message>sample string 9</Message>
<MiddleInitial>sample string 6</MiddleInitial>
<VisitorRequestId>c882ebe2-3b43-4652-897b-0968ccb05e3f</VisitorRequestId>
<VisitorRequestInstanceId>d5de4c85-240a-41c9-aef8-421486ad5e57</VisitorRequestInstanceId>
<VisitorStatus>NotCheckedIn</VisitorStatus>
<sVisitorTypeId>73e76de7-f1a9-43c7-aff7-31efc9c808fc</sVisitorTypeId>
</VisitorRequestInstanceViewModel>
</VisitorRequestInstances>
</AddUpdateVisitorRequestResult>