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	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": "d1e0f343-d732-402d-b53b-980869ec5d81",
  "VisitorRequestId": "96183bc6-06ae-4ea7-967a-80e5c24608a4",
  "DateExpected": "2024-04-26T19:07:53.8148054+00:00",
  "DateTimeArrived": "2024-04-26T19:07:53.8148054+00:00",
  "AssignedAccessLevelId": 1,
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "MiddleInitial": "sample string 6",
  "GuestCompany": "sample string 7",
  "HostPersonId": "ae1ebda8-e4ff-4f3d-8add-ff75ddc54b43",
  "Message": "sample string 9",
  "sVisitorTypeId": "958e7e48-05fc-4d28-8f65-f6e3a077130e",
  "GroupHashTag": "sample string 11",
  "VisitorStatus": 0,
  "Deleted": true,
  "Card": {
    "PersonCardId": "5199e1d7-51b6-4805-9cd6-73970a28ab28",
    "CardName": "sample string 2",
    "CardId": "5e1ef91b-1c02-4b05-a786-18cda84140e2",
    "CardType": 4,
    "CardACSystemId": "85adc7a0-c88c-4260-8775-1636bc7cda57",
    "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": "2024-04-26T19:07:53.8148054+00:00",
    "DateInserted": "2024-04-26T19:07:53.8148054+00:00",
    "DateUpdated": "2024-04-26T19:07:53.8148054+00:00",
    "CardActivationStartDateTime": "2024-04-26T19:07:53.8148054+00:00",
    "CardDeactivationStartDateTime": "2024-04-26T19:07:53.8148054+00:00",
    "CardUserFlags": 1,
    "EncryptedMobileCredentials": [
      {
        "MobileKeySetId": "c94f1d30-2c25-480e-858a-1586afdbf30b",
        "KeyIndex": 2,
        "EncryptedCredential": "sample string 3"
      },
      {
        "MobileKeySetId": "c94f1d30-2c25-480e-858a-1586afdbf30b",
        "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>85adc7a0-c88c-4260-8775-1636bc7cda57</CardACSystemId>
    <CardACSystemName>sample string 6</CardACSystemName>
    <CardActivationStartDateTime>2024-04-26T19:07:53.8148054+00:00</CardActivationStartDateTime>
    <CardDeactivationStartDateTime>2024-04-26T19:07:53.8148054+00:00</CardDeactivationStartDateTime>
    <CardId>5e1ef91b-1c02-4b05-a786-18cda84140e2</CardId>
    <CardName>sample string 2</CardName>
    <CardSerialNumber>1</CardSerialNumber>
    <CardType>4</CardType>
    <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
    <CredentialType>Proximity</CredentialType>
    <DateInserted>2024-04-26T19:07:53.8148054+00:00</DateInserted>
    <DateUpdated>2024-04-26T19:07:53.8148054+00:00</DateUpdated>
    <EncryptedMobileCredentials>
      <EncryptedCredentialData>
        <EncryptedCredential>sample string 3</EncryptedCredential>
        <KeyIndex>2</KeyIndex>
        <MobileKeySetId>c94f1d30-2c25-480e-858a-1586afdbf30b</MobileKeySetId>
      </EncryptedCredentialData>
      <EncryptedCredentialData>
        <EncryptedCredential>sample string 3</EncryptedCredential>
        <KeyIndex>2</KeyIndex>
        <MobileKeySetId>c94f1d30-2c25-480e-858a-1586afdbf30b</MobileKeySetId>
      </EncryptedCredentialData>
    </EncryptedMobileCredentials>
    <ExternalCardNumber>sample string 8</ExternalCardNumber>
    <FacilityCode>9</FacilityCode>
    <HidInvitationCode>sample string 13</HidInvitationCode>
    <InternalCardNumber>7</InternalCardNumber>
    <InvitationRedeemedDateTime>2024-04-26T19:07:53.8148054+00:00</InvitationRedeemedDateTime>
    <IssueCode>10</IssueCode>
    <PIN>sample string 11</PIN>
    <PersonCardId>5199e1d7-51b6-4805-9cd6-73970a28ab28</PersonCardId>
  </Card>
  <DateExpected>2024-04-26T19:07:53.8148054+00:00</DateExpected>
  <DateTimeArrived>2024-04-26T19:07:53.8148054+00:00</DateTimeArrived>
  <Deleted>true</Deleted>
  <FirstName>sample string 4</FirstName>
  <GroupHashTag>sample string 11</GroupHashTag>
  <GuestCompany>sample string 7</GuestCompany>
  <HostPersonId>ae1ebda8-e4ff-4f3d-8add-ff75ddc54b43</HostPersonId>
  <LastName>sample string 5</LastName>
  <Message>sample string 9</Message>
  <MiddleInitial>sample string 6</MiddleInitial>
  <VisitorRequestId>96183bc6-06ae-4ea7-967a-80e5c24608a4</VisitorRequestId>
  <VisitorRequestInstanceId>d1e0f343-d732-402d-b53b-980869ec5d81</VisitorRequestInstanceId>
  <VisitorStatus>NotCheckedIn</VisitorStatus>
  <sVisitorTypeId>958e7e48-05fc-4d28-8f65-f6e3a077130e</sVisitorTypeId>
</VisitorRequestInstanceViewModel>