Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

URI: https://api.onlinephotosubmission.com/api/people/{id}

Example URI: https://api.onlinephotosubmission.com/api/people/123 
Example URI: https://api.onlinephotosubmission.com/api/people/jon.doe@foo.edu?findBy=email
Example URI: https://api.onlinephotosubmission.com/api/people/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

DEPRECATION NOTICE: Finding a person by email address or identifier (aka Student ID/Employee ID) without specifying the findBy parameter is still supported but has been deprecated, and will no longer be supported on or after April 1, 2019.

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,
  "emailGroupName":"Online Students",
  "additionalPhotoRequired":true ,
  "enabled":true
}
Response
202 ACCEPTED


  • No labels