GET api/v1/VisitorRequestInstances?GuestPersonId={GuestPersonId}&Start={Start}&End={End}&IncludeCardInfo={IncludeCardInfo}
Returns all instances when passed a Guest's PersonId. Start is treated as today at 00:00:01 when null, End is treated as 00:00:01 tomorrow when null
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
GuestPersonId | globally unique identifier |
Required |
|
Start | date |
None. |
|
End | date |
None. |
|
IncludeCardInfo | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of VisitorRequestInstanceViewModelName | Description | Type | Additional information |
---|---|---|---|
VisitorRequestInstanceId |
Represents the PK of an existing Visitor Request Instance in BluSKY |
globally unique identifier |
None. |
VisitorRequestId |
Represents the correspondent Visitor Request |
globally unique identifier |
None. |
DateExpected | date |
None. |
|
DateTimeArrived | date |
None. |
|
AssignedAccessLevelId | integer |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
MiddleInitial | string |
None. |
|
GuestCompany | string |
None. |
|
HostPersonId | globally unique identifier |
None. |
|
Message | string |
None. |
|
sVisitorTypeId | globally unique identifier |
None. |
|
GroupHashTag | string |
None. |
|
VisitorStatus | VisitorStatuses |
None. |
|
Deleted | boolean |
None. |
|
Card | PersonCardViewModel |
None. |
Response Formats
application/json, text/json
Sample:
[ { "VisitorRequestInstanceId": "5c391e68-07a1-479a-8b62-5371acdd0532", "VisitorRequestId": "a0956aa1-ee07-4c3b-9402-2dfbd3d195b4", "DateExpected": "2025-09-17T11:47:51.5195247+00:00", "DateTimeArrived": "2025-09-17T11:47:51.5195247+00:00", "AssignedAccessLevelId": 1, "FirstName": "sample string 4", "LastName": "sample string 5", "MiddleInitial": "sample string 6", "GuestCompany": "sample string 7", "HostPersonId": "6e726925-8404-4ff3-8d73-d378cb275568", "Message": "sample string 9", "sVisitorTypeId": "cc924968-6b80-4ade-940e-7962e4f1e2bd", "GroupHashTag": "sample string 11", "VisitorStatus": 0, "Deleted": true, "Card": { "PersonCardId": "e08a55fd-8662-42c0-8bfe-b44b5cea457e", "CardName": "sample string 2", "CardId": "d3e4eaed-ac13-45bd-9548-5528080cc0db", "CardType": 4, "CardACSystemId": "27e3776c-6c53-4671-97a7-d0c7cab8bdc5", "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-09-17T11:47:51.5195247+00:00", "DateInserted": "2025-09-17T11:47:51.5195247+00:00", "DateUpdated": "2025-09-17T11:47:51.5195247+00:00", "CardActivationStartDateTime": "2025-09-17T11:47:51.5195247+00:00", "CardDeactivationStartDateTime": "2025-09-17T11:47:51.5195247+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "70a01b42-fa56-47f1-b8fd-cd4d602a05d3", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "70a01b42-fa56-47f1-b8fd-cd4d602a05d3", "KeyIndex": 2, "EncryptedCredential": "sample string 3" } ], "CredentialType": 1 } }, { "VisitorRequestInstanceId": "5c391e68-07a1-479a-8b62-5371acdd0532", "VisitorRequestId": "a0956aa1-ee07-4c3b-9402-2dfbd3d195b4", "DateExpected": "2025-09-17T11:47:51.5195247+00:00", "DateTimeArrived": "2025-09-17T11:47:51.5195247+00:00", "AssignedAccessLevelId": 1, "FirstName": "sample string 4", "LastName": "sample string 5", "MiddleInitial": "sample string 6", "GuestCompany": "sample string 7", "HostPersonId": "6e726925-8404-4ff3-8d73-d378cb275568", "Message": "sample string 9", "sVisitorTypeId": "cc924968-6b80-4ade-940e-7962e4f1e2bd", "GroupHashTag": "sample string 11", "VisitorStatus": 0, "Deleted": true, "Card": { "PersonCardId": "e08a55fd-8662-42c0-8bfe-b44b5cea457e", "CardName": "sample string 2", "CardId": "d3e4eaed-ac13-45bd-9548-5528080cc0db", "CardType": 4, "CardACSystemId": "27e3776c-6c53-4671-97a7-d0c7cab8bdc5", "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-09-17T11:47:51.5195247+00:00", "DateInserted": "2025-09-17T11:47:51.5195247+00:00", "DateUpdated": "2025-09-17T11:47:51.5195247+00:00", "CardActivationStartDateTime": "2025-09-17T11:47:51.5195247+00:00", "CardDeactivationStartDateTime": "2025-09-17T11:47:51.5195247+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "70a01b42-fa56-47f1-b8fd-cd4d602a05d3", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "70a01b42-fa56-47f1-b8fd-cd4d602a05d3", "KeyIndex": 2, "EncryptedCredential": "sample string 3" } ], "CredentialType": 1 } } ]
application/xml, text/xml
Sample:
<ArrayOfVisitorRequestInstanceViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <VisitorRequestInstanceViewModel> <AssignedAccessLevelId>1</AssignedAccessLevelId> <Card> <CardACSystemId>27e3776c-6c53-4671-97a7-d0c7cab8bdc5</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2025-09-17T11:47:51.5195247+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-09-17T11:47:51.5195247+00:00</CardDeactivationStartDateTime> <CardId>d3e4eaed-ac13-45bd-9548-5528080cc0db</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-09-17T11:47:51.5195247+00:00</DateInserted> <DateUpdated>2025-09-17T11:47:51.5195247+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>70a01b42-fa56-47f1-b8fd-cd4d602a05d3</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>70a01b42-fa56-47f1-b8fd-cd4d602a05d3</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2025-09-17T11:47:51.5195247+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>e08a55fd-8662-42c0-8bfe-b44b5cea457e</PersonCardId> </Card> <DateExpected>2025-09-17T11:47:51.5195247+00:00</DateExpected> <DateTimeArrived>2025-09-17T11:47:51.5195247+00:00</DateTimeArrived> <Deleted>true</Deleted> <FirstName>sample string 4</FirstName> <GroupHashTag>sample string 11</GroupHashTag> <GuestCompany>sample string 7</GuestCompany> <HostPersonId>6e726925-8404-4ff3-8d73-d378cb275568</HostPersonId> <LastName>sample string 5</LastName> <Message>sample string 9</Message> <MiddleInitial>sample string 6</MiddleInitial> <VisitorRequestId>a0956aa1-ee07-4c3b-9402-2dfbd3d195b4</VisitorRequestId> <VisitorRequestInstanceId>5c391e68-07a1-479a-8b62-5371acdd0532</VisitorRequestInstanceId> <VisitorStatus>NotCheckedIn</VisitorStatus> <sVisitorTypeId>cc924968-6b80-4ade-940e-7962e4f1e2bd</sVisitorTypeId> </VisitorRequestInstanceViewModel> <VisitorRequestInstanceViewModel> <AssignedAccessLevelId>1</AssignedAccessLevelId> <Card> <CardACSystemId>27e3776c-6c53-4671-97a7-d0c7cab8bdc5</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2025-09-17T11:47:51.5195247+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-09-17T11:47:51.5195247+00:00</CardDeactivationStartDateTime> <CardId>d3e4eaed-ac13-45bd-9548-5528080cc0db</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-09-17T11:47:51.5195247+00:00</DateInserted> <DateUpdated>2025-09-17T11:47:51.5195247+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>70a01b42-fa56-47f1-b8fd-cd4d602a05d3</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>70a01b42-fa56-47f1-b8fd-cd4d602a05d3</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2025-09-17T11:47:51.5195247+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>e08a55fd-8662-42c0-8bfe-b44b5cea457e</PersonCardId> </Card> <DateExpected>2025-09-17T11:47:51.5195247+00:00</DateExpected> <DateTimeArrived>2025-09-17T11:47:51.5195247+00:00</DateTimeArrived> <Deleted>true</Deleted> <FirstName>sample string 4</FirstName> <GroupHashTag>sample string 11</GroupHashTag> <GuestCompany>sample string 7</GuestCompany> <HostPersonId>6e726925-8404-4ff3-8d73-d378cb275568</HostPersonId> <LastName>sample string 5</LastName> <Message>sample string 9</Message> <MiddleInitial>sample string 6</MiddleInitial> <VisitorRequestId>a0956aa1-ee07-4c3b-9402-2dfbd3d195b4</VisitorRequestId> <VisitorRequestInstanceId>5c391e68-07a1-479a-8b62-5371acdd0532</VisitorRequestInstanceId> <VisitorStatus>NotCheckedIn</VisitorStatus> <sVisitorTypeId>cc924968-6b80-4ade-940e-7962e4f1e2bd</sVisitorTypeId> </VisitorRequestInstanceViewModel> </ArrayOfVisitorRequestInstanceViewModel>