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": "2015-04-11T17:26:28Z",
"additionalPhotoRequired": true,
"additionalPhotos": {
"Government Issued ID": null
},
"authorities": [
{
"class": "com.campuscardtools.myphotoid.Role",
"id": 4,
"authority": "ROLE_DIRECTOR"
},
{
"class": "com.campuscardtools.myphotoid.Role",
"id": 2,
"authority": "ROLE_OFFICE"
},
{
"class": "com.campuscardtools.myphotoid.Role",
"id": 3,
"authority": "ROLE_CARDHOLDER"
}
],
"currentPhoto": {
"aspectRatio": 0.75,
"classifications": [
{
"id": 145302,
"score": 0.9963,
"requirementName": "Helper Bot"
}
],
"domainClass": "com.campuscardtools.myphotoid.Photo",
"helperBotReviewed": true,
"id": 244004,
"isAspectRatioCorrect": false,
"links": {
"bytes": "https://s3.amazonaws.com/photos.onlinephotosubmission.com/9kfpihiemv536j6m0s2eo6valakij2k57q6vnncjsg55frgs5uv68av1pjg4qgv1.jpg"
},
"lowestClassification": 0.9963,
"originalPhoto": {
"id": 243992,
"publicKey": "u09bu565dbg8ntjn8gn39nuh9qdtthvo7dlii78gh69ud9q4lr9npjd43smvf2vo",
"links": {
"bytes": "https://s3.amazonaws.com/photos.onlinephotosubmission.com/u09bu565dbg8ntjn8gn39nuh9qdtthvo7dlii78gh69ud9q4lr9npjd43smvf2vo.jpg"
}
},
"person": {
"id": 90,
"username": "director@sharptop.co",
"email": "director@sharptop.co",
"identifier": "d256436",
"organization": {
"id": 92,
"name": "Test Org.",
"photoRequirements": [...],
"identifier": null,
"badPhotoThreshold": 0.4,
"goodPhotoThreshold": 0.8
},
"additionalPhotos": [],
"additionalPhotoRequired": true,
"previouslyApprovedPhoto": {
"aspectRatio": 0,
"classifications": [],
"domainClass": "com.campuscardtools.myphotoid.Photo",
"helperBotReviewed": false,
"id": 136,
"isAspectRatioCorrect": false,
"links": {
"bytes": "https://s3.amazonaws.com/photos.onlinephotosubmission.com/419e7e8346c8c436a146ddd30c97898b59c66b9072aee592810ed1b53f372936.jpg"
},
"lowestClassification": null,
"originalPhoto": null,
"person": {
"id": 90,
"username": "director@sharptop.co",
"email": "director@sharptop.co",
"identifier": "d256436",
"organization": {
"id": 92,
"name": "Test Org.",
"photoRequirements": [...],
"identifier": null,
"badPhotoThreshold": 0.4,
"goodPhotoThreshold": 0.8
},
"additionalPhotos": [],
"additionalPhotoRequired": true
},
"personHasApprovedPhoto": true,
"publicKey": "419e7e8346c8c436a146ddd30c97898b59c66b9072aee592810ed1b53f372936",
"status": "DONE"
}
},
"personHasApprovedPhoto": true,
"publicKey": "9kfpihiemv536j6m0s2eo6valakij2k57q6vnncjsg55frgs5uv68av1pjg4qgv1",
"status": "PENDING"
},
"customFields": {
"First Name": null,
"Last Name": null
},
"dateTermsAccepted": "2015-05-24T06:44:54Z",
"domainClass": "com.campuscardtools.myphotoid.Person",
"email": "director@sharptop.co",
"emailsReceived": [
{
"address": "director@sharptop.co",
"formattedTimestamp": "10-19-2017 11:23 AM EDT",
"subject": "Your Photo Was Approved",
"timestamp": "2017-10-19 11:23:17.0"
},
{
"address": "director@sharptop.co",
"formattedTimestamp": "10-20-2017 02:29 PM EDT",
"subject": "Instant Photo Feedback",
"timestamp": "2017-10-20 14:29:29.0"
},
{
"address": "director@sharptop.co",
"formattedTimestamp": "Jan 19 12:47 PM EST",
"subject": "Your Photo Was Approved",
"timestamp": "2018-01-19 12:47:53.0"
},
{
"address": "director@sharptop.co",
"formattedTimestamp": "Jun 20 12:34 AM EDT",
"subject": "Instant Photo Feedback",
"timestamp": "2018-06-20 00:34:42.0"
},
{
"address": "director@sharptop.co",
"formattedTimestamp": "Sep 26 10:07 AM EDT",
"subject": "Instant Photo Feedback",
"timestamp": "2018-09-26 10:07:24.0"
}
],
"enabled": true,
"homeOrganization": {
"id": 8,
"hasDescendents": true,
"descendents": [
{
"id": 92
},
{
"id": 100064
},
{
"id": 46
},
{
"id": 100079
},
{
"id": 100047
},
{
"id": 100096
},
{
"id": 87
},
{
"id": 91
}
]
},
"id": 90,
"identifier": "d256436",
"links": null,
"organization": {
"id": 92,
"domainClass": "com.campuscardtools.myphotoid.Organization",
"name": "Test Org.",
"isPaid": true,
"termsOfService": null,
"photoRequirements": [...],
"customFields": [
{
"name": "First Name"
},
{
"name": "Last Name"
}
],
"customCssUrl": "https://sharptopco.github.io/cloudcard-custom-assets/blankcssfile.css",
"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",
"height": 200,
"width": 200
},
"preventMultiplePhotos": false,
"approvalsPerDay": 0,
"approvalsMadeToday": 0,
"canApproveMorePhotosToday": true,
"emailReplyTo": "Hello From CloudCard <hello@cloudcardtools.com>",
"helperBotDelay": 1000,
"additionalPhotoTypes": [
{
"errors": {
"errors": []
},
"name": "Government Issued ID",
"notBound": false,
"prompt": "Please submit a photo of your government issued ID.",
"required": false
}
]
},
"passwordExpired": false,
"passwordResetRequired": false,
"readOnly": false,
"username": "director@sharptop.co"
}