GET api/v2/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
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": "4fc9b8bb-4128-4f09-b415-73e5c2f341a5", "VisitorRequestId": "01d4cf25-98e1-44fd-8b4a-6b6d6b0b7963", "DateExpected": "2025-07-26T10:03:09.3010871+00:00", "DateTimeArrived": "2025-07-26T10:03:09.3010871+00:00", "AssignedAccessLevelId": 1, "FirstName": "sample string 4", "LastName": "sample string 5", "MiddleInitial": "sample string 6", "GuestCompany": "sample string 7", "HostPersonId": "540f7081-1115-42ff-8cfd-de26eb46052d", "Message": "sample string 9", "sVisitorTypeId": "f7c510bc-9735-4d44-bb68-0baedadd86ca", "GroupHashTag": "sample string 11", "VisitorStatus": 0, "Deleted": true, "Card": { "PersonCardId": "9cb56589-965b-4628-a9a8-6308ba9fdf70", "CardName": "sample string 2", "CardId": "3c95fe53-da87-47fe-bb5e-3c481805579a", "CardType": 4, "CardACSystemId": "37d34605-e68e-40b4-995f-54b0449e6042", "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-26T10:03:09.3010871+00:00", "DateInserted": "2025-07-26T10:03:09.3010871+00:00", "DateUpdated": "2025-07-26T10:03:09.3010871+00:00", "CardActivationStartDateTime": "2025-07-26T10:03:09.3010871+00:00", "CardDeactivationStartDateTime": "2025-07-26T10:03:09.3010871+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "98d24cf9-b066-4749-8ccf-2e8e64bb7ef8", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "98d24cf9-b066-4749-8ccf-2e8e64bb7ef8", "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>37d34605-e68e-40b4-995f-54b0449e6042</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2025-07-26T10:03:09.3010871+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-07-26T10:03:09.3010871+00:00</CardDeactivationStartDateTime> <CardId>3c95fe53-da87-47fe-bb5e-3c481805579a</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-07-26T10:03:09.3010871+00:00</DateInserted> <DateUpdated>2025-07-26T10:03:09.3010871+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>98d24cf9-b066-4749-8ccf-2e8e64bb7ef8</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>98d24cf9-b066-4749-8ccf-2e8e64bb7ef8</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2025-07-26T10:03:09.3010871+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>9cb56589-965b-4628-a9a8-6308ba9fdf70</PersonCardId> </Card> <DateExpected>2025-07-26T10:03:09.3010871+00:00</DateExpected> <DateTimeArrived>2025-07-26T10:03:09.3010871+00:00</DateTimeArrived> <Deleted>true</Deleted> <FirstName>sample string 4</FirstName> <GroupHashTag>sample string 11</GroupHashTag> <GuestCompany>sample string 7</GuestCompany> <HostPersonId>540f7081-1115-42ff-8cfd-de26eb46052d</HostPersonId> <LastName>sample string 5</LastName> <Message>sample string 9</Message> <MiddleInitial>sample string 6</MiddleInitial> <VisitorRequestId>01d4cf25-98e1-44fd-8b4a-6b6d6b0b7963</VisitorRequestId> <VisitorRequestInstanceId>4fc9b8bb-4128-4f09-b415-73e5c2f341a5</VisitorRequestInstanceId> <VisitorStatus>NotCheckedIn</VisitorStatus> <sVisitorTypeId>f7c510bc-9735-4d44-bb68-0baedadd86ca</sVisitorTypeId> </VisitorRequestInstanceViewModel>