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": "332df2b8-0ffa-4e4b-9093-3d01eb06d3a1",
"Cards": [
{
"NumberOfCardUses": 1,
"PublicNotes": "sample string 1",
"PersonCardId": "6da77db6-e8f4-4531-9a96-e1a80fd93b37",
"CardName": "sample string 3",
"CardId": "9da9169e-288b-4d35-a82e-b9d94fa29e9f",
"CardType": 5,
"CardACSystemId": "2086e869-b943-44c1-b014-18276d20b920",
"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": "2026-07-18T13:43:44.4422198+00:00",
"DateInserted": "2026-07-18T13:43:44.4422198+00:00",
"DateUpdated": "2026-07-18T13:43:44.4422198+00:00",
"CardActivationStartDateTime": "2026-07-18T13:43:44.4422198+00:00",
"CardDeactivationStartDateTime": "2026-07-18T13:43:44.4422198+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "9c65e2a0-00b1-412b-998a-0af09fdde504",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "9c65e2a0-00b1-412b-998a-0af09fdde504",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
}
],
"CredentialType": 1
},
{
"NumberOfCardUses": 1,
"PublicNotes": "sample string 1",
"PersonCardId": "6da77db6-e8f4-4531-9a96-e1a80fd93b37",
"CardName": "sample string 3",
"CardId": "9da9169e-288b-4d35-a82e-b9d94fa29e9f",
"CardType": 5,
"CardACSystemId": "2086e869-b943-44c1-b014-18276d20b920",
"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": "2026-07-18T13:43:44.4422198+00:00",
"DateInserted": "2026-07-18T13:43:44.4422198+00:00",
"DateUpdated": "2026-07-18T13:43:44.4422198+00:00",
"CardActivationStartDateTime": "2026-07-18T13:43:44.4422198+00:00",
"CardDeactivationStartDateTime": "2026-07-18T13:43:44.4422198+00:00",
"CardUserFlags": 1,
"EncryptedMobileCredentials": [
{
"MobileKeySetId": "9c65e2a0-00b1-412b-998a-0af09fdde504",
"KeyIndex": 2,
"EncryptedCredential": "sample string 3"
},
{
"MobileKeySetId": "9c65e2a0-00b1-412b-998a-0af09fdde504",
"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>2086e869-b943-44c1-b014-18276d20b920</CardACSystemId>
<CardACSystemName>sample string 7</CardACSystemName>
<CardActivationStartDateTime>2026-07-18T13:43:44.4422198+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2026-07-18T13:43:44.4422198+00:00</CardDeactivationStartDateTime>
<CardId>9da9169e-288b-4d35-a82e-b9d94fa29e9f</CardId>
<CardName>sample string 3</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>5</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2026-07-18T13:43:44.4422198+00:00</DateInserted>
<DateUpdated>2026-07-18T13:43:44.4422198+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>9c65e2a0-00b1-412b-998a-0af09fdde504</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>9c65e2a0-00b1-412b-998a-0af09fdde504</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 9</ExternalCardNumber>
<FacilityCode>10</FacilityCode>
<HidInvitationCode>sample string 14</HidInvitationCode>
<InternalCardNumber>8</InternalCardNumber>
<InvitationRedeemedDateTime>2026-07-18T13:43:44.4422198+00:00</InvitationRedeemedDateTime>
<IssueCode>11</IssueCode>
<PIN>sample string 12</PIN>
<PersonCardId>6da77db6-e8f4-4531-9a96-e1a80fd93b37</PersonCardId>
<NumberOfCardUses>1</NumberOfCardUses>
<PublicNotes>sample string 1</PublicNotes>
</PersonCardViewModelV2>
<PersonCardViewModelV2>
<CardACSystemId>2086e869-b943-44c1-b014-18276d20b920</CardACSystemId>
<CardACSystemName>sample string 7</CardACSystemName>
<CardActivationStartDateTime>2026-07-18T13:43:44.4422198+00:00</CardActivationStartDateTime>
<CardDeactivationStartDateTime>2026-07-18T13:43:44.4422198+00:00</CardDeactivationStartDateTime>
<CardId>9da9169e-288b-4d35-a82e-b9d94fa29e9f</CardId>
<CardName>sample string 3</CardName>
<CardSerialNumber>1</CardSerialNumber>
<CardType>5</CardType>
<CardUserFlags>ActiveCardholderRecord</CardUserFlags>
<CredentialType>Proximity</CredentialType>
<DateInserted>2026-07-18T13:43:44.4422198+00:00</DateInserted>
<DateUpdated>2026-07-18T13:43:44.4422198+00:00</DateUpdated>
<EncryptedMobileCredentials>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>9c65e2a0-00b1-412b-998a-0af09fdde504</MobileKeySetId>
</EncryptedCredentialData>
<EncryptedCredentialData>
<EncryptedCredential>sample string 3</EncryptedCredential>
<KeyIndex>2</KeyIndex>
<MobileKeySetId>9c65e2a0-00b1-412b-998a-0af09fdde504</MobileKeySetId>
</EncryptedCredentialData>
</EncryptedMobileCredentials>
<ExternalCardNumber>sample string 9</ExternalCardNumber>
<FacilityCode>10</FacilityCode>
<HidInvitationCode>sample string 14</HidInvitationCode>
<InternalCardNumber>8</InternalCardNumber>
<InvitationRedeemedDateTime>2026-07-18T13:43:44.4422198+00:00</InvitationRedeemedDateTime>
<IssueCode>11</IssueCode>
<PIN>sample string 12</PIN>
<PersonCardId>6da77db6-e8f4-4531-9a96-e1a80fd93b37</PersonCardId>
<NumberOfCardUses>1</NumberOfCardUses>
<PublicNotes>sample string 1</PublicNotes>
</PersonCardViewModelV2>
</Cards>
<UserId>332df2b8-0ffa-4e4b-9093-3d01eb06d3a1</UserId>
</PersonCardAndUserIdViewModelV2>