Versions Compared

Old Version 43

changes.mady.by.user Tony Erskine

Saved on

compared with

New Version Current

changes.mady.by.user April Gray

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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://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
Code Block
languagejson
{
  "email": "jon.doe@foo.edu"
}
title
Example HTTP Request Body - Setting other optional fields
 Code Block
languagejson
{
  "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
...
 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.
 Code Block
titleExample Response
202 ACCEPTED
Headers: 
  Location: https://api.onlinephotosubmission.com/api/people/{id}

...
titleExample Response (with ?renderResource=true)
collapsetrue
...
 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,
        "isPaid": true,
        "downloadLabel": "Download Photos",
        "allowAutoCrop": false,
        "logoutUrl": "",
        "allowAutoRotate": false,
        "allowAutoDenial": false,
        "allowDeprecatedEndpoints": false,
        "maxNumberOfInvitations": 0,
        "photoDimensions": {
            "id": 6,
            "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,
       "canViewOrganizationList "parent": null,
        "allowAutoApproval": false,
        "currentPhototermsOfService": null,
        "customFieldssiteURL": {"",
        "NotesautoArchiveAction": null,
        "daysBetweenInvitations": 14,
        }"lastUpdated": "2022-01-31T18:17:29Z",
        "dateTermsAcceptedbackgroundImage": null,
        "domainClasssendAutomaticFeedback": "com.campuscardtools.myphotoid.Person", false,
        "usePersonIdentifier": true,
        "emailemailDomains": [],
"black.beard@pirates.com",        "autoArchiveStatus": null,
     "emailGroup   "additionalPhotoTypes": [],
        "defaultGroup": {
            "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",
            ": 92name": "Zip File"
        },
        "approvalsMadeToday": 0,
        "hasDescendentsbackgroundReplacementEnabled": false,
        "canApproveMorePhotosToday": true,
        "descendentscustomFields": [],
        "photoRequirements": [
            {
                "id": },100851,
                "idlistIndex": 3858280,
      "identifier          "lastUpdated": "K0001",2019-04-26T20:30:09Z",
                "linksorganization": {
                    "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": 100133
                },
                ": 92,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,
         "name": "Test Org.       "listIndex": 2,
                "lastUpdated": "2019-04-26T20:30:09Z",
        "isPaid": true,        "organization": {
                    "id": 100133
                },
          "termsOfService      "uniqueName": "Color Photo",
                "classifierUrl": null,
                "hidden": false,
                "requirement": "Must be a color photo",
                "version": 0,
          "photoRequirements      "domainClass": ["us.cloudcard..],api.PhotoRequirement"
            },
            {
                "id": 100854,
                "listIndex": 3,
                "lastUpdated"customFields": [: "2019-04-26T20:30:09Z",
                "organization": {
                    "id": 100133
                },
                "nameuniqueName": "NotesNo Accessories",
                "promptclassifierUrl": null,
                "sortOrderhidden": 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": 100133
                },
                "uniqueName": "Face Camera",
                "classifierUrl": null,
                ": 100067hidden": 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",
                "logoutUrl": null,"organization": {
                    "id": 100133
                },
                "uniqueName": "Look At Camera",
         "useEmailAsUsername       "classifierUrl": true,null,
                "usePersonIdentifierhidden": truefalse,
          "personIdentifierLabel      "requirement": "ID Number",Eyes should be open and looking at the camera",
                "version": 0,
                "downloadStrategydomainClass": "us.cloudcard.api.PhotoRequirement"
            },
            {
                "id": 100857,
                "EXTERNALlistIndex": 6,
                "namelastUpdated": "External Application"2019-04-26T20:30:09Z",
                "organization": {
                    "id": 100133
                },
                "uniqueName": "Generic",
                "classifierUrl": "https://helper-bot.onlinephotosubmission.com/generic",
                "hidden": true,
                "downloadLabelrequirement": "Download PhotosMust be a good photo",
          "photoDimensions      "version": {0,
                "width": 200domainClass": "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": 3100133
        },
        "receivableEmails": ",empty",
        "name": "Default",
        "domainClass": "us.cloudcard.api.EmailGroup",
        "version": 0
    },
   }, "preArchiveIdentifier": null,
    "dateTermsAccepted": null,
    "preventMultiplePhotospasswordExpired": false,
    "lastUpdated": "2022-01-31T18:34:57Z",
    "additionalPhotos": null,
    "additionalPhotoRequired": true,
    "approvalsPerDayquicksightArn": 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": {},
    "readOnly"homeOrganization": {
        "id": 100133,
        "hasDescendents": false,
        "unsubscribedescendents": false, []
    },
    "links": {
        "usernamelogin": "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
}