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.
URI: https://api.onlinephotosubmission.com/api/people
HTTP Method: POST
Required Headers: X-Auth-Token (see: Authentication)
Optional URL Parameters:
sendInvitation=[true|false]default istrue
IfsendInvitationis 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
{
"email": "jon.doe@foo.edu"
}
Example HTTP Request Body - Setting other optional fields
{
"email": "jon.doe@foo.edu",
"identifier":"ABC123",
"emailGroupName":"Online Students",
"additionalPhotoRequired":"true",
"customFields":{
"Last_Name":"Card",
"First Name":"Carry A",
"Upload Date":"2017 - 06 - 22 11:17AM",
"Batch":"1"
}
}
| Field | Description |
|---|---|
| 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. |
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.
Example Response
202 ACCEPTED
Headers:
Location: https://api.onlinephotosubmission.com/api/people/{id}