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 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.

...

Code Block

title	Example HTTP Request Body - Using option "identifier" field to set ID NumberSetting other optional fields

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

Code Block

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

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

Field	Description
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.

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

title	Current Example Response (Likely to Change Soonwith ?renderResource=true)
collapse	true

201 created
{
     "accountExpired": false,
    "accountLocked": false,
    "activatedDate": null,
    "additionalPhotoRequired": true,
    "additionalPhotos": {},
    "authorities": [
        {
            "classauthority":"com.campuscardtools.myphotoid.Role "ROLE_CARDHOLDER",
            "id": 3,
            "authorityversion":"ROLE_CARDHOLDER" 0
        }
    ],
    "canSwitchOrganizations": false,
    "canViewOrganizationList": false,
    "currentPhoto": null,
    "customFields": {
        "Upload DateNotes":{ null
    },
    "dateTermsAccepted": null,
    "classdomainClass": "com.campuscardtools.myphotoid.CustomFieldValuePerson",
    "email": "black.beard@pirates.com",
    "idemailGroup":3541, {
        "customFieldid":{ 23,
        "name": "Default",
        "classreceivableEmails":"com.campuscardtools.myphotoid.CustomField" "login,approval,denial,BAD,GOOD,MAYBE,welcome"
    },
    "enabled": true,
    "homeOrganization": {
        "id": 92,
        ":34hasDescendents": false,
        "descendents": []
    },
    "id": 385828,
    "lastUpdatedidentifier":"2017-06-26T20:00:47Z",
 "K0001",
    "links": {
        "login": null
    },
    "personorganization": {
        "id": 92,
        "classdomainClass": "com.campuscardtools.myphotoid.PersonOrganization",
        "name": "Test Org.",
 "id       "isPaid":123 true,
        }"termsOfService": "null",
         "valuephotoRequirements":"2017 - 06 - 22 11:17AM" [...],
        "customFields": [
  },       "Last Name":null,  {
    "First Name":{           "classname":"com.campuscardtools.myphotoid.CustomFieldValue", "Notes",
                "idprompt":3540 null,
                "customFieldsortOrder":{ 1,
                "classshowInList":"com.campuscardtools.myphotoid.CustomField", true,
                "idallowUserInput":31 false,
                "requireUserInput": }false,
                "lastUpdated": "20172018-0612-26T2018T21:0005:47Z18Z",
                "personid":{ 100067,
                "classversion":"com.campuscardtools.myphotoid.Person",
 0
           "id":123 }
        }],

        "valuecustomCssUrl":"Carry A" "https://sharptopco.github.io/cloudcard-custom-assets/blankcssfile.css",
        "logoutUrl": }null,
        "BatchuseEmailAsUsername":{ 
true,
        "classusePersonIdentifier":"com.campuscardtools.myphotoid.CustomFieldValue" true,
        "personIdentifierLabel": "idID Number":3542,
         "customFielddownloadStrategy": { 
            "classid":"com.campuscardtools.myphotoid.CustomField "EXTERNAL",
            "idname":33 "External Application"
        },
         "lastUpdateddownloadLabel":"2017-06-26T20:00:47Z "Download Photos",
         "personphotoDimensions": {
             "classwidth":"com.campuscardtools.myphotoid.Person" 200,
            "height": 200,
            "description"id":123: "200:200 (1:1)",
            },"id": 3,
            "valueversion":"1" 0
        },
   },     "dateTermsAcceptedpreventMultiplePhotos":null false,
        "domainClassapprovalsPerDay":"com.campuscardtools.myphotoid.Person" 0,
        "emailapprovalsMadeToday":"john.doe@foo.edu", 0,
        "enabledcanApproveMorePhotosToday": true,
    "id":123,    "identifieremailReplyTo":"ABC123 "Hello From CloudCard <hello@cloudcardtools.com>",
   "latestPhoto": null,    "organizationhelperBotDelay":{ ... 1000
    },
    "passwordExpired": false,
    "passwordResetRequired": false,
    "readOnly": false,
    "unsubscribe": false,
    "username": "johnblack.doe@foobeard@pirates.educom"
}

Code Block

title	Proposed Response (Not Currently in Production)Example Response

202 ACCEPTED
Headers: 
  Location: https://api.onlinephotosubmission.com/api/people/123
{
  "id":123,
  "uri": "https://api.onlinephotosubmission.com/api/people/123"
}id}

Versions Compared

Old Version 39

New Version 40

Key