GET api/v2/VisitorRequestInstances?FacilityId={FacilityId}&Start={Start}&End={End}&IncludeCardInfo={IncludeCardInfo}
Returns all instances when passed a FacilityId.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 |
|---|---|---|---|
| FacilityId | 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 VisitorRequestInstanceViewModel| Name | 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": "8654c736-924a-45e6-a914-06120e0261f0",
"VisitorRequestId": "cf97e553-8402-419d-a4f0-7c08ae335d66",
"DateExpected": "2026-09-02T16:10:55.5770147+00:00",
"DateTimeArrived": "2026-09-02T16:10:55.5770147+00:00",
"AssignedAccessLevelId": 1,
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleInitial": "sample string 6",
"GuestCompany": "sample string 7",
"HostPersonId": "2df15854-6473-400b-95f2-4514088a8b99",
"Message": "sample string 9",
"sVisitorTypeId": "5a1bd4a5-d19b-449a-b6c0-9ec119cd4f35",
"GroupHashTag": "sample string 11",
"VisitorStatus": 0,
"Deleted": true,
"Card": {
"PersonCardId": "d443f853-4087-4917-ae4b-3238c08d8dfe",
"CardName": "sample string 2",
"CardId": "942c9c1c-995c-4ae0-9749-1d60df57219f",
"CardType": 4,
"CardACSystemId": "37272da7-3775-42f4-9500-421ad9a9ef4d",
"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-09-02T16:10:55.5770147+00:00",
"DateInserted": "2026-09-02T16:10:55.5770147+00:00",
"DateUpdated": "2026-09-02T16:10:55.5770147+00:00",
"CardActivationStartDateTime": "2026-09-02T16:10:55.5770147+00:00",
"CardDeactivationStartDateTime": "2026-09-02T16:10:55.5770147+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "5bbfa236-3935-4560-88c7-70e807587eb0",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "5bbfa236-3935-4560-88c7-70e807587eb0",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
}
],
"CredentialType": 1
}
},
{
"VisitorRequestInstanceId": "8654c736-924a-45e6-a914-06120e0261f0",
"VisitorRequestId": "cf97e553-8402-419d-a4f0-7c08ae335d66",
"DateExpected": "2026-09-02T16:10:55.5770147+00:00",
"DateTimeArrived": "2026-09-02T16:10:55.5770147+00:00",
"AssignedAccessLevelId": 1,
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleInitial": "sample string 6",
"GuestCompany": "sample string 7",
"HostPersonId": "2df15854-6473-400b-95f2-4514088a8b99",
"Message": "sample string 9",
"sVisitorTypeId": "5a1bd4a5-d19b-449a-b6c0-9ec119cd4f35",
"GroupHashTag": "sample string 11",
"VisitorStatus": 0,
"Deleted": true,
"Card": {
"PersonCardId": "d443f853-4087-4917-ae4b-3238c08d8dfe",
"CardName": "sample string 2",
"CardId": "942c9c1c-995c-4ae0-9749-1d60df57219f",
"CardType": 4,
"CardACSystemId": "37272da7-3775-42f4-9500-421ad9a9ef4d",
"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-09-02T16:10:55.5770147+00:00",
"DateInserted": "2026-09-02T16:10:55.5770147+00:00",
"DateUpdated": "2026-09-02T16:10:55.5770147+00:00",
"CardActivationStartDateTime": "2026-09-02T16:10:55.5770147+00:00",
"CardDeactivationStartDateTime": "2026-09-02T16:10:55.5770147+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "5bbfa236-3935-4560-88c7-70e807587eb0",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "5bbfa236-3935-4560-88c7-70e807587eb0",
"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>37272da7-3775-42f4-9500-421ad9a9ef4d</CardACSystemId>
<CardACSystemName>sample string 6</CardACSystemName>
<CardActivationStartDateTime>2026-09-02T16:10:55.5770147+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2026-09-02T16:10:55.5770147+00:00</CardDeactivationStartDateTime>
<CardId>942c9c1c-995c-4ae0-9749-1d60df57219f</CardId>
<CardName>sample string 2</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>4</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2026-09-02T16:10:55.5770147+00:00</DateInserted>
<DateUpdated>2026-09-02T16:10:55.5770147+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>5bbfa236-3935-4560-88c7-70e807587eb0</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>5bbfa236-3935-4560-88c7-70e807587eb0</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 8</ExternalCardNumber>
<FacilityCode>9</FacilityCode>
<HidInvitationCode>sample string 13</HidInvitationCode>
<InternalCardNumber>7</InternalCardNumber>
<InvitationRedeemedDateTime>2026-09-02T16:10:55.5770147+00:00</InvitationRedeemedDateTime>
<IssueCode>10</IssueCode>
<PIN>sample string 11</PIN>
<PersonCardId>d443f853-4087-4917-ae4b-3238c08d8dfe</PersonCardId>
</Card>
<DateExpected>2026-09-02T16:10:55.5770147+00:00</DateExpected>
<DateTimeArrived>2026-09-02T16:10:55.5770147+00:00</DateTimeArrived>
<Deleted>true</Deleted>
<FirstName>sample string 4</FirstName>
<GroupHashTag>sample string 11</GroupHashTag>
<GuestCompany>sample string 7</GuestCompany>
<HostPersonId>2df15854-6473-400b-95f2-4514088a8b99</HostPersonId>
<LastName>sample string 5</LastName>
<Message>sample string 9</Message>
<MiddleInitial>sample string 6</MiddleInitial>
<VisitorRequestId>cf97e553-8402-419d-a4f0-7c08ae335d66</VisitorRequestId>
<VisitorRequestInstanceId>8654c736-924a-45e6-a914-06120e0261f0</VisitorRequestInstanceId>
<VisitorStatus>NotCheckedIn</VisitorStatus>
<sVisitorTypeId>5a1bd4a5-d19b-449a-b6c0-9ec119cd4f35</sVisitorTypeId>
</VisitorRequestInstanceViewModel>
<VisitorRequestInstanceViewModel>
<AssignedAccessLevelId>1</AssignedAccessLevelId>
<Card>
<CardACSystemId>37272da7-3775-42f4-9500-421ad9a9ef4d</CardACSystemId>
<CardACSystemName>sample string 6</CardACSystemName>
<CardActivationStartDateTime>2026-09-02T16:10:55.5770147+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2026-09-02T16:10:55.5770147+00:00</CardDeactivationStartDateTime>
<CardId>942c9c1c-995c-4ae0-9749-1d60df57219f</CardId>
<CardName>sample string 2</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>4</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2026-09-02T16:10:55.5770147+00:00</DateInserted>
<DateUpdated>2026-09-02T16:10:55.5770147+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>5bbfa236-3935-4560-88c7-70e807587eb0</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>5bbfa236-3935-4560-88c7-70e807587eb0</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 8</ExternalCardNumber>
<FacilityCode>9</FacilityCode>
<HidInvitationCode>sample string 13</HidInvitationCode>
<InternalCardNumber>7</InternalCardNumber>
<InvitationRedeemedDateTime>2026-09-02T16:10:55.5770147+00:00</InvitationRedeemedDateTime>
<IssueCode>10</IssueCode>
<PIN>sample string 11</PIN>
<PersonCardId>d443f853-4087-4917-ae4b-3238c08d8dfe</PersonCardId>
</Card>
<DateExpected>2026-09-02T16:10:55.5770147+00:00</DateExpected>
<DateTimeArrived>2026-09-02T16:10:55.5770147+00:00</DateTimeArrived>
<Deleted>true</Deleted>
<FirstName>sample string 4</FirstName>
<GroupHashTag>sample string 11</GroupHashTag>
<GuestCompany>sample string 7</GuestCompany>
<HostPersonId>2df15854-6473-400b-95f2-4514088a8b99</HostPersonId>
<LastName>sample string 5</LastName>
<Message>sample string 9</Message>
<MiddleInitial>sample string 6</MiddleInitial>
<VisitorRequestId>cf97e553-8402-419d-a4f0-7c08ae335d66</VisitorRequestId>
<VisitorRequestInstanceId>8654c736-924a-45e6-a914-06120e0261f0</VisitorRequestInstanceId>
<VisitorStatus>NotCheckedIn</VisitorStatus>
<sVisitorTypeId>5a1bd4a5-d19b-449a-b6c0-9ec119cd4f35</sVisitorTypeId>
</VisitorRequestInstanceViewModel>
</ArrayOfVisitorRequestInstanceViewModel>