...
...
...
...
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/
...
HTTP Method: GET
Required Headers: X-Auth-Token (see: Authentication)
...
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, findBy must be used when querying email/identifier
HTTP Method: GET
Required Headers: X-Auth-Token (see: Authentication)
Example HTTP Request Body
...
(LEAVE REQUEST BODY EMPTY)
...
title | Example Response |
---|
...
Code Block |
---|
(LEAVE REQUEST BODY EMPTY) |
Example Response
Code Block | ||
---|---|---|
| ||
200 OK { "id": 577782, "dateCreated": "2022-01-31T18:16:40Z", "passwordResetRequired": false, "organization": { "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, "approvalsPerDay": 10, "expirationDate": null, "backgroundColor": null, "parent": null, "allowAutoApproval": false, "termsOfService": null, "siteURL": "", "autoArchiveAction": null, "daysBetweenInvitations": 14, "lastUpdated": "2022-01-31T18:17:29Z", "backgroundImage": null, "sendAutomaticFeedback": false, "usePersonIdentifier": true, "emailDomains": [], "autoArchiveStatus": null, "additionalPhotoTypes": [], "defaultGroup": { "id": 108, "organization": { "id": 100133 }, "receivableEmails": ",empty", "name": "Default", "domainClass": "us.cloudcard.api.EmailGroup", "version": 0 }, "goodPhotoThreshold": 0.8, "personIdentifierLabel": "ID Number", "preventMultiplePhotos": false, "customCssUrl": "", "useEmailAsUsername": true, "helperBotDelay": 600000, "downloadStrategy": { "id": "ZIP", "name": "Zip File" }, "approvalsMadeToday": 0, "backgroundReplacementEnabled": false, "canApproveMorePhotosToday": true, "customFields": [], "photoRequirements": [ { "id": 100851, "listIndex": 0, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "Crop", "classifierUrl": null, "hidden": false, "requirement": "Should be cropped slightly above head to middle of chest", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" }, { "id": 100852, "listIndex": 1, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "Plain Background", "classifierUrl": null, "hidden": false, "requirement": "Should be taken against a plain, light background", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" }, { "id": 100853, "listIndex": 2, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "Color Photo", "classifierUrl": null, "hidden": false, "requirement": "Must be a color photo", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" }, { "id": 100854, "listIndex": 3, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "No Accessories", "classifierUrl": null, "hidden": false, "requirement": "Must not include sunglasses or hat", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" }, { "id": 100855, "listIndex": 4, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "Face Camera", "classifierUrl": null, "hidden": false, "requirement": "Must be positioned directly facing the camera", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" }, { "id": 100856, "listIndex": 5, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "Look At Camera", "classifierUrl": null, "hidden": false, "requirement": "Eyes should be open and looking at the camera", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" }, { "class": "com.campuscardtools.myphotoid.Role", "id": 3100857, "authoritylistIndex": "ROLE_CARDHOLDER"6, } ], "currentPhotolastUpdated": {"2019-04-26T20:30:09Z", "aspectRatio": 1, "classifications": [...],organization": { "domainClass": "com.campuscardtools.myphotoid.Photo", "id": 12061,100133 "isAspectRatioCorrect": true, }, "links": { "bytes": "https://api.onlinephotosubmission.com/api/photos/lotsofrandomlettersandnumbers/bytes" "uniqueName": "Generic", }, "lowestClassificationclassifierUrl": 0.0185, "https://helper-bot.onlinephotosubmission.com/generic", "originalPhoto": { "idhidden": 12060true, "publicKeyrequirement": "lotsofrandomlettersandnumbersMust be a good photo", "linksversion": {0, "bytesdomainClass": "https://api.onlinephotosubmission.com/api/photos/lotsofrandomlettersandnumbers/bytesus.cloudcard.api.PhotoRequirement" } ] }, }, "personpreArchiveEmail": {...},null, "accountExpired": false, "publicKeydateArchived": null, "lotsofrandomlettersandnumbersunsubscribe", : false, "statusidentifier": "PENDING" }12345600", "customFieldsemailGroup": { "Campusid": {108, "classorganization": "com.campuscardtools.myphotoid.CustomFieldValue",{ "id": 11858, 100133 }, "customFieldreceivableEmails": {...}, ",empty", "lastUpdatedname": "2017-11-21T13:38:23ZDefault", "domainClass": "us.cloudcard.api.EmailGroup", "person": { "version": 0 }, "classpreArchiveIdentifier": "com.campuscardtools.myphotoid.Person",null, "dateTermsAccepted": null, "passwordExpired": false, "idlastUpdated": 18762"2022-01-31T18:16:49Z", "additionalPhotoRequired": true, }"quicksightArn": null, "preArchiveUsername": null, "valueusername": "Eastapi_example@cloudcard.us", "accountLocked": false, }, "activatedDate": null, "Nameenabled": {true, "email": "api_example@cloudcard.us", "classdomainClass": "comus.campuscardtoolscloudcard.myphotoidapi.CustomFieldValuePerson", "idauthorities": 11857, [ "customField": {...}, "lastUpdatedid": "2017-11-21T13:38:23Z"3, "personauthority": { "ROLE_CARDHOLDER", "classdomainClass": "comus.campuscardtoolscloudcard.myphotoidapi.PersonRole", "idversion": 0 18762 } }], "canViewOrganizationList": false, "valuecanSwitchOrganizations": false, "Grace Hopper" "customFields": {}, }"homeOrganization": { }, "dateTermsAcceptedid": null100133, "domainClasshasDescendents": "com.campuscardtools.myphotoid.Person", "email": "grace.hopper@sharptop.io",false, "emailsReceiveddescendents": 1 [] }, "enabledlinks": truenull, "idemail": 18762"api_example@cloudcard.us", "identifier": "S6345512345600", "latestPhotousername": null"api_example@cloudcard.us", "linksreadOnly": nullfalse, "organizationrestorable": {false, "status": "ACTIVE", "idadditionalPhotos": 8, {}, "domainClasscurrentPhoto": "com.campuscardtools.myphotoid.Organization",{ "nameid": "SharpTop Company"3678, "isPaiddateCreated": true"2023-06-26T15:01:12Z", "termsOfServiceupVotes": "..."0, "photoRequirementswidth": [...]600, "customFieldsdateApproved": [...]null, "customCssUrlexternalURL": null"https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg", "useEmailAsUsernamelastUpdated": true"2023-06-26T15:01:12Z", "usePersonIdentifierhelperBotReviewed": truefalse, "personIdentifierLabelaspectRatio": "ID Number"1.0, "downloadStrategyheight": { 600, "idbackgroundReplaced": "ZIP"false, "namedownVotes": "Zip0, File" "automaticallyApprovedOrDenied": }false, "downloadLabelpublicKey": "Download Photos000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQ52va5u4lB58RBFc7OoRTUQSr9Jr21HU30hhfSe4nVjPQM4ji", "aspectRatiomanuallyEdited": { false, "classstatus": "com.campuscardtools.myphotoid.AspectRatioPENDING", "iddomainClass": 3, "us.cloudcard.api.Photo", "descriptionperson": "1:1", {...removed for brevity...}, "heightclassifications": 1, [], "widthlowestClassification": 1null, "isAspectRatioCorrect": }true, "preventMultiplePhotoslinks": false, { "approvalsPerDaybytes": 0,"https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg" "approvalsMadeToday": 2}, "canApproveMorePhotosTodayoriginalPhoto": truenull, "allowAutoCroppersonHasApprovedPhoto": truefalse, "allowAutoRotateversion": true0, "additionalPhotoTypesonHoldReasons": [] }, "passwordExpiredhelpScoutBeacon": falsenull, "passwordResetRequiredpreviouslyApprovedPhoto": false, "readOnly": false, "username": "grace.hopper@sharptop.io"null } |