PUT api/v1/VisitorRequests/{id}
Updates a single VisitorRequest that is already in the system. Returns Success/Error code.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Represents the PK of an existing Visitor Request in BluSKY |
globally unique identifier |
Required |
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": "12e0a1a1-8037-4f92-b18b-3b4ab92b1ffe", "GuestPersonId": "4775db0b-9074-438b-8bd5-1d4b3a9523ac", "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": "fc95370a-d4bc-463d-8882-843134185103", "HostPersonId": "dd7c7aa7-eed5-4390-acfe-821cd4dfea17", "FacilityId": "769e98d7-874f-4e23-99d9-0443bc03d8f8", "ACSystemId": "6e2d05bd-8a9b-49a4-b16e-4954d918d0cd", "Floors": [ { "FloorId": "20fad780-e51f-482c-b9c5-b74b9f0af6ea", "Name": "sample string 2", "PhysicalSequence": 3, "Deleted": true }, { "FloorId": "20fad780-e51f-482c-b9c5-b74b9f0af6ea", "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>6e2d05bd-8a9b-49a4-b16e-4954d918d0cd</ACSystemId> <Deleted>true</Deleted> <FacilityId>769e98d7-874f-4e23-99d9-0443bc03d8f8</FacilityId> <Floors> <FloorsViewModel> <Deleted>true</Deleted> <FloorId>20fad780-e51f-482c-b9c5-b74b9f0af6ea</FloorId> <Name>sample string 2</Name> <PhysicalSequence>3</PhysicalSequence> </FloorsViewModel> <FloorsViewModel> <Deleted>true</Deleted> <FloorId>20fad780-e51f-482c-b9c5-b74b9f0af6ea</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>4775db0b-9074-438b-8bd5-1d4b3a9523ac</GuestPersonId> <GuestPhone>sample string 4</GuestPhone> <HostPersonId>dd7c7aa7-eed5-4390-acfe-821cd4dfea17</HostPersonId> <Message>sample string 8</Message> <RequestedAccessLevelId>1</RequestedAccessLevelId> <VisitationPattern>sample string 7</VisitationPattern> <VisitorRequestId>12e0a1a1-8037-4f92-b18b-3b4ab92b1ffe</VisitorRequestId> <VisitorTypeId>fc95370a-d4bc-463d-8882-843134185103</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": "26e23b61-7680-4ce6-aab7-1b3bafb1a5f0", "VisitorRequestInstances": [ { "VisitorRequestInstanceId": "d0dde5c3-e0b1-4c83-84d9-9f46c84c490f", "VisitorRequestId": "f949175a-d3df-4540-b599-62aacb93fdea", "DateExpected": "2025-07-02T10:30:08.9125628+00:00", "DateTimeArrived": "2025-07-02T10:30:08.9125628+00:00", "AssignedAccessLevelId": 1, "FirstName": "sample string 4", "LastName": "sample string 5", "MiddleInitial": "sample string 6", "GuestCompany": "sample string 7", "HostPersonId": "c762de2f-f703-4a10-953f-1eb49868f001", "Message": "sample string 9", "sVisitorTypeId": "2592b8c5-3c8d-4440-a44e-27fdf3200588", "GroupHashTag": "sample string 11", "VisitorStatus": 0, "Deleted": true, "Card": { "PersonCardId": "e225989e-6160-4467-9bd2-87ef53b02322", "CardName": "sample string 2", "CardId": "75702af4-bb57-4c72-9e03-a821971996a1", "CardType": 4, "CardACSystemId": "030d1b0e-c719-49b8-aae4-c393d91b11b2", "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-07-02T10:30:08.9125628+00:00", "DateInserted": "2025-07-02T10:30:08.9125628+00:00", "DateUpdated": "2025-07-02T10:30:08.9125628+00:00", "CardActivationStartDateTime": "2025-07-02T10:30:08.9125628+00:00", "CardDeactivationStartDateTime": "2025-07-02T10:30:08.9125628+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "0529d1e6-5ffe-4191-a0ec-a3b598ec4985", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "0529d1e6-5ffe-4191-a0ec-a3b598ec4985", "KeyIndex": 2, "EncryptedCredential": "sample string 3" } ], "CredentialType": 1 } }, { "VisitorRequestInstanceId": "d0dde5c3-e0b1-4c83-84d9-9f46c84c490f", "VisitorRequestId": "f949175a-d3df-4540-b599-62aacb93fdea", "DateExpected": "2025-07-02T10:30:08.9125628+00:00", "DateTimeArrived": "2025-07-02T10:30:08.9125628+00:00", "AssignedAccessLevelId": 1, "FirstName": "sample string 4", "LastName": "sample string 5", "MiddleInitial": "sample string 6", "GuestCompany": "sample string 7", "HostPersonId": "c762de2f-f703-4a10-953f-1eb49868f001", "Message": "sample string 9", "sVisitorTypeId": "2592b8c5-3c8d-4440-a44e-27fdf3200588", "GroupHashTag": "sample string 11", "VisitorStatus": 0, "Deleted": true, "Card": { "PersonCardId": "e225989e-6160-4467-9bd2-87ef53b02322", "CardName": "sample string 2", "CardId": "75702af4-bb57-4c72-9e03-a821971996a1", "CardType": 4, "CardACSystemId": "030d1b0e-c719-49b8-aae4-c393d91b11b2", "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-07-02T10:30:08.9125628+00:00", "DateInserted": "2025-07-02T10:30:08.9125628+00:00", "DateUpdated": "2025-07-02T10:30:08.9125628+00:00", "CardActivationStartDateTime": "2025-07-02T10:30:08.9125628+00:00", "CardDeactivationStartDateTime": "2025-07-02T10:30:08.9125628+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "0529d1e6-5ffe-4191-a0ec-a3b598ec4985", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "0529d1e6-5ffe-4191-a0ec-a3b598ec4985", "KeyIndex": 2, "EncryptedCredential": "sample string 3" } ], "CredentialType": 1 } } ], "Value": "a312fe80-dc8e-415e-8c2d-b634f0cba7dc", "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>a312fe80-dc8e-415e-8c2d-b634f0cba7dc</Value> <GuestPersonId>26e23b61-7680-4ce6-aab7-1b3bafb1a5f0</GuestPersonId> <VisitorRequestInstances> <VisitorRequestInstanceViewModel> <AssignedAccessLevelId>1</AssignedAccessLevelId> <Card> <CardACSystemId>030d1b0e-c719-49b8-aae4-c393d91b11b2</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2025-07-02T10:30:08.9125628+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-07-02T10:30:08.9125628+00:00</CardDeactivationStartDateTime> <CardId>75702af4-bb57-4c72-9e03-a821971996a1</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-07-02T10:30:08.9125628+00:00</DateInserted> <DateUpdated>2025-07-02T10:30:08.9125628+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>0529d1e6-5ffe-4191-a0ec-a3b598ec4985</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>0529d1e6-5ffe-4191-a0ec-a3b598ec4985</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2025-07-02T10:30:08.9125628+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>e225989e-6160-4467-9bd2-87ef53b02322</PersonCardId> </Card> <DateExpected>2025-07-02T10:30:08.9125628+00:00</DateExpected> <DateTimeArrived>2025-07-02T10:30:08.9125628+00:00</DateTimeArrived> <Deleted>true</Deleted> <FirstName>sample string 4</FirstName> <GroupHashTag>sample string 11</GroupHashTag> <GuestCompany>sample string 7</GuestCompany> <HostPersonId>c762de2f-f703-4a10-953f-1eb49868f001</HostPersonId> <LastName>sample string 5</LastName> <Message>sample string 9</Message> <MiddleInitial>sample string 6</MiddleInitial> <VisitorRequestId>f949175a-d3df-4540-b599-62aacb93fdea</VisitorRequestId> <VisitorRequestInstanceId>d0dde5c3-e0b1-4c83-84d9-9f46c84c490f</VisitorRequestInstanceId> <VisitorStatus>NotCheckedIn</VisitorStatus> <sVisitorTypeId>2592b8c5-3c8d-4440-a44e-27fdf3200588</sVisitorTypeId> </VisitorRequestInstanceViewModel> <VisitorRequestInstanceViewModel> <AssignedAccessLevelId>1</AssignedAccessLevelId> <Card> <CardACSystemId>030d1b0e-c719-49b8-aae4-c393d91b11b2</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2025-07-02T10:30:08.9125628+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-07-02T10:30:08.9125628+00:00</CardDeactivationStartDateTime> <CardId>75702af4-bb57-4c72-9e03-a821971996a1</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-07-02T10:30:08.9125628+00:00</DateInserted> <DateUpdated>2025-07-02T10:30:08.9125628+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>0529d1e6-5ffe-4191-a0ec-a3b598ec4985</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>0529d1e6-5ffe-4191-a0ec-a3b598ec4985</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2025-07-02T10:30:08.9125628+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>e225989e-6160-4467-9bd2-87ef53b02322</PersonCardId> </Card> <DateExpected>2025-07-02T10:30:08.9125628+00:00</DateExpected> <DateTimeArrived>2025-07-02T10:30:08.9125628+00:00</DateTimeArrived> <Deleted>true</Deleted> <FirstName>sample string 4</FirstName> <GroupHashTag>sample string 11</GroupHashTag> <GuestCompany>sample string 7</GuestCompany> <HostPersonId>c762de2f-f703-4a10-953f-1eb49868f001</HostPersonId> <LastName>sample string 5</LastName> <Message>sample string 9</Message> <MiddleInitial>sample string 6</MiddleInitial> <VisitorRequestId>f949175a-d3df-4540-b599-62aacb93fdea</VisitorRequestId> <VisitorRequestInstanceId>d0dde5c3-e0b1-4c83-84d9-9f46c84c490f</VisitorRequestInstanceId> <VisitorStatus>NotCheckedIn</VisitorStatus> <sVisitorTypeId>2592b8c5-3c8d-4440-a44e-27fdf3200588</sVisitorTypeId> </VisitorRequestInstanceViewModel> </VisitorRequestInstances> </AddUpdateVisitorRequestResult>