PUT api/v1/VisitorRequestInstances/{VisitorRequestInstanceId}/Card
Updates the card data for the existing Visitor Request Instance
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| VisitorRequestInstanceId | globally unique identifier |
Required |
Body Parameters
UpdateVisitorCardViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CardActivationStartDateTime |
Optional: Date and time of the card activation |
date |
None. |
| CardDeactivationStartDateTime |
Optional: Date and time of the card de-activation |
date |
None. |
| CardUserFlags |
Card User Flags |
CardUserFlags |
None. |
| ModifyActivationDates |
Whether to modify the card activation dates. If true and both (de)activation values are null, the card is considered permanently active |
boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"CardActivationStartDateTime": "2025-10-11T23:46:03.3768641+00:00",
"CardDeactivationStartDateTime": "2025-10-11T23:46:03.3768641+00:00",
"CardUserFlags": 1,
"ModifyActivationDates": true
}
application/xml, text/xml
Sample:
<UpdateVisitorCardViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <CardActivationStartDateTime>2025-10-11T23:46:03.3768641+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-10-11T23:46:03.3768641+00:00</CardDeactivationStartDateTime> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <ModifyActivationDates>true</ModifyActivationDates> </UpdateVisitorCardViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
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
application/json, text/json
Sample:
{
"ResultCode": 1,
"Description": "sample string 2"
}
application/xml, text/xml
Sample:
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <Description>sample string 2</Description> <HttpStatusCode>Continue</HttpStatusCode> <ResultCode>1</ResultCode> </Result>