Versions Compared

Key

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

...

For example:

If the user agent wishes to send the user-id "Aladdin" and password "open sesame," it would use the following header field:

      Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQXXXXXXXXXXXXXXXXXX==

Response Codes

...

  • 200 - When the request was successful and there is a body to be returned

  • 204 - When the request was successful but there is no body to be returned 

  • 401 - The user is unauthorized to call the API

  • 403 - The user is authorized to call the API but does not have access to this resource.

  • 404 - The requested resource was not found.

    • This should not be used for operations where multiple results are expected such as a list or search. In this case an empty array or excluding the result from the array is the desired behavior.

  • 429 - rate limit exceeded.

  • 500 - An unexpected error occurred.