Versions Compared

Old Version 17

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.

...

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 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": {}, "authorities": [ {
Code Block
titlelanguageExample 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,
               "class": "com.campuscardtools.myphotoid.Role",listIndex": 3,
                "idlastUpdated": 3"2019-04-26T20:30:09Z",
            "authority": "ROLE_CARDHOLDER"   "organization": {
    }     ],     "canSwitchOrganizations": false,     "canViewOrganizationListid": false,100133
    "currentPhoto": null,     "customFields": {      },
  "Notes": {             "classuniqueName": "com.campuscardtools.myphotoid.CustomFieldValueNo Accessories",
                "idclassifierUrl": 413609null,
                "customFieldhidden": {false,
                "classrequirement": "com.campuscardtools.myphotoid.CustomFieldMust not include sunglasses or hat",
                "id": 100067"version": 0,
                },
"domainClass": "us.cloudcard.api.PhotoRequirement"
           "lastUpdated": "2019-12-04T17:47:09Z",
 },
           "person": {
                "classid": "com.campuscardtools.myphotoid.Person"100855,
                "idlistIndex": 236680
         4,
   },             "valuelastUpdated": "Bacon"
 2019-04-26T20:30:09Z",
      }     },     "dateTermsAcceptedorganization": null,
    "domainClass": "com.campuscardtools.myphotoid.Person",{
    "email": "john.arnold+rrtest@gmail.com",     "emailGroup": {         "id": 100133
   23,         "name": "Default",   },
     "receivableEmails": "welcome,login,approval,denial,BAD,GOOD,MAYBE"     },     "enableduniqueName": "Face trueCamera",
      "homeOrganization": {         "idclassifierUrl": 92null,
  
     "hasDescendents": false,           "descendentshidden": false,
[]     },     "id": 236680,     "identifierrequirement": "K0006",
    "links": null,Must be positioned directly facing the camera",
      "organization": {         "idversion": 920,
    
   "domainClass": "com.campuscardtools.myphotoid.Organization",             "namedomainClass": "Test Org.",us.cloudcard.api.PhotoRequirement"
         "isPaid": true,  },
      "termsOfService": null,     {
   "photoRequirements": [             {"id": 100856,
                "idlistIndex": 4405,
                "lastUpdated": "uniqueName": "Face Camera2019-04-26T20:30:09Z",
                "requirementorganization": "Must be positioned directly facing the camera",{
                    "listIndexid": 4,100133
                "hidden": false},
             },   "uniqueName": "Look         {At Camera",
                "idclassifierUrl": 442null,
                "uniqueNamehidden": "HelperBot"false,
                "requirement": "Do not deleteEyes should be open and looking at the camera",
                "listIndexversion": 60,
                "hiddendomainClass": true"us.cloudcard.api.PhotoRequirement"
            },
            {
                "id": 441100857,
                "uniqueNamelistIndex": "Look At Camera"6,
                "requirement": "Eyes should be open and looking at the cameralastUpdated": "2019-04-26T20:30:09Z",
                "listIndexorganization": {
   5,                 "hiddenid": 100133
   false             },
                 {"uniqueName": "Generic",
                "idclassifierUrl": 438"https://helper-bot.onlinephotosubmission.com/generic",
                "uniqueNamehidden": "Color Photo"true,
                "requirement": "Must be a colorgood photo",
                "listIndexversion": 20,
                "hiddendomainClass": false "us.cloudcard.api.PhotoRequirement"
            }
        ]
    },
    "preArchiveEmail": null,
    "accountExpired": false,
 {   "dateArchived": null,
       "unsubscribe": false,
    "ididentifier": 436"12345600",
       "emailGroup": {
        "uniqueNameid": "Crop"108,
           "organization": {
    "requirement": "Should be cropped slightly above head to middle of chest","id": 100133
        },
        "listIndexreceivableEmails": 0,",empty",
        "name": "Default",
        "hiddendomainClass": false "us.cloudcard.api.EmailGroup",
        "version": 0
    },
    "preArchiveIdentifier": null,
    "dateTermsAccepted": null,
{    "passwordExpired": false,
      "lastUpdated": "2022-01-31T18:16:49Z",
    "idadditionalPhotoRequired": 439true,
    "quicksightArn": null,
    "preArchiveUsername": null,
    "uniqueNameusername": "No Accessoriesapi_example@cloudcard.us",
    "accountLocked": false,
    "activatedDate": null,
    "requirementenabled": "Musttrue,
not include sunglasses or hat",
           "email": "api_example@cloudcard.us",
    "listIndexdomainClass": 3"us.cloudcard.api.Person",
    "authorities": [
        {
 "hidden": false             }"id": 3,
            {
"authority": "ROLE_CARDHOLDER",
              "domainClass": "id": 437,
   us.cloudcard.api.Role",
            "uniqueNameversion": 0
"Plain Background",       }
    ],
    "requirementcanViewOrganizationList": "Shouldfalse,
be taken against a plain, light background" "canSwitchOrganizations": false,
    "customFields": {},
        "homeOrganization": {
 "listIndex": 1,        "id": 100133,
        "hiddenhasDescendents": false,
        "descendents": []
  }  },
      ],
   "links": null,
    "customFieldsemail": ["api_example@cloudcard.us",
    "identifier": "12345600",
    "username":  {"api_example@cloudcard.us",
      "readOnly": false,
    "restorable": false,
    "namestatus": "NotesACTIVE",
    "additionalPhotos": {},
    "currentPhoto": {
}        "id": ]3678,
        "customCssUrldateCreated": "https://sharptopco.github.io/cloudcard-custom-assets/blankcssfile.css"2023-06-26T15:01:12Z",
        "upVotes": 0,
        "logoutUrlwidth": null600,
        "useEmailAsUsernamedateApproved": truenull,
        "usePersonIdentifierexternalURL": true"https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg",
        "lastUpdated"personIdentifierLabel": "ID Number: "2023-06-26T15:01:12Z",
        "downloadStrategyhelperBotReviewed": {
   false,
        "idaspectRatio": "EXTERNAL",
   1.0,
        "nameheight": "External600,
Application"        "backgroundReplaced": }false,
        "downloadLabeldownVotes": "Download Photos"0,
        "photoDimensionsautomaticallyApprovedOrDenied": {
   false,
        "classpublicKey": "com000002.campuscardtools23.myphotoid177.PhotoDimensionsF02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQ52va5u4lB58RBFc7OoRTUQSr9Jr21HU30hhfSe4nVjPQM4ji",
   
        "idmanuallyEdited": 3false,
   
        "descriptionstatus": "200:200 (1:1)PENDING",
   
        "heightdomainClass": 200"us.cloudcard.api.Photo",
        "person": {...removed   "width": 200for brevity...},
         }"classifications": [],
        "preventMultiplePhotoslowestClassification": falsenull,
        "approvalsPerDayisAspectRatioCorrect": 0true,
        "approvalsMadeTodaylinks": {
   0,         "canApproveMorePhotosTodaybytes": true,
  "https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg"
     "emailReplyTo": "Hello From CloudCard <hello@cloudcardtools.com>" },
        "helperBotDelayoriginalPhoto": 1000null,
        "additionalPhotoTypespersonHasApprovedPhoto": []
false,
   },     "passwordExpiredversion": false0,
        "passwordResetRequiredonHoldReasons": false,[]
    "readOnly": false},
    "unsubscribehelpScoutBeacon": falsenull,
    "usernamepreviouslyApprovedPhoto": "john.arnold+rrtest@gmail.com"null
}