Request
All requests are made to https://api-beta.fasteignir.is/. The path defines which resource is to be queried and in which format the request and response shall be given in. Currently, only the JSON format is supported.
Authentication
Authentication is handled by basic HTTP authentication.
Resources
Resources are a fundamental part of the API, in which all data manipulation and retreivals are done within. The available resources are documented.
- GET
- Retrieves an object. If the request path is set to the root of a resource, a list of objects stored within are sent back. If set to an object, the object is sent back.
- POST
- Creates a new object. The HTTP "Location" header of the response will contain the path that shall be used for further manipulation of the created object.
- PUT
- Updates an object. The response body will be empty and the HTTP status code set to 200.
- DELETE
- Deletes an object. The response body will be empty and the HTTP status code set to 200.
Status codes
- 200
- Found
- 201
- Created
- 401
- Unauthorized. The given username and password may be wrong, or does not have sufficient permissions to successfully process the request.
- 406
- Not acceptable.
- 422
- Unprocessable entity. The submitted entity does not fit within the set constraints. See Errors for further details.
Actions after unsuccessful requests
If a 401 or 422 status code is received when a request is sent to the API, that same request should not be sent again without correcting the cause that lead to 401 or 422 status code.