Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

This Example Project demonstrates how to consume this API endpoint within a C# project.


URI: https://app.cloudcardtools.com/api/people/{ id | email | identifier }

...

Example URI: https://app.cloudcardtools.com/api/people/123123 
Example URI: https://app.cloudcardtools.com/api/people/jon.doe@foo.edu?findBy=email
Example URI: https://app.cloudcardtools.com/api/people/A1234567
 

...

?findBy=indentifier


Info

If the findBy parameter is not specified, this endpoints searches for a person with a matching cardholder by id  (aka database id), email, and then by identifier (aka student ID) in that order; and it returns the first matching cardholder.Be aware that, if you search by an identifier value that contains digits only, there is the possibility that there will be a cardholder in your organization with the same database id, in which case the cardholder with the matching database ID will be returned rather than the cardholder with the matching identifierID).


Note

DEPRECATION NOTICE: Finding a person by email address or identifier (aka Student ID/Employee ID) without specifying the findBy parameter is still supported but has been deprecated, and will no longer be supported on or after April 1, 2019.

HTTP Method: GET

Required Headers: X-Auth-Token (see: Authentication)

...