> For the complete documentation index, see [llms.txt](https://knowledge.out-smart.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledge.out-smart.com/openapi/response.md). # Response Each request results in a JSON object with the following parameters: * code: `1001` (number) - The response code of the executed request, * messages: (array\[string]) - Array containing detailed messages of the executed request, * response: (object) - Response object Following code can occur in a response: | Code | Meaning | | ---- | ----------------------------------------------------------------------------------------------------------------------------------------- | | 200 | Request successfully executed. | | 1000 | The URL being called is not containing an endpoint. | | 1001 | The endpoint being provided is unknown on our side. | | 1002 | Request is missing the GET parameter: token. | | 1003 | Request is missing the GET parameter: software\_token. | | 1004 | Client token provided is unauthorized to execute this request. | | 1005 | Software token provided is unauthorized to execute this request. Either the token is not correct or it's not matched to the client token. | | 1006 | All endpoints should use https. | | 1007 | A general uncaught error occured. Please let WorkorderApp know. | | 1008 | The server did not receive a message body. | | 1009 | The server did receive a message body but was unable to parse this to a valid JSON array or object. | | 1100 | The insert or update of an employee failed. | | 1101 | A required field is missing in this request. | | 1200 | The insert or update of a material row failed. | | 1201 | A required field is missing in this request. | | 1300 | The insert or update of a relation failed. | | 1301 | A required field is missing in this request. | | 1400 | No location data found for this customer. | | 1500 | Workorder not found by given criteria. | | 1501 | Posted workorder is missing a required field. | | 1502 | Update workorder request is missing update data. | | 1503 | No data changed. | | 1504 | There was problem parsing the data being added. | | 1600 | Delete of an entity failed. | | 1700 | The insert or update of an project failed. | | 1701 | A required field is missing or date is invalid in this request. | | 1800 | The insert or update of a hourtype failed. | | 1801 | A required field is missing, active is not 1 or 0 or price cannot be parsed in this request. | | 1900 | The insert or update of an object failed. | | 1901 | A required field is missing. | | 2000 | The insert or update of a supplier failed. | | 2001 | A required field is missing. | | 2100 | The insert or update of a part failed. | | 2101 | A required field is missing. | | 2200 | The insert or update of an object part failed. | | 2201 | A required field is missing. | | 2300 | The insert or update of a form failed. | | 2301 | A required field is missing. | | 2400 | The insert or update of a category failed. | | 2401 | A required field is missing. | | 2500 | The insert or update of a material category failed. | | 2501 | A required field is missing. | | 2600 | The insert or update of a worktype failed. | | 2601 | A required field is missing | | 2700 | The insert or update of a payment method failed. | | 2701 | A required field is missing. | | 2800 | The insert or update of a workstatus failed. | | 2801 | A required field is missing. | | 2900 | The insert or update of an address failed. | | 2901 | A required field is missing. | | 3000 | The insert or update of a contact person failed. | | 3001 | A required field is missing. | | 3100 | The insert or update of a sub material failed. | | 3101 | A required field is missing. | | 3102 | An incorrect material code for the parent material or sub material was provided. | | 3103 | An error occured when deleting a sub material. | | 3200 | The insert of a warehouse material failed. | | 3201 | The update of a warehouse material failed. | | 3202 | A required field is missing. | | 3203 | An incorrect material code was provided. | | 3204 | An incorrect warehouse code was provided. | | 3205 | An error occured when deleting a warehouse material. | #### Example JSON * { "code": 1001, "messages": \[], "response": null } --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://knowledge.out-smart.com/openapi/response.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.