POST api/listings/:id/enquiries

Resource URL

POST Data

Example Request

{
  "enquiry":      "Can I pick this pet up on Wednesday?",
  "email":        "email@example.com",
  "name":         "John Doe",
  "phone_number": "08 9400 1234"
}

Successful Response

A successful request to this resource will return a status code of 200 OK. The response body will contain a JSON object with the contents of the enquiry.

For example, using the above example request the API would return the following data:

{
  "enquiry":      "Can I pick this pet up on Wednesday?",
  "email":        "email@example.com",
  "name":         "John Doe",
  "phone_number": "08 9400 1234"
}

Error Response

An erroneous request to this resource will return a 400 Bad Request or 404 Not Found. The response body will contain a JSON object with details of the error.

The error object will contain:

An example erroneous request where the parameters of the enquiry are omitted is:

The response status code will be 400 Bad Request and the response body from this request will be:

{
  "errors":{
    "enquiry":      "Can't be blank",
    "email":        "Can't be blank, is invalid",
    "name":         "Can't be blank",
    "phone_number": "Can't be blank"
  },
  "error_code":     "invalid_parameters"
}

If the request POST data is fine but the Listing that matches the id provided is rehomed or removed, the response code will be a 404 Not Found and the response body will be:

{
  "errors":{
    "id":       "has been removed/rehomed",
  },
  "error_code": "inactive_id"
}

If the request POST data is fine but the id provided doesn't match to a listing, the response code will be a 404 Not Found and the response body will be:

{
  "errors":{
    "id":       "does not exist in the system",
  },
  "error_code": "invalid_id"
}