UpdateVisitorRequest

Overview

Updates a single VisitorRequest that is already in the system. Returns Success/Error code.

Request Information

Method

POST - api/Visitor/UpdateVisitorRequest

URI Parameters

None.

Body Parameters

AddUpdateVisitorRequestViewModel

Name	Description	Type	Additional information
VisitorRequestId	Conditional: Represents the PK of an existing Visitor Request in BluSKY if calling an Update method. Not used for Add methods	globally unique identifier	None.
GuestPersonId	Conditional: Represents the PK of an existing Visitor Request Guest in BluSKY if calling an Update method. Not used for Add methods	globally unique identifier	None.
GuestFirstName	Required: Represents the Guest's first/given name. Max Length = 60	string	None.
GuestLastName	Required: Represents the Guest's last name / surname. Max Length = 60	string	None.
GuestEmail	Optional: Represents the email address of the Guest	string	None.
GuestPhone	Optional: Represents the phone number of the Guest	string	None.
GuestCompanyName	Optional: Represents the name of the occupancy or vendor instance that the Guest belongs to	string	None.
GroupHashTag	Optional: Represents the group name that the Guest may belong to (if provided)	string	None.
VisitationPattern	Required: Represents the visitation pattern that has been requested for the Guest	string	None.
Message	Optional: Represents a supplemental message that will be viewable by Security/Reception when the Guest arrives	string	None.
VisitorTypeId	Required: Represents a supplemental message that will be viewable by Security/Reception when the Guest arrives. Retrieve possible values from /Visitor/GetAllVisitorTypes	globally unique identifier	None.
HostPersonId	Required: Represents the PK of an existing Visitor Request Host in BluSKY. Used for both Add and Update	globally unique identifier	None.
FacilityId	Required: Represents the PK of the facility that the Guest is expected at. Retrieve possible values from /Facility/GetAllFacilities	globally unique identifier	None.
ACSystemId	Required: Represents the PK of the Access Control System that the Host is located in. Retrieve possible values from /ACSystem/GetAllSystems	globally unique identifier	None.
Floors	Optional: Represents the list of floors that the Guest will be allowed to visit if Access Levels are not being used.	Collection of FloorsViewModel	None.
RequestedAccessLevelId	Optional: Represents an Access Level assignments requested by the Requestor for the Visitor. Retrieve possible values from /AccessLevel/GetAllAccessLevels	globally unique identifier	None.
Deleted	Required: Represents whether the Visitor Request is deleted or not. Should be false for Add methods.	boolean	None.

JSON

{
  "VisitorRequestId": "29a88be3-c7ac-446d-8975-e4b296c0fd4e",
  "GuestPersonId": "ee8a1ae8-e963-49fb-8155-eb6b7e79452e",
  "GuestFirstName": "sample string 1",
  "GuestLastName": "sample string 2",
  "GuestEmail": "sample string 3",
  "GuestPhone": "sample string 4",
  "GuestCompanyName": "sample string 5",
  "GroupHashTag": "sample string 6",
  "VisitationPattern": "sample string 7",
  "Message": "sample string 8",
  "VisitorTypeId": "14c28629-e265-452d-a1b5-68eb371bf917",
  "HostPersonId": "6f1c9788-092d-41f7-9b72-285425e3df6f",
  "FacilityId": "7fc5d72f-56bc-4965-8eee-b4766d0b80c1",
  "ACSystemId": "4187946a-273b-47ce-9b03-44dd8351e80e",
  "Floors": [
    {
      "FloorId": "6bc0ab1b-fb9b-4576-ab5d-1e75476a0881",
      "Name": "sample string 2",
      "PhysicalSequence": 3,
      "Deleted": true
    },
    {
      "FloorId": "6bc0ab1b-fb9b-4576-ab5d-1e75476a0881",
      "Name": "sample string 2",
      "PhysicalSequence": 3,
      "Deleted": true
    }
  ],
  "RequestedAccessLevelId": "df1d9342-15ce-4f38-809a-d3eef54d67f6",
  "Deleted": true
}

XML

<AddUpdateVisitorRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
  <ACSystemId>4187946a-273b-47ce-9b03-44dd8351e80e</ACSystemId>
  <Deleted>true</Deleted>
  <FacilityId>7fc5d72f-56bc-4965-8eee-b4766d0b80c1</FacilityId>
  <Floors>
    <FloorsViewModel>
      <Deleted>true</Deleted>
      <FloorId>6bc0ab1b-fb9b-4576-ab5d-1e75476a0881</FloorId>
      <Name>sample string 2</Name>
      <PhysicalSequence>3</PhysicalSequence>
    </FloorsViewModel>
    <FloorsViewModel>
      <Deleted>true</Deleted>
      <FloorId>6bc0ab1b-fb9b-4576-ab5d-1e75476a0881</FloorId>
      <Name>sample string 2</Name>
      <PhysicalSequence>3</PhysicalSequence>
    </FloorsViewModel>
  </Floors>
  <GroupHashTag>sample string 6</GroupHashTag>
  <GuestCompanyName>sample string 5</GuestCompanyName>
  <GuestEmail>sample string 3</GuestEmail>
  <GuestFirstName>sample string 1</GuestFirstName>
  <GuestLastName>sample string 2</GuestLastName>
  <GuestPersonId>ee8a1ae8-e963-49fb-8155-eb6b7e79452e</GuestPersonId>
  <GuestPhone>sample string 4</GuestPhone>
  <HostPersonId>6f1c9788-092d-41f7-9b72-285425e3df6f</HostPersonId>
  <Message>sample string 8</Message>
  <RequestedAccessLevelId>df1d9342-15ce-4f38-809a-d3eef54d67f6</RequestedAccessLevelId>
  <VisitationPattern>sample string 7</VisitationPattern>
  <VisitorRequestId>29a88be3-c7ac-446d-8975-e4b296c0fd4e</VisitorRequestId>
  <VisitorTypeId>14c28629-e265-452d-a1b5-68eb371bf917</VisitorTypeId>
</AddUpdateVisitorRequestViewModel>

Response Information

Resource Description

Result

Name	Description	Type	Additional information
ResultCode	Represents the result code	integer	None.
Description	Represents a description of the result code	string	None.

Response Formats

JSON

{
  "ResultCode": 1,
  "Description": "sample string 2"
}

XML

<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
  <Description>sample string 2</Description>
  <ResultCode>1</ResultCode>
</Result>