GET api/v1/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
PersonCardAndUserIdViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | globally unique identifier |
None. |
|
| Cards | Collection of PersonCardViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"UserId": "8f3e6f93-a856-42e5-a3ef-39a5b7b67a88",
"Cards": [
{
"PersonCardId": "036f4f21-3657-4651-9c71-34a19d021b19",
"CardName": "sample string 2",
"CardId": "fefc9a06-7826-4802-96fb-583a9cb15f9a",
"CardType": 4,
"CardACSystemId": "ffbd9a7f-d0ab-4ca3-a291-534ada855871",
"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": "2026-09-05T20:18:13.8829039+00:00",
"DateInserted": "2026-09-05T20:18:13.8829039+00:00",
"DateUpdated": "2026-09-05T20:18:13.8829039+00:00",
"CardActivationStartDateTime": "2026-09-05T20:18:13.8829039+00:00",
"CardDeactivationStartDateTime": "2026-09-05T20:18:13.8829039+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "3e834081-dfdf-4c87-892e-be4ab20a8df9",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "3e834081-dfdf-4c87-892e-be4ab20a8df9",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
}
],
"CredentialType": 1
},
{
"PersonCardId": "036f4f21-3657-4651-9c71-34a19d021b19",
"CardName": "sample string 2",
"CardId": "fefc9a06-7826-4802-96fb-583a9cb15f9a",
"CardType": 4,
"CardACSystemId": "ffbd9a7f-d0ab-4ca3-a291-534ada855871",
"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": "2026-09-05T20:18:13.8829039+00:00",
"DateInserted": "2026-09-05T20:18:13.8829039+00:00",
"DateUpdated": "2026-09-05T20:18:13.8829039+00:00",
"CardActivationStartDateTime": "2026-09-05T20:18:13.8829039+00:00",
"CardDeactivationStartDateTime": "2026-09-05T20:18:13.8829039+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "3e834081-dfdf-4c87-892e-be4ab20a8df9",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "3e834081-dfdf-4c87-892e-be4ab20a8df9",
"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>ffbd9a7f-d0ab-4ca3-a291-534ada855871</CardACSystemId>
<CardACSystemName>sample string 6</CardACSystemName>
<CardActivationStartDateTime>2026-09-05T20:18:13.8829039+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2026-09-05T20:18:13.8829039+00:00</CardDeactivationStartDateTime>
<CardId>fefc9a06-7826-4802-96fb-583a9cb15f9a</CardId>
<CardName>sample string 2</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>4</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2026-09-05T20:18:13.8829039+00:00</DateInserted>
<DateUpdated>2026-09-05T20:18:13.8829039+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>3e834081-dfdf-4c87-892e-be4ab20a8df9</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>3e834081-dfdf-4c87-892e-be4ab20a8df9</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 8</ExternalCardNumber>
<FacilityCode>9</FacilityCode>
<HidInvitationCode>sample string 13</HidInvitationCode>
<InternalCardNumber>7</InternalCardNumber>
<InvitationRedeemedDateTime>2026-09-05T20:18:13.8829039+00:00</InvitationRedeemedDateTime>
<IssueCode>10</IssueCode>
<PIN>sample string 11</PIN>
<PersonCardId>036f4f21-3657-4651-9c71-34a19d021b19</PersonCardId>
</PersonCardViewModel>
<PersonCardViewModel>
<CardACSystemId>ffbd9a7f-d0ab-4ca3-a291-534ada855871</CardACSystemId>
<CardACSystemName>sample string 6</CardACSystemName>
<CardActivationStartDateTime>2026-09-05T20:18:13.8829039+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2026-09-05T20:18:13.8829039+00:00</CardDeactivationStartDateTime>
<CardId>fefc9a06-7826-4802-96fb-583a9cb15f9a</CardId>
<CardName>sample string 2</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>4</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2026-09-05T20:18:13.8829039+00:00</DateInserted>
<DateUpdated>2026-09-05T20:18:13.8829039+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>3e834081-dfdf-4c87-892e-be4ab20a8df9</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>3e834081-dfdf-4c87-892e-be4ab20a8df9</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 8</ExternalCardNumber>
<FacilityCode>9</FacilityCode>
<HidInvitationCode>sample string 13</HidInvitationCode>
<InternalCardNumber>7</InternalCardNumber>
<InvitationRedeemedDateTime>2026-09-05T20:18:13.8829039+00:00</InvitationRedeemedDateTime>
<IssueCode>10</IssueCode>
<PIN>sample string 11</PIN>
<PersonCardId>036f4f21-3657-4651-9c71-34a19d021b19</PersonCardId>
</PersonCardViewModel>
</Cards>
<UserId>8f3e6f93-a856-42e5-a3ef-39a5b7b67a88</UserId>
</PersonCardAndUserIdViewModel>