This Example Project demonstrates how to consume this API endpoint within a C# project.
URI: https://api.onlinephotosubmission.com/api/people/{ id | email | identifier }
Example URI: https://api.onlinephotosubmission.com/api/people/123
Example URI: https://api.onlinephotosubmission.com/api/people/jon.doe@foo.edu?findBy=email
Example URI: https://api.onlinephotosubmission.com/api/people/A1234567?findBy=identifier
Optional URL Parameters: findBy=[id|email|identifier] (default id)
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)
Example HTTP Request Body
(LEAVE REQUEST BODY EMPTY)
Example Response
200 OK
{
"accountExpired": false,
"accountLocked": false,
"activatedDate": null,
"additionalPhotoRequired": false,
"additionalPhotos": {},
"authorities": [
{
"class": "com.campuscardtools.myphotoid.Role",
"id": 3,
"authority": "ROLE_CARDHOLDER"
}
],
"canSwitchOrganizations": false,
"canViewOrganizationList": false,
"currentPhoto": null,
"customFields": {
"Notes": {
"class": "com.campuscardtools.myphotoid.CustomFieldValue",
"id": 413609,
"customField": {
"class": "com.campuscardtools.myphotoid.CustomField",
"id": 100067
},
"lastUpdated": "2019-12-04T17:47:09Z",
"person": {
"class": "com.campuscardtools.myphotoid.Person",
"id": 236680
},
"value": "Bacon"
}
},
"dateTermsAccepted": null,
"domainClass": "com.campuscardtools.myphotoid.Person",
"email": "john.arnold+rrtest@gmail.com",
"emailGroup": {
"id": 23,
"name": "Default",
"receivableEmails": "welcome,login,approval,denial,BAD,GOOD,MAYBE"
},
"enabled": true,
"homeOrganization": {
"id": 92,
"hasDescendents": false,
"descendents": []
},
"id": 236680,
"identifier": "K0006",
"links": null,
"organization": {
"id": 92,
"domainClass": "com.campuscardtools.myphotoid.Organization",
"name": "Test Org.",
"isPaid": true,
"termsOfService": null,
"photoRequirements": [
{
"id": 440,
"uniqueName": "Face Camera",
"requirement": "Must be positioned directly facing the camera",
"listIndex": 4,
"hidden": false
},
{
"id": 442,
"uniqueName": "HelperBot",
"requirement": "Do not delete",
"listIndex": 6,
"hidden": true
},
{
"id": 441,
"uniqueName": "Look At Camera",
"requirement": "Eyes should be open and looking at the camera",
"listIndex": 5,
"hidden": false
},
{
"id": 438,
"uniqueName": "Color Photo",
"requirement": "Must be a color photo",
"listIndex": 2,
"hidden": false
},
{
"id": 436,
"uniqueName": "Crop",
"requirement": "Should be cropped slightly above head to middle of chest",
"listIndex": 0,
"hidden": false
},
{
"id": 439,
"uniqueName": "No Accessories",
"requirement": "Must not include sunglasses or hat",
"listIndex": 3,
"hidden": false
},
{
"id": 437,
"uniqueName": "Plain Background",
"requirement": "Should be taken against a plain, light background",
"listIndex": 1,
"hidden": false
}
],
"customFields": [
{
"name": "Notes"
}
],
"customCssUrl": "https://sharptopco.github.io/cloudcard-custom-assets/blankcssfile.css",
"logoutUrl": null,
"useEmailAsUsername": true,
"usePersonIdentifier": true,
"personIdentifierLabel": "ID Number",
"downloadStrategy": {
"id": "EXTERNAL",
"name": "External Application"
},
"downloadLabel": "Download Photos",
"photoDimensions": {
"class": "com.campuscardtools.myphotoid.PhotoDimensions",
"id": 3,
"description": "200:200 (1:1)",
"height": 200,
"width": 200
},
"preventMultiplePhotos": false,
"approvalsPerDay": 0,
"approvalsMadeToday": 0,
"canApproveMorePhotosToday": true,
"emailReplyTo": "Hello From CloudCard <hello@cloudcardtools.com>",
"helperBotDelay": 1000,
"additionalPhotoTypes": []
},
"passwordExpired": false,
"passwordResetRequired": false,
"readOnly": false,
"unsubscribe": false,
"username": "john.arnold+rrtest@gmail.com"
}