GET api/v1/VisitorRequestInstances/NextInstance?GuestPersonId={GuestPersonId}&Start={Start}&End={End}&IncludeCardInfo={IncludeCardInfo}
Returns a single record of the next instance for a given PersonId for a Guest. "Next" is defined as any instance > 00:00:01 of current day when Start is null and less than End or if End is null, then 00:00:01 of start plus one day.
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
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": "d4f23a43-d45b-4474-8ae9-ee261d04c1a0",
"VisitorRequestId": "7327aecd-9b5e-44fe-9a6d-24faa18e15bc",
"DateExpected": "2026-01-15T10:05:09.6136712+00:00",
"DateTimeArrived": "2026-01-15T10:05:09.6136712+00:00",
"AssignedAccessLevelId": 1,
"FirstName": "sample string 4",
"LastName": "sample string 5",
"MiddleInitial": "sample string 6",
"GuestCompany": "sample string 7",
"HostPersonId": "b54b3738-183c-4d20-b6ba-99cc4774731a",
"Message": "sample string 9",
"sVisitorTypeId": "4aaa995c-b281-4114-b10c-f551273daf7d",
"GroupHashTag": "sample string 11",
"VisitorStatus": 0,
"Deleted": true,
"Card": {
"PersonCardId": "44efe9a5-85c2-4306-aeea-9331143eb18f",
"CardName": "sample string 2",
"CardId": "8640f3e4-cfa2-40a1-9783-88976f270edc",
"CardType": 4,
"CardACSystemId": "34e6c206-3756-4506-87a7-56d73ce8a934",
"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-01-15T10:05:09.6136712+00:00",
"DateInserted": "2026-01-15T10:05:09.6136712+00:00",
"DateUpdated": "2026-01-15T10:05:09.6136712+00:00",
"CardActivationStartDateTime": "2026-01-15T10:05:09.6136712+00:00",
"CardDeactivationStartDateTime": "2026-01-15T10:05:09.6136712+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "f7ff48e5-8f17-4e66-9e9f-4e602ce3345c",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "f7ff48e5-8f17-4e66-9e9f-4e602ce3345c",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
}
],
"CredentialType": 1
}
}
application/xml, text/xml
Sample:
<VisitorRequestInstanceViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
<AssignedAccessLevelId>1</AssignedAccessLevelId>
<Card>
<CardACSystemId>34e6c206-3756-4506-87a7-56d73ce8a934</CardACSystemId>
<CardACSystemName>sample string 6</CardACSystemName>
<CardActivationStartDateTime>2026-01-15T10:05:09.6136712+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2026-01-15T10:05:09.6136712+00:00</CardDeactivationStartDateTime>
<CardId>8640f3e4-cfa2-40a1-9783-88976f270edc</CardId>
<CardName>sample string 2</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>4</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2026-01-15T10:05:09.6136712+00:00</DateInserted>
<DateUpdated>2026-01-15T10:05:09.6136712+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>f7ff48e5-8f17-4e66-9e9f-4e602ce3345c</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>f7ff48e5-8f17-4e66-9e9f-4e602ce3345c</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 8</ExternalCardNumber>
<FacilityCode>9</FacilityCode>
<HidInvitationCode>sample string 13</HidInvitationCode>
<InternalCardNumber>7</InternalCardNumber>
<InvitationRedeemedDateTime>2026-01-15T10:05:09.6136712+00:00</InvitationRedeemedDateTime>
<IssueCode>10</IssueCode>
<PIN>sample string 11</PIN>
<PersonCardId>44efe9a5-85c2-4306-aeea-9331143eb18f</PersonCardId>
</Card>
<DateExpected>2026-01-15T10:05:09.6136712+00:00</DateExpected>
<DateTimeArrived>2026-01-15T10:05:09.6136712+00:00</DateTimeArrived>
<Deleted>true</Deleted>
<FirstName>sample string 4</FirstName>
<GroupHashTag>sample string 11</GroupHashTag>
<GuestCompany>sample string 7</GuestCompany>
<HostPersonId>b54b3738-183c-4d20-b6ba-99cc4774731a</HostPersonId>
<LastName>sample string 5</LastName>
<Message>sample string 9</Message>
<MiddleInitial>sample string 6</MiddleInitial>
<VisitorRequestId>7327aecd-9b5e-44fe-9a6d-24faa18e15bc</VisitorRequestId>
<VisitorRequestInstanceId>d4f23a43-d45b-4474-8ae9-ee261d04c1a0</VisitorRequestInstanceId>
<VisitorStatus>NotCheckedIn</VisitorStatus>
<sVisitorTypeId>4aaa995c-b281-4114-b10c-f551273daf7d</sVisitorTypeId>
</VisitorRequestInstanceViewModel>