Page Comparison

Note
The ability to update a person via this endpoint has been deprecated. If you need to update a person, please refer to the Update a Person endpoint.

Info
This Example Project demonstrates how to consume an older version this API endpoint within a Java project.

Info
This Example Project demonstrates how to consume an older version of this API endpoint within a C# project.

URI: https://api.onlinephotosubmission.com/api/people

HTTP Method: POST

Required Headers: X-Auth-Token (see: Authentication)

Optional URL Parameters:

sendInvitation=[true|false] default is true If sendInvitation is false, cardholders will not receive an email invitation.
If sendInvitation is true (or not specified), the user's password will be reset, all previous login links will be deprovisioned, and an email invitation will be sent to the cardholder.
allowUpdate=[true|false] default is false If allowUpdate is true and CloudCard finds a person with the same email address or identifier, CloudCard will update the person with the information contained in this request.
getLoginLink=[true|false] default is false If getLoginLink is true, the user's password will be reset, all previous login links will be deprovisioned, and a new link will be returned in the response.

Info
By default, this request results in an email being sent to the newly created user. If you don't want an email to be sent, you can use the `sendInvitation` url parameter to turn emails off: `https://app.cloudcardtools.com/api/people?sendInvitation=false`(note that `sendInvitation=true` has no effect, as `true` is the default value.

Code Block

title	Example HTTP Request Body - Email Only

{
  "email": "jon.doe@foo.edu"
}

Code Block

title	Example HTTP Request Body - Using option "identifier" field to set ID Number

{
  "email": "jon.doe@foo.edu",
  "identifier":"ABC123"
}

Code Block

title	Example HTTP Request Body - Set the user's custom fields

{
  "email": "jon.doe@foo.edu",
  "identifier":"ABC123",
  "customFields":{ 
    "Last_Name":"Card",
    "First Name":"Carry A",
    "Upload Date":"2017 - 06 - 22 11:17AM",
    "Batch":"1"
  }
}

201 created { "accountExpired":false, "accountLocked":false, "activatedDate":null, "authorities":[ {

Code Block

title	Example Response (w/ getLoginLink=true)

Note

This endpoint should only be used to create a person. If you need to update a person, please refer to the Update a Person endpoint.

Info
This Example Project demonstrates how to consume this API endpoint within a Java project.

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

URI: https://api.cloudcard.us/person

HTTP Method: POST

Required Headers: X-Auth-Token (see: Authentication)

Optional URL Parameters:

sendInvitation=[true|false] default is true
If sendInvitation is false, cardholders will not receive an email invitation.
If sendInvitation is true (or not specified), an email invitation will be sent to the cardholder.

Example HTTP Request Body - Email Only

Code Block

language	json

{
  "email": "jon.doe@foo.edu"
}

Example HTTP Request Body - Setting other optional fields

Code Block

language	json

{
  "email": "jon.doe@foo.edu",
  "identifier":"ABC123",
  "cardholderGroupName":"Online Students",
  "additionalPhotoRequired":true,
  "enabled":true,
  "customFields":{ 
    "Last_Name":"Card",
    "First Name":"Carry A",
    "Upload Date":"2017 - 06 - 22 11:17AM",
    "Batch":"1"
  }
}

Field Descriptions

Include Page

	Person Field Descriptions
	Person Field Descriptions

Example Response (with ?renderResource=true)

201 created or 200 OK { "accountExpired":false, "accountLocked":false, "activatedDate":null, "authorities":[...], "currentPhoto":null, "customFields":{...}, "dateTermsAccepted":null, "domainClass":"com.campuscardtools.myphotoid.Person", "email":"john.doe@foo.edu", "enabled":true,

lastUpdated": "2022-01-31T18:34:57Z",
    "additionalPhotos": null,
    "additionalPhotoRequired": true,
    "quicksightArn": null,
    "preArchiveUsername": null,
    "username": "jonathan+apiexample@cloudcard.us",
    "accountLocked": false,
    "activatedDate": null,
    "enabled": true,
    "email": "jonathan+apiexample@cloudcard.us",
    "domainClass": "us.cloudcard.api.Person",
    "authorities": [
        {
            "authority": "ROLE_CARDHOLDER"
        }
    ],
    "canViewOrganizationList": false,
    "canSwitchOrganizations": false,
    "customFields": {},
    "homeOrganization": {
        "id":

123,

 100133,
        "

identifier

hasDescendents":

"ABC123",

 false,
        "

latestPhoto

descendents":

null

[]
    },
    "links": {
        "login": "https://test-app.onlinephotosubmission.com/#/login?

access

auth_token=

lotsOfRandomLettersAndNumbersLotsOfRandomLettersAndNumbers

bfki4g6mod5t9ff93sl83jokn06jnmddm6obnpb6vbittg7dfjv1dsscki6v1jjn"
    },
    "

organization

email":

{

 "jonathan+apiexample@cloudcard.

.. }

us",
    "identifier": null,
    "username": "jonathan+apiexample@cloudcard.us",
    "readOnly": false,
    "

passwordExpired

restorable": false,
    "

passwordResetRequired

status":

false

 "ACTIVE",
    "

readOnly

additionalPhotos":

false

 {},
    "

username

currentPhoto":

"john.doe@foo.edu" }

Code Block

201 created
{
    "id": 577784,
    "dateCreated": "2022-01-31T18:34:57Z",
    "passwordResetRequired": false,
    "customFieldValues": [],
    "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,
                "domainClass": "us.cloudcard.api.PhotoRequirement"
            },
            {
                "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,
                "classlastUpdated":"com.campuscardtools.myphotoid.Role "2019-04-26T20:30:09Z",
         "id":3,       "organization": {
 "authority":"ROLE_CARDHOLDER"       }    ],    "currentPhoto":null,    "customFieldsid":{ 
100133
     "Upload Date":{           "class":"com.campuscardtools.myphotoid.CustomFieldValue",    },
      "id":3541,          "customFielduniqueName":{ "Look At Camera",
                "classclassifierUrl":"com.campuscardtools.myphotoid.CustomField" null,
                "idhidden":34   false,
      },          "lastUpdated":"2017-06-26T20:00:47Z",
         "person":{requirement": "Eyes should be open and looking at the camera",
                "classversion":"com.campuscardtools.myphotoid.Person", 0,
                "iddomainClass":123 "us.cloudcard.api.PhotoRequirement"
            },
          "value":"2017 - 06{
- 22 11:17AM"       },       "Last Nameid":null 100857,
      "First Name":{ 
         "classlistIndex":"com.campuscardtools.myphotoid.CustomFieldValue", 6,
                "idlastUpdated":3540, "2019-04-26T20:30:09Z",
           "customField":{     "organization": {
       "class":"com.campuscardtools.myphotoid.CustomField",             "id":31 100133
        },          "lastUpdated":"2017-06-26T20:00:47Z",
         "person":{},
                "classuniqueName":"com.campuscardtools.myphotoid.Person "Generic",
                "idclassifierUrl":123
  "https://helper-bot.onlinephotosubmission.com/generic",
       },          "valuehidden":"Carry A"
      },
  true,
    "Batch":{            "classrequirement":"com.campuscardtools.myphotoid.CustomFieldValue",
   "Must be a good photo",
      "id":3542,          "customFieldversion":{ 0,
                "classdomainClass": "comus.campuscardtoolscloudcard.myphotoidapi.CustomField",PhotoRequirement"
            }
   "id":33     ]
    },
    "preArchiveEmail": null,
    "lastUpdatedaccountExpired":"2017-06-26T20:00:47Z" false,
    "roles": null,
    "persondateArchived":{ null,
    "photos": null,
      "classunsubscribe":"com.campuscardtools.myphotoid.Person" false,
       "identifier": null,
    "idemailGroup":123 {
        "id": }108,

        "valueorganization":"1"  {
    }    },    "dateTermsAcceptedid":null, 100133
  "domainClass":"com.campuscardtools.myphotoid.Person",    "email":"john.doe@foo.edu",    "enabled":true},
    "id":123,    "identifierreceivableEmails": "ABC123,empty",
   "latestPhoto": null,     "linksname": {"Default",
        "logindomainClass": "https://app.onlinephotosubmission.com/#/login?access_token=lotsOfRandomLettersAndNumbersLotsOfRandomLettersAndNumbers"us.cloudcard.api.EmailGroup",
    },    "organization":{ ...version": 0
    },
    "passwordExpiredpreArchiveIdentifier":false null,
    "passwordResetRequireddateTermsAccepted":false null,
    "readOnlypasswordExpired": false,
    "username":"john.doe@foo.edu"
}

Excerpt

Creating Login Links

One frequent use case for this endpoint is to create and retrieve login links for a user, so they can be forwarded directly to CloudCard from another application witthout having to login again. This is described on the Single Sign-On page. This process works equally well for new or existing users.

Process

Gather necessary information, (i.e. email, identifier, custom field values).

Submit the following request

Code Block

language	js
title	.../api/people?allowUpdate=true&getLoginLink=true

// for a new cardholder or if you're not sure if it's a new cardholder, send all the cardholder's information
{
	"email": "jack.sparrow@pirates.com",
	"identifier": "180214-01",
	"customFields": {...}
}

// for an existing cardholder, you only need to send email or identifier
{ "identifier": "123456" }

Code Block

title	Example Response (w/ getLoginLink=true)

Note

allowUpdate must be true if you are using this with an existing cardholder because getting a new login link resets the cardholder's password, invalidates all old login links, and creates a new login link for the cardholder.

Any other fields in the request body will update the corresponding values for the cardholder.

Forward the user or display a link to the URL specified in the login.link field.

 null,
    "previouslyApprovedPhoto": null
}

Versions Compared

Old Version 28

New Version Current

Key

Example HTTP Request Body - Setting other optional fields

Field Descriptions

Example Response (with ?renderResource=true)

Creating Login Links

Process