Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejson
{
  "email": "jon.doe@foo.edu",
  "identifier":"ABC123",
  "emailGroupName":"Online Students",
  "additionalPhotoRequired":"true",
  "enabled":true,
  "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.

enabled

(default: true), Must be true for the user to access CloudCard

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

...