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.
Table of contents
- Header
- Parameters
- Responses
- Shemas
|
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:
- Operation methods used
- Endpoint
- Description
- Example of a query
Operation methods in PANTHEON API:
|
|
Retrieves data from the server.
|
|
|
Creates new records in database or retrieves data from the server.
|
|
|
Updates existing records.
|
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.
 |
Hint
This is a HINT and should be marked with this icon. If necessary, copy this whole table and add a new hint.
|
 |
Warning
This is a WARNING and should be marked with this icon. If necessary, copy this whole table and add a new warning.
|
3. Subtitle
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
| Entry 1 |
Description of entry |
| Entry 2 |
Description of entry |
| Entry 3 |
Description of entry |
| Entry 4 |
Description of entry |
| Entry 5 |
Description of entry |
| Entry 6 |
Description of entry |
4. Subtitle
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
5. Subtitle
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.