...
...
...
...
| Info |
|---|
This This Example Project demonstrates demonstrates how to consume this API endpoint within a C# project. |
URI: https://
...
api.
...
cloudcard.
...
us/
...
person/
...
{id
...
}
...
Example URI: https://
...
api.
...
cloudcard.
...
us/
...
person/123
...
Example URI:
...
https://
...
api.
...
cloudcard.
...
us/
...
person/
...
jon.doe@foo.edu?findBy=email
...
Example URI: https://
...
api.
...
cloudcard.
...
us/
...
person/
...
A1234567?findBy=
...
identifier
Optional URL Parameters: findBy=[id|email|identifier] (default id)
| Note |
|---|
DEPRECATION NOTICE: Finding a person by email address or identifier (aka Student ID/Employee ID) without specifying the |
HTTP Method: GET
Required Headers: X-Auth-Token (see: Authentication)
...
| title | Example HTTP Request Body |
|---|
. Note, findBy must be used when querying email/identifier
HTTP Method: GET
Required Headers: X-Auth-Token (see: Authentication)
Example HTTP Request Body
| Code Block |
|---|
(LEAVE REQUEST BODY EMPTY) |
Example Response
| Code Block | ||
|---|---|---|
| ||
200 OK { "accountExpiredid": false577782, "accountLockeddateCreated": false, "2022-01-31T18:16:40Z", "passwordResetRequired": false, "activatedDateorganization": { "2015-04-11T17:26:28Z", "id": 100133, "isPaid": true, "downloadLabel": "Download Photos", "allowAutoCrop": false, "logoutUrl": "", "allowAutoRotate": false, "allowAutoDenial": false, "allowDeprecatedEndpoints": false, "maxNumberOfInvitations": 0, "photoDimensions": { "id": 6, "width": 300, "height": 300, "description": "300:300 (1:1)", "domainClass": "us.cloudcard.api.PhotoDimensions", "version": 0, "value": 1.0, "longSide": 300, "shortSide": 300 }, "name": "Postman Test", "badPhotoThreshold": 0.4, "helpScoutBeacons": [], "allowAutoBackgroundReplacement": false, "sendEmailFrom": "Online Photo Submission <sent.from.customer@onlinephotosubmission.com>", "identifier": null, "emailReplyTo": null, "additionalPhotoRequiredapprovalsPerDay": true10, "additionalPhotosexpirationDate": {null, "Government Issued IDbackgroundColor": null, }, "authoritiesparent": null, [ {"allowAutoApproval": false, "termsOfService": null, "classsiteURL": "com.campuscardtools.myphotoid.Role", "autoArchiveAction": null, "iddaysBetweenInvitations": 414, "authoritylastUpdated": "ROLE_DIRECTOR"2022-01-31T18:17:29Z", "backgroundImage": }null, { "sendAutomaticFeedback": false, "classusePersonIdentifier": "com.campuscardtools.myphotoid.Role"true, "idemailDomains": 2[], "authorityautoArchiveStatus": "ROLE_OFFICE" null, }"additionalPhotoTypes": [], "defaultGroup": { "classid": "com.campuscardtools.myphotoid.Role"108, "idorganization": 3,{ "authorityid": "ROLE_CARDHOLDER"100133 } ]}, "currentPhoto": { "aspectRatioreceivableEmails": 0.75,",empty", "classifications": [ "name": "Default", { "domainClass": "us.cloudcard.api.EmailGroup", "idversion": 0 145302, }, "scoregoodPhotoThreshold": 0.99638, "personIdentifierLabel": "ID Number", "requirementNamepreventMultiplePhotos": "Helperfalse, Bot" "customCssUrl": "", } ]"useEmailAsUsername": true, "domainClasshelperBotDelay": "com.campuscardtools.myphotoid.Photo"600000, "helperBotRevieweddownloadStrategy": true, { "id": 244004"ZIP", "isAspectRatioCorrect": false, "name": "Zip File" "links": { }, "bytesapprovalsMadeToday": "https://s3.amazonaws.com/photos.onlinephotosubmission.com/9kfpihiemv536j6m0s2eo6valakij2k57q6vnncjsg55frgs5uv68av1pjg4qgv1.jpg"0, }"backgroundReplacementEnabled": false, "lowestClassificationcanApproveMorePhotosToday": 0.9963true, "originalPhotocustomFields": {[], "photoRequirements": [ "id": 243992, { "publicKey": "u09bu565dbg8ntjn8gn39nuh9qdtthvo7dlii78gh69ud9q4lr9npjd43smvf2vo", "linksid": {100851, "byteslistIndex": "https://s3.amazonaws.com/photos.onlinephotosubmission.com/u09bu565dbg8ntjn8gn39nuh9qdtthvo7dlii78gh69ud9q4lr9npjd43smvf2vo.jpg"0, } "lastUpdated": "2019-04-26T20:30:09Z", }, "personorganization": { "id": 90, "id": 100133 "username": "director@sharptop.co", }, "email": "director@sharptop.co", "identifieruniqueName": "d256436Crop", "organizationclassifierUrl": {null, "idhidden": 92false, "namerequirement": "Test Org.Should be cropped slightly above head to middle of chest", "photoRequirementsversion": [...]0, "identifierdomainClass": null,"us.cloudcard.api.PhotoRequirement" "badPhotoThreshold": 0.4}, { "goodPhotoThreshold": 0.8 "id": }100852, "additionalPhotoslistIndex": [],1, "additionalPhotoRequiredlastUpdated": true,"2019-04-26T20:30:09Z", "previouslyApprovedPhotoorganization": { "aspectRatioid": 0,100133 "classifications": []}, "domainClassuniqueName": "com.campuscardtools.myphotoid.PhotoPlain Background", "helperBotReviewedclassifierUrl": falsenull, "idhidden": 136false, "isAspectRatioCorrectrequirement": false "Should be taken against a plain, light background", "linksversion": {0, "bytesdomainClass": "https://s3.amazonaws.com/photos.onlinephotosubmission.com/419e7e8346c8c436a146ddd30c97898b59c66b9072aee592810ed1b53f372936.jpgus.cloudcard.api.PhotoRequirement" }, }, { "lowestClassificationid": null100853, "originalPhotolistIndex": null2, "personlastUpdated": { "2019-04-26T20:30:09Z", "idorganization": 90,{ "usernameid": "director@sharptop.co",100133 }, "email": "director@sharptop.co", "uniqueName": "Color Photo", "identifier": "d256436", "classifierUrl": null, "organization": { "hidden": false, "idrequirement": 92,"Must be a color photo", "version": 0, "name": "Test Org.", "domainClass": "us.cloudcard.api.PhotoRequirement" "photoRequirements": [...], }, { "identifier": null, "id": 100854, "badPhotoThresholdlistIndex": 0.4, 3, "goodPhotoThresholdlastUpdated": 0.8"2019-04-26T20:30:09Z", "organization": { }, "additionalPhotosid": [],100133 }, "additionalPhotoRequired": true "uniqueName": "No }Accessories", "personHasApprovedPhotoclassifierUrl": truenull, "publicKeyhidden": "419e7e8346c8c436a146ddd30c97898b59c66b9072aee592810ed1b53f372936"false, "statusrequirement": "DONE"Must not include sunglasses or hat", } "version": 0, }, "personHasApprovedPhotodomainClass": true,"us.cloudcard.api.PhotoRequirement" "publicKey": "9kfpihiemv536j6m0s2eo6valakij2k57q6vnncjsg55frgs5uv68av1pjg4qgv1" }, "status": "PENDING" { }, "customFields": { "First Nameid": null100855, "Last Name": null }, "dateTermsAcceptedlistIndex": "2015-05-24T06:44:54Z"4, "domainClass": "com.campuscardtools.myphotoid.Person", "email": "director@sharptop.co", "lastUpdated"emailsReceived": [: "2019-04-26T20:30:09Z", { "organization": { "address": "director@sharptop.co", "formattedTimestampid": "10-19-2017 11:23 AM EDT",100133 "subject": "Your Photo Was Approved",}, "timestampuniqueName": "2017-10-19 11:23:17.0""Face Camera", }, "classifierUrl": null, { "addresshidden": "director@sharptop.co",false, "formattedTimestamprequirement": "10-20-2017 02:29 PM EDTMust be positioned directly facing the camera", "subjectversion": 0, "Instant Photo Feedback", "timestampdomainClass": "2017-10-20 14:29:29.0us.cloudcard.api.PhotoRequirement" }, }, { { "address": "director@sharptop.co", "formattedTimestampid": "Jan100856, 19 12:47 PM EST", "subjectlistIndex": "Your5, Photo Was Approved", "timestamplastUpdated": "20182019-0104-19 1226T20:4730:53.009Z", }, "organization": { "address": "director@sharptop.co", "id": 100133 "formattedTimestamp": "Jun 20 12:34 AM EDT", }, "subject": "Instant Photo Feedback", "uniqueName": "Look At Camera", "timestamp": "2018-06-20 00:34:42.0" }, "classifierUrl": null, { "addresshidden": "director@sharptop.co"false, "formattedTimestamprequirement": "Sep 26 10:07 AM EDT",Eyes should be open and looking at the camera", "subject": "Instant Photo Feedback",version": 0, "timestampdomainClass": "2018-09-26 10:07:24.0us.cloudcard.api.PhotoRequirement" } }, ], "enabled": true, "homeOrganization": { "id": 8, "hasDescendentsid": true100857, "descendents": [ {"listIndex": 6, "idlastUpdated": 92 "2019-04-26T20:30:09Z", }, "organization": { { "id": 100064100133 }, }, { "uniqueName": "Generic", "id": 46 "classifierUrl": "https://helper-bot.onlinephotosubmission.com/generic", }, {"hidden": true, "idrequirement": 100079"Must be a good photo", }, "version": 0, { "iddomainClass": 100047"us.cloudcard.api.PhotoRequirement" }, ] { }, "preArchiveEmail": null, "idaccountExpired": 100096false, "dateArchived": null, "unsubscribe": }false, "identifier": "12345600", "emailGroup": { { "id": 108, "idorganization": 87{ }, "id": 100133 }, { "receivableEmails": ",empty", "idname": 91"Default", "domainClass": "us.cloudcard.api.EmailGroup", } ]"version": 0 }, "idpreArchiveIdentifier": 90null, "identifierdateTermsAccepted": "d256436"null, "linkspasswordExpired": nullfalse, "organizationlastUpdated": {"2022-01-31T18:16:49Z", "additionalPhotoRequired": true, "idquicksightArn": 92null, "domainClasspreArchiveUsername": "com.campuscardtools.myphotoid.Organization", null, "nameusername": "Test Org.api_example@cloudcard.us", "accountLocked": false, "isPaidactivatedDate": truenull, "enabled": true, "termsOfServiceemail": null"api_example@cloudcard.us", "photoRequirementsdomainClass": ["us.cloudcard.api.]Person", "authorities": [ "customFields": [ { { "id": 3, "nameauthority": "ROLE_CARDHOLDER"First, Name" }"domainClass": "us.cloudcard.api.Role", {"version": 0 } ], "namecanViewOrganizationList": "Lastfalse, Name" "canSwitchOrganizations": false, }"customFields": {}, ],"homeOrganization": { "customCssUrlid": "https://sharptopco.github.io/cloudcard-custom-assets/blankcssfile.css"100133, "useEmailAsUsernamehasDescendents": truefalse, "usePersonIdentifierdescendents": true,[] }, "personIdentifierLabellinks": "ID Number"null, "downloadStrategyemail": {"api_example@cloudcard.us", "identifier": "12345600", "idusername": "EXTERNALapi_example@cloudcard.us", "readOnly": false, "restorable": false, "namestatus": "External ApplicationACTIVE", "additionalPhotos": {}, "downloadLabelcurrentPhoto": "Download Photos", { "photoDimensionsid": {3678, "classdateCreated": "com.campuscardtools.myphotoid.PhotoDimensions", 2023-06-26T15:01:12Z", "idupVotes": 30, "descriptionwidth": "200:200"600, "heightdateApproved": 200null, "width": 200 }"externalURL": "https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg", "preventMultiplePhotoslastUpdated": false, "approvalsPerDay": 0"2023-06-26T15:01:12Z", "approvalsMadeTodayhelperBotReviewed": 0false, "canApproveMorePhotosTodayaspectRatio": true1.0, "emailReplyToheight": "Hello From CloudCard <hello@cloudcardtools.com>"600, "helperBotDelaybackgroundReplaced": 1000false, "additionalPhotoTypesdownVotes": [0, "automaticallyApprovedOrDenied": false, { "publicKey": "000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQ52va5u4lB58RBFc7OoRTUQSr9Jr21HU30hhfSe4nVjPQM4ji", "errorsmanuallyEdited": {false, "status": "PENDING", "errorsdomainClass": []"us.cloudcard.api.Photo", "person": {...removed for brevity...}, "classifications": [], "namelowestClassification": "Governmentnull, Issued ID", "isAspectRatioCorrect": true, "notBoundlinks": false,{ "prompt": "Please submit a photo of your government issued ID.", "bytes": "https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg" }, "requiredoriginalPhoto": falsenull, "personHasApprovedPhoto": false, } "version": 0, ] }, "passwordExpiredonHoldReasons": false,[] "passwordResetRequired": false}, "readOnlyhelpScoutBeacon": falsenull, "usernamepreviouslyApprovedPhoto": "director@sharptop.co"null } |