GET api/v1/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	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": "e19f7c80-092a-4ade-bea6-8e9e94ac6ca4",
    "VisitorRequestId": "9e3be2bd-1657-487c-9231-7fc2093a7617",
    "DateExpected": "2025-03-13T19:23:53.801893+00:00",
    "DateTimeArrived": "2025-03-13T19:23:53.801893+00:00",
    "AssignedAccessLevelId": 1,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "MiddleInitial": "sample string 6",
    "GuestCompany": "sample string 7",
    "HostPersonId": "ef14bfcc-4f6d-4468-acc0-a1d24c26dab2",
    "Message": "sample string 9",
    "sVisitorTypeId": "21852145-0bb5-4fea-8578-13c04c2661af",
    "GroupHashTag": "sample string 11",
    "VisitorStatus": 0,
    "Deleted": true,
    "Card": {
      "PersonCardId": "7cb7270e-80b5-4b2f-865b-356349a2933e",
      "CardName": "sample string 2",
      "CardId": "74ef724c-844b-4757-9386-839926a2be9c",
      "CardType": 4,
      "CardACSystemId": "3cc7dbe0-bd4f-428c-89f8-9649fbea6785",
      "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-03-13T19:23:53.801893+00:00",
      "DateInserted": "2025-03-13T19:23:53.801893+00:00",
      "DateUpdated": "2025-03-13T19:23:53.801893+00:00",
      "CardActivationStartDateTime": "2025-03-13T19:23:53.801893+00:00",
      "CardDeactivationStartDateTime": "2025-03-13T19:23:53.801893+00:00",
      "CardUserFlags": 1,
      "EncryptedMobileCredentials": [
        {
          "MobileKeySetId": "04d7812a-b8ac-42fe-9baf-572e0c41ea8e",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        },
        {
          "MobileKeySetId": "04d7812a-b8ac-42fe-9baf-572e0c41ea8e",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        }
      ],
      "CredentialType": 1
    }
  },
  {
    "VisitorRequestInstanceId": "e19f7c80-092a-4ade-bea6-8e9e94ac6ca4",
    "VisitorRequestId": "9e3be2bd-1657-487c-9231-7fc2093a7617",
    "DateExpected": "2025-03-13T19:23:53.801893+00:00",
    "DateTimeArrived": "2025-03-13T19:23:53.801893+00:00",
    "AssignedAccessLevelId": 1,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "MiddleInitial": "sample string 6",
    "GuestCompany": "sample string 7",
    "HostPersonId": "ef14bfcc-4f6d-4468-acc0-a1d24c26dab2",
    "Message": "sample string 9",
    "sVisitorTypeId": "21852145-0bb5-4fea-8578-13c04c2661af",
    "GroupHashTag": "sample string 11",
    "VisitorStatus": 0,
    "Deleted": true,
    "Card": {
      "PersonCardId": "7cb7270e-80b5-4b2f-865b-356349a2933e",
      "CardName": "sample string 2",
      "CardId": "74ef724c-844b-4757-9386-839926a2be9c",
      "CardType": 4,
      "CardACSystemId": "3cc7dbe0-bd4f-428c-89f8-9649fbea6785",
      "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-03-13T19:23:53.801893+00:00",
      "DateInserted": "2025-03-13T19:23:53.801893+00:00",
      "DateUpdated": "2025-03-13T19:23:53.801893+00:00",
      "CardActivationStartDateTime": "2025-03-13T19:23:53.801893+00:00",
      "CardDeactivationStartDateTime": "2025-03-13T19:23:53.801893+00:00",
      "CardUserFlags": 1,
      "EncryptedMobileCredentials": [
        {
          "MobileKeySetId": "04d7812a-b8ac-42fe-9baf-572e0c41ea8e",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        },
        {
          "MobileKeySetId": "04d7812a-b8ac-42fe-9baf-572e0c41ea8e",
          "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>3cc7dbe0-bd4f-428c-89f8-9649fbea6785</CardACSystemId>
      <CardACSystemName>sample string 6</CardACSystemName>
      <CardActivationStartDateTime>2025-03-13T19:23:53.801893+00:00</CardActivationStartDateTime>
      <CardDeactivationStartDateTime>2025-03-13T19:23:53.801893+00:00</CardDeactivationStartDateTime>
      <CardId>74ef724c-844b-4757-9386-839926a2be9c</CardId>
      <CardName>sample string 2</CardName>
      <CardSerialNumber>1</CardSerialNumber>
      <CardType>4</CardType>
      <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
      <CredentialType>Proximity</CredentialType>
      <DateInserted>2025-03-13T19:23:53.801893+00:00</DateInserted>
      <DateUpdated>2025-03-13T19:23:53.801893+00:00</DateUpdated>
      <EncryptedMobileCredentials>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>04d7812a-b8ac-42fe-9baf-572e0c41ea8e</MobileKeySetId>
        </EncryptedCredentialData>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>04d7812a-b8ac-42fe-9baf-572e0c41ea8e</MobileKeySetId>
        </EncryptedCredentialData>
      </EncryptedMobileCredentials>
      <ExternalCardNumber>sample string 8</ExternalCardNumber>
      <FacilityCode>9</FacilityCode>
      <HidInvitationCode>sample string 13</HidInvitationCode>
      <InternalCardNumber>7</InternalCardNumber>
      <InvitationRedeemedDateTime>2025-03-13T19:23:53.801893+00:00</InvitationRedeemedDateTime>
      <IssueCode>10</IssueCode>
      <PIN>sample string 11</PIN>
      <PersonCardId>7cb7270e-80b5-4b2f-865b-356349a2933e</PersonCardId>
    </Card>
    <DateExpected>2025-03-13T19:23:53.801893+00:00</DateExpected>
    <DateTimeArrived>2025-03-13T19:23:53.801893+00:00</DateTimeArrived>
    <Deleted>true</Deleted>
    <FirstName>sample string 4</FirstName>
    <GroupHashTag>sample string 11</GroupHashTag>
    <GuestCompany>sample string 7</GuestCompany>
    <HostPersonId>ef14bfcc-4f6d-4468-acc0-a1d24c26dab2</HostPersonId>
    <LastName>sample string 5</LastName>
    <Message>sample string 9</Message>
    <MiddleInitial>sample string 6</MiddleInitial>
    <VisitorRequestId>9e3be2bd-1657-487c-9231-7fc2093a7617</VisitorRequestId>
    <VisitorRequestInstanceId>e19f7c80-092a-4ade-bea6-8e9e94ac6ca4</VisitorRequestInstanceId>
    <VisitorStatus>NotCheckedIn</VisitorStatus>
    <sVisitorTypeId>21852145-0bb5-4fea-8578-13c04c2661af</sVisitorTypeId>
  </VisitorRequestInstanceViewModel>
  <VisitorRequestInstanceViewModel>
    <AssignedAccessLevelId>1</AssignedAccessLevelId>
    <Card>
      <CardACSystemId>3cc7dbe0-bd4f-428c-89f8-9649fbea6785</CardACSystemId>
      <CardACSystemName>sample string 6</CardACSystemName>
      <CardActivationStartDateTime>2025-03-13T19:23:53.801893+00:00</CardActivationStartDateTime>
      <CardDeactivationStartDateTime>2025-03-13T19:23:53.801893+00:00</CardDeactivationStartDateTime>
      <CardId>74ef724c-844b-4757-9386-839926a2be9c</CardId>
      <CardName>sample string 2</CardName>
      <CardSerialNumber>1</CardSerialNumber>
      <CardType>4</CardType>
      <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
      <CredentialType>Proximity</CredentialType>
      <DateInserted>2025-03-13T19:23:53.801893+00:00</DateInserted>
      <DateUpdated>2025-03-13T19:23:53.801893+00:00</DateUpdated>
      <EncryptedMobileCredentials>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>04d7812a-b8ac-42fe-9baf-572e0c41ea8e</MobileKeySetId>
        </EncryptedCredentialData>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>04d7812a-b8ac-42fe-9baf-572e0c41ea8e</MobileKeySetId>
        </EncryptedCredentialData>
      </EncryptedMobileCredentials>
      <ExternalCardNumber>sample string 8</ExternalCardNumber>
      <FacilityCode>9</FacilityCode>
      <HidInvitationCode>sample string 13</HidInvitationCode>
      <InternalCardNumber>7</InternalCardNumber>
      <InvitationRedeemedDateTime>2025-03-13T19:23:53.801893+00:00</InvitationRedeemedDateTime>
      <IssueCode>10</IssueCode>
      <PIN>sample string 11</PIN>
      <PersonCardId>7cb7270e-80b5-4b2f-865b-356349a2933e</PersonCardId>
    </Card>
    <DateExpected>2025-03-13T19:23:53.801893+00:00</DateExpected>
    <DateTimeArrived>2025-03-13T19:23:53.801893+00:00</DateTimeArrived>
    <Deleted>true</Deleted>
    <FirstName>sample string 4</FirstName>
    <GroupHashTag>sample string 11</GroupHashTag>
    <GuestCompany>sample string 7</GuestCompany>
    <HostPersonId>ef14bfcc-4f6d-4468-acc0-a1d24c26dab2</HostPersonId>
    <LastName>sample string 5</LastName>
    <Message>sample string 9</Message>
    <MiddleInitial>sample string 6</MiddleInitial>
    <VisitorRequestId>9e3be2bd-1657-487c-9231-7fc2093a7617</VisitorRequestId>
    <VisitorRequestInstanceId>e19f7c80-092a-4ade-bea6-8e9e94ac6ca4</VisitorRequestInstanceId>
    <VisitorStatus>NotCheckedIn</VisitorStatus>
    <sVisitorTypeId>21852145-0bb5-4fea-8578-13c04c2661af</sVisitorTypeId>
  </VisitorRequestInstanceViewModel>
</ArrayOfVisitorRequestInstanceViewModel>