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": "7afaf46a-da95-4499-a644-91fd04809b32", "VisitorRequestId": "5b743100-4bd9-468b-bb50-b970e15ab72a", "DateExpected": "2025-07-26T09:57:23.4420355+00:00", "DateTimeArrived": "2025-07-26T09:57:23.4420355+00:00", "AssignedAccessLevelId": 1, "FirstName": "sample string 4", "LastName": "sample string 5", "MiddleInitial": "sample string 6", "GuestCompany": "sample string 7", "HostPersonId": "daa91c2a-156c-4edc-8e76-4ffcd15d9088", "Message": "sample string 9", "sVisitorTypeId": "c5b40831-23b0-4eeb-b03e-009424180e0a", "GroupHashTag": "sample string 11", "VisitorStatus": 0, "Deleted": true, "Card": { "PersonCardId": "b3097466-5c4e-4247-a6fb-4cc35c2685e0", "CardName": "sample string 2", "CardId": "822bd2be-44b4-4b2c-b4fe-aa71c8ff1466", "CardType": 4, "CardACSystemId": "d0f8ada6-774b-4a37-8ba3-86418777a1fe", "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-26T09:57:23.4420355+00:00", "DateInserted": "2025-07-26T09:57:23.4420355+00:00", "DateUpdated": "2025-07-26T09:57:23.4420355+00:00", "CardActivationStartDateTime": "2025-07-26T09:57:23.4420355+00:00", "CardDeactivationStartDateTime": "2025-07-26T09:57:23.4420355+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "0f5023f7-1826-4c50-b1ab-ed54ac608b51", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "0f5023f7-1826-4c50-b1ab-ed54ac608b51", "KeyIndex": 2, "EncryptedCredential": "sample string 3" } ], "CredentialType": 1 } }, { "VisitorRequestInstanceId": "7afaf46a-da95-4499-a644-91fd04809b32", "VisitorRequestId": "5b743100-4bd9-468b-bb50-b970e15ab72a", "DateExpected": "2025-07-26T09:57:23.4420355+00:00", "DateTimeArrived": "2025-07-26T09:57:23.4420355+00:00", "AssignedAccessLevelId": 1, "FirstName": "sample string 4", "LastName": "sample string 5", "MiddleInitial": "sample string 6", "GuestCompany": "sample string 7", "HostPersonId": "daa91c2a-156c-4edc-8e76-4ffcd15d9088", "Message": "sample string 9", "sVisitorTypeId": "c5b40831-23b0-4eeb-b03e-009424180e0a", "GroupHashTag": "sample string 11", "VisitorStatus": 0, "Deleted": true, "Card": { "PersonCardId": "b3097466-5c4e-4247-a6fb-4cc35c2685e0", "CardName": "sample string 2", "CardId": "822bd2be-44b4-4b2c-b4fe-aa71c8ff1466", "CardType": 4, "CardACSystemId": "d0f8ada6-774b-4a37-8ba3-86418777a1fe", "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-26T09:57:23.4420355+00:00", "DateInserted": "2025-07-26T09:57:23.4420355+00:00", "DateUpdated": "2025-07-26T09:57:23.4420355+00:00", "CardActivationStartDateTime": "2025-07-26T09:57:23.4420355+00:00", "CardDeactivationStartDateTime": "2025-07-26T09:57:23.4420355+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "0f5023f7-1826-4c50-b1ab-ed54ac608b51", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "0f5023f7-1826-4c50-b1ab-ed54ac608b51", "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>d0f8ada6-774b-4a37-8ba3-86418777a1fe</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2025-07-26T09:57:23.4420355+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-07-26T09:57:23.4420355+00:00</CardDeactivationStartDateTime> <CardId>822bd2be-44b4-4b2c-b4fe-aa71c8ff1466</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-07-26T09:57:23.4420355+00:00</DateInserted> <DateUpdated>2025-07-26T09:57:23.4420355+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>0f5023f7-1826-4c50-b1ab-ed54ac608b51</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>0f5023f7-1826-4c50-b1ab-ed54ac608b51</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2025-07-26T09:57:23.4420355+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>b3097466-5c4e-4247-a6fb-4cc35c2685e0</PersonCardId> </Card> <DateExpected>2025-07-26T09:57:23.4420355+00:00</DateExpected> <DateTimeArrived>2025-07-26T09:57:23.4420355+00:00</DateTimeArrived> <Deleted>true</Deleted> <FirstName>sample string 4</FirstName> <GroupHashTag>sample string 11</GroupHashTag> <GuestCompany>sample string 7</GuestCompany> <HostPersonId>daa91c2a-156c-4edc-8e76-4ffcd15d9088</HostPersonId> <LastName>sample string 5</LastName> <Message>sample string 9</Message> <MiddleInitial>sample string 6</MiddleInitial> <VisitorRequestId>5b743100-4bd9-468b-bb50-b970e15ab72a</VisitorRequestId> <VisitorRequestInstanceId>7afaf46a-da95-4499-a644-91fd04809b32</VisitorRequestInstanceId> <VisitorStatus>NotCheckedIn</VisitorStatus> <sVisitorTypeId>c5b40831-23b0-4eeb-b03e-009424180e0a</sVisitorTypeId> </VisitorRequestInstanceViewModel> <VisitorRequestInstanceViewModel> <AssignedAccessLevelId>1</AssignedAccessLevelId> <Card> <CardACSystemId>d0f8ada6-774b-4a37-8ba3-86418777a1fe</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2025-07-26T09:57:23.4420355+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-07-26T09:57:23.4420355+00:00</CardDeactivationStartDateTime> <CardId>822bd2be-44b4-4b2c-b4fe-aa71c8ff1466</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-07-26T09:57:23.4420355+00:00</DateInserted> <DateUpdated>2025-07-26T09:57:23.4420355+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>0f5023f7-1826-4c50-b1ab-ed54ac608b51</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>0f5023f7-1826-4c50-b1ab-ed54ac608b51</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2025-07-26T09:57:23.4420355+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>b3097466-5c4e-4247-a6fb-4cc35c2685e0</PersonCardId> </Card> <DateExpected>2025-07-26T09:57:23.4420355+00:00</DateExpected> <DateTimeArrived>2025-07-26T09:57:23.4420355+00:00</DateTimeArrived> <Deleted>true</Deleted> <FirstName>sample string 4</FirstName> <GroupHashTag>sample string 11</GroupHashTag> <GuestCompany>sample string 7</GuestCompany> <HostPersonId>daa91c2a-156c-4edc-8e76-4ffcd15d9088</HostPersonId> <LastName>sample string 5</LastName> <Message>sample string 9</Message> <MiddleInitial>sample string 6</MiddleInitial> <VisitorRequestId>5b743100-4bd9-468b-bb50-b970e15ab72a</VisitorRequestId> <VisitorRequestInstanceId>7afaf46a-da95-4499-a644-91fd04809b32</VisitorRequestInstanceId> <VisitorStatus>NotCheckedIn</VisitorStatus> <sVisitorTypeId>c5b40831-23b0-4eeb-b03e-009424180e0a</sVisitorTypeId> </VisitorRequestInstanceViewModel> </ArrayOfVisitorRequestInstanceViewModel>