Page Comparison

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 this API endpoint within a Java project.

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

URI: https https://api.onlinephotosubmissioncloudcard.com/api/people us/person

HTTP Method: POST

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

...

Code Block

language	json

{
  "email": "jon.doe@foo.edu",
  "identifier":"ABC123",
  "emailGroupNamecardholderGroupName":"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

...

Example Response

Code Block
202 ACCEPTED Headers: Location: https://api.onlinephotosubmission.com/api/people/{id}

Example Response (with ?renderResource=true)

...

Include Page

...

email

...

The cardholders' email address. Also used as the username

...

identifier

...

The organization's unique identifier for the cardholder, i.e. student ID or employee ID.

...

emailGroupName

...

The email recipient group into which the cardholder should be place

...

additionalPhotoRequired

...

If true, the cardholder is required to submit all supplemental documents defined for that organization, i.e. government issued ID, signature, etc.

...

custom fields

...

A map of key value pairs. The keys are the names of the custom fields. The values are the custom field values for this cardholder.

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,
        "isPaid": true,
        "downloadLabel": "Download Photos",
        "allowAutoCrop": false,
        "logoutUrl": "",
        "allowAutoRotate": false,
        "accountLockedallowAutoDenial": false,
        "activatedDateallowDeprecatedEndpoints": nullfalse,
        "additionalPhotoRequiredmaxNumberOfInvitations": true0,
        "additionalPhotosphotoDimensions": {}
            "id": 6,
    "authorities": [        "width": 300,
            {"height": 300,
            "authoritydescription": "ROLE_CARDHOLDER300:300 (1:1)",
            "iddomainClass": 3"us.cloudcard.api.PhotoDimensions",
            "version": 0,
            "value": 1.0,
            "longSide": 300,
            "shortSide": 300
        },
        "name": "Postman Test",
        "badPhotoThreshold": 0.4,
        "helpScoutBeacons": [],
        "canSwitchOrganizationsallowAutoBackgroundReplacement": false,
        "sendEmailFrom": "Online Photo Submission <sent.from.customer@onlinephotosubmission.com>",
        "identifier": null,
        "emailReplyTo": null,
        "approvalsPerDay": 10,
        "expirationDate": null,
        "backgroundColor": null,
        "parent": null,
        "canViewOrganizationListallowAutoApproval": false,
        "currentPhototermsOfService": null,
        "customFieldssiteURL": {"",
        "NotesautoArchiveAction": null,
        }"daysBetweenInvitations": 14,
        "lastUpdated": "2022-01-31T18:17:29Z",
        "dateTermsAcceptedbackgroundImage": null,
    "domainClass    "sendAutomaticFeedback": false,
        "usePersonIdentifier": "com.campuscardtools.myphotoid.Person",true,
        "emailDomains": [],
        "emailautoArchiveStatus": "black.beard@pirates.com"null,
        "additionalPhotoTypes": [],
        "emailGroupdefaultGroup": {
            "id": 23108,
            "nameorganization": {
      "Default"          "id": 100133
            },
            "receivableEmails": ",empty"login,approval,denial,BAD,GOOD,MAYBE,welcome"
    },,
            "name": "Default",
            "domainClass": "us.cloudcard.api.EmailGroup",
            "version": 0
        },
        "goodPhotoThreshold": 0.8,
        "personIdentifierLabel": "ID Number",
        "preventMultiplePhotos": false,
        "customCssUrl": "",
        "enableduseEmailAsUsername": true,
    "homeOrganization    "helperBotDelay": 600000,
        "downloadStrategy": {
            "id": "ZIP",
            "name": "Zip File"
        },
        "approvalsMadeToday": 920,
        "hasDescendentsbackgroundReplacementEnabled": false,
        "descendentscanApproveMorePhotosToday": true,
        "customFields": [],
        "photoRequirements": [
            {
             },   "id": 100851,
                "idlistIndex": 3858280,
       "identifier         "lastUpdated": "K00012019-04-26T20:30:09Z",
    "links            "organization": {
        "login": null
                "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": 92,": 100133
                },
                "uniqueName": "Plain Background",
                "classifierUrl": null,
                "hidden": false,
                "requirement": "Should be taken against a plain, light background",
                "version": 0,
                "domainClass": "comus.campuscardtoolscloudcard.myphotoid.Organization",api.PhotoRequirement"
            },
            {
                "id": 100853,
                "namelistIndex": 2,
"Test Org.",
                "lastUpdated": "2019-04-26T20:30:09Z",
                "organization": {
       "isPaid": true             "id": 100133
                },
        "termsOfService": "null",        "uniqueName": "Color Photo",
                "classifierUrl": null,
                "hidden": false,
                "requirement": "Must be a color photo",
                "version": 0,
                "photoRequirementsdomainClass": ["us.cloudcard..],api.PhotoRequirement"
            },
            {
                "id": 100854,
                "listIndex": 3,
                "customFieldslastUpdated": ["2019-04-26T20:30:09Z",
                "organization": {
                "name    "id": 100133
                },
                "uniqueName": "NotesNo Accessories",
                "promptclassifierUrl": null,
                "sortOrder"hidden": false,
                "requirement": "Must not include sunglasses or hat",
                "version": 10,
                "showInListdomainClass": true,"us.cloudcard.api.PhotoRequirement"
            },
            {
                "allowUserInputid": false100855,
                "requireUserInputlistIndex": false4,
                "lastUpdated": "20182019-1204-18T2126T20:0530:18Z09Z",
                "organization": {
                    "id": 100067 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,
                "customCssUrllistIndex": 5,
  "https://sharptopco.github.io/cloudcard-custom-assets/blankcssfile.css",              "lastUpdated": "2019-04-26T20:30:09Z",
                "organization": {
                    "id": 100133
                },
                "logoutUrluniqueName": null,"Look At Camera",
                "useEmailAsUsernameclassifierUrl": true,null,
                "usePersonIdentifierhidden": true,false,
                "personIdentifierLabelrequirement": "ID Number",Eyes should be open and looking at the camera",
                "version": 0,
          "downloadStrategy": {      "domainClass": "us.cloudcard.api.PhotoRequirement"
            },
            {
                "id": 100857,
  "EXTERNAL"              "listIndex": 6,
                "namelastUpdated": "2019-04-26T20:30:09Z",
                "External Application""organization": {
                    "id": 100133
                },
                "uniqueName": "Generic",
                "classifierUrl": "https://helper-bot.onlinephotosubmission.com/generic",
                "hidden": true,
                "downloadLabelrequirement": "Download PhotosMust be a good photo",
        "photoDimensions": {        "version": 0,
                "widthdomainClass": 200 "us.cloudcard.api.PhotoRequirement"
            }
        ]
    },
    "preArchiveEmail": null,
    "accountExpired": false,
    "heightroles": 200null,
    "dateArchived": null,
    "photos": null,
    "descriptionunsubscribe": false,
    "identifier"200:200 (1:1)": null,
    "emailGroup": {
        "id": 108,
        "organization": {
            "id": 100133
        },
        "receivableEmails": ",empty",
        "name": 3"Default",
        "domainClass": "us.cloudcard.api.EmailGroup",
        "version": 0
    },
    "preArchiveIdentifier": }null,
    "dateTermsAccepted": null,
    "preventMultiplePhotospasswordExpired": false,
    "lastUpdated": "2022-01-31T18:34:57Z",
    "additionalPhotos": null,
   "approvalsPerDay "additionalPhotoRequired": true,
    "quicksightArn": 0null,
    "preArchiveUsername": null,
    "approvalsMadeTodayusername": 0,"jonathan+apiexample@cloudcard.us",
    "accountLocked": false,
    "canApproveMorePhotosTodayactivatedDate": truenull,
    "enabled": true,
    "emailReplyToemail": "Hello From CloudCard <hello@cloudcardtools.com>"jonathan+apiexample@cloudcard.us",
    "domainClass": "us.cloudcard.api.Person",
    "authorities": [
        "helperBotDelay": 1000{
            "authority": "ROLE_CARDHOLDER"
        }
    ],
    "passwordExpiredcanViewOrganizationList": false,
    "passwordResetRequiredcanSwitchOrganizations": false,
    "customFields": {},
    "homeOrganization": {
        "id": 100133,
        "readOnlyhasDescendents": false,
        "unsubscribedescendents": false []
    },
    "usernamelinks": {
        "login": "black.beard@pirates.com"https://test-app.onlinephotosubmission.com/#/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 44

New Version Current

Key

Field Descriptions

Example Response

Example Response (with ?renderResource=true)

Example Response (with ?renderResource=true)