Page Comparison

Warning
As of Jan 2019, this endpoint is undergoing some significant performance improvements and is likely to change, so please contact support@onlinephotosubmission.com for more information.

Note
This endpoint should only be used to create a person. 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.

...

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

title

Code Block

language	json

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

Code Block

Example HTTP Request Body -

...

Setting other optional fields

Code Block

language	json

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

Code Block

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

{,
  "emailcardholderGroupName":"Online Students"jon.doe@foo.edu",
  "identifieradditionalPhotoRequired":true,
  "ABC123enabled":true,
  "customFields":{ 
    "Last_Name":"Card",
    "First Name":"Carry A",
    "Upload Date":"2017 - 06 - 22 11:17AM",
    "Batch":"1"
  }
}

Info
Because this endpoint is currently being improved, we've included the examples of both the current HTTP response and the proposed HTTP response. Please, be aware this could change in the near future; and contact support if you have more questions.

...

title	Current Response (Likely to Change Soon)
collapse	true

...

Field Descriptions

Include Page

	Person Field Descriptions
	Person Field Descriptions

Example Response (with ?renderResource=true)

Code Block

201 created
{
    "id": 577784,
    "dateCreated": "2022-01-31T18:34:57Z",
    "passwordResetRequired": false,
    "customFieldValues": [],
    "organization": {
        "id": 100133,
        "accountExpired":false,"isPaid": true,
        "downloadLabel": "Download Photos",
        "allowAutoCrop": false,
        "logoutUrl": "",
        "accountLocked"allowAutoRotate": false,
        "allowAutoDenial": false,
        "activatedDateallowDeprecatedEndpoints":null false,
        "authoritiesmaxNumberOfInvitations":[ 0,
        "photoDimensions": {
          "class":"com.campuscardtools.myphotoid.Role",  "id": 6,
            "width": 300,
            "height": 300,
            "description": "300:300 (1:1)",
            "domainClass": "us.cloudcard.api.PhotoDimensions",
            "version": 0,
            "idvalue":3, 1.0,
            "authoritylongSide":"ROLE_CARDHOLDER" 300,
            "shortSide": 300
        },
        "name": "Postman Test",
        "badPhotoThreshold": 0.4,
        "helpScoutBeacons": [],
        "currentPhoto":null,
   "customFields":{"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": {
            "Upload Date":{"id": 108,
            "organization": {
                "id": 100133
            "class":"com.campuscardtools.myphotoid.CustomFieldValue",},
            "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":3541, "ZIP",
            "name": "Zip "customField":{File"
        },
        "approvalsMadeToday": 0,
        "backgroundReplacementEnabled": false,
        "classcanApproveMorePhotosToday":"com.campuscardtools.myphotoid.CustomField", true,
        "customFields": [],
        "photoRequirements": [
            {
                "id":34 100851,
                "listIndex": },0,
                "lastUpdated": "20172019-0604-26T20:0030:47Z09Z",
                "personorganization": {
                    "id": 100133
                },
                "uniqueName": "Crop",
                "classifierUrl": null,
                "hidden": false,
                "requirement": "Should be cropped slightly above head to middle of chest",
"class":"com.campuscardtools.myphotoid.Person",                "version": 0,
                "domainClass": "us.cloudcard.api.PhotoRequirement"
            },
            {
                "id":123 100852,
                "listIndex": },1,
                "lastUpdated"value":"2017 - 06 - 22 11:17AM": "2019-04-26T20:30:09Z",
                "organization": {
                    "id": 100133
                },
                "uniqueName": "Plain "Last Name":null,Background",
                "classifierUrl": null,
                "First Name":{"hidden": false,
                "requirement": "Should be taken against a plain, light background",
                "version": 0,
                "classdomainClass": "comus.campuscardtoolscloudcard.myphotoidapi.CustomFieldValue",PhotoRequirement"
            },
            {
                "id": 100853,
                ":3540,listIndex": 2,
                "lastUpdated": "2019-04-26T20:30:09Z",
                "customFieldorganization": {
                    "id": 100133
                },
                "uniqueName": "Color Photo",
             "class":"com.campuscardtools.myphotoid.CustomField"   "classifierUrl": null,
                "hidden": false,
                "requirement": "Must be a color photo",
                "version": 0,
                "domainClass": "us.cloudcard.api.PhotoRequirement"
            },
            {
                "id":31 100854,
                "listIndex": },3,
                "lastUpdated": "20172019-0604-26T20:0030:47Z09Z",
                "personorganization": {
                    "id": 100133
                },
                "uniqueName": "No Accessories",
       "class":"com.campuscardtools.myphotoid.Person",
           "classifierUrl": null,
                "hidden": false,
                "requirement": "Must not include sunglasses or hat",
                "version": 0,
                "domainClass": "us.cloudcard.api.PhotoRequirement"
            },
            {
                "id":123 100855,
                "listIndex": },4,
                "value":"Carry A"lastUpdated": "2019-04-26T20:30:09Z",
                "organization": {
                    "id": 100133
                },
                "BatchuniqueName":{ "Face Camera",
                "classclassifierUrl":"com.campuscardtools.myphotoid.CustomFieldValue", null,
                "hidden": false,
                "idrequirement":3542, "Must be positioned directly facing the camera",
                "customFieldversion":{ 0,
                "classdomainClass": "comus.campuscardtoolscloudcard.myphotoidapi.CustomField",PhotoRequirement"
            },
            {
                "id":33 100856,
                "listIndex": },5,
                "lastUpdated": "20172019-0604-26T20:0030:47Z09Z",
                "personorganization": {
                    "id": 100133
                },
                "uniqueName": "Look At "class":"com.campuscardtools.myphotoid.Person",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":123 100133
                },
                "uniqueName": "value":"1""Generic",
                "classifierUrl": "https://helper-bot.onlinephotosubmission.com/generic",
                "hidden": true,
                 }
   }"requirement": "Must be a good photo",
   "dateTermsAccepted":null,             "version": 0,
                "domainClass": "comus.campuscardtoolscloudcard.myphotoidapi.Person",PhotoRequirement"
            }
        ]
    },
    "emailpreArchiveEmail":"john.doe@foo.edu", null,
    "accountExpired": false,
    "enabledroles":true null,
    "iddateArchived":123 null,
    "identifierphotos":"ABC123", null,
    "unsubscribe": false,
    "latestPhotoidentifier": null,
    "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:34:57Z",
    "passwordResetRequired":false,"additionalPhotos": null,
    "additionalPhotoRequired": true,
    "quicksightArn": null,
    "readOnlypreArchiveUsername":false null,
    "username": "john.doe@foo.edu"
}

Code Block

title	Proposed Response (Not Currently in Production)

202 ACCEPTED
Headers: 
  Location: https://api.onlinephotosubmission.com/api/people/123
{
  "id":123,
  "urijonathan+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": 100133,
        "hasDescendents": false,
        "descendents": []
    },
    "links": {
        "login": "https://apitest-app.onlinephotosubmission.com/api/people/123"#/login?auth_token=bfki4g6mod5t9ff93sl83jokn06jnmddm6obnpb6vbittg7dfjv1dsscki6v1jjn"
    },
    "email": "jonathan+apiexample@cloudcard.us",
    "identifier": null,
    "username": "jonathan+apiexample@cloudcard.us",
    "readOnly": false,
    "restorable": false,
    "status": "ACTIVE",
    "additionalPhotos": {},
    "currentPhoto": null,
    "previouslyApprovedPhoto": null
}

Versions Compared

Old Version 39

New Version Current

Key

Example HTTP Request Body -

Setting other optional fields

Field Descriptions

Example Response (with ?renderResource=true)