Versions Compared

Version Old Version 2 New Version 3
Changes made by

Tony Erskine

Tony Erskine

Saved on

Key

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

URI: https://app.cloudcardtools.com/api/people/{id}

...

Optional URL Parameters: 

  • allowCreate=[true|false] default is false 
    • If true a new person will be created if a person is not found for the specified URI.  
    • If false an error, 404 Not Found, is returned if a person is not found for the specified URI.
  • getLoginLink=[true|false] default is false

    • If false, just the person is returned as the root element of the JSON object

    • If true, the person is return alongside his login link as the user and access_link elements of the JSON response object.  A person's login link contains a unique, secure token that allows them to log into the CloudCard without entering their username or password.

Code Block
titleExample HTTP Request Body - All fields are optional
{
  "email": "jon.doe@foo.edu",
  "identifier":"ABC123",
  "Some Custom Field":"Some Custom Field Value",
  "Another Custom Field":"Another Custom Field Value"
}


Code Block
titleExample HTTP Response
collapsetrue
201 created

{
     "accountExpired": false,
    "accountLocked": false,
    "activatedDate": null,
    "authorities": [
        {
            "class": "com.campuscardtools.myphotoid.Role",
            "id": 3,
            "authority": "ROLE_CARDHOLDER"
        }
    ],
    "currentPhoto":null, {
        "customFieldsaspectRatio":{ 0.9915966387,
        "Upload Dateclassifications":{ [],
         "classdomainClass": "com.campuscardtools.myphotoid.CustomFieldValuePhoto",

        "id":3541 11982,

        "customFieldisAspectRatioCorrect":{ 
  true,
         "classlinks":"com.campuscardtools.myphotoid.CustomField", {
            "idbytes":34
 "https://test.cloudcardtools.com/api/photos/jflsdkjflf/bytes"
        },
         "lastUpdatedlowestClassification":"2017-06-26T20:00:47Z",
 null,
        "personoriginalPhoto":{ null,
            "classperson":"com {.campuscardtools.myphotoid.Person"},
  
         "idpublicKey":123
         } "jflsdkjflf",
         "valuestatus":"2017 - 06 - 22 11:17AM"
 "DONE"
     },
    "customFields": {
"Last Name":null,       "First Name": {
            "class": "com.campuscardtools.myphotoid.CustomFieldValue",
            "id":3540 11790,
            "customField": {...},
             "classlastUpdated":"com.campuscardtools.myphotoid.CustomField "2018-01-12T18:21:27Z",
            "idperson":31
   {...},
      },          "lastUpdatedvalue":"2017-06-26T20:00:47Z", "Abe Lincoln"
        }
 "person":{   },
    "dateTermsAccepted": null,
    "classdomainClass": "com.campuscardtools.myphotoid.Person",
       "email": "bacon@test.edu",
    "idemailsReceived":123 2,
    "enabled": true,
    "id": }19674,
    "identifier": "bacon",
    "valuelatestPhoto":"Carry A" null,
    "organization": {
 },       "Batchid":{ 38,
         "classdomainClass": "com.campuscardtools.myphotoid.CustomFieldValueOrganization",
        "name": "idTest Univ":3542,

        "customFieldisPaid":{ true,
        "termsOfService": "Lorem ipsum dolor sit  "class":"com.campuscardtools.myphotoid.CustomField",amet, ...",
        "photoRequirements": [],
        "idcustomFields":33 [
            {
      },          "lastUpdatedname":"2017-06-26T20:00:47Z", "Name"
            }
   "person":{     ],
        "classcustomCssUrl":"com.campuscardtools.myphotoid.Person",
  null,
          "iduseEmailAsUsername":123 true,
        "usePersonIdentifier": }true,
         "valuepersonIdentifierLabel": "1ID Number",
      }    "downloadStrategy": {...},
   "dateTermsAccepted":null,     "domainClassaspectRatio":"com {.campuscardtools.myphotoid.Person",},
        "emailpreventMultiplePhotos":"john.doe@foo.edu" false,
        "enabledapprovalsPerDay":true null,
        "idapprovalsMadeToday":123 0,
        "identifiercanApproveMorePhotosToday":"ABC123" true,
        "latestPhotoallowAutoCrop": nullfalse,
        "organizationallowAutoRotate":{ ... false
    },
    "passwordExpired": false,
    "passwordResetRequired": false,
    "readOnly": false,
    "username": "johnbacon@test.doe@foo.edu"
}


Code Block
titleExample HTTP Response (w/ Login Link)
collapsetrue
200 OK
{
    "user": {
        "class": "com.campuscardtools.myphotoid.Person",
        "id": 19674,
        "accountExpired": false,
        "accountLocked": false,
        "activatedDate": null,
        "additionalPhotos": [],
        "customFieldValues": [
            {
                "class": "com.campuscardtools.myphotoid.CustomFieldValue",
                "id": 11790
            }
        ],
        "dateTermsAccepted": null,
        "email": "bacon@test.edu",
        "enabled": true,
        "identifier": "bacon",
        "lastUpdated": "2018-01-16T20:47:44Z",
        "organization": {
            "class": "com.campuscardtools.myphotoid.Organization",
            "id": 38
        },
        "password": "29cDb7jiPtjXG0vEgiRl3Shn",
        "passwordExpired": false,
        "passwordResetRequired": false,
        "photos": [
            {
                "class": "com.campuscardtools.myphotoid.Photo",
                "id": 11982
            }
        ],
        "roles": [
            {
                "class": "com.campuscardtools.myphotoid.PersonRole",
                "id": null
            }
        ],
        "username": "bacon@test.edu"
    },
    "access_link": "https://test.cloudcardtools.com/#/login?access_token=YmFjb25AdGVzdC5lZHUsMjljRGI3amlQdGpYRzB2RWdpUmwzU2hukjflskdjhfkajfewlkrjflsfkndlaf"
}