Request
Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. The interface responds to different methods depending on the action required. The following methods can be used for corresponding URI.
| Method | Use |
|---|---|
| GET | For simple retrieval of information, you should use the GET method. The information you request will be returned to you as a JSON object. Any request using the GET method is read-only and will not affect any of the objects you are querying. |
| POST | To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint. |
| PUT | To update the information about a resource, the PUT method is available. The PUT request contains all attributes that are to be updated for an object. |
| PATCH | To update the partial information about a resource, the PATCH method is available. The PATCH request contains only attributes that are to be updated for an object. |
| DELETE | To destroy a resource, use the DELETE method. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. |