Versions Compared

Old Version 19

changes.mady.by.user Tony Erskine

Saved on

compared with

New Version Current

changes.mady.by.user Tony Erskine

Saved on

Key

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

...

...

...

...


Info

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

URI: https://api.onlinephotosubmissioncloudcard.comus/api/peopleperson/{id | email | identifier }

...

           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 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)

...

. 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
200 OK { "accountExpired": false, "accountLocked": false, "activatedDate": null, "additionalPhotoRequired": false, "additionalPhotos": {
Code Block
language
titleExample Response
json
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"
         "Government Issued ID": null},
    },     "authorities": [     {
   {             "authorityid": "ROLE_CARDHOLDER"100854,
                "defaultMappedFieldslistIndex": 3,
[                "lastUpdated": "authority2019-04-26T20:30:09Z",
                "id",organization": {
                    "versionid": 100133
           ],     },
                "errorsuniqueName": {"No Accessories",
                "errorsclassifierUrl": []null,
            },    "hidden": false,
       "excludedFields": [        "requirement": "Must not include sunglasses or    "grailsApplicationhat",
                "springSecurityServiceversion": 0,
                "domainClass": "messageSourceus.cloudcard.api.PhotoRequirement"
            ]},
            {
 "id": 3,               "versionid": 0
100855,
       }     ],     "canSwitchOrganizationslistIndex": false4,
   
"canViewOrganizationList": false,     "currentPhoto": {         "aspectRatiolastUpdated": 1.0"2019-04-26T20:30:09Z",
        "classifications": [       "organization":  {
   {                 "id": 257974,100133
                "score": 0.9263},
                "requirementNameuniqueName": "HelperBot"
            }
Face Camera",
       ],         "domainClassclassifierUrl": "com.campuscardtools.myphotoid.Photo",
null,
       "helperBotReviewed": true,
        "idhidden": 552814false,
        "isAspectRatioCorrect": true,         "linksrequirement": "Must {be positioned directly facing the camera",
       "bytes": "https://s3.amazonaws.com/....jpg"        "version": }0,
  
     "lowestClassification": 0.9263,           "originalPhotodomainClass": {"us.cloudcard.api.PhotoRequirement"
            },
 "id": 552812,          {
  "publicKey": "...",             "linksid": {
 100856,
              "bytes": "https://s3.amazonaws.com/....jpg"  "listIndex": 5,
            }
    "lastUpdated": "2019-04-26T20:30:09Z",
       },         "personorganization": {
            "id": 235068,       "id": 100133
    "username": "cia5348@sharptop.io",           },
 "email": "cia5348@sharptop.io",               "identifieruniqueName": "cia5348Look At Camera",
                "organizationclassifierUrl": {null,
                "idhidden": 92false,
                "namerequirement": "Test Org.",
                "photoRequirements": [...]Eyes should be open and looking at the camera",
                "identifierversion": null0,
                "badPhotoThresholddomainClass": 0.4,"us.cloudcard.api.PhotoRequirement"
            },
   "goodPhotoThreshold": 0.8         {
   },             "additionalPhotosid": []100857,
                "additionalPhotoRequiredlistIndex": false
6,
       },         "personHasApprovedPhotolastUpdated": true,"2019-04-26T20:30:09Z",
                "publicKeyorganization": "...", {
          "status": "READY_FOR_DOWNLOAD",         "versionid": 171100133
    },     "customFields": {      },
  "Notes": {             "iduniqueName": 586856,"Generic",
                "valueclassifierUrl": "Brad Pitt"https://helper-bot.onlinephotosubmission.com/generic",
        }     },
    "dateTermsAcceptedhidden": nulltrue,
    "domainClass": "com.campuscardtools.myphotoid.Person",     "email": "cia5348@sharptop.io",     "emailGrouprequirement": {"Must be a       "id": 23,
  good photo",
     "name": "Default",           "receivableEmailsversion": "login,approval,denial,BAD,GOOD,MAYBE,welcome"0,
     },     "enabled": true,     "homeOrganizationdomainClass": {"us.cloudcard.api.PhotoRequirement"
           "id": 92, }
        "hasDescendents": false,]
    },
    "descendents": []preArchiveEmail": null,
    "accountExpired": }false,
    "iddateArchived": 235068null,
    "identifierunsubscribe": "cia5348"false,
    "linksidentifier": null"12345600",
    "organizationemailGroup": {
        "id": 92108,
        "domainClassorganization": "com.campuscardtools.myphotoid.Organization", {
            "nameid": "Test Org." 100133
        },
        "isPaidreceivableEmails": true",empty",
        "termsOfServicename": "nullDefault",
        "photoRequirementsdomainClass": ["us.cloudcard.api.]EmailGroup",
        "customFieldsversion": 0
 [   },
    "preArchiveIdentifier": null,
   { "dateTermsAccepted": null,
    "passwordExpired": false,
    "lastUpdated": "2022-01-31T18:16:49Z",
      "nameadditionalPhotoRequired": "Notes"true,
      "quicksightArn": null,
         "promptpreArchiveUsername": null,
    "username": "api_example@cloudcard.us",
    "accountLocked": false,
    "sortOrderactivatedDate": 1null,
           "enabled": true,
    "showInListemail": true"api_example@cloudcard.us",
    "domainClass": "us.cloudcard.api.Person",
    "authorities":  [
   "allowUserInput": false,    {
            "requireUserInputid": false3,
                "lastUpdatedauthority": "2018-12-18T21:05:18ZROLE_CARDHOLDER",
                "id": 100067,
 "domainClass": "us.cloudcard.api.Role",
              "version": 0
        }
   } ],
       ],
   "canViewOrganizationList": false,
    "customCssUrlcanSwitchOrganizations": "https://sharptopco.github.io/cloudcard-custom-assets/blankcssfile.css",
   false,
    "logoutUrlcustomFields": null,
   {},
    "useEmailAsUsernamehomeOrganization": true,{
        "usePersonIdentifierid": true100133,
        "personIdentifierLabelhasDescendents": "ID Number"false,
        "downloadStrategydescendents": {[]
       },
    "idlinks": "EXTERNAL"null,
       "email": "api_example@cloudcard.us",
    "nameidentifier": "External Application"
        },
   12345600",
    "downloadLabelusername": "Download Photosapi_example@cloudcard.us",
    "readOnly": false,
    "photoDimensionsrestorable": {false,
      "status": "ACTIVE",
     "widthadditionalPhotos": 200{},
    "currentPhoto": {
        "heightid": 2003678,
   
        "descriptiondateCreated": "200:200 (1:1)2023-06-26T15:01:12Z",
        "upVotes": 0,
        "idwidth": 3600,
        "dateApproved": null,
  "version": 0         }"externalURL": "https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg",
        "preventMultiplePhotoslastUpdated": false"2023-06-26T15:01:12Z",
        "approvalsPerDayhelperBotReviewed": 0false,
        "approvalsMadeTodayaspectRatio": 1.0,
        "canApproveMorePhotosTodayheight": true600,
        "emailReplyTobackgroundReplaced": "Hello From CloudCard <hello@cloudcardtools.com>"false,
        "helperBotDelaydownVotes": 10000,
        "additionalPhotoTypesautomaticallyApprovedOrDenied": [
          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,
   {
            "promptbytes": "Do IT!",https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg"
        },
        "requiredoriginalPhoto": falsenull,
        "personHasApprovedPhoto": false,
  }         ]
    }"version": 0,
    "passwordExpired": false,
    "passwordResetRequiredonHoldReasons": false,[]
    "readOnly": false},
    "unsubscribehelpScoutBeacon": falsenull,
    "usernamepreviouslyApprovedPhoto": "cia5348@sharptop.io"null
}