Access to the API must be achieved through an OAuth flow or by having a user that is logged in to the system (with a session, etc).
\n\nWhen communicating with the API, developers must set a header in the HTTP request to specify which version of the API they want to use:
\n| Header Name | \nValue | \nVersion Accessed | \n
|---|---|---|
'Accept' | \n 'application/vnd.exercises.openstax.v1' | \n v1 | \n
Many of the API specifications provide a related JSON schema. These schemas are based on the standard defined at http://json-schema.org/. A lot of these schemas aren’t overly specific to the actions they are listed under, e.g. they always say that an id is required but that isn’t the case when new data is being posted to a create call.
Users have the following String attributes: username first_name last_name full_name title
\n","version":"v1","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/v1/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"Return a set of Users matching query terms","deprecated":null}],"formats":null,"full_description":"\nAccepts a query string along with options and returns a JSON representation of the matching Users. Some User data may be filtered out depending on the caller’s status and privileges in the system. The schema for the returned JSON result is shown below.
\n\n\n{\n \"type\": \"object\",\n \"required\": [\n \"total_count\",\n \"items\"\n ],\n \"properties\": {\n \"total_count\": {\n \"type\": \"integer\",\n \"description\": \"The number of accounts matching the query; can be more than the number returned\"\n },\n \"items\": {\n \"type\": \"array\",\n \"description\": \"The accounts matching the query or a subset thereof when paginating\",\n \"items\": {}\n }\n },\n \"additionalProperties\": false\n}\n","errors":[],"params":[{"name":"q","full_name":"q","description":"\nThe search query string, built up as a space-separated collection of search conditions on different fields. Each condition is formatted as “field_name:comma-separated-values”. The resulting list of users will match all of the conditions (boolean ‘and’). Each condition will produce a list of users where those users must match any of the comma-separated-values (boolean ‘or’). The fields_names and their characteristics are given below. When a field is listed as using wildcard matching, it means that any fields that start with a comma-separated-value will be matched.
\n\nusername – Matches usernames, case insensitive. (uses wildcard matching)first_name – Matches users’ first names, case insensitive. (uses wildcard matching)last_name – Matches users’ last names, case insensitive. (uses wildcard matching)name – Matches users’ first, last, or full names, case insenstive. (uses wildcard matching)id – Matches users’ IDs exactly.email – Matches users’ emails exactly.You can also add search terms without prefixes, separated by spaces. These terms will be searched for in all of the prefix categories. Any matching users will be returned. When combined with prefixed search terms, the final results will contain users matching any of the non prefixed terms and all of the prefixed terms.
\n\nExamples:
\n\nusername:ric – returns ‘richb’ and ‘ricardo’ users.
username:ric name:"Van Buren" – returns the ‘Ricardo Van Buren’ user.
ric – returns ‘richb’, ‘ricardo’, and ‘Jimmy Rich’ users.
A string that indicates how to sort the results of the query. The string is a comma-separated list of fields with an optional sort direction. The sort will be performed in the order the fields are given. The fields can be one of username, first_name, last_name, full_name, id, created_at. Sort directions can either be ASC for an ascending sort, or DESC for a descending sort. If not provided, an ascending sort is assumed. Sort directions should be separated from the fields by a space. (default: username ASC)
Example:
\n\nlast_name, username DESC – sorts by last name ascending, then by username descending
Gets the current user’s profile.
\n\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\"\n },\n \"username\": {\n \"type\": \"string\"\n },\n \"first_name\": {\n \"type\": \"string\"\n },\n \"last_name\": {\n \"type\": \"string\"\n },\n \"full_name\": {\n \"type\": \"string\"\n },\n \"title\": {\n \"type\": \"string\"\n },\n \"faculty_status\": {\n \"type\": \"string\"\n },\n \"self_reported_role\": {\n \"type\": \"string\"\n },\n \"uuid\": {\n \"type\": \"string\"\n },\n \"support_identifier\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": false\n}\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/users/update","name":"update","apis":[{"api_url":"/api/user","http_method":"PATCH","short_description":"Updates the current user's profile","deprecated":null}],"formats":null,"full_description":"\nUpdates the current user’s profile.
\n\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"first_name\": {\n \"type\": \"string\"\n },\n \"last_name\": {\n \"type\": \"string\"\n },\n \"full_name\": {\n \"type\": \"string\"\n },\n \"title\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": false\n}\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/v1/users/destroy","name":"destroy","apis":[{"api_url":"/api/user","http_method":"DELETE","short_description":"Disables the current user's account","deprecated":null}],"formats":null,"full_description":"\nDisables the current user’s account.
\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}]}}