POST api/v2/Users/{id}/UserCards/ReplaceCardIfExists
Adds a Card to an existing User. If the card is assigned to another user un-assigns it first. Returns Success/Error code plus primary key of UserCard entry made.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
None. |
Body Parameters
ReplaceUserCardIfExistsViewModelV2| Name | Description | Type | Additional information |
|---|---|---|---|
| NumberOfCardUses |
Number of Card Uses |
integer |
None. |
| PublicNotes |
Public Notes |
string |
None. |
| UserId |
Required: The PK of the existing User that you want to add the card to. |
globally unique identifier |
None. |
| CardId |
Optional: The PK of an existing card that you want to assign to the User. Retrieve possible values from /Card/GetAllCards. If null, CardType, CardACSystem, InternalCardNumber, ExternalCardNumber and Facility code are required. |
globally unique identifier |
None. |
| CardType |
Conditional: If CardId is null, this is required. Represents the type of card being added dynamically. Retrieve possible values from /Card/GetAllCardTypes |
integer |
None. |
| CardACSystemId |
Conditional: If CardId is null, this is required. Represents the Access Control System of the card being added dynamically. Retrieve possible values from /ACSystem/GetAllSystems |
globally unique identifier |
None. |
| InternalCardNumber |
Conditional: If CardId is null, this is required. Represents the internal/encoded number of the card being added dynamically. |
integer |
None. |
| ExternalCardNumber |
Conditional: If CardId is null, this is required. Represents the external number printed on the card being added dynamically. |
string |
None. |
| CardSerialNumber |
Conditional: If CardType supports it, this is required. Represents the serial number of the smart card being added dynamically. |
integer |
None. |
| FacilityCode |
Conditional: If CardType supports it, this is required. Represents the facility code of the smart card being added dynamically. |
integer |
None. |
| IssueCode |
Conditional: If CardType supports it, this is required. Represents the issue code of the smart card being added dynamically. |
integer |
None. |
| PIN |
Optional: The PIN that the User may use in conjunction with this Card for Card + PIN mode or for when Readers are in PIN mode only. |
string |
None. |
| EnforceOccupancySystem |
Optional: Requests to verify if the CardACSystemId matches the system the User's Occupancy belongs to |
boolean |
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. |
Request Formats
application/json, text/json
{
"NumberOfCardUses": 1,
"PublicNotes": "sample string 1",
"UserId": "ec93fe8d-0c3e-4b88-9fd6-ba97552a4f67",
"CardId": "174a29e7-5080-4c2d-b571-c7d8f9df2358",
"CardType": 3,
"CardACSystemId": "e03521b8-b2ab-4e81-8faa-910d83f4de82",
"InternalCardNumber": 4,
"ExternalCardNumber": "sample string 5",
"CardSerialNumber": 1,
"FacilityCode": 1,
"IssueCode": 1,
"PIN": "sample string 6",
"EnforceOccupancySystem": true,
"CardActivationStartDateTime": "2025-03-10T20:32:28.1554217+00:00",
"CardDeactivationStartDateTime": "2025-03-10T20:32:28.1554217+00:00",
"CardUserFlags": 1
}
application/xml, text/xml
<ReplaceUserCardIfExistsViewModelV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <CardACSystemId>e03521b8-b2ab-4e81-8faa-910d83f4de82</CardACSystemId> <CardActivationStartDateTime>2025-03-10T20:32:28.1554217+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-03-10T20:32:28.1554217+00:00</CardDeactivationStartDateTime> <CardId>174a29e7-5080-4c2d-b571-c7d8f9df2358</CardId> <CardSerialNumber>1</CardSerialNumber> <CardType>3</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <EnforceOccupancySystem>true</EnforceOccupancySystem> <ExternalCardNumber>sample string 5</ExternalCardNumber> <FacilityCode>1</FacilityCode> <InternalCardNumber>4</InternalCardNumber> <IssueCode>1</IssueCode> <PIN>sample string 6</PIN> <UserId>ec93fe8d-0c3e-4b88-9fd6-ba97552a4f67</UserId> <NumberOfCardUses>1</NumberOfCardUses> <PublicNotes>sample string 1</PublicNotes> </ReplaceUserCardIfExistsViewModelV2>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ReplaceCardIfExistsResult| Name | Description | Type | Additional information |
|---|---|---|---|
| PreviousUserId |
Represents a UserId for a user the card previously belonged to |
globally unique identifier |
None. |
| CurrentUserId |
Represents a UserId for a user the card has been assigned to |
globally unique identifier |
None. |
| ExternalCardNumber |
Represents the serial number of the smart card being added dynamically |
string |
None. |
| InternalCardNumber |
Represents the internal/encoded number of the card being added dynamically. |
integer |
None. |
| FacilityCode |
Represents the facility code of the smart card being added dynamically. |
integer |
None. |
| CardType |
Represents the type of card being added dynamically. Retrieve possible values from /Card/GetAllCardTypes |
integer |
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
{
"PreviousUserId": "1cbba047-1697-4b4b-9b94-a4e5ea1c32fb",
"CurrentUserId": "d9846542-3665-4a16-b18a-ef7663b5ef31",
"ExternalCardNumber": "sample string 1",
"InternalCardNumber": 1,
"FacilityCode": 1,
"CardType": 1,
"Value": "dffb12c1-0408-43b3-b2a8-6a9bc37b40d5",
"ResultCode": 3,
"Description": "sample string 4"
}
application/xml, text/xml
<ReplaceCardIfExistsResult 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>dffb12c1-0408-43b3-b2a8-6a9bc37b40d5</Value> <CardType>1</CardType> <CurrentUserId>d9846542-3665-4a16-b18a-ef7663b5ef31</CurrentUserId> <ExternalCardNumber>sample string 1</ExternalCardNumber> <FacilityCode>1</FacilityCode> <InternalCardNumber>1</InternalCardNumber> <PreviousUserId>1cbba047-1697-4b4b-9b94-a4e5ea1c32fb</PreviousUserId> </ReplaceCardIfExistsResult>