GET api/v2/Users/GetLoggedInUsersCards?IncludeDeleted={IncludeDeleted}&FacilityCode={FacilityCode}
Returns list of cards for the user who is logged In
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeDeleted | boolean |
Default value is False |
|
| FacilityCode | integer |
Default value is -1 |
Body Parameters
None.
Response Information
Resource Description
PersonCardAndUserIdViewModelV2| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | globally unique identifier |
None. |
|
| Cards | Collection of PersonCardViewModelV2 |
None. |
Response Formats
application/json, text/json
Sample:
{
"UserId": "c0e455aa-48f8-4e7b-979f-c33d49f38cac",
"Cards": [
{
"NumberOfCardUses": 1,
"PublicNotes": "sample string 1",
"PersonCardId": "f8c69f7c-6ce6-4478-b65f-86ab5a125243",
"CardName": "sample string 3",
"CardId": "e770f5a7-8b97-404e-a550-3007fffe7990",
"CardType": 5,
"CardACSystemId": "563e41b7-bb67-48d3-a297-4202fa5da0d0",
"CardACSystemName": "sample string 7",
"InternalCardNumber": 8,
"ExternalCardNumber": "sample string 9",
"CardSerialNumber": 1,
"FacilityCode": 10,
"IssueCode": 11,
"PIN": "sample string 12",
"Deleted": true,
"HidInvitationCode": "sample string 14",
"InvitationRedeemedDateTime": "2025-12-01T12:13:22.3888702+00:00",
"DateInserted": "2025-12-01T12:13:22.3888702+00:00",
"DateUpdated": "2025-12-01T12:13:22.3888702+00:00",
"CardActivationStartDateTime": "2025-12-01T12:13:22.3888702+00:00",
"CardDeactivationStartDateTime": "2025-12-01T12:13:22.3888702+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "191596a6-4e32-45c7-86d8-2dee3023b54e",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "191596a6-4e32-45c7-86d8-2dee3023b54e",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
}
],
"CredentialType": 1
},
{
"NumberOfCardUses": 1,
"PublicNotes": "sample string 1",
"PersonCardId": "f8c69f7c-6ce6-4478-b65f-86ab5a125243",
"CardName": "sample string 3",
"CardId": "e770f5a7-8b97-404e-a550-3007fffe7990",
"CardType": 5,
"CardACSystemId": "563e41b7-bb67-48d3-a297-4202fa5da0d0",
"CardACSystemName": "sample string 7",
"InternalCardNumber": 8,
"ExternalCardNumber": "sample string 9",
"CardSerialNumber": 1,
"FacilityCode": 10,
"IssueCode": 11,
"PIN": "sample string 12",
"Deleted": true,
"HidInvitationCode": "sample string 14",
"InvitationRedeemedDateTime": "2025-12-01T12:13:22.3888702+00:00",
"DateInserted": "2025-12-01T12:13:22.3888702+00:00",
"DateUpdated": "2025-12-01T12:13:22.3888702+00:00",
"CardActivationStartDateTime": "2025-12-01T12:13:22.3888702+00:00",
"CardDeactivationStartDateTime": "2025-12-01T12:13:22.3888702+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "191596a6-4e32-45c7-86d8-2dee3023b54e",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "191596a6-4e32-45c7-86d8-2dee3023b54e",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
}
],
"CredentialType": 1
}
]
}
application/xml, text/xml
Sample:
<PersonCardAndUserIdViewModelV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
<Cards>
<PersonCardViewModelV2>
<CardACSystemId>563e41b7-bb67-48d3-a297-4202fa5da0d0</CardACSystemId>
<CardACSystemName>sample string 7</CardACSystemName>
<CardActivationStartDateTime>2025-12-01T12:13:22.3888702+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2025-12-01T12:13:22.3888702+00:00</CardDeactivationStartDateTime>
<CardId>e770f5a7-8b97-404e-a550-3007fffe7990</CardId>
<CardName>sample string 3</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>5</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2025-12-01T12:13:22.3888702+00:00</DateInserted>
<DateUpdated>2025-12-01T12:13:22.3888702+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>191596a6-4e32-45c7-86d8-2dee3023b54e</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>191596a6-4e32-45c7-86d8-2dee3023b54e</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 9</ExternalCardNumber>
<FacilityCode>10</FacilityCode>
<HidInvitationCode>sample string 14</HidInvitationCode>
<InternalCardNumber>8</InternalCardNumber>
<InvitationRedeemedDateTime>2025-12-01T12:13:22.3888702+00:00</InvitationRedeemedDateTime>
<IssueCode>11</IssueCode>
<PIN>sample string 12</PIN>
<PersonCardId>f8c69f7c-6ce6-4478-b65f-86ab5a125243</PersonCardId>
<NumberOfCardUses>1</NumberOfCardUses>
<PublicNotes>sample string 1</PublicNotes>
</PersonCardViewModelV2>
<PersonCardViewModelV2>
<CardACSystemId>563e41b7-bb67-48d3-a297-4202fa5da0d0</CardACSystemId>
<CardACSystemName>sample string 7</CardACSystemName>
<CardActivationStartDateTime>2025-12-01T12:13:22.3888702+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2025-12-01T12:13:22.3888702+00:00</CardDeactivationStartDateTime>
<CardId>e770f5a7-8b97-404e-a550-3007fffe7990</CardId>
<CardName>sample string 3</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>5</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2025-12-01T12:13:22.3888702+00:00</DateInserted>
<DateUpdated>2025-12-01T12:13:22.3888702+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>191596a6-4e32-45c7-86d8-2dee3023b54e</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>191596a6-4e32-45c7-86d8-2dee3023b54e</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 9</ExternalCardNumber>
<FacilityCode>10</FacilityCode>
<HidInvitationCode>sample string 14</HidInvitationCode>
<InternalCardNumber>8</InternalCardNumber>
<InvitationRedeemedDateTime>2025-12-01T12:13:22.3888702+00:00</InvitationRedeemedDateTime>
<IssueCode>11</IssueCode>
<PIN>sample string 12</PIN>
<PersonCardId>f8c69f7c-6ce6-4478-b65f-86ab5a125243</PersonCardId>
<NumberOfCardUses>1</NumberOfCardUses>
<PublicNotes>sample string 1</PublicNotes>
</PersonCardViewModelV2>
</Cards>
<UserId>c0e455aa-48f8-4e7b-979f-c33d49f38cac</UserId>
</PersonCardAndUserIdViewModelV2>