URI: https://api.onlinephotosubmission.com/person/{id}
Example URI: https://api.onlinephotosubmission.com/person/123
Example URI: https://api.onlinephotosubmission.com/person/jon.doe@foo.edu?findBy=email
Example URI: https://api.onlinephotosubmission.com/person/A1234567?findBy=identifier
Optional URL Parameters:
findBy=[id|email|identifier](default id)updateRoles=[true|false](default true)
IfupdateRolesistrueor absent, any roles not explicitly granted will be removed
DEPRECATION NOTICE: The old URI https://api.onlinephotosubmission.com/api/people/{id | email | identifier} is now deprecated and will no longer be supported after January 1, 2023.
HTTP Method: PUT
Required Headers: X-Auth-Token (see: Authentication)
Optional URL Parameters: none
Example HTTP Request Body - All fields are optional
{
"email": "jon.doe@foo.edu",
"identifier":"ABC123",
"Some Custom Field Name":"Some Custom Field Value",
"Another Custom Field Name":"Another Custom Field Value",
"ROLE_DIRECTOR":false,
"ROLE_OFFICE":true,
"cardholderGroupName":"Online Students",
"additionalPhotoRequired":true ,
"enabled":true
}
Response
202 ACCEPTED
Field Descriptions
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. |
cardholderGroupName | 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 |
|