PUT api/v1/VisitorRequests/{id}

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

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Represents the PK of an existing Visitor Request in BluSKY	globally unique identifier	Required

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	Max length: 60
GuestLastName	Required: Represents the Guest's last name / surname. Max Length = 60	string	Max length: 60
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	integer	None.
Deleted	Required: Represents whether the Visitor Request is deleted or not. Should be false for Add methods.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "VisitorRequestId": "36b7fa2c-1d24-4edd-971e-723588dff728",
  "GuestPersonId": "40288eb6-2e43-4c5d-8744-8701ba2176ad",
  "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": "e056561f-76df-4399-8d7f-249cb2c54ba2",
  "HostPersonId": "1e6a88ce-293f-4639-a754-aa6a0aecb6cb",
  "FacilityId": "5935207f-1789-457e-8027-86c27d585a87",
  "ACSystemId": "81cc6dc8-92c9-40da-b6c5-f05308c070ef",
  "Floors": [
    {
      "FloorId": "095e67b4-7308-46fc-9a6e-d305dcd41c20",
      "Name": "sample string 2",
      "PhysicalSequence": 3,
      "Deleted": true
    },
    {
      "FloorId": "095e67b4-7308-46fc-9a6e-d305dcd41c20",
      "Name": "sample string 2",
      "PhysicalSequence": 3,
      "Deleted": true
    }
  ],
  "RequestedAccessLevelId": 1,
  "Deleted": true
}

application/xml, text/xml

Sample:

<AddUpdateVisitorRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <ACSystemId>81cc6dc8-92c9-40da-b6c5-f05308c070ef</ACSystemId>
  <Deleted>true</Deleted>
  <FacilityId>5935207f-1789-457e-8027-86c27d585a87</FacilityId>
  <Floors>
    <FloorsViewModel>
      <Deleted>true</Deleted>
      <FloorId>095e67b4-7308-46fc-9a6e-d305dcd41c20</FloorId>
      <Name>sample string 2</Name>
      <PhysicalSequence>3</PhysicalSequence>
    </FloorsViewModel>
    <FloorsViewModel>
      <Deleted>true</Deleted>
      <FloorId>095e67b4-7308-46fc-9a6e-d305dcd41c20</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>40288eb6-2e43-4c5d-8744-8701ba2176ad</GuestPersonId>
  <GuestPhone>sample string 4</GuestPhone>
  <HostPersonId>1e6a88ce-293f-4639-a754-aa6a0aecb6cb</HostPersonId>
  <Message>sample string 8</Message>
  <RequestedAccessLevelId>1</RequestedAccessLevelId>
  <VisitationPattern>sample string 7</VisitationPattern>
  <VisitorRequestId>36b7fa2c-1d24-4edd-971e-723588dff728</VisitorRequestId>
  <VisitorTypeId>e056561f-76df-4399-8d7f-249cb2c54ba2</VisitorTypeId>
</AddUpdateVisitorRequestViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddUpdateVisitorRequestResult

Name	Description	Type	Additional information
GuestPersonId	Represents a person ID of a visitor	globally unique identifier	None.
VisitorRequestInstances	Contains all existing future visitor request instances for a given request	Collection of VisitorRequestInstanceViewModel	None.
Value	Represents the PK value that was created as a result of an add	globally unique identifier	None.
ResultCode	Represents the result code	integer	None.
Description	Represents a description of the result code	string	None.

Response Formats

application/json, text/json

Sample:

{
  "GuestPersonId": "736f308c-13f5-4cec-8f0f-c08a84404379",
  "VisitorRequestInstances": [
    {
      "VisitorRequestInstanceId": "5bbd086b-fb56-4d31-a510-5499373b4b97",
      "VisitorRequestId": "7f70c0d4-2283-441d-b923-e7e31902797b",
      "DateExpected": "2024-04-25T17:57:02.7519144+00:00",
      "DateTimeArrived": "2024-04-25T17:57:02.7519144+00:00",
      "AssignedAccessLevelId": 1,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "MiddleInitial": "sample string 6",
      "GuestCompany": "sample string 7",
      "HostPersonId": "353bade2-a1e0-4990-b5e5-15acd0ed726e",
      "Message": "sample string 9",
      "sVisitorTypeId": "0e5ef780-2432-4f57-b94b-b8e308662247",
      "GroupHashTag": "sample string 11",
      "VisitorStatus": 0,
      "Deleted": true,
      "Card": {
        "PersonCardId": "ec5f3986-0464-43a6-bf54-a948e2540565",
        "CardName": "sample string 2",
        "CardId": "d9e8e1bc-202a-4a56-beec-61249e4dba22",
        "CardType": 4,
        "CardACSystemId": "3a7c04d3-c175-46f0-b89b-edc8c8ab4dd5",
        "CardACSystemName": "sample string 6",
        "InternalCardNumber": 7,
        "ExternalCardNumber": "sample string 8",
        "CardSerialNumber": 1,
        "FacilityCode": 9,
        "IssueCode": 10,
        "PIN": "sample string 11",
        "Deleted": true,
        "HidInvitationCode": "sample string 13",
        "InvitationRedeemedDateTime": "2024-04-25T17:57:02.7519144+00:00",
        "DateInserted": "2024-04-25T17:57:02.7519144+00:00",
        "DateUpdated": "2024-04-25T17:57:02.7519144+00:00",
        "CardActivationStartDateTime": "2024-04-25T17:57:02.7519144+00:00",
        "CardDeactivationStartDateTime": "2024-04-25T17:57:02.7519144+00:00",
        "CardUserFlags": 1,
        "EncryptedMobileCredentials": [
          {
            "MobileKeySetId": "4d3646bf-f258-4db0-8366-6e0c1dcf8b15",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          },
          {
            "MobileKeySetId": "4d3646bf-f258-4db0-8366-6e0c1dcf8b15",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          }
        ],
        "CredentialType": 1
      }
    },
    {
      "VisitorRequestInstanceId": "5bbd086b-fb56-4d31-a510-5499373b4b97",
      "VisitorRequestId": "7f70c0d4-2283-441d-b923-e7e31902797b",
      "DateExpected": "2024-04-25T17:57:02.7519144+00:00",
      "DateTimeArrived": "2024-04-25T17:57:02.7519144+00:00",
      "AssignedAccessLevelId": 1,
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "MiddleInitial": "sample string 6",
      "GuestCompany": "sample string 7",
      "HostPersonId": "353bade2-a1e0-4990-b5e5-15acd0ed726e",
      "Message": "sample string 9",
      "sVisitorTypeId": "0e5ef780-2432-4f57-b94b-b8e308662247",
      "GroupHashTag": "sample string 11",
      "VisitorStatus": 0,
      "Deleted": true,
      "Card": {
        "PersonCardId": "ec5f3986-0464-43a6-bf54-a948e2540565",
        "CardName": "sample string 2",
        "CardId": "d9e8e1bc-202a-4a56-beec-61249e4dba22",
        "CardType": 4,
        "CardACSystemId": "3a7c04d3-c175-46f0-b89b-edc8c8ab4dd5",
        "CardACSystemName": "sample string 6",
        "InternalCardNumber": 7,
        "ExternalCardNumber": "sample string 8",
        "CardSerialNumber": 1,
        "FacilityCode": 9,
        "IssueCode": 10,
        "PIN": "sample string 11",
        "Deleted": true,
        "HidInvitationCode": "sample string 13",
        "InvitationRedeemedDateTime": "2024-04-25T17:57:02.7519144+00:00",
        "DateInserted": "2024-04-25T17:57:02.7519144+00:00",
        "DateUpdated": "2024-04-25T17:57:02.7519144+00:00",
        "CardActivationStartDateTime": "2024-04-25T17:57:02.7519144+00:00",
        "CardDeactivationStartDateTime": "2024-04-25T17:57:02.7519144+00:00",
        "CardUserFlags": 1,
        "EncryptedMobileCredentials": [
          {
            "MobileKeySetId": "4d3646bf-f258-4db0-8366-6e0c1dcf8b15",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          },
          {
            "MobileKeySetId": "4d3646bf-f258-4db0-8366-6e0c1dcf8b15",
            "KeyIndex": 2,
            "EncryptedCredential": "sample string 3"
          }
        ],
        "CredentialType": 1
      }
    }
  ],
  "Value": "3942331c-ea51-4e96-ba9f-6fc3dadac636",
  "ResultCode": 3,
  "Description": "sample string 4"
}

application/xml, text/xml

Sample:

<AddUpdateVisitorRequestResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <Description>sample string 4</Description>
  <HttpStatusCode>Continue</HttpStatusCode>
  <ResultCode>3</ResultCode>
  <Value>3942331c-ea51-4e96-ba9f-6fc3dadac636</Value>
  <GuestPersonId>736f308c-13f5-4cec-8f0f-c08a84404379</GuestPersonId>
  <VisitorRequestInstances>
    <VisitorRequestInstanceViewModel>
      <AssignedAccessLevelId>1</AssignedAccessLevelId>
      <Card>
        <CardACSystemId>3a7c04d3-c175-46f0-b89b-edc8c8ab4dd5</CardACSystemId>
        <CardACSystemName>sample string 6</CardACSystemName>
        <CardActivationStartDateTime>2024-04-25T17:57:02.7519144+00:00</CardActivationStartDateTime>
        <CardDeactivationStartDateTime>2024-04-25T17:57:02.7519144+00:00</CardDeactivationStartDateTime>
        <CardId>d9e8e1bc-202a-4a56-beec-61249e4dba22</CardId>
        <CardName>sample string 2</CardName>
        <CardSerialNumber>1</CardSerialNumber>
        <CardType>4</CardType>
        <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
        <CredentialType>Proximity</CredentialType>
        <DateInserted>2024-04-25T17:57:02.7519144+00:00</DateInserted>
        <DateUpdated>2024-04-25T17:57:02.7519144+00:00</DateUpdated>
        <EncryptedMobileCredentials>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>4d3646bf-f258-4db0-8366-6e0c1dcf8b15</MobileKeySetId>
          </EncryptedCredentialData>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>4d3646bf-f258-4db0-8366-6e0c1dcf8b15</MobileKeySetId>
          </EncryptedCredentialData>
        </EncryptedMobileCredentials>
        <ExternalCardNumber>sample string 8</ExternalCardNumber>
        <FacilityCode>9</FacilityCode>
        <HidInvitationCode>sample string 13</HidInvitationCode>
        <InternalCardNumber>7</InternalCardNumber>
        <InvitationRedeemedDateTime>2024-04-25T17:57:02.7519144+00:00</InvitationRedeemedDateTime>
        <IssueCode>10</IssueCode>
        <PIN>sample string 11</PIN>
        <PersonCardId>ec5f3986-0464-43a6-bf54-a948e2540565</PersonCardId>
      </Card>
      <DateExpected>2024-04-25T17:57:02.7519144+00:00</DateExpected>
      <DateTimeArrived>2024-04-25T17:57:02.7519144+00:00</DateTimeArrived>
      <Deleted>true</Deleted>
      <FirstName>sample string 4</FirstName>
      <GroupHashTag>sample string 11</GroupHashTag>
      <GuestCompany>sample string 7</GuestCompany>
      <HostPersonId>353bade2-a1e0-4990-b5e5-15acd0ed726e</HostPersonId>
      <LastName>sample string 5</LastName>
      <Message>sample string 9</Message>
      <MiddleInitial>sample string 6</MiddleInitial>
      <VisitorRequestId>7f70c0d4-2283-441d-b923-e7e31902797b</VisitorRequestId>
      <VisitorRequestInstanceId>5bbd086b-fb56-4d31-a510-5499373b4b97</VisitorRequestInstanceId>
      <VisitorStatus>NotCheckedIn</VisitorStatus>
      <sVisitorTypeId>0e5ef780-2432-4f57-b94b-b8e308662247</sVisitorTypeId>
    </VisitorRequestInstanceViewModel>
    <VisitorRequestInstanceViewModel>
      <AssignedAccessLevelId>1</AssignedAccessLevelId>
      <Card>
        <CardACSystemId>3a7c04d3-c175-46f0-b89b-edc8c8ab4dd5</CardACSystemId>
        <CardACSystemName>sample string 6</CardACSystemName>
        <CardActivationStartDateTime>2024-04-25T17:57:02.7519144+00:00</CardActivationStartDateTime>
        <CardDeactivationStartDateTime>2024-04-25T17:57:02.7519144+00:00</CardDeactivationStartDateTime>
        <CardId>d9e8e1bc-202a-4a56-beec-61249e4dba22</CardId>
        <CardName>sample string 2</CardName>
        <CardSerialNumber>1</CardSerialNumber>
        <CardType>4</CardType>
        <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
        <CredentialType>Proximity</CredentialType>
        <DateInserted>2024-04-25T17:57:02.7519144+00:00</DateInserted>
        <DateUpdated>2024-04-25T17:57:02.7519144+00:00</DateUpdated>
        <EncryptedMobileCredentials>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>4d3646bf-f258-4db0-8366-6e0c1dcf8b15</MobileKeySetId>
          </EncryptedCredentialData>
          <EncryptedCredentialData>
            <EncryptedCredential>sample string 3</EncryptedCredential>
            <KeyIndex>2</KeyIndex>
            <MobileKeySetId>4d3646bf-f258-4db0-8366-6e0c1dcf8b15</MobileKeySetId>
          </EncryptedCredentialData>
        </EncryptedMobileCredentials>
        <ExternalCardNumber>sample string 8</ExternalCardNumber>
        <FacilityCode>9</FacilityCode>
        <HidInvitationCode>sample string 13</HidInvitationCode>
        <InternalCardNumber>7</InternalCardNumber>
        <InvitationRedeemedDateTime>2024-04-25T17:57:02.7519144+00:00</InvitationRedeemedDateTime>
        <IssueCode>10</IssueCode>
        <PIN>sample string 11</PIN>
        <PersonCardId>ec5f3986-0464-43a6-bf54-a948e2540565</PersonCardId>
      </Card>
      <DateExpected>2024-04-25T17:57:02.7519144+00:00</DateExpected>
      <DateTimeArrived>2024-04-25T17:57:02.7519144+00:00</DateTimeArrived>
      <Deleted>true</Deleted>
      <FirstName>sample string 4</FirstName>
      <GroupHashTag>sample string 11</GroupHashTag>
      <GuestCompany>sample string 7</GuestCompany>
      <HostPersonId>353bade2-a1e0-4990-b5e5-15acd0ed726e</HostPersonId>
      <LastName>sample string 5</LastName>
      <Message>sample string 9</Message>
      <MiddleInitial>sample string 6</MiddleInitial>
      <VisitorRequestId>7f70c0d4-2283-441d-b923-e7e31902797b</VisitorRequestId>
      <VisitorRequestInstanceId>5bbd086b-fb56-4d31-a510-5499373b4b97</VisitorRequestInstanceId>
      <VisitorStatus>NotCheckedIn</VisitorStatus>
      <sVisitorTypeId>0e5ef780-2432-4f57-b94b-b8e308662247</sVisitorTypeId>
    </VisitorRequestInstanceViewModel>
  </VisitorRequestInstances>
</AddUpdateVisitorRequestResult>