PUT api/v2/Users/{id}/UserCards

Updates details of a card's current assignment. Returns Success/Error code.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

None.

Body Parameters

UpdateUserCardViewModelV2
NameDescriptionTypeAdditional information
NumberOfCardUses

Number of Card Uses. Pass a negative value to clear

 integer

None.
PublicNotes

Public Notes

 string

None.
CredentialTypeId

Credential Type Id (optional)

 integer

None.
UserId

The PK of a User that has a given Card assigned

 globally unique identifier

None.
CardId

The PK of the Card

 globally unique identifier

None.
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: 
{
  "NumberOfCardUses": 1,
  "PublicNotes": "sample string 1",
  "CredentialTypeId": 1,
  "UserId": "8991f3ac-26cd-4c60-9a78-ecca8f441631",
  "CardId": "a784cc6c-38f8-49a8-a49a-f7febc7485fb",
  "CardActivationStartDateTime": "2025-10-22T06:04:08.1095338+00:00",
  "CardDeactivationStartDateTime": "2025-10-22T06:04:08.1095338+00:00",
  "CardUserFlags": 1,
  "ModifyActivationDates": true
}

application/xml, text/xml

Sample: 
<UpdateUserCardViewModelV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <CardActivationStartDateTime>2025-10-22T06:04:08.1095338+00:00</CardActivationStartDateTime>
  <CardDeactivationStartDateTime>2025-10-22T06:04:08.1095338+00:00</CardDeactivationStartDateTime>
  <CardId>a784cc6c-38f8-49a8-a49a-f7febc7485fb</CardId>
  <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
  <ModifyActivationDates>true</ModifyActivationDates>
  <UserId>8991f3ac-26cd-4c60-9a78-ecca8f441631</UserId>
  <CredentialTypeId>1</CredentialTypeId>
  <NumberOfCardUses>1</NumberOfCardUses>
  <PublicNotes>sample string 1</PublicNotes>
</UpdateUserCardViewModelV2>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result
NameDescriptionTypeAdditional 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>