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

Code Block
titlelanguage	Example Responsejson
200 OK

{
    "accountExpiredid": false577782,
    "accountLockeddateCreated": false"2022-01-31T18:16:40Z",
    "activatedDatepasswordResetRequired": nullfalse,
    "additionalPhotosorganization": {},
        "authoritiesid": [100133,
        {
   "isPaid": true,
        "classdownloadLabel": "Download "com.campuscardtools.myphotoid.Role",Photos",
            "idallowAutoCrop": 3false,
  
         "authoritylogoutUrl": "ROLE_CARDHOLDER",
        }
"allowAutoRotate": false,
   ],     "currentPhotoallowAutoDenial": {false,
        "aspectRatioallowDeprecatedEndpoints": 1false,
        "classificationsmaxNumberOfInvitations": [...]0,
        "domainClassphotoDimensions": "com.campuscardtools.myphotoid.Photo", {
          "  "id": 120616,
            "isAspectRatioCorrectwidth": true300,
            "linksheight": {300,
            "bytesdescription": "https://api.onlinephotosubmission.com/api/photos/lotsofrandomlettersandnumbers/bytes"
    300:300 (1:1)",
   },         "lowestClassificationdomainClass": 0.0185"us.cloudcard.api.PhotoDimensions",
            "originalPhotoversion": {0,
            "idvalue": 120601.0,
            "publicKeylongSide": "17d0bb4d96dae04395199308bbc56362279679fff0ffe2b36144ac2d261533d3"300,
            "linksshortSide": 300
{        },
        "bytesname": "https://api.onlinephotosubmission.com/api/photos/lotsofrandomlettersandnumbers/bytes"Postman Test",
          "badPhotoThreshold": 0.4,
 }         }"helpScoutBeacons": [],
        "personallowAutoBackgroundReplacement": {...}false,
        "publicKeysendEmailFrom": "lotsofrandomlettersandnumbersOnline Photo Submission <sent.from.customer@onlinephotosubmission.com>",
        "statusidentifier": "PENDING"
null,
   },     "customFieldsemailReplyTo": {null,
        "CampusapprovalsPerDay": { 10,
        "expirationDate": null,
        "classbackgroundColor": "com.campuscardtools.myphotoid.CustomFieldValue",
   null,
        "idparent": 11858null,
   
        "customFieldallowAutoApproval": {...},
 false,
          "lastUpdatedtermsOfService": "2017-11-21T13:38:23Z"null,
           "siteURL": "person":,
{        "autoArchiveAction": null,
        "classdaysBetweenInvitations": "com.campuscardtools.myphotoid.Person"14,
        "lastUpdated": "2022-01-31T18:17:29Z",
        "idbackgroundImage": 18762null,
            },
   "sendAutomaticFeedback": false,
        "valueusePersonIdentifier": true,
"East"         }"emailDomains": [],
        "NameautoArchiveStatus": {null,
        "additionalPhotoTypes": [],
        "classdefaultGroup": "com.campuscardtools.myphotoid.CustomFieldValue",{
            "id": 11857108,
            "customFieldorganization": {...},
                "lastUpdatedid": "2017-11-21T13:38:23Z",100133
            "person": {},
                 "classreceivableEmails": "com.campuscardtools.myphotoid.Person,empty",
               "name": "idDefault":,
18762             }"domainClass": "us.cloudcard.api.EmailGroup",
            "valueversion": "Grace Hopper"0
        }
,
   },     "dateTermsAcceptedgoodPhotoThreshold": null,0.8,
        "domainClasspersonIdentifierLabel": "com.campuscardtools.myphotoid.PersonID Number",
        "emailpreventMultiplePhotos": "grace.hopper@sharptop.io",false,
        "emailsReceivedcustomCssUrl": 1,"",
        "enableduseEmailAsUsername": true,
        "idhelperBotDelay": 18762600000,
        "identifierdownloadStrategy": "S63455",{
    "latestPhoto": null,       "linksid": null"ZIP",
    "organization        "name": {"Zip File"
       "id": 8},
        "domainClassapprovalsMadeToday": "com.campuscardtools.myphotoid.Organization"0,
        "namebackgroundReplacementEnabled": "SharpTop Company"false,
        "isPaidcanApproveMorePhotosToday": true,
        "termsOfServicecustomFields": "..."[],
        "photoRequirements": [
            {
                "id": 22100851,
                "uniqueNamelistIndex": "Color Photo"0,
                "requirementlastUpdated": "Must be a color photo.2019-04-26T20:30:09Z",
                "listIndexorganization": 2, {
                    "hiddenid": 100133
   false             },
                 {"uniqueName": "Crop",
                "idclassifierUrl": 25null,
                "uniqueNamehidden": "Look At Camera"false,
                "requirement": "EyesShould be shouldcropped beslightly openabove andhead lookingto atmiddle theof camerachest",
                "listIndexversion": 50,
                "hiddendomainClass": false"us.cloudcard.api.PhotoRequirement"
            },
            {
                "id": 21100852,
                "uniqueNamelistIndex": "Plain Background"1,
                "requirementlastUpdated": "Should be taken against a plain, light background2019-04-26T20:30:09Z",
                "listIndexorganization": 1,{
                    "hiddenid": 100133
   false             },
             {   "uniqueName": "Plain Background",
                "idclassifierUrl": 23null,
                "uniqueNamehidden": "No Accessories"false,
                "requirement": "MustShould notbe include sunglasses or hattaken against a plain, light background",
                "listIndexversion": 30,
                "hiddendomainClass": false"us.cloudcard.api.PhotoRequirement"
            },
            {
                "id": 20100853,
                "uniqueNamelistIndex": "Crop"2,
                "requirementlastUpdated": "Should be cropped slightly above head to middle of chest","2019-04-26T20:30:09Z",
                "organization": {
       "listIndex": 0,            "id":  100133
  "hidden": false             },
            {    "uniqueName": "Color Photo",
                "idclassifierUrl": 125null,
                "uniqueNamehidden": "Generic"false,
                "requirement": "Must be a good IDcolor photo",
                "listIndexversion": 90,
                "hiddendomainClass": true"us.cloudcard.api.PhotoRequirement"
            },
            {
                "id": 24100854,
                "uniqueNamelistIndex": "Face Camera"3,
                "requirementlastUpdated": "Must be positioned directly facing the camera2019-04-26T20:30:09Z",
                "listIndexorganization": {
   4,                 "hiddenid": 100133
   false             }
,
       ],         "customFieldsuniqueName": ["No Accessories",
           {       "classifierUrl": null,
         "name       "hidden": "Campus"false,
            },    "requirement": "Must not include sunglasses or hat",
  {
                "nameversion": "Name" 0,
              }  "domainClass": "us.cloudcard.api.PhotoRequirement"
     ],         "customCssUrl": null},
            {
                "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"
            },
            {
                "id": 100857,
                "listIndex": 6,
                "lastUpdated": "2019-04-26T20:30:09Z",
                "organization": {
                    "id": 100133
                },
                "uniqueName": "Generic",
                "classifierUrl": "https://helper-bot.onlinephotosubmission.com/generic",
                "hidden": true,
                "requirement": "Must be a good photo",
                "version": 0,
                "domainClass": "us.cloudcard.api.PhotoRequirement"
            }
        ]
    },
    "preArchiveEmail": null,
    "accountExpired": false,
    "dateArchived": null,
    "unsubscribe": false,
    "identifier": "12345600",
    "emailGroup": {
        "id": 108,
        "organization": {
            "id": 100133
        },
        "receivableEmails": ",empty",
        "name": "Default",
        "domainClass": "us.cloudcard.api.EmailGroup",
        "version": 0
    },
    "preArchiveIdentifier": null,
    "dateTermsAccepted": null,
    "passwordExpired": false,
    "lastUpdated": "2022-01-31T18:16:49Z",
    "additionalPhotoRequired": true,
    "quicksightArn": null,
    "preArchiveUsername": null,
    "username": "api_example@cloudcard.us",
    "accountLocked": false,
    "activatedDate": null,
    "enabled": true,
    "email": "api_example@cloudcard.us",
    "domainClass": "us.cloudcard.api.Person",
    "authorities": [
        {
            "id": 3,
            "authority": "ROLE_CARDHOLDER",
            "domainClass": "us.cloudcard.api.Role",
            "version": 0
        }
    ],
    "canViewOrganizationList": false,
    "canSwitchOrganizations": false,
    "customFields": {},
    "homeOrganization": {
        "id": 100133,
        "hasDescendents": false,
        "descendents": []
    },
    "links": null,
    "email": "api_example@cloudcard.us",
    "identifier": "12345600",
    "username": "api_example@cloudcard.us",
    "readOnly": false,
    "restorable": false,
    "status": "ACTIVE",
    "additionalPhotos": {},
    "currentPhoto": {
        "id": 3678,
        "dateCreated": "2023-06-26T15:01:12Z",
        "upVotes": 0,
        "width": 600,
        "dateApproved": null,
        "externalURL": "https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg",
        "lastUpdated": "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": 1null,
        }"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 7

New Version Current

Key

Example HTTP Request Body

Example Response
