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

NameDescriptionTypeAdditional 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 VisitorRequestInstanceViewModel
NameDescriptionTypeAdditional 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": "844e1d5c-d5e0-498a-90dc-8b9be16572f8",
    "VisitorRequestId": "3d4bedcd-6b92-4126-b64b-0788aee81f6d",
    "DateExpected": "2024-03-29T11:45:29.2225224+00:00",
    "DateTimeArrived": "2024-03-29T11:45:29.2225224+00:00",
    "AssignedAccessLevelId": 1,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "MiddleInitial": "sample string 6",
    "GuestCompany": "sample string 7",
    "HostPersonId": "a6f98c9f-938a-4b91-83f3-d7fa5c53de65",
    "Message": "sample string 9",
    "sVisitorTypeId": "b2eb7c94-ca24-49aa-bc53-1ae4acd1c25a",
    "GroupHashTag": "sample string 11",
    "VisitorStatus": 0,
    "Deleted": true,
    "Card": {
      "PersonCardId": "a8f92650-6855-4f26-a083-0cfd4458e6d7",
      "CardName": "sample string 2",
      "CardId": "c6ebf3e0-a70d-45eb-96d3-74810e00b18b",
      "CardType": 4,
      "CardACSystemId": "132de29f-b321-4116-ad13-43255be1941a",
      "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-03-29T11:45:29.2225224+00:00",
      "DateInserted": "2024-03-29T11:45:29.2225224+00:00",
      "DateUpdated": "2024-03-29T11:45:29.2225224+00:00",
      "CardActivationStartDateTime": "2024-03-29T11:45:29.2225224+00:00",
      "CardDeactivationStartDateTime": "2024-03-29T11:45:29.2225224+00:00",
      "CardUserFlags": 1,
      "EncryptedMobileCredentials": [
        {
          "MobileKeySetId": "4f6d0e9a-9c1e-40b2-a3cb-c7f1d7bca33e",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        },
        {
          "MobileKeySetId": "4f6d0e9a-9c1e-40b2-a3cb-c7f1d7bca33e",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        }
      ],
      "CredentialType": 1
    }
  },
  {
    "VisitorRequestInstanceId": "844e1d5c-d5e0-498a-90dc-8b9be16572f8",
    "VisitorRequestId": "3d4bedcd-6b92-4126-b64b-0788aee81f6d",
    "DateExpected": "2024-03-29T11:45:29.2225224+00:00",
    "DateTimeArrived": "2024-03-29T11:45:29.2225224+00:00",
    "AssignedAccessLevelId": 1,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "MiddleInitial": "sample string 6",
    "GuestCompany": "sample string 7",
    "HostPersonId": "a6f98c9f-938a-4b91-83f3-d7fa5c53de65",
    "Message": "sample string 9",
    "sVisitorTypeId": "b2eb7c94-ca24-49aa-bc53-1ae4acd1c25a",
    "GroupHashTag": "sample string 11",
    "VisitorStatus": 0,
    "Deleted": true,
    "Card": {
      "PersonCardId": "a8f92650-6855-4f26-a083-0cfd4458e6d7",
      "CardName": "sample string 2",
      "CardId": "c6ebf3e0-a70d-45eb-96d3-74810e00b18b",
      "CardType": 4,
      "CardACSystemId": "132de29f-b321-4116-ad13-43255be1941a",
      "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-03-29T11:45:29.2225224+00:00",
      "DateInserted": "2024-03-29T11:45:29.2225224+00:00",
      "DateUpdated": "2024-03-29T11:45:29.2225224+00:00",
      "CardActivationStartDateTime": "2024-03-29T11:45:29.2225224+00:00",
      "CardDeactivationStartDateTime": "2024-03-29T11:45:29.2225224+00:00",
      "CardUserFlags": 1,
      "EncryptedMobileCredentials": [
        {
          "MobileKeySetId": "4f6d0e9a-9c1e-40b2-a3cb-c7f1d7bca33e",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        },
        {
          "MobileKeySetId": "4f6d0e9a-9c1e-40b2-a3cb-c7f1d7bca33e",
          "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>132de29f-b321-4116-ad13-43255be1941a</CardACSystemId>
      <CardACSystemName>sample string 6</CardACSystemName>
      <CardActivationStartDateTime>2024-03-29T11:45:29.2225224+00:00</CardActivationStartDateTime>
      <CardDeactivationStartDateTime>2024-03-29T11:45:29.2225224+00:00</CardDeactivationStartDateTime>
      <CardId>c6ebf3e0-a70d-45eb-96d3-74810e00b18b</CardId>
      <CardName>sample string 2</CardName>
      <CardSerialNumber>1</CardSerialNumber>
      <CardType>4</CardType>
      <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
      <CredentialType>Proximity</CredentialType>
      <DateInserted>2024-03-29T11:45:29.2225224+00:00</DateInserted>
      <DateUpdated>2024-03-29T11:45:29.2225224+00:00</DateUpdated>
      <EncryptedMobileCredentials>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>4f6d0e9a-9c1e-40b2-a3cb-c7f1d7bca33e</MobileKeySetId>
        </EncryptedCredentialData>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>4f6d0e9a-9c1e-40b2-a3cb-c7f1d7bca33e</MobileKeySetId>
        </EncryptedCredentialData>
      </EncryptedMobileCredentials>
      <ExternalCardNumber>sample string 8</ExternalCardNumber>
      <FacilityCode>9</FacilityCode>
      <HidInvitationCode>sample string 13</HidInvitationCode>
      <InternalCardNumber>7</InternalCardNumber>
      <InvitationRedeemedDateTime>2024-03-29T11:45:29.2225224+00:00</InvitationRedeemedDateTime>
      <IssueCode>10</IssueCode>
      <PIN>sample string 11</PIN>
      <PersonCardId>a8f92650-6855-4f26-a083-0cfd4458e6d7</PersonCardId>
    </Card>
    <DateExpected>2024-03-29T11:45:29.2225224+00:00</DateExpected>
    <DateTimeArrived>2024-03-29T11:45:29.2225224+00:00</DateTimeArrived>
    <Deleted>true</Deleted>
    <FirstName>sample string 4</FirstName>
    <GroupHashTag>sample string 11</GroupHashTag>
    <GuestCompany>sample string 7</GuestCompany>
    <HostPersonId>a6f98c9f-938a-4b91-83f3-d7fa5c53de65</HostPersonId>
    <LastName>sample string 5</LastName>
    <Message>sample string 9</Message>
    <MiddleInitial>sample string 6</MiddleInitial>
    <VisitorRequestId>3d4bedcd-6b92-4126-b64b-0788aee81f6d</VisitorRequestId>
    <VisitorRequestInstanceId>844e1d5c-d5e0-498a-90dc-8b9be16572f8</VisitorRequestInstanceId>
    <VisitorStatus>NotCheckedIn</VisitorStatus>
    <sVisitorTypeId>b2eb7c94-ca24-49aa-bc53-1ae4acd1c25a</sVisitorTypeId>
  </VisitorRequestInstanceViewModel>
  <VisitorRequestInstanceViewModel>
    <AssignedAccessLevelId>1</AssignedAccessLevelId>
    <Card>
      <CardACSystemId>132de29f-b321-4116-ad13-43255be1941a</CardACSystemId>
      <CardACSystemName>sample string 6</CardACSystemName>
      <CardActivationStartDateTime>2024-03-29T11:45:29.2225224+00:00</CardActivationStartDateTime>
      <CardDeactivationStartDateTime>2024-03-29T11:45:29.2225224+00:00</CardDeactivationStartDateTime>
      <CardId>c6ebf3e0-a70d-45eb-96d3-74810e00b18b</CardId>
      <CardName>sample string 2</CardName>
      <CardSerialNumber>1</CardSerialNumber>
      <CardType>4</CardType>
      <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
      <CredentialType>Proximity</CredentialType>
      <DateInserted>2024-03-29T11:45:29.2225224+00:00</DateInserted>
      <DateUpdated>2024-03-29T11:45:29.2225224+00:00</DateUpdated>
      <EncryptedMobileCredentials>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>4f6d0e9a-9c1e-40b2-a3cb-c7f1d7bca33e</MobileKeySetId>
        </EncryptedCredentialData>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>4f6d0e9a-9c1e-40b2-a3cb-c7f1d7bca33e</MobileKeySetId>
        </EncryptedCredentialData>
      </EncryptedMobileCredentials>
      <ExternalCardNumber>sample string 8</ExternalCardNumber>
      <FacilityCode>9</FacilityCode>
      <HidInvitationCode>sample string 13</HidInvitationCode>
      <InternalCardNumber>7</InternalCardNumber>
      <InvitationRedeemedDateTime>2024-03-29T11:45:29.2225224+00:00</InvitationRedeemedDateTime>
      <IssueCode>10</IssueCode>
      <PIN>sample string 11</PIN>
      <PersonCardId>a8f92650-6855-4f26-a083-0cfd4458e6d7</PersonCardId>
    </Card>
    <DateExpected>2024-03-29T11:45:29.2225224+00:00</DateExpected>
    <DateTimeArrived>2024-03-29T11:45:29.2225224+00:00</DateTimeArrived>
    <Deleted>true</Deleted>
    <FirstName>sample string 4</FirstName>
    <GroupHashTag>sample string 11</GroupHashTag>
    <GuestCompany>sample string 7</GuestCompany>
    <HostPersonId>a6f98c9f-938a-4b91-83f3-d7fa5c53de65</HostPersonId>
    <LastName>sample string 5</LastName>
    <Message>sample string 9</Message>
    <MiddleInitial>sample string 6</MiddleInitial>
    <VisitorRequestId>3d4bedcd-6b92-4126-b64b-0788aee81f6d</VisitorRequestId>
    <VisitorRequestInstanceId>844e1d5c-d5e0-498a-90dc-8b9be16572f8</VisitorRequestInstanceId>
    <VisitorStatus>NotCheckedIn</VisitorStatus>
    <sVisitorTypeId>b2eb7c94-ca24-49aa-bc53-1ae4acd1c25a</sVisitorTypeId>
  </VisitorRequestInstanceViewModel>
</ArrayOfVisitorRequestInstanceViewModel>