GET api/v2/Users/UserCards?EmailAddress={EmailAddress}&IncludeDeleted={IncludeDeleted}&FacilityCode={FacilityCode}
Returns list of cards for a given user by the User Email Address
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
EmailAddress | string |
Required |
|
IncludeDeleted | boolean |
Default value is False |
|
FacilityCode | integer |
Default value is -1 |
Body Parameters
None.
Response Information
Resource Description
PersonCardAndUserIdViewModelV2Name | Description | Type | Additional information |
---|---|---|---|
UserId | globally unique identifier |
None. |
|
Cards | Collection of PersonCardViewModelV2 |
None. |
Response Formats
application/json, text/json
Sample:
{ "UserId": "4d3d5e4f-7a43-4c8a-80db-7de9780c9626", "Cards": [ { "NumberOfCardUses": 1, "PublicNotes": "sample string 1", "PersonCardId": "7884400a-919d-46a7-a2db-82d4e355f4ab", "CardName": "sample string 3", "CardId": "259e7306-1e7b-43f9-84f3-1380b75a278b", "CardType": 5, "CardACSystemId": "48f71041-0d75-4e8e-b3b2-95143e1c9831", "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-06-29T09:40:20.2346792+00:00", "DateInserted": "2025-06-29T09:40:20.2346792+00:00", "DateUpdated": "2025-06-29T09:40:20.2346792+00:00", "CardActivationStartDateTime": "2025-06-29T09:40:20.2346792+00:00", "CardDeactivationStartDateTime": "2025-06-29T09:40:20.2346792+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "7b274e1b-8637-45e4-bfb7-0992466907e0", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "7b274e1b-8637-45e4-bfb7-0992466907e0", "KeyIndex": 2, "EncryptedCredential": "sample string 3" } ], "CredentialType": 1 }, { "NumberOfCardUses": 1, "PublicNotes": "sample string 1", "PersonCardId": "7884400a-919d-46a7-a2db-82d4e355f4ab", "CardName": "sample string 3", "CardId": "259e7306-1e7b-43f9-84f3-1380b75a278b", "CardType": 5, "CardACSystemId": "48f71041-0d75-4e8e-b3b2-95143e1c9831", "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-06-29T09:40:20.2346792+00:00", "DateInserted": "2025-06-29T09:40:20.2346792+00:00", "DateUpdated": "2025-06-29T09:40:20.2346792+00:00", "CardActivationStartDateTime": "2025-06-29T09:40:20.2346792+00:00", "CardDeactivationStartDateTime": "2025-06-29T09:40:20.2346792+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "7b274e1b-8637-45e4-bfb7-0992466907e0", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "7b274e1b-8637-45e4-bfb7-0992466907e0", "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>48f71041-0d75-4e8e-b3b2-95143e1c9831</CardACSystemId> <CardACSystemName>sample string 7</CardACSystemName> <CardActivationStartDateTime>2025-06-29T09:40:20.2346792+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-06-29T09:40:20.2346792+00:00</CardDeactivationStartDateTime> <CardId>259e7306-1e7b-43f9-84f3-1380b75a278b</CardId> <CardName>sample string 3</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>5</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-06-29T09:40:20.2346792+00:00</DateInserted> <DateUpdated>2025-06-29T09:40:20.2346792+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>7b274e1b-8637-45e4-bfb7-0992466907e0</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>7b274e1b-8637-45e4-bfb7-0992466907e0</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 9</ExternalCardNumber> <FacilityCode>10</FacilityCode> <HidInvitationCode>sample string 14</HidInvitationCode> <InternalCardNumber>8</InternalCardNumber> <InvitationRedeemedDateTime>2025-06-29T09:40:20.2346792+00:00</InvitationRedeemedDateTime> <IssueCode>11</IssueCode> <PIN>sample string 12</PIN> <PersonCardId>7884400a-919d-46a7-a2db-82d4e355f4ab</PersonCardId> <NumberOfCardUses>1</NumberOfCardUses> <PublicNotes>sample string 1</PublicNotes> </PersonCardViewModelV2> <PersonCardViewModelV2> <CardACSystemId>48f71041-0d75-4e8e-b3b2-95143e1c9831</CardACSystemId> <CardACSystemName>sample string 7</CardACSystemName> <CardActivationStartDateTime>2025-06-29T09:40:20.2346792+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2025-06-29T09:40:20.2346792+00:00</CardDeactivationStartDateTime> <CardId>259e7306-1e7b-43f9-84f3-1380b75a278b</CardId> <CardName>sample string 3</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>5</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2025-06-29T09:40:20.2346792+00:00</DateInserted> <DateUpdated>2025-06-29T09:40:20.2346792+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>7b274e1b-8637-45e4-bfb7-0992466907e0</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>7b274e1b-8637-45e4-bfb7-0992466907e0</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 9</ExternalCardNumber> <FacilityCode>10</FacilityCode> <HidInvitationCode>sample string 14</HidInvitationCode> <InternalCardNumber>8</InternalCardNumber> <InvitationRedeemedDateTime>2025-06-29T09:40:20.2346792+00:00</InvitationRedeemedDateTime> <IssueCode>11</IssueCode> <PIN>sample string 12</PIN> <PersonCardId>7884400a-919d-46a7-a2db-82d4e355f4ab</PersonCardId> <NumberOfCardUses>1</NumberOfCardUses> <PublicNotes>sample string 1</PublicNotes> </PersonCardViewModelV2> </Cards> <UserId>4d3d5e4f-7a43-4c8a-80db-7de9780c9626</UserId> </PersonCardAndUserIdViewModelV2>