GET api/v1/VisitorRequests?VisitorRequestId={VisitorRequestId}
Returns a single VisitorRequestViewModel if the API token has rights to view it
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
VisitorRequestId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
VisitorViewModelName | 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
application/json, text/json
{ "VisitorRequestId": "f6bf405b-545b-41a8-9998-795b4b7dd414", "GuestPersonId": "285d86ab-ff02-4618-89c1-d4f55bdbc204", "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": "102e1402-4a08-455b-869b-84ebe27832fb", "HostPersonId": "e80dd402-f9f2-4aab-b5eb-00091f06ec87", "HostFirstName": "sample string 13", "HostLastName": "sample string 14", "HostEmail": "sample string 15", "HostPhone": "sample string 16", "HostCompanyName": "sample string 17", "FacilityId": "2c242226-151e-43e4-bfae-adb4cabdbfbd", "FacilityName": "sample string 18", "ACSystemId": "fd1025d1-51a7-49a0-96c5-07f3856cdc8a", "ACSystemName": "sample string 19", "RequestedAccessLevel": { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2024-04-25T17:13:52.3299124+00:00", "AccessLevelEndDate": "2024-04-25T17:13:52.3299124+00:00", "Deleted": true, "ACSystemId": "443330d9-f40c-4707-bc26-f279e898f2b7", "CompanyId": "574dfd38-025c-4256-8f4a-ac7984107af8", "ApplyByDefault": true, "AccessLevelTypeId": "41d280dd-87e9-4160-8e7c-6fd142728bb1", "FacilityId": "1e763379-210a-42fa-900b-5fcc7c5d7468" }, "Deleted": true }
application/xml, text/xml
<VisitorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <ACSystemId>fd1025d1-51a7-49a0-96c5-07f3856cdc8a</ACSystemId> <ACSystemName>sample string 19</ACSystemName> <Deleted>true</Deleted> <FacilityId>2c242226-151e-43e4-bfae-adb4cabdbfbd</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>285d86ab-ff02-4618-89c1-d4f55bdbc204</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>e80dd402-f9f2-4aab-b5eb-00091f06ec87</HostPersonId> <HostPhone>sample string 16</HostPhone> <Message>sample string 10</Message> <RequestedAccessLevel> <ACSystemId>443330d9-f40c-4707-bc26-f279e898f2b7</ACSystemId> <AccessLevelEndDate>2024-04-25T17:13:52.3299124+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2024-04-25T17:13:52.3299124+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>574dfd38-025c-4256-8f4a-ac7984107af8</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </RequestedAccessLevel> <VisitationPattern>sample string 9</VisitationPattern> <VisitorRequestId>f6bf405b-545b-41a8-9998-795b4b7dd414</VisitorRequestId> <VisitorTypeId>102e1402-4a08-455b-869b-84ebe27832fb</VisitorTypeId> </VisitorViewModel>