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 5 Next »

This request can return a large amount of data (> 10 MB).

This endpoint returns a lightweight report of all people in your organization.

URI: https://api.onlinephotosubmission.com/api/reports/people

Example URI: https://api.onlinephotosubmission.com/api/reports/people

Example URI: https://api.onlinephotosubmission.com/api/reports/people?include=3,4,5,username2@your-org.com,AB123

Optional URL Parameters: include={value}[{value},{value},{value}]

The optional include instructs the report to only include people whose database ID, email address, or customer identifier (i.e. Student ID Number) match a value in the list of comma separated values. See above example.

HTTP Method: GET

Required Headers: X-Auth-Token (see: Authentication)

Example HTTP Request Body
[Leave Empty]
Example Response
200 OK
[
    {
        "id": 3
		"email": "username@your-org.com",
        "identifier": "123456",
		"enabled": true,
        "First_Name": "John",
        "Last_Name": "Doe",
        "Campus": "Eastside"
    },
    {
        "id": 42
        "email": "username2@your-org.com",
        "identifier": "234567",
		"enabled": false,
        "First_Name": "Jane",
        "Last_Name": "Doe",
        "Campus": "Westside"
    },
    {
        "id": 14
        "email": "username3@your-org.com",
        "identifier": "AB123",
		"enabled": true,
        "First_Name": "Bob",
        "Last_Name": "Ross",
        "Campus": "PBS"
    }
    ...
]
  • No labels