Versions Compared

Key

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

...

Installations using the Shibboleth single sign-on integration for authentication will require an alternate URL/domain to make HTTP(s) requests to the API.

API Response Codes

Here is the list of Response Status Codes the API might return to your Requests.

StatusWhat it means
200The Request was received and executed successfully.
400The Request was received, but contained Bad Data, so was not executed.


Configuring REST Headers

Depending on the desired formatting of the request, there are two headers that can be sent.

...

We currently offer JSON , PHP , and XML output formats.
(PHP returns a serialized array which can be converted back to an array using the unserialize() function)

What a Request Looks like
Anchor
MakingARequest
MakingARequest

...

A basic request looks like this:

...