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": "0add1284-6dbe-4c0b-9e89-48428345756d",
"Cards": [
{
"PersonCardId": "005424f9-622f-44ba-b79f-bf9b75d9b7a4",
"CardName": "sample string 2",
"CardId": "28b8b47c-470a-4ee2-a483-1ac75648d607",
"CardType": 4,
"CardACSystemId": "96160475-5ef9-4728-9802-fd07664f20fe",
"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-11-05T03:53:20.5102311+00:00",
"DateInserted": "2025-11-05T03:53:20.5102311+00:00",
"DateUpdated": "2025-11-05T03:53:20.5102311+00:00",
"CardActivationStartDateTime": "2025-11-05T03:53:20.5102311+00:00",
"CardDeactivationStartDateTime": "2025-11-05T03:53:20.5102311+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "9f53e3f5-77fd-4d52-af68-ce3d5a5fbd79",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "9f53e3f5-77fd-4d52-af68-ce3d5a5fbd79",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
}
],
"CredentialType": 1
},
{
"PersonCardId": "005424f9-622f-44ba-b79f-bf9b75d9b7a4",
"CardName": "sample string 2",
"CardId": "28b8b47c-470a-4ee2-a483-1ac75648d607",
"CardType": 4,
"CardACSystemId": "96160475-5ef9-4728-9802-fd07664f20fe",
"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-11-05T03:53:20.5102311+00:00",
"DateInserted": "2025-11-05T03:53:20.5102311+00:00",
"DateUpdated": "2025-11-05T03:53:20.5102311+00:00",
"CardActivationStartDateTime": "2025-11-05T03:53:20.5102311+00:00",
"CardDeactivationStartDateTime": "2025-11-05T03:53:20.5102311+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "9f53e3f5-77fd-4d52-af68-ce3d5a5fbd79",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "9f53e3f5-77fd-4d52-af68-ce3d5a5fbd79",
"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>96160475-5ef9-4728-9802-fd07664f20fe</CardACSystemId>
<CardACSystemName>sample string 6</CardACSystemName>
<CardActivationStartDateTime>2025-11-05T03:53:20.5102311+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2025-11-05T03:53:20.5102311+00:00</CardDeactivationStartDateTime>
<CardId>28b8b47c-470a-4ee2-a483-1ac75648d607</CardId>
<CardName>sample string 2</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>4</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2025-11-05T03:53:20.5102311+00:00</DateInserted>
<DateUpdated>2025-11-05T03:53:20.5102311+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>9f53e3f5-77fd-4d52-af68-ce3d5a5fbd79</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>9f53e3f5-77fd-4d52-af68-ce3d5a5fbd79</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 8</ExternalCardNumber>
<FacilityCode>9</FacilityCode>
<HidInvitationCode>sample string 13</HidInvitationCode>
<InternalCardNumber>7</InternalCardNumber>
<InvitationRedeemedDateTime>2025-11-05T03:53:20.5102311+00:00</InvitationRedeemedDateTime>
<IssueCode>10</IssueCode>
<PIN>sample string 11</PIN>
<PersonCardId>005424f9-622f-44ba-b79f-bf9b75d9b7a4</PersonCardId>
</PersonCardViewModel>
<PersonCardViewModel>
<CardACSystemId>96160475-5ef9-4728-9802-fd07664f20fe</CardACSystemId>
<CardACSystemName>sample string 6</CardACSystemName>
<CardActivationStartDateTime>2025-11-05T03:53:20.5102311+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2025-11-05T03:53:20.5102311+00:00</CardDeactivationStartDateTime>
<CardId>28b8b47c-470a-4ee2-a483-1ac75648d607</CardId>
<CardName>sample string 2</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>4</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2025-11-05T03:53:20.5102311+00:00</DateInserted>
<DateUpdated>2025-11-05T03:53:20.5102311+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>9f53e3f5-77fd-4d52-af68-ce3d5a5fbd79</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>9f53e3f5-77fd-4d52-af68-ce3d5a5fbd79</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 8</ExternalCardNumber>
<FacilityCode>9</FacilityCode>
<HidInvitationCode>sample string 13</HidInvitationCode>
<InternalCardNumber>7</InternalCardNumber>
<InvitationRedeemedDateTime>2025-11-05T03:53:20.5102311+00:00</InvitationRedeemedDateTime>
<IssueCode>10</IssueCode>
<PIN>sample string 11</PIN>
<PersonCardId>005424f9-622f-44ba-b79f-bf9b75d9b7a4</PersonCardId>
</PersonCardViewModel>
</Cards>
<UserId>0add1284-6dbe-4c0b-9e89-48428345756d</UserId>
</PersonCardAndUserIdViewModel>