GET api/v1/Users/UserCards?UserId={UserId}&IncludeDeleted={IncludeDeleted}&FacilityCode={FacilityCode}
Returns list of cards for a given user by the UserId
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
UserId | globally unique identifier |
Required |
|
IncludeDeleted | boolean |
Default value is False |
|
FacilityCode | integer |
Default value is -1 |
Body Parameters
None.
Response Information
Resource Description
PersonCardAndUserIdViewModelName | Description | Type | Additional information |
---|---|---|---|
UserId | globally unique identifier |
None. |
|
Cards | Collection of PersonCardViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "UserId": "3a88f5c4-b296-4061-a336-a53841b2c532", "Cards": [ { "PersonCardId": "c7fa9926-05fc-4292-ae9b-536ee9160a1d", "CardName": "sample string 2", "CardId": "517a13c6-87e7-4087-b366-6439d82e62a9", "CardType": 4, "CardACSystemId": "6cd718ac-f5bf-4f11-ab9b-24c125db7664", "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": "2025-07-08T05:18:48.3693044+00:00", "DateInserted": "2025-07-08T05:18:48.3693044+00:00", "DateUpdated": "2025-07-08T05:18:48.3693044+00:00", "CardActivationStartDateTime": "2025-07-08T05:18:48.3693044+00:00", "CardDeactivationStartDateTime": "2025-07-08T05:18:48.3693044+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "54888a51-1516-44e5-b2bd-222da0fe53c8", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "54888a51-1516-44e5-b2bd-222da0fe53c8", "KeyIndex": 2, "EncryptedCredential": "sample string 3" } ], "CredentialType": 1 }, { "PersonCardId": "c7fa9926-05fc-4292-ae9b-536ee9160a1d", "CardName": "sample string 2", "CardId": "517a13c6-87e7-4087-b366-6439d82e62a9", "CardType": 4, "CardACSystemId": "6cd718ac-f5bf-4f11-ab9b-24c125db7664", "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": "2025-07-08T05:18:48.3693044+00:00", "DateInserted": "2025-07-08T05:18:48.3693044+00:00", "DateUpdated": "2025-07-08T05:18:48.3693044+00:00", "CardActivationStartDateTime": "2025-07-08T05:18:48.3693044+00:00", "CardDeactivationStartDateTime": "2025-07-08T05:18:48.3693044+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "54888a51-1516-44e5-b2bd-222da0fe53c8", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "54888a51-1516-44e5-b2bd-222da0fe53c8", "KeyIndex": 2, "EncryptedCredential": "sample string 3" } ], "CredentialType": 1 } ] }
application/xml, text/xml
Sample:
<PersonCardAndUserIdViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <Cards> <PersonCardViewModel> <CardACSystemId>6cd718ac-f5bf-4f11-ab9b-24c125db7664</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2025-07-08T05:18:48.3693044+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-07-08T05:18:48.3693044+00:00</CardDeactivationStartDateTime> <CardId>517a13c6-87e7-4087-b366-6439d82e62a9</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-07-08T05:18:48.3693044+00:00</DateInserted> <DateUpdated>2025-07-08T05:18:48.3693044+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>54888a51-1516-44e5-b2bd-222da0fe53c8</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>54888a51-1516-44e5-b2bd-222da0fe53c8</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2025-07-08T05:18:48.3693044+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>c7fa9926-05fc-4292-ae9b-536ee9160a1d</PersonCardId> </PersonCardViewModel> <PersonCardViewModel> <CardACSystemId>6cd718ac-f5bf-4f11-ab9b-24c125db7664</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2025-07-08T05:18:48.3693044+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-07-08T05:18:48.3693044+00:00</CardDeactivationStartDateTime> <CardId>517a13c6-87e7-4087-b366-6439d82e62a9</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-07-08T05:18:48.3693044+00:00</DateInserted> <DateUpdated>2025-07-08T05:18:48.3693044+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>54888a51-1516-44e5-b2bd-222da0fe53c8</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>54888a51-1516-44e5-b2bd-222da0fe53c8</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2025-07-08T05:18:48.3693044+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>c7fa9926-05fc-4292-ae9b-536ee9160a1d</PersonCardId> </PersonCardViewModel> </Cards> <UserId>3a88f5c4-b296-4061-a336-a53841b2c532</UserId> </PersonCardAndUserIdViewModel>