GET api/v1/VisitorRequests

Returns a list of VisitorViewModels that the API token has rights to view

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of VisitorViewModel
NameDescriptionTypeAdditional information
VisitorRequestId

Represents the PK of an existing Visitor Request in BluSKY

 globally unique identifier

None.
GuestPersonId

Represents the PK of an existing Visitor Request Guest in BluSKY

 globally unique identifier

None.
GuestFirstName

Represents the Guest's first/given name.

 string

None.
GuestLastName

Represents the Guest's last name / surname.

 string

None.
GuestEmail

Represents the email address of the Guest

 string

None.
GuestPhone

Represents the phone number of the Guest

 string

None.
GuestCompanyName

Represents the name of the occupancy or vendor instance that the Guest belongs to

 string

None.
GroupHashTag

Represents the group name that the Guest may belong to (if provided)

 string

None.
VisitationPattern

Represents the visitation pattern that has been requested for the Guest

 string

None.
Message

Represents a supplemental message that will be viewable by Security/Reception when the Guest arrives

 string

None.
VisitorTypeId

Represents a supplemental message that will be viewable by Security/Reception when the Guest arrives

 globally unique identifier

None.
HostPersonId

Represents the PK of an existing Visitor Request Host in BluSKY

 globally unique identifier

None.
HostFirstName

Represents the Host's first/given name.

 string

None.
HostLastName

Represents the Host's last name / surname.

 string

None.
HostEmail

Represents the email address of the Host

 string

None.
HostPhone

Represents the phone number of the Host

 string

None.
HostCompanyName

Represents the name of the occupancy or vendor instance that the Host belongs to

 string

None.
FacilityId

Represents the PK of the facility that the Guest is expected at

 globally unique identifier

None.
FacilityName

Represents the name of the facility that the Guest is expected at

 string

None.
ACSystemId

Represents the PK of the Access Control System that the Host is located in

 globally unique identifier

None.
ACSystemName

Represents the name of the Access Control System that the Host is located in

 string

None.
RequestedAccessLevel

Represents an Access Level assignments requested by the Requestor for the Visitor

 AccessLevelViewModel

None.
Deleted

Represents whether the Visitor Request is deleted or not.

 boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "VisitorRequestId": "41a11991-8e28-4069-80c9-3dbd240dbe26",
    "GuestPersonId": "c464b093-a791-4acc-adb6-4669932fdc9f",
    "GuestFirstName": "sample string 3",
    "GuestLastName": "sample string 4",
    "GuestEmail": "sample string 5",
    "GuestPhone": "sample string 6",
    "GuestCompanyName": "sample string 7",
    "GroupHashTag": "sample string 8",
    "VisitationPattern": "sample string 9",
    "Message": "sample string 10",
    "VisitorTypeId": "4f25a26e-8750-421e-97b2-c6834afa99be",
    "HostPersonId": "fe5c909d-f860-4977-b536-955c55af75a1",
    "HostFirstName": "sample string 13",
    "HostLastName": "sample string 14",
    "HostEmail": "sample string 15",
    "HostPhone": "sample string 16",
    "HostCompanyName": "sample string 17",
    "FacilityId": "0993b6da-de76-41f5-b053-5f9167ea405e",
    "FacilityName": "sample string 18",
    "ACSystemId": "998bce82-0f5c-438e-ad3a-8d2555a72acb",
    "ACSystemName": "sample string 19",
    "RequestedAccessLevel": {
      "AccessLevelId": 1,
      "Name": "sample string 2",
      "AccessLevelStartDate": "2025-03-14T13:08:04.1458794+00:00",
      "AccessLevelEndDate": "2025-03-14T13:08:04.1458794+00:00",
      "Deleted": true,
      "ACSystemId": "a8fc85cc-2a9b-4495-82c4-6d9b1fad5b37",
      "CompanyId": "afec1300-a1ad-4bf4-8fbc-860a01b88cf8",
      "ApplyByDefault": true,
      "AccessLevelTypeId": "9fc96d14-fad4-4bd3-9d03-0fb099715633",
      "FacilityId": "319b7272-7ce8-4936-8cc2-957c0a75ecb9"
    },
    "Deleted": true
  },
  {
    "VisitorRequestId": "41a11991-8e28-4069-80c9-3dbd240dbe26",
    "GuestPersonId": "c464b093-a791-4acc-adb6-4669932fdc9f",
    "GuestFirstName": "sample string 3",
    "GuestLastName": "sample string 4",
    "GuestEmail": "sample string 5",
    "GuestPhone": "sample string 6",
    "GuestCompanyName": "sample string 7",
    "GroupHashTag": "sample string 8",
    "VisitationPattern": "sample string 9",
    "Message": "sample string 10",
    "VisitorTypeId": "4f25a26e-8750-421e-97b2-c6834afa99be",
    "HostPersonId": "fe5c909d-f860-4977-b536-955c55af75a1",
    "HostFirstName": "sample string 13",
    "HostLastName": "sample string 14",
    "HostEmail": "sample string 15",
    "HostPhone": "sample string 16",
    "HostCompanyName": "sample string 17",
    "FacilityId": "0993b6da-de76-41f5-b053-5f9167ea405e",
    "FacilityName": "sample string 18",
    "ACSystemId": "998bce82-0f5c-438e-ad3a-8d2555a72acb",
    "ACSystemName": "sample string 19",
    "RequestedAccessLevel": {
      "AccessLevelId": 1,
      "Name": "sample string 2",
      "AccessLevelStartDate": "2025-03-14T13:08:04.1458794+00:00",
      "AccessLevelEndDate": "2025-03-14T13:08:04.1458794+00:00",
      "Deleted": true,
      "ACSystemId": "a8fc85cc-2a9b-4495-82c4-6d9b1fad5b37",
      "CompanyId": "afec1300-a1ad-4bf4-8fbc-860a01b88cf8",
      "ApplyByDefault": true,
      "AccessLevelTypeId": "9fc96d14-fad4-4bd3-9d03-0fb099715633",
      "FacilityId": "319b7272-7ce8-4936-8cc2-957c0a75ecb9"
    },
    "Deleted": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfVisitorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <VisitorViewModel>
    <ACSystemId>998bce82-0f5c-438e-ad3a-8d2555a72acb</ACSystemId>
    <ACSystemName>sample string 19</ACSystemName>
    <Deleted>true</Deleted>
    <FacilityId>0993b6da-de76-41f5-b053-5f9167ea405e</FacilityId>
    <FacilityName>sample string 18</FacilityName>
    <GroupHashTag>sample string 8</GroupHashTag>
    <GuestCompanyName>sample string 7</GuestCompanyName>
    <GuestEmail>sample string 5</GuestEmail>
    <GuestFirstName>sample string 3</GuestFirstName>
    <GuestLastName>sample string 4</GuestLastName>
    <GuestPersonId>c464b093-a791-4acc-adb6-4669932fdc9f</GuestPersonId>
    <GuestPhone>sample string 6</GuestPhone>
    <HostCompanyName>sample string 17</HostCompanyName>
    <HostEmail>sample string 15</HostEmail>
    <HostFirstName>sample string 13</HostFirstName>
    <HostLastName>sample string 14</HostLastName>
    <HostPersonId>fe5c909d-f860-4977-b536-955c55af75a1</HostPersonId>
    <HostPhone>sample string 16</HostPhone>
    <Message>sample string 10</Message>
    <RequestedAccessLevel>
      <ACSystemId>a8fc85cc-2a9b-4495-82c4-6d9b1fad5b37</ACSystemId>
      <AccessLevelEndDate>2025-03-14T13:08:04.1458794+00:00</AccessLevelEndDate>
      <AccessLevelId>1</AccessLevelId>
      <AccessLevelStartDate>2025-03-14T13:08:04.1458794+00:00</AccessLevelStartDate>
      <ApplyByDefault>true</ApplyByDefault>
      <CompanyId>afec1300-a1ad-4bf4-8fbc-860a01b88cf8</CompanyId>
      <Deleted>true</Deleted>
      <Name>sample string 2</Name>
    </RequestedAccessLevel>
    <VisitationPattern>sample string 9</VisitationPattern>
    <VisitorRequestId>41a11991-8e28-4069-80c9-3dbd240dbe26</VisitorRequestId>
    <VisitorTypeId>4f25a26e-8750-421e-97b2-c6834afa99be</VisitorTypeId>
  </VisitorViewModel>
  <VisitorViewModel>
    <ACSystemId>998bce82-0f5c-438e-ad3a-8d2555a72acb</ACSystemId>
    <ACSystemName>sample string 19</ACSystemName>
    <Deleted>true</Deleted>
    <FacilityId>0993b6da-de76-41f5-b053-5f9167ea405e</FacilityId>
    <FacilityName>sample string 18</FacilityName>
    <GroupHashTag>sample string 8</GroupHashTag>
    <GuestCompanyName>sample string 7</GuestCompanyName>
    <GuestEmail>sample string 5</GuestEmail>
    <GuestFirstName>sample string 3</GuestFirstName>
    <GuestLastName>sample string 4</GuestLastName>
    <GuestPersonId>c464b093-a791-4acc-adb6-4669932fdc9f</GuestPersonId>
    <GuestPhone>sample string 6</GuestPhone>
    <HostCompanyName>sample string 17</HostCompanyName>
    <HostEmail>sample string 15</HostEmail>
    <HostFirstName>sample string 13</HostFirstName>
    <HostLastName>sample string 14</HostLastName>
    <HostPersonId>fe5c909d-f860-4977-b536-955c55af75a1</HostPersonId>
    <HostPhone>sample string 16</HostPhone>
    <Message>sample string 10</Message>
    <RequestedAccessLevel>
      <ACSystemId>a8fc85cc-2a9b-4495-82c4-6d9b1fad5b37</ACSystemId>
      <AccessLevelEndDate>2025-03-14T13:08:04.1458794+00:00</AccessLevelEndDate>
      <AccessLevelId>1</AccessLevelId>
      <AccessLevelStartDate>2025-03-14T13:08:04.1458794+00:00</AccessLevelStartDate>
      <ApplyByDefault>true</ApplyByDefault>
      <CompanyId>afec1300-a1ad-4bf4-8fbc-860a01b88cf8</CompanyId>
      <Deleted>true</Deleted>
      <Name>sample string 2</Name>
    </RequestedAccessLevel>
    <VisitationPattern>sample string 9</VisitationPattern>
    <VisitorRequestId>41a11991-8e28-4069-80c9-3dbd240dbe26</VisitorRequestId>
    <VisitorTypeId>4f25a26e-8750-421e-97b2-c6834afa99be</VisitorTypeId>
  </VisitorViewModel>
</ArrayOfVisitorViewModel>