GET api/v1/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
PersonCardAndUserIdViewModelName | Description | Type | Additional information |
---|---|---|---|
UserId | globally unique identifier |
None. |
|
Cards | Collection of PersonCardViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "UserId": "efe1cd2d-fd37-4090-bc09-439607447956", "Cards": [ { "PersonCardId": "7c958759-3392-45ed-bd15-142285a5d50a", "CardName": "sample string 2", "CardId": "74450991-9eef-4a1d-b32a-aa595b761ea8", "CardType": 4, "CardACSystemId": "1d929911-e15c-486f-9efd-9b55e212a03f", "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": "2024-04-27T02:06:39.1093621+00:00", "DateInserted": "2024-04-27T02:06:39.1093621+00:00", "DateUpdated": "2024-04-27T02:06:39.1093621+00:00", "CardActivationStartDateTime": "2024-04-27T02:06:39.1093621+00:00", "CardDeactivationStartDateTime": "2024-04-27T02:06:39.1093621+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "e604e2a3-c5d3-4180-9834-741d085b93d8", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "e604e2a3-c5d3-4180-9834-741d085b93d8", "KeyIndex": 2, "EncryptedCredential": "sample string 3" } ], "CredentialType": 1 }, { "PersonCardId": "7c958759-3392-45ed-bd15-142285a5d50a", "CardName": "sample string 2", "CardId": "74450991-9eef-4a1d-b32a-aa595b761ea8", "CardType": 4, "CardACSystemId": "1d929911-e15c-486f-9efd-9b55e212a03f", "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": "2024-04-27T02:06:39.1093621+00:00", "DateInserted": "2024-04-27T02:06:39.1093621+00:00", "DateUpdated": "2024-04-27T02:06:39.1093621+00:00", "CardActivationStartDateTime": "2024-04-27T02:06:39.1093621+00:00", "CardDeactivationStartDateTime": "2024-04-27T02:06:39.1093621+00:00", "CardUserFlags": 1, "EncryptedMobileCredentials": [ { "MobileKeySetId": "e604e2a3-c5d3-4180-9834-741d085b93d8", "KeyIndex": 2, "EncryptedCredential": "sample string 3" }, { "MobileKeySetId": "e604e2a3-c5d3-4180-9834-741d085b93d8", "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>1d929911-e15c-486f-9efd-9b55e212a03f</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2024-04-27T02:06:39.1093621+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2024-04-27T02:06:39.1093621+00:00</CardDeactivationStartDateTime> <CardId>74450991-9eef-4a1d-b32a-aa595b761ea8</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2024-04-27T02:06:39.1093621+00:00</DateInserted> <DateUpdated>2024-04-27T02:06:39.1093621+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>e604e2a3-c5d3-4180-9834-741d085b93d8</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>e604e2a3-c5d3-4180-9834-741d085b93d8</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2024-04-27T02:06:39.1093621+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>7c958759-3392-45ed-bd15-142285a5d50a</PersonCardId> </PersonCardViewModel> <PersonCardViewModel> <CardACSystemId>1d929911-e15c-486f-9efd-9b55e212a03f</CardACSystemId> <CardACSystemName>sample string 6</CardACSystemName> <CardActivationStartDateTime>2024-04-27T02:06:39.1093621+00:00</CardActivationStartDateTime> <CardDeactivationStartDateTime>2024-04-27T02:06:39.1093621+00:00</CardDeactivationStartDateTime> <CardId>74450991-9eef-4a1d-b32a-aa595b761ea8</CardId> <CardName>sample string 2</CardName> <CardSerialNumber>1</CardSerialNumber> <CardType>4</CardType> <CardUserFlags>ActiveCardholderRecord</CardUserFlags> <CredentialType>Proximity</CredentialType> <DateInserted>2024-04-27T02:06:39.1093621+00:00</DateInserted> <DateUpdated>2024-04-27T02:06:39.1093621+00:00</DateUpdated> <EncryptedMobileCredentials> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>e604e2a3-c5d3-4180-9834-741d085b93d8</MobileKeySetId> </EncryptedCredentialData> <EncryptedCredentialData> <EncryptedCredential>sample string 3</EncryptedCredential> <KeyIndex>2</KeyIndex> <MobileKeySetId>e604e2a3-c5d3-4180-9834-741d085b93d8</MobileKeySetId> </EncryptedCredentialData> </EncryptedMobileCredentials> <ExternalCardNumber>sample string 8</ExternalCardNumber> <FacilityCode>9</FacilityCode> <HidInvitationCode>sample string 13</HidInvitationCode> <InternalCardNumber>7</InternalCardNumber> <InvitationRedeemedDateTime>2024-04-27T02:06:39.1093621+00:00</InvitationRedeemedDateTime> <IssueCode>10</IssueCode> <PIN>sample string 11</PIN> <PersonCardId>7c958759-3392-45ed-bd15-142285a5d50a</PersonCardId> </PersonCardViewModel> </Cards> <UserId>efe1cd2d-fd37-4090-bc09-439607447956</UserId> </PersonCardAndUserIdViewModel>