| 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:
...
sendInvitation=[true|false]default istrue
IfsendInvitationisfalse, cardholders will not receive an email invitation.
IfsendInvitationistrue(or not specified), an 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" } } | ||
| Code Block | ||
Field Descriptions
| Include Page | ||||
|---|---|---|---|---|
|
Example Response (with ?renderResource=true)
| Code Block |
|---|
201 created
{
"id": 577784,
"dateCreated": "2022-01-31T18:34:57Z",
"accountExpired":false,
"accountLocked":false, "passwordResetRequired": false,
"customFieldValues": [],
"organization": {
"id": 100133,
"isPaid": true,
"downloadLabel": "Download Photos",
"allowAutoCrop": false,
"logoutUrl": "",
"allowAutoRotate": false,
"allowAutoDenial": false,
"activatedDateallowDeprecatedEndpoints":null, false,
"authoritiesmaxNumberOfInvitations":[ 0,
"photoDimensions": {
"id": 6,
"width": 300,
"height": 300,
"description": "300:300 (1:1)",
"class "domainClass": "comus.campuscardtoolscloudcard.myphotoid.Role",api.PhotoDimensions",
"version": 0,
"idvalue":3, 1.0,
"authoritylongSide":"ROLE_CARDHOLDER" 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": [],
"currentPhotoautoArchiveStatus": null,
"customFields"additionalPhotoTypes": [],
"defaultGroup": {
"Upload Date":{"id": 108,
"organization": {
"class":"com.campuscardtools.myphotoid.CustomFieldValue",
"id":3541,
"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"
},
"customFieldapprovalsMadeToday":{ 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",
"version": 0,
"classdomainClass": "comus.campuscardtoolscloudcard.myphotoidapi.Person",PhotoRequirement"
},
{
"id":123 100852,
"listIndex": },1,
"valuelastUpdated":"2017 - 06 - 22 11:17AM" "2019-04-26T20:30:09Z",
"organization": {
"id": 100133
},
"uniqueName": "Plain "Last Name":null,Background",
"classifierUrl": null,
"hidden": false,
"First Name":{"requirement": "Should be taken against a plain, light background",
"version": 0,
"classdomainClass": "comus.campuscardtoolscloudcard.myphotoidapi.CustomFieldValue",PhotoRequirement"
},
{
"id": 100853,
"listIndex":3540,: 2,
"lastUpdated": "2019-04-26T20:30:09Z",
"customFieldorganization": {
"class":"com.campuscardtools.myphotoid.CustomField", "id": 100133
},
"uniqueName": "Color Photo",
"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",
"classifierUrl": null,
"hidden": false,
"requirement": "Must not include sunglasses or hat",
"version": 0,
"classdomainClass": "comus.campuscardtoolscloudcard.myphotoid.Person",api.PhotoRequirement"
},
{
"id": 100855,
"listIndex": 4,
"lastUpdated": "2019-04-26T20:30:09Z",
"organization": {
"id":123 100133
},
"uniqueName": "Face Camera",
"valueclassifierUrl":"Carry A"
}, null,
"hidden": false,
"requirement": "Must be positioned directly facing the camera",
"Batch":{ "version": 0,
"classdomainClass": "comus.campuscardtoolscloudcard.myphotoidapi.CustomFieldValue",PhotoRequirement"
},
{
"id": 100856,
"listIndex": 5,
"lastUpdated": ":3542,2019-04-26T20:30:09Z",
"customFieldorganization": {
"id": 100133
},
"uniqueName": "Look At Camera",
"classifierUrl": null,
"hidden": false,
"requirement": "Eyes should be open and looking at the camera",
"version": 0,
"classdomainClass": "comus.campuscardtoolscloudcard.myphotoidapi.CustomField",PhotoRequirement"
},
{
"id":33 100857,
"listIndex": },6,
"lastUpdated": "20172019-0604-26T20:0030:47Z09Z",
"personorganization": {
"id": 100133
},
"uniqueName": "Generic",
"classclassifierUrl": "https://helper-bot.onlinephotosubmission.com.campuscardtools.myphotoid.Person",
/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":123 100133
},
"receivableEmails": ",empty",
"name": "value"Default",
"domainClass":"1" "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": "comus.campuscardtoolscloudcard.myphotoidapi.Person",
"authorities": [
{
"emailauthority":"john.doe@foo.edu", "ROLE_CARDHOLDER"
}
],
"canViewOrganizationList": false,
"enabledcanSwitchOrganizations":true false,
"idcustomFields":123, {},
"homeOrganization": {
"identifierid":"ABC123", 100133,
"hasDescendents": false,
"latestPhotodescendents": null []
},
"organizationlinks": {
"login": "https://test-app.onlinephotosubmission.com/#/login?auth_token=bfki4g6mod5t9ff93sl83jokn06jnmddm6obnpb6vbittg7dfjv1dsscki6v1jjn"
},
"email": "jonathan+apiexample@cloudcard. },us",
"identifier": null,
"username": "jonathan+apiexample@cloudcard.us",
"passwordExpiredreadOnly": false,
"passwordResetRequiredrestorable": false,
"status": "ACTIVE",
"readOnlyadditionalPhotos":false {},
"usernamecurrentPhoto":"john.doe@foo.edu" null,
"previouslyApprovedPhoto": null
} |