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": "7fa5e28a-8ce3-451d-8a2e-24660589a233", "Cards": [ { "NumberOfCardUses": 1, "PublicNotes": "sample string 1", "PersonCardId": "34b81378-fb6f-4019-bce0-16bb49aae76b", "CardName": "sample string 3", "CardId": "f246c175-a074-40a7-ab90-714cf2fd3a26", "CardType": 5, "CardACSystemId": "36fdc166-162f-4a7d-999e-55c33637a70b", "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": "2024-05-05T10:16:20.8730144+00:00", "DateInserted": "2024-05-05T10:16:20.8730144+00:00", "DateUpdated": "2024-05-05T10:16:20.8730144+00:00", "CardActivationStartDateTime": "2024-05-05T10:16:20.8730144+00:00", "CardDeactivationStartDateTime": "2024-05-05T10:16:20.8730144+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "3673449e-878c-45d1-91e2-04f94d063c18", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "3673449e-878c-45d1-91e2-04f94d063c18", "KeyIndex": 2, "EncryptedCredential": "sample string 3" } ], "CredentialType": 1 }, { "NumberOfCardUses": 1, "PublicNotes": "sample string 1", "PersonCardId": "34b81378-fb6f-4019-bce0-16bb49aae76b", "CardName": "sample string 3", "CardId": "f246c175-a074-40a7-ab90-714cf2fd3a26", "CardType": 5, "CardACSystemId": "36fdc166-162f-4a7d-999e-55c33637a70b", "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": "2024-05-05T10:16:20.8730144+00:00", "DateInserted": "2024-05-05T10:16:20.8730144+00:00", "DateUpdated": "2024-05-05T10:16:20.8730144+00:00", "CardActivationStartDateTime": "2024-05-05T10:16:20.8730144+00:00", "CardDeactivationStartDateTime": "2024-05-05T10:16:20.8730144+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "3673449e-878c-45d1-91e2-04f94d063c18", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "3673449e-878c-45d1-91e2-04f94d063c18", "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>36fdc166-162f-4a7d-999e-55c33637a70b</CardACSystemId> <CardACSystemName>sample string 7</CardACSystemName> <CardActivationStartDateTime>2024-05-05T10:16:20.8730144+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2024-05-05T10:16:20.8730144+00:00</CardDeactivationStartDateTime> <CardId>f246c175-a074-40a7-ab90-714cf2fd3a26</CardId> <CardName>sample string 3</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>5</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2024-05-05T10:16:20.8730144+00:00</DateInserted> <DateUpdated>2024-05-05T10:16:20.8730144+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>3673449e-878c-45d1-91e2-04f94d063c18</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>3673449e-878c-45d1-91e2-04f94d063c18</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 9</ExternalCardNumber> <FacilityCode>10</FacilityCode> <HidInvitationCode>sample string 14</HidInvitationCode> <InternalCardNumber>8</InternalCardNumber> <InvitationRedeemedDateTime>2024-05-05T10:16:20.8730144+00:00</InvitationRedeemedDateTime> <IssueCode>11</IssueCode> <PIN>sample string 12</PIN> <PersonCardId>34b81378-fb6f-4019-bce0-16bb49aae76b</PersonCardId> <NumberOfCardUses>1</NumberOfCardUses> <PublicNotes>sample string 1</PublicNotes> </PersonCardViewModelV2> <PersonCardViewModelV2> <CardACSystemId>36fdc166-162f-4a7d-999e-55c33637a70b</CardACSystemId> <CardACSystemName>sample string 7</CardACSystemName> <CardActivationStartDateTime>2024-05-05T10:16:20.8730144+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2024-05-05T10:16:20.8730144+00:00</CardDeactivationStartDateTime> <CardId>f246c175-a074-40a7-ab90-714cf2fd3a26</CardId> <CardName>sample string 3</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>5</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2024-05-05T10:16:20.8730144+00:00</DateInserted> <DateUpdated>2024-05-05T10:16:20.8730144+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>3673449e-878c-45d1-91e2-04f94d063c18</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>3673449e-878c-45d1-91e2-04f94d063c18</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 9</ExternalCardNumber> <FacilityCode>10</FacilityCode> <HidInvitationCode>sample string 14</HidInvitationCode> <InternalCardNumber>8</InternalCardNumber> <InvitationRedeemedDateTime>2024-05-05T10:16:20.8730144+00:00</InvitationRedeemedDateTime> <IssueCode>11</IssueCode> <PIN>sample string 12</PIN> <PersonCardId>34b81378-fb6f-4019-bce0-16bb49aae76b</PersonCardId> <NumberOfCardUses>1</NumberOfCardUses> <PublicNotes>sample string 1</PublicNotes> </PersonCardViewModelV2> </Cards> <UserId>7fa5e28a-8ce3-451d-8a2e-24660589a233</UserId> </PersonCardAndUserIdViewModelV2>