GetAllVisitorRequestsByOccupancyId

Last updated

Dec 14, 2016
Save as PDF
Share
1. Share
2. Tweet
3. Share

Overview

Returns a list of VisitorViewModels from a given Facility that the API token has rights to view.

Request Information

Method

GET - api/Visitor/GetAllVisitorRequestsByOccupancyId/{OccupancyId}

URI Parameters

Name	Description	Type	Additional information
OccupancyId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of VisitorViewModel

Name	Description	Type	Additional 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

JSON

01[
02  {
03    "VisitorRequestId": "9e53d8e1-f71d-485c-bfa8-ec09d5e43959",
04    "GuestPersonId": "2e83f97c-70d5-4a42-9f32-74b9d0a2fb4a",
05    "GuestFirstName": "sample string 3",
06    "GuestLastName": "sample string 4",
07    "GuestEmail": "sample string 5",
08    "GuestPhone": "sample string 6",
09    "GuestCompanyName": "sample string 7",
10    "GroupHashTag": "sample string 8",
11    "VisitationPattern": "sample string 9",
12    "Message": "sample string 10",
13    "VisitorTypeId": "913772b0-52b9-4068-b099-8f1926b7d908",
14    "HostPersonId": "20025a88-fd12-4cf3-8d5f-41c51342c92c",
15    "HostFirstName": "sample string 13",
16    "HostLastName": "sample string 14",
17    "HostEmail": "sample string 15",
18    "HostPhone": "sample string 16",
19    "HostCompanyName": "sample string 17",
20    "FacilityId": "aed6fadb-621c-489b-a146-d595fc860158",
21    "FacilityName": "sample string 18",
22    "ACSystemId": "b418e2f4-2e0b-44d4-bba2-4e60e4690fb9",
23    "ACSystemName": "sample string 19",
24    "RequestedAccessLevel": {
25      "AccessLevelId": 1,
26      "Name": "sample string 2"
27    },
28    "Deleted": true
29  },
30  {
31    "VisitorRequestId": "9e53d8e1-f71d-485c-bfa8-ec09d5e43959",
32    "GuestPersonId": "2e83f97c-70d5-4a42-9f32-74b9d0a2fb4a",
33    "GuestFirstName": "sample string 3",
34    "GuestLastName": "sample string 4",
35    "GuestEmail": "sample string 5",
36    "GuestPhone": "sample string 6",
37    "GuestCompanyName": "sample string 7",
38    "GroupHashTag": "sample string 8",
39    "VisitationPattern": "sample string 9",
40    "Message": "sample string 10",
41    "VisitorTypeId": "913772b0-52b9-4068-b099-8f1926b7d908",
42    "HostPersonId": "20025a88-fd12-4cf3-8d5f-41c51342c92c",
43    "HostFirstName": "sample string 13",
44    "HostLastName": "sample string 14",
45    "HostEmail": "sample string 15",
46    "HostPhone": "sample string 16",
47    "HostCompanyName": "sample string 17",
48    "FacilityId": "aed6fadb-621c-489b-a146-d595fc860158",
49    "FacilityName": "sample string 18",
50    "ACSystemId": "b418e2f4-2e0b-44d4-bba2-4e60e4690fb9",
51    "ACSystemName": "sample string 19",
52    "RequestedAccessLevel": {
53      "AccessLevelId": 1,
54      "Name": "sample string 2"
55    },
56    "Deleted": true
57  }
58]

XML

01<ArrayOfVisitorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
02  <VisitorViewModel>
03    <ACSystemId>b418e2f4-2e0b-44d4-bba2-4e60e4690fb9</ACSystemId>
04    <ACSystemName>sample string 19</ACSystemName>
05    <Deleted>true</Deleted>
06    <FacilityId>aed6fadb-621c-489b-a146-d595fc860158</FacilityId>
07    <FacilityName>sample string 18</FacilityName>
08    <GroupHashTag>sample string 8</GroupHashTag>
09    <GuestCompanyName>sample string 7</GuestCompanyName>
10    <GuestEmail>sample string 5</GuestEmail>
11    <GuestFirstName>sample string 3</GuestFirstName>
12    <GuestLastName>sample string 4</GuestLastName>
13    <GuestPersonId>2e83f97c-70d5-4a42-9f32-74b9d0a2fb4a</GuestPersonId>
14    <GuestPhone>sample string 6</GuestPhone>
15    <HostCompanyName>sample string 17</HostCompanyName>
16    <HostEmail>sample string 15</HostEmail>
17    <HostFirstName>sample string 13</HostFirstName>
18    <HostLastName>sample string 14</HostLastName>
19    <HostPersonId>20025a88-fd12-4cf3-8d5f-41c51342c92c</HostPersonId>
20    <HostPhone>sample string 16</HostPhone>
21    <Message>sample string 10</Message>
22    <RequestedAccessLevel>
23      <AccessLevelId>1</AccessLevelId>
24      <Name>sample string 2</Name>
25    </RequestedAccessLevel>
26    <VisitationPattern>sample string 9</VisitationPattern>
27    <VisitorRequestId>9e53d8e1-f71d-485c-bfa8-ec09d5e43959</VisitorRequestId>
28    <VisitorTypeId>913772b0-52b9-4068-b099-8f1926b7d908</VisitorTypeId>
29  </VisitorViewModel>
30  <VisitorViewModel>
31    <ACSystemId>b418e2f4-2e0b-44d4-bba2-4e60e4690fb9</ACSystemId>
32    <ACSystemName>sample string 19</ACSystemName>
33    <Deleted>true</Deleted>
34    <FacilityId>aed6fadb-621c-489b-a146-d595fc860158</FacilityId>
35    <FacilityName>sample string 18</FacilityName>
36    <GroupHashTag>sample string 8</GroupHashTag>
37    <GuestCompanyName>sample string 7</GuestCompanyName>
38    <GuestEmail>sample string 5</GuestEmail>
39    <GuestFirstName>sample string 3</GuestFirstName>
40    <GuestLastName>sample string 4</GuestLastName>
41    <GuestPersonId>2e83f97c-70d5-4a42-9f32-74b9d0a2fb4a</GuestPersonId>
42    <GuestPhone>sample string 6</GuestPhone>
43    <HostCompanyName>sample string 17</HostCompanyName>
44    <HostEmail>sample string 15</HostEmail>
45    <HostFirstName>sample string 13</HostFirstName>
46    <HostLastName>sample string 14</HostLastName>
47    <HostPersonId>20025a88-fd12-4cf3-8d5f-41c51342c92c</HostPersonId>
48    <HostPhone>sample string 16</HostPhone>
49    <Message>sample string 10</Message>
50    <RequestedAccessLevel>
51      <AccessLevelId>1</AccessLevelId>
52      <Name>sample string 2</Name>
53    </RequestedAccessLevel>
54    <VisitationPattern>sample string 9</VisitationPattern>
55    <VisitorRequestId>9e53d8e1-f71d-485c-bfa8-ec09d5e43959</VisitorRequestId>
56    <VisitorTypeId>913772b0-52b9-4068-b099-8f1926b7d908</VisitorTypeId>
57  </VisitorViewModel>
58</ArrayOfVisitorViewModel>