Authorization User Roles HTTP Methods Real-Time Data Streaming Status Codes Content Types Errors Pagination Rate Limiting Versioning
Please beware that the documentation is still in Alpha!
The API expects all writing requests (i.e. POST; and PUT) in JSON format with the Content-Type
header set to application/json
header
(optionally as Content-Type: application/json; charset=UTF-8)
).
The API uses JSON as the response format, which is accompanied by the Content-Type: application/hal+json
header in most responses. The only exceptions are the Reports endpoints, which return the Content-Type: application/json
header.
Here is an example of a request using cURL:
1link$curl -X POST \
2link$ http://api.marxact.com/projects \
3link$ -H 'Content-Type: application/json' \
4link$ -d '{ "name": "My marXact Surveying Project" }'
And here is an example of a successful response:
1linkHTTP/1.1 201 Created
2linkContent-Type: application/json
3link
4link{
5link "id": "12a3b4c5-6d78-9e10f-g1112-1hi3j1k41516",
6link "name": "My marXact Surveying Project"
7link}