Versions Compared

Key

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

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)
    If updateRoles is true or absent, any roles not explicitly granted will be removed

Note

DEPRECATION NOTICE: The URI https://api.onlinephotosubmission.com/api/people/{id | email | identifier} is now deprecated and will no longer be supported after October 1, 2022.

HTTP Method: PUT
Required Headers: X-Auth-Token (see: Authentication)
Optional URL Parameters: none

Example HTTP Request Body - All fields are optional
Code Block
languagejson
{
  "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,
  "emailGroupName":"Online Students",
  "additionalPhotoRequired":true ,
  "enabled":true
}
Response
Code Block
202 ACCEPTED

Field Descriptions
Include Page
Person Field Descriptions
Person Field Descriptions