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
AddUpdateVisitorRequestViewModelName | 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": "dad948d3-e8a7-406a-bf1d-4976ccf439d1", "GuestPersonId": "2cb8dfe5-2741-4178-9593-cb187e441d1b", "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": "4fda11d7-e800-45f3-945e-828fc8765719", "HostPersonId": "02796690-7394-4577-a199-162ee5919d87", "FacilityId": "b03431b7-6852-4298-8e8f-74c2f68d5f5c", "ACSystemId": "f5b2cb83-9797-475e-9377-89da2b8700e4", "Floors": [ { "FloorId": "cd4e3757-3102-46fd-941a-799d828bb441", "Name": "sample string 2", "PhysicalSequence": 3, "Deleted": true }, { "FloorId": "cd4e3757-3102-46fd-941a-799d828bb441", "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>f5b2cb83-9797-475e-9377-89da2b8700e4</ACSystemId> <Deleted>true</Deleted> <FacilityId>b03431b7-6852-4298-8e8f-74c2f68d5f5c</FacilityId> <Floors> <FloorsViewModel> <Deleted>true</Deleted> <FloorId>cd4e3757-3102-46fd-941a-799d828bb441</FloorId> <Name>sample string 2</Name> <PhysicalSequence>3</PhysicalSequence> </FloorsViewModel> <FloorsViewModel> <Deleted>true</Deleted> <FloorId>cd4e3757-3102-46fd-941a-799d828bb441</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>2cb8dfe5-2741-4178-9593-cb187e441d1b</GuestPersonId> <GuestPhone>sample string 4</GuestPhone> <HostPersonId>02796690-7394-4577-a199-162ee5919d87</HostPersonId> <Message>sample string 8</Message> <RequestedAccessLevelId>1</RequestedAccessLevelId> <VisitationPattern>sample string 7</VisitationPattern> <VisitorRequestId>dad948d3-e8a7-406a-bf1d-4976ccf439d1</VisitorRequestId> <VisitorTypeId>4fda11d7-e800-45f3-945e-828fc8765719</VisitorTypeId> </AddUpdateVisitorRequestViewModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
AddUpdateVisitorRequestResultName | 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": "b7476498-5be0-4921-b896-0b2e9b7af327", "VisitorRequestInstances": [ { "VisitorRequestInstanceId": "a87c7b4d-5f50-46c6-9bc7-9c5f2f965e81", "VisitorRequestId": "8466ae21-bcfe-45ba-8e38-59a076e63623", "DateExpected": "2025-06-01T17:39:49.4207869+00:00", "DateTimeArrived": "2025-06-01T17:39:49.4207869+00:00", "AssignedAccessLevelId": 1, "FirstName": "sample string 4", "LastName": "sample string 5", "MiddleInitial": "sample string 6", "GuestCompany": "sample string 7", "HostPersonId": "dc093fde-f4b5-425f-a10e-9a59a36e9ac0", "Message": "sample string 9", "sVisitorTypeId": "a6bf5ab9-1aeb-4f4e-84ae-43745a119f56", "GroupHashTag": "sample string 11", "VisitorStatus": 0, "Deleted": true, "Card": { "PersonCardId": "b52460a2-de90-4676-b3d7-676df3c8afee", "CardName": "sample string 2", "CardId": "75a73a4a-a8e6-427d-948a-7988225980d4", "CardType": 4, "CardACSystemId": "3df9634b-c371-4069-8d82-eef8a6063545", "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": "2025-06-01T17:39:49.4207869+00:00", "DateInserted": "2025-06-01T17:39:49.4207869+00:00", "DateUpdated": "2025-06-01T17:39:49.4207869+00:00", "CardActivationStartDateTime": "2025-06-01T17:39:49.4207869+00:00", "CardDeactivationStartDateTime": "2025-06-01T17:39:49.4207869+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "23b8df6b-de57-439e-af4c-775566e18c2f", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "23b8df6b-de57-439e-af4c-775566e18c2f", "KeyIndex": 2, "EncryptedCredential": "sample string 3" } ], "CredentialType": 1 } }, { "VisitorRequestInstanceId": "a87c7b4d-5f50-46c6-9bc7-9c5f2f965e81", "VisitorRequestId": "8466ae21-bcfe-45ba-8e38-59a076e63623", "DateExpected": "2025-06-01T17:39:49.4207869+00:00", "DateTimeArrived": "2025-06-01T17:39:49.4207869+00:00", "AssignedAccessLevelId": 1, "FirstName": "sample string 4", "LastName": "sample string 5", "MiddleInitial": "sample string 6", "GuestCompany": "sample string 7", "HostPersonId": "dc093fde-f4b5-425f-a10e-9a59a36e9ac0", "Message": "sample string 9", "sVisitorTypeId": "a6bf5ab9-1aeb-4f4e-84ae-43745a119f56", "GroupHashTag": "sample string 11", "VisitorStatus": 0, "Deleted": true, "Card": { "PersonCardId": "b52460a2-de90-4676-b3d7-676df3c8afee", "CardName": "sample string 2", "CardId": "75a73a4a-a8e6-427d-948a-7988225980d4", "CardType": 4, "CardACSystemId": "3df9634b-c371-4069-8d82-eef8a6063545", "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": "2025-06-01T17:39:49.4207869+00:00", "DateInserted": "2025-06-01T17:39:49.4207869+00:00", "DateUpdated": "2025-06-01T17:39:49.4207869+00:00", "CardActivationStartDateTime": "2025-06-01T17:39:49.4207869+00:00", "CardDeactivationStartDateTime": "2025-06-01T17:39:49.4207869+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "23b8df6b-de57-439e-af4c-775566e18c2f", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "23b8df6b-de57-439e-af4c-775566e18c2f", "KeyIndex": 2, "EncryptedCredential": "sample string 3" } ], "CredentialType": 1 } } ], "Value": "a5efdb21-1d5d-47ae-a010-33f8902c450c", "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>a5efdb21-1d5d-47ae-a010-33f8902c450c</Value> <GuestPersonId>b7476498-5be0-4921-b896-0b2e9b7af327</GuestPersonId> <VisitorRequestInstances> <VisitorRequestInstanceViewModel> <AssignedAccessLevelId>1</AssignedAccessLevelId> <Card> <CardACSystemId>3df9634b-c371-4069-8d82-eef8a6063545</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2025-06-01T17:39:49.4207869+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-06-01T17:39:49.4207869+00:00</CardDeactivationStartDateTime> <CardId>75a73a4a-a8e6-427d-948a-7988225980d4</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-06-01T17:39:49.4207869+00:00</DateInserted> <DateUpdated>2025-06-01T17:39:49.4207869+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>23b8df6b-de57-439e-af4c-775566e18c2f</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>23b8df6b-de57-439e-af4c-775566e18c2f</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2025-06-01T17:39:49.4207869+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>b52460a2-de90-4676-b3d7-676df3c8afee</PersonCardId> </Card> <DateExpected>2025-06-01T17:39:49.4207869+00:00</DateExpected> <DateTimeArrived>2025-06-01T17:39:49.4207869+00:00</DateTimeArrived> <Deleted>true</Deleted> <FirstName>sample string 4</FirstName> <GroupHashTag>sample string 11</GroupHashTag> <GuestCompany>sample string 7</GuestCompany> <HostPersonId>dc093fde-f4b5-425f-a10e-9a59a36e9ac0</HostPersonId> <LastName>sample string 5</LastName> <Message>sample string 9</Message> <MiddleInitial>sample string 6</MiddleInitial> <VisitorRequestId>8466ae21-bcfe-45ba-8e38-59a076e63623</VisitorRequestId> <VisitorRequestInstanceId>a87c7b4d-5f50-46c6-9bc7-9c5f2f965e81</VisitorRequestInstanceId> <VisitorStatus>NotCheckedIn</VisitorStatus> <sVisitorTypeId>a6bf5ab9-1aeb-4f4e-84ae-43745a119f56</sVisitorTypeId> </VisitorRequestInstanceViewModel> <VisitorRequestInstanceViewModel> <AssignedAccessLevelId>1</AssignedAccessLevelId> <Card> <CardACSystemId>3df9634b-c371-4069-8d82-eef8a6063545</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2025-06-01T17:39:49.4207869+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-06-01T17:39:49.4207869+00:00</CardDeactivationStartDateTime> <CardId>75a73a4a-a8e6-427d-948a-7988225980d4</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-06-01T17:39:49.4207869+00:00</DateInserted> <DateUpdated>2025-06-01T17:39:49.4207869+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>23b8df6b-de57-439e-af4c-775566e18c2f</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>23b8df6b-de57-439e-af4c-775566e18c2f</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2025-06-01T17:39:49.4207869+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>b52460a2-de90-4676-b3d7-676df3c8afee</PersonCardId> </Card> <DateExpected>2025-06-01T17:39:49.4207869+00:00</DateExpected> <DateTimeArrived>2025-06-01T17:39:49.4207869+00:00</DateTimeArrived> <Deleted>true</Deleted> <FirstName>sample string 4</FirstName> <GroupHashTag>sample string 11</GroupHashTag> <GuestCompany>sample string 7</GuestCompany> <HostPersonId>dc093fde-f4b5-425f-a10e-9a59a36e9ac0</HostPersonId> <LastName>sample string 5</LastName> <Message>sample string 9</Message> <MiddleInitial>sample string 6</MiddleInitial> <VisitorRequestId>8466ae21-bcfe-45ba-8e38-59a076e63623</VisitorRequestId> <VisitorRequestInstanceId>a87c7b4d-5f50-46c6-9bc7-9c5f2f965e81</VisitorRequestInstanceId> <VisitorStatus>NotCheckedIn</VisitorStatus> <sVisitorTypeId>a6bf5ab9-1aeb-4f4e-84ae-43745a119f56</sVisitorTypeId> </VisitorRequestInstanceViewModel> </VisitorRequestInstances> </AddUpdateVisitorRequestResult>