Note |
---|
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 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:
, the user's password will be reset, all previous login links will be deprovisionedsendInvitation=[true|false]
default istrue
IfsendInvitation
isfalse
, cardholders will not receive an email invitation.
IfsendInvitation
istrue
(or not specified),
andan email invitation will be sent to the cardholder
.
...
.
...
Example HTTP Request Body - Email Only
Code Block | ||
---|---|---|
| ||
{ "email": "jon.doe@foo.edu" } | ||
Code Block | ||
Example HTTP Request Body -
...
Setting other optional fields
Code Block | ||
---|---|---|
| ||
{
"email": "jon.doe@foo.edu",
"identifier":"ABC123"
} | ||
Code Block | ||
| ||
{, "emailcardholderGroupName": "jon.doe@foo.edu"Online Students", "identifieradditionalPhotoRequired":true, "ABC123enabled":true, "customFields":{ "Last_Name":"Card", "First Name":"Carry A", "Upload Date":"2017 - 06 - 22 11:17AM", "Batch":"1" } } |
Field Descriptions
Include Page | ||||
---|---|---|---|---|
|
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, "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, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "Look At 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": 100133 }, "uniqueName": "Generic", "classifierUrl": "https://helper-bot.onlinephotosubmission.com/generic", "hidden": true, "requirement": "Must be a good photo", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" } ] }, "preArchiveEmail": null, "accountExpired": false, "roles": null, "dateArchived": null, "photos": null, "unsubscribe": false, "identifier": 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", "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": 100133, "hasDescendents": false, "descendents": [] }, "links": { "login": "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 } |