Response Codes

Possible response codes that may be returned by the ConstructionOnline API

All requests made to the ConstructionOnline API will return a HTTP response status code that indicates whether or not the request was successfully completed. Occasionally, requests made to the ConstructionOnline API may not be successful. There are a number of reasons why a request may fail, from a non-existent resource to an internal server error. In case of failure, the ConstructionOnline API will return a specific client or server error response that indicates the reason for failure, as well as any additional information in the response body in JSON format.

Status Code Meaning Description
200 Success The request succeeded. This will appear for successful GET, POST, and PUT requests.
400 Bad Request The request failed due to a client error, such as a missing or malformed parameter. 
404 Not Found The request failed because the server could not find the requested resource. This could mean the endpoint is no requested or the resource itself does not exist.
429 Too Many Requests The request failed because a rate limit was exceeded. Documentation on rate limits can be found here. 
500 Internal Server Error The request failed due to a problem on ConstructionOnline's end.

Example

Request

GET https://api.constructiononline.com/api/Lead

Response

HTTP 404 Not Found

{

"Message" : "No HTTP resource was found that matches the request URI 'https://api.constructiononline.com/api/Lead
"MessageDetail" : "No type was found that matches the controller named 'Lead'."

}

Have more questions?

If you need additional assistance, encounter any issues, or have any requests concerning the API or its documentation, please contact the ConstructionOnline development team at api@uda1.com.