Understanding the Badge API document structure

The Badge API reference documents for the Badge app single sign-on API and the PACS API follow this basic structure.

The introduction contains the title of the resource, and a brief description.

Request format

HTTP method

The method used to perform the action, such as GET, POST, and the like.

HTTP header

The type of content used by the method.

Resource URL

The URL, including all the parameters.

Parameters

A table listing the parameters used in the Resource URL.

Parameter	Required?	Description
The name of the parameter used	Whether the parameter is required or optional	A description of the parameter

Request body

Defines the structure of the JSON object that the user of the API needs to pass into the call of the method. GET methods do not have a request body. Many POST methods also do not have a request body.

Response format

Response header

The type of content used by the method.

Response body

Defines the structure of the JSON object to be returned.

Example

Example request

An example of the method request, if applicable.

Example response

An example of the method response, if applicable.