RESTful Functions Overview: Difference between revisions
(Created page with "The RESTful macro functions in MapTool are for advanced users. This is merely an overview of the MapTool implementation of RESTful functions and not a tutorial covering REST...") |
No edit summary |
||
| Line 15: | Line 15: | ||
* Patch - {{func|REST.patch}} | * Patch - {{func|REST.patch}} | ||
* Delete - {{func|REST.delete}} | * Delete - {{func|REST.delete}} | ||
See the entry for each macro function for details about their use. | |||
== REST Status Codes == | |||
Each request can return the server response or a full response with data typically in a XML or JSON format. | Each request can return the server response or a full response with data typically in a XML or JSON format. | ||
The full response will include a status code. A partial list: | The full response will include a status code. A partial list of status codes: | ||
{|class="wikitable" | {|class="wikitable" | ||
Revision as of 22:03, 17 March 2019
The RESTful macro functions in MapTool are for advanced users. This is merely an overview of the MapTool implementation of RESTful functions and not a tutorial covering REST and REST APIs. Those can be readily found on the web such as REST API Tutorial.
What is REST?
REST is acronym for REpresentational State Transfer. It is architectural style for distributed hypermedia systems and was first presented by Roy Fielding in 2000 in his famous dissertation.
(Definition from tutorial linked above.)
MapTool REST Operations
MapTool supports the following REST requests:
- Get - REST.get()
- Post - REST.post()
- Put - REST.put()
- Patch - REST.patch()
- Delete - REST.delete()
See the entry for each macro function for details about their use.
REST Status Codes
Each request can return the server response or a full response with data typically in a XML or JSON format.
The full response will include a status code. A partial list of status codes:
| 200 | OK |
| 201 | Created |
| 202 | Accepted |
| 204 | No Content |
| 400 | Bad Request |
| 404 | Not Found |