GetVisitorRequestById
Overview
Returns a single VisitorRequestViewModel if the API token has rights to view it.
Request Information
Method
GET - api/Visitor/GetVisitorRequestById/{VisitorRequestId}
URI Parameters
None.
| Name | Description | Type | Additional information |
|---|---|---|---|
| VisitorRequestId | globally unique identifier | Required |
Body Parameters
None.
Response Information
Resource Description
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
{
"VisitorRequestId": "5a13a3a8-e7d1-435a-a32b-fbc33b6b69f4",
"GuestPersonId": "f52ce0e2-989c-40bb-9ea7-c0b841d1c087",
"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": "241b3f8c-d931-4d19-a2c3-47573b535cdd",
"HostPersonId": "eff7e059-2b19-487e-8375-1ab56e005e82",
"HostFirstName": "sample string 13",
"HostLastName": "sample string 14",
"HostEmail": "sample string 15",
"HostPhone": "sample string 16",
"HostCompanyName": "sample string 17",
"FacilityId": "24d99561-a902-43c5-8d7b-618bfeda8e1d",
"FacilityName": "sample string 18",
"ACSystemId": "d621e69e-5fd7-499f-856b-16a16fcc8e5a",
"ACSystemName": "sample string 19",
"RequestedAccessLevel": {
"AccessLevelId": 1,
"Name": "sample string 2"
},
"Deleted": true
}
XML
<VisitorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
<ACSystemId>d621e69e-5fd7-499f-856b-16a16fcc8e5a</ACSystemId>
<ACSystemName>sample string 19</ACSystemName>
<Deleted>true</Deleted>
<FacilityId>24d99561-a902-43c5-8d7b-618bfeda8e1d</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>f52ce0e2-989c-40bb-9ea7-c0b841d1c087</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>eff7e059-2b19-487e-8375-1ab56e005e82</HostPersonId>
<HostPhone>sample string 16</HostPhone>
<Message>sample string 10</Message>
<RequestedAccessLevel>
<AccessLevelId>1</AccessLevelId>
`<Name>`sample string 2</Name>
</RequestedAccessLevel>
<VisitationPattern>sample string 9</VisitationPattern>
<VisitorRequestId>5a13a3a8-e7d1-435a-a32b-fbc33b6b69f4</VisitorRequestId>
<VisitorTypeId>241b3f8c-d931-4d19-a2c3-47573b535cdd</VisitorTypeId>
</VisitorViewModel>