PUT api/v2/VisitorRequestInstances/{VisitorRequestInstanceId}/Card
Updates a card data for the Visitor Request Instance
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
VisitorRequestInstanceId | string |
None. |
Body Parameters
AddUpdateVisitorCardViewModel2Name | Description | Type | Additional information |
---|---|---|---|
VisitorRequestInstanceId |
The Id of the visitor request instance to look for |
globally unique identifier |
None. |
Card |
Visitor card data |
VisitorCardViewModel2 |
None. |
ReassignIfExists |
If true and the card belongs to another visitor already, forces to re-assign the card to this one |
boolean |
None. |
CheckIn |
If true, also checks in current visitor |
boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "VisitorRequestInstanceId": "4f2c9ac5-c078-402c-8ab1-1f06f59c3bd6", "Card": { "CardId": "76df126e-ac8c-4df0-827f-d8017d3b8842", "CardType": 1, "InternalCardNumber": 2, "ExternalCardNumber": "sample string 3", "CardSerialNumber": 1, "FacilityCode": 1, "IssueCode": 1, "PIN": "sample string 4", "CardActivationStartDateTime": "2025-03-31T14:09:44.8720285+00:00", "CardDeactivationStartDateTime": "2025-03-31T14:09:44.8720285+00:00", "CardUserFlags": 1 }, "ReassignIfExists": true, "CheckIn": true }
application/xml, text/xml
Sample:
<AddUpdateVisitorCardViewModel2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <Card> <CardActivationStartDateTime>2025-03-31T14:09:44.8720285+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-03-31T14:09:44.8720285+00:00</CardDeactivationStartDateTime> <CardId>76df126e-ac8c-4df0-827f-d8017d3b8842</CardId> <CardSerialNumber>1</CardSerialNumber> <CardType>1</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <ExternalCardNumber>sample string 3</ExternalCardNumber> <FacilityCode>1</FacilityCode> <InternalCardNumber>2</InternalCardNumber> <IssueCode>1</IssueCode> <PIN>sample string 4</PIN> </Card> <CheckIn>true</CheckIn> <ReassignIfExists>true</ReassignIfExists> <VisitorRequestInstanceId>4f2c9ac5-c078-402c-8ab1-1f06f59c3bd6</VisitorRequestInstanceId> </AddUpdateVisitorCardViewModel2>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResultWithGuidName | Description | Type | Additional information |
---|---|---|---|
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:
{ "Value": "12bb8b70-25cf-44ee-b998-87ad217a4f70", "ResultCode": 2, "Description": "sample string 3" }
application/xml, text/xml
Sample:
<ResultWithGuid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <Description>sample string 3</Description> <HttpStatusCode>Continue</HttpStatusCode> <ResultCode>2</ResultCode> <Value>12bb8b70-25cf-44ee-b998-87ad217a4f70</Value> </ResultWithGuid>