Catalog of Web Services description 

Online Catalog of Web services is common place where API documentation is located.

In this framework you can read, copy and test various methods and adjust them for your needs.

1. Header

The Header of a single PANTHEON API example contains information about which operation method is being used, API endpoint relative to the base URL, description of an action shown and working example of a query:

1. Operation methods used
2. Endpoint
3. Description
4. Example of a query

Operation methods in PANTHEON API:

2. Parameters

In the Parameters an example of a query without values is shown.

By selecting the button Try it out, query editor is opened and you can prepare your own queries.

After the data or query is entered you can execute the method, by selecting the Execute button. If you want to escape the editor, select the Cancel button.

2.1 Parameters field

In some API’s the data can be also entered in Parameters field:

2.1.1 Input field

In the parameter field Ident, you can enter your item.

2.1.2 Request body

In the Request body you can enter your query or edit the one given as an example.

3. Responses

In the Responses the results are shown after the query is executed.

Responses include:

1. Curl
2. Request URL
3. Server response

3.1 Curl

Contains a cURL command-line tool with query parameters that were executed. With the copy icon in right bottom corner you can easily copy cURL line in the clipboard.

3.2 Request URL

Contains the URL that was used by the method. It consists of HTTPS method, base URL and endpoint or resource URI.

3.3 Server response

The results of a successfully executed query are shown here.

Response headers contain information about content type, charset, time and server of the executed query.

In the response body the results are presented in JSON format. They can be copied to clipboard or downloaded as .json file with selection of a corresponding button in the bottom right corner.

Codes shown in the Responses show the status of the executed query.

4. Schemas

Schemas contain information about objects data structure. 

Specific schema provides a description of the specified object.