Page Comparison

...
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, 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, "additionalPhotos": {}, "authorities": [ {
Code Block
language
title	Example 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"
            },
            {
                "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,
                "classdomainClass": "comus.campuscardtoolscloudcard.myphotoidapi.RolePhotoRequirement",
            "id": 3},
            "authority": "ROLE_CARDHOLDER"
 {
      }     ],     "currentPhotoid": {
 100855,
      "aspectRatio": 1,         "classificationslistIndex": [...],
  4,
     "domainClass": "com.campuscardtools.myphotoid.Photo",           "idlastUpdated": 12061,
 "2019-04-26T20:30:09Z",
      "isAspectRatioCorrect": true,         "linksorganization": {

           "bytes": "https://api.onlinephotosubmission.com/api/photos/lotsofrandomlettersandnumbers/bytes"         },"id": 100133
        "lowestClassification": 0.0185,        },
  "originalPhoto": {             "iduniqueName": "Face 12060,Camera",
                "publicKeyclassifierUrl": "lotsofrandomlettersandnumbers",null,
                "linkshidden": {false,
                "bytesrequirement": "https://api.onlinephotosubmission.com/api/photos/lotsofrandomlettersandnumbers/bytes"
            }
Must be positioned directly facing the camera",
       },         "personversion": {...},
 0,
      "publicKey": "lotsofrandomlettersandnumbers",         "statusdomainClass": "PENDINGus.cloudcard.api.PhotoRequirement"
    },     "customFields": {   },
     "Campus": {           {
 "class": "com.campuscardtools.myphotoid.CustomFieldValue",               "id": 11858100856,
                "customFieldlistIndex": {...},5,
                "lastUpdated": "20172019-1104-21T1326T20:3830:23Z09Z",
                "personorganization": {
                    "classid": "com.campuscardtools.myphotoid.Person", 100133
                },
     "id": 18762          "uniqueName": "Look At },Camera",
                "valueclassifierUrl": "East"
null,
       },         "Namehidden": false,
   {             "classrequirement": "com.campuscardtools.myphotoid.CustomFieldValue",Eyes should be open and looking at the camera",
                "idversion": 118570,
                "customFielddomainClass": {"us.cloudcard.api.},PhotoRequirement"
            "lastUpdated": "2017-11-21T13:38:23Z",
},
           "person": {
                "classid": "com.campuscardtools.myphotoid.Person"100857,
                "idlistIndex": 6,
    18762             },"lastUpdated": "2019-04-26T20:30:09Z",
                "valueorganization": {
"Grace Hopper"         }     },     "dateTermsAcceptedid": null, 100133
            "domainClass": "com.campuscardtools.myphotoid.Person",    },
     "email": "grace.hopper@sharptop.io",     "emailsReceived": [    "uniqueName": "Generic",
   {             "addressclassifierUrl": "grace.hopper@sharptop.io",https://helper-bot.onlinephotosubmission.com/generic",
                "formattedTimestamphidden": "10-19-2017 11:23 AM EDT", true,
                "subjectrequirement": "YourMust be Photoa Wasgood Approvedphoto",
                "timestampversion": "2017-10-19 11:23:17.0" 0,
                },
"domainClass": "us.cloudcard.api.PhotoRequirement"
       {     }
       "address": "grace.hopper@sharptop.io", ]
       },
    "formattedTimestamppreArchiveEmail": "10-20-2017 02:29 PM EDT" null,
    "accountExpired": false,
       "dateArchived": null,
    "subjectunsubscribe": "Instant Photo Feedback"false,
       "identifier": "12345600",
    "timestampemailGroup": "2017-10-20 14:29:29.0"{
        "id": }108,
        "organization": {
            "addressid": "grace.hopper@sharptop.io", 100133
        },
        "formattedTimestampreceivableEmails": "Jan 19 12:47 PM EST",",empty",
        "name": "Default",
        "subjectdomainClass": "Your Photo Was Approved",
  "us.cloudcard.api.EmailGroup",
        "version": 0
    },
    "timestamppreArchiveIdentifier": "2018-01-19 12:47:53.0"null,
    "dateTermsAccepted": null,
  },  "passwordExpired": false,
     {"lastUpdated": "2022-01-31T18:16:49Z",
       "additionalPhotoRequired": true,
    "addressquicksightArn": "grace.hopper@sharptop.io"null,
    "preArchiveUsername": null,
     "username": "formattedTimestamp": "Jun 13 9:53 AM EDT"api_example@cloudcard.us",
    "accountLocked": false,
       "activatedDate": null,
    "subjectenabled": "Instant Photo Feedback"true,
       "email": "api_example@cloudcard.us",
    "timestampdomainClass": "2018-06-13 09:53:52.0"us.cloudcard.api.Person",
        },"authorities": [
        {
            "addressid": "grace.hopper@sharptop.io"3,
            "formattedTimestampauthority": "Jun 13 9:54 AM EDTROLE_CARDHOLDER",
            "subjectdomainClass": "Instant Photo Feedbackus.cloudcard.api.Role",
            "timestamp": "2018-06-13 09:54:30.0"version": 0
        },
    ],
   { "canViewOrganizationList": false,
    "canSwitchOrganizations": false,
    "addresscustomFields": "grace.hopper@sharptop.io",{},
    "homeOrganization": {
        "formattedTimestampid": 100133,
 "Jun 18 3:14 PM EDT",   "hasDescendents": false,
        "subjectdescendents": "Your[]
Photo Was Approved",  },
    "links": null,
    "timestampemail": "2018-06-18 15:14:05.0"api_example@cloudcard.us",
        }
    ]"identifier": "12345600",
    "enabledusername": true"api_example@cloudcard.us",
    "idreadOnly": 18762false,
    "identifierrestorable": "S63455"false,
    "latestPhotostatus": null"ACTIVE",
    "linksadditionalPhotos": null{},
    "organizationcurrentPhoto": {
        "id": 83678,
        "domainClassdateCreated": "com.campuscardtools.myphotoid.Organization",
        "name": "SharpTop Company2023-06-26T15:01:12Z",
        "isPaidupVotes": true0,
        "termsOfServicewidth": "..."600,
        "photoRequirementsdateApproved": [...]null,
        "customFieldsexternalURL": [...]"https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg",
        "customCssUrllastUpdated": null"2023-06-26T15:01:12Z",
        "useEmailAsUsernamehelperBotReviewed": truefalse,
        "usePersonIdentifieraspectRatio": true1.0,
        "personIdentifierLabelheight": "ID Number"600,
        "downloadStrategybackgroundReplaced": {
   false,
        "iddownVotes": "ZIP",
   0,
        "nameautomaticallyApprovedOrDenied": "Zip File"
        }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": null,
1        "isAspectRatioCorrect": }true,
        "preventMultiplePhotoslinks": false, {
             "approvalsPerDay": 0,"bytes": "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
}
Versions Compared

Old Version 10

New Version Current

Key

Example HTTP Request Body

Example Response
