### Get Suppliers GET Response Example Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Example JSON response for the GET /suppliers endpoint, listing supplier details. ```json { "code": 200, "messages": [], "response": [ { "sup_code": "001", "sup_name": "Pirelli", "sup_image":"" }, { "sup_code": "002", "sup_name": "Volkswagen", "sup_image":"" } ] } ``` -------------------------------- ### Get Payment Methods [GET] - Response Example Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Provides an example of a successful response when retrieving payment methods. ```json { "code": 200, "messages": [], "response": [ { "pmd_description": "Cash" }, { "pmd_description": "Pin" } ] } ``` -------------------------------- ### Get Solutions [GET] - JSON Response Example Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Shows the expected JSON response when fetching solutions from WorkOrderApp. Each solution object contains 'code', 'description', and 'app_enabled', providing details about available solutions within the system. ```json {"code":200,"messages":[],"response":[{"code":"HARD_RESET","description":"Hard reset","app_enabled":"0"},{"code":"SOFT_RESET","description":"Soft reset","app_enabled":"0"},{"code":"Update","description":"Update","app_enabled":"0"}]} ``` -------------------------------- ### Get Priorities [GET] - Response Example Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Shows a sample successful response when fetching priorities. ```json { "code": 200, "messages": [], "response": [ { "code": "10", "description": "High", "app_enabled": "0" }, { "code": "1", "description": "Low", "app_enabled": "1" } ] } ``` -------------------------------- ### Get Forms Response Example Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Example JSON response for the GET forms endpoint, illustrating the structure of form data including fields, labels, and options. ```json { "code": 200, "messages": [], "response": [ { "name": "Checklist", "data": "{\"fields\":[{\"label\": \"Type zonnepaneel\",\"field_type\": \"radio\",\"required\": true,\"field_options\": {\"options\":[{\"label\": \"a\",\"checked\": false},{\"label\": \"b\",\"checked\": false},{\"label\": \"c\",\"checked\": false}]},\"cid\": \"c2\"}]}", "template": "" }, { "name": "Controle lijst", "data": "{\"fields\":[{\"label\": \"Jaartal\",\"field_type\": \"text\",\"required\": true,\"field_options\": {\"size\": \"small\",\"value\": \"\"},\"cid\": \"c2\"},{\"label\": \"Staat van het huis goed\",\"field_type\": \"checkboxes\",\"required\": true,\"field_options\": {\"options\":[{\"label\": \"Ja\",\"checked\": false},{\"label\": \"Nee\",\"checked\": false},{\"label\": \"Weet ik niet\",\"checked\": false}]},\"cid\": \"c6\"}]}", "template": "" }, { "name": "Eigen form", "data": "{\"fields\":[{\"label\": \"Type pomp\",\"field_type\": \"checkboxes\",\"required\": true,\"field_options\": {\"options\":[{\"label\": \"type A\",\"checked\": false},{\"label\": \"type B\",\"checked\": false},{\"label\": \"type C\",\"checked\": false}]},\"cid\": \"c2\"},{\"label\": \"Serienummer\",\"field_type\": \"text\",\"required\": true,\"field_options\": {\"size\": \"small\",\"value\": \"\"},\"cid\": \"c6\"},{\"label\": \"Dropdown\",\"field_type\": \"dropdown\",\"required\": true,\"field_options\": {\"options\":[{\"label\": \"A\",\"checked\": false},{\"label\": \"B\",\"checked\": false}],\"include_blank_option\": false},\"cid\": \"c10\"}]}", "template": "" } ] } ``` -------------------------------- ### Add Solutions [POST] - JSON Request Example Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Provides an example of the JSON request body for adding solutions to WorkOrderApp. The payload includes 'code', 'description', and 'app_enabled' for each solution. This allows for synchronization of solution data with the application. ```json [{"code":"HARD_RESET","description":"Hard reset","app_enabled":"0"},{"code":"SOFT_RESET","description":"Soft reset","app_enabled":"0"},{"code":"Update","description":"Update","app_enabled":"0"}] ``` -------------------------------- ### Add Suppliers POST Response Example (Success) Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Example JSON response for a successful POST to the /suppliers endpoint, indicating the number of suppliers synced. ```json { "code": 200, "messages": [], "response": 2 } ``` -------------------------------- ### Add Suppliers POST Request Example (Empty Body) Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Example of an empty request body for the POST /suppliers endpoint. ```text Body ``` -------------------------------- ### Get Object Parts Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Retrieves specific object parts with detailed information including installation and warranty dates. ```APIDOC ## GET /object_parts/changed ### Description Fetches changed object parts. Changes can be made from the app. Use the `opr_timestamp_mutate` parameter to filter records mutated after a specific timestamp (Y-m-d H:i:s). ### Method GET ### Endpoint /object_parts/changed/{?token,software_token,opr_timestamp_mutate} ### Parameters #### Query Parameters - **token** (string) - Required - WorkorderApp customer token. - **software_token** (string) - Required - WorkorderApp external software token. - **opr_timestamp_mutate** (string) - Optional - Timestamp in 'Y-m-d H:i:s' format to filter records mutated after this time. ### Response #### Success Response (200) - **code** (integer) - The status code of the response. - **messages** (array) - An array of messages related to the response. - **response** (array) - An array of object part objects that have changed. - **opr_obj_code** (string) - Object code. - **opr_prt_code** (string) - Object part code. - **opr_serial_number** (string) - Serial number of parts used in the object. - **opr_description** (string) - Description of a part. - **opr_timestamp_installation** (string) - Date of installation (Y-m-d). - **opr_warranty_months** (string) - Amount of months for warranty calculation. - **opr_timestamp_warranty_expires** (string) - Warranty expiration date. - **opr_amount** (string) - Amount of parts used in the object. - **val_value_1** to **val_value_20** (string) - Freefield values. #### Response Example ```json { "code": 200, "messages": [], "response": [ { "opr_obj_code": "Object 1", "opr_prt_code": "001", "opr_serial_number": "65644456", "opr_description": "", "opr_timestamp_installation": "2018-10-11", "opr_warranty_months": "24", "opr_timestamp_warranty_expires": "2020-10-11", "opr_amount": "4", "val_value_1": "Free field 1 value", "val_value_2": "Free field 1 value", "val_value_3": null, "val_value_4": null, "val_value_5": null, "val_value_6": null, "val_value_7": null, "val_value_8": null, "val_value_9": null, "val_value_10": null, "val_value_11": null, "val_value_12": null, "val_value_13": null, "val_value_14": null, "val_value_15": null, "val_value_16": null, "val_value_17": null, "val_value_18": null, "val_value_19": null, "val_value_20": null } ] } ``` ``` -------------------------------- ### Add Suppliers POST Request Example (Unparsable JSON) Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Example JSON payload for the POST /suppliers endpoint with unparsable JSON. ```json [{"sup_code":: "001","sup_name": "Pirelli","sup_image":""},{"sup_code": "002","sup_name": "Volkswagen","sup_image":""}] ``` -------------------------------- ### Add Suppliers POST Request Example (Correct Data) Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Example JSON payload for the POST /suppliers endpoint with correct supplier data, used for syncing with WorkOrderApp. ```json [{"sup_code":"001","sup_name":"Pirelli","sup_image":""},{"sup_code":"002","sup_name":"Volkswagen","sup_image":""}] ``` -------------------------------- ### Get Material Translations GET Response Example Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Example JSON response for retrieving material translations. It includes an array of translation objects, each with an ID, reference_key, original text, translation, and language. ```json { "code": 200, "messages": [], "response": [ { "id": "1", "reference_key": "1", "original": "HD unit 2500bar", "translation": "Test", "language": "en" }, { "id": "2", "reference_key": "354578735453", "original": "Artikel voor voorraad 123", "translation": "ojunnn", "language": "ar" }, { "id": "3", "reference_key": "354578735453", "original": "Artikel voor voorraad 123", "translation": "qwerfde", "language": "ca" }, { "id": "4", "reference_key": "9", "original": "test artikel met geen voorraad", "translation": "tester", "language": "bg" }, { "id": "5", "reference_key": "9", "original": "test artikel met geen voorraad", "translation": "qwertw", "language": "hr" }, { "id": "6", "reference_key": "9", "original": "test artikel met geen voorraad", "translation": "testio", "language": "it" }, { "id": "7", "reference_key": "12345", "original": "hier", "translation": "daar", "language": "nl" }, { "id": "22", "reference_key": "1", "original": "testBar", "translation": "Test", "language": "GR" }, { "id": "23", "reference_key": "1234515", "original": "testBar2", "translation": "Test2", "language": "lu" } ]} ``` -------------------------------- ### Add Payment Methods [POST] - Request Body Examples Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Demonstrates the request body formats for adding payment methods. It includes examples of valid JSON, unparsable JSON, and an empty body. ```json [ { "pmd_description": "Cash" }, { "pmd_description": "Pin" } ] ``` ```json [ { "pmd_description": "Cash" }, { "pmd_description": "Pin" } ] ``` ```json ``` -------------------------------- ### Add Suppliers POST Response Example (Unable to Fetch Body) Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Example JSON response for the POST /suppliers endpoint when the request body cannot be fetched. ```json { "code": 1008, "messages": [ "Unable to fetch body" ], "response": null } ``` -------------------------------- ### Get Errors [GET] - JSON Response Example Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Illustrates the JSON response structure when retrieving a list of errors from WorkOrderApp. The response includes 'code', 'description', and 'app_enabled' for each error entry, indicating the current error configurations. ```json {"code":200,"messages":[],"response":[{"code":"GENERAL","description":"General error","app_enabled":"0"},{"code":"MECHANICAL","description":"Mechanical error","app_enabled":"0"},{"code":"SOFTWARE","description":"Software error","app_enabled":"0"}]} ``` -------------------------------- ### Add Suppliers POST Response Example (Unable to Parse) Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Example JSON response for the POST /suppliers endpoint when the request body is unparsable. ```json { "code": 1009, "messages": [ "Unable to parse body" ], "response": null } ``` -------------------------------- ### Get Material Categories (GET) Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Retrieves a list of all synced material categories. Requires a customer token and software token. ```json { "code": 200, "messages": [], "response": [ { "mct_mat_code": "001", "mct_cat_code": "7" } ] } ``` -------------------------------- ### Add Suppliers POST Response Example (Required Field Missing) Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Example JSON response for the POST /suppliers endpoint when a required field is missing. ```json { "code": 2001, "messages": [ "Required field missing: sup_code" ], "response": null } ``` -------------------------------- ### Add Material Translation POST Request Example Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Example of a POST request to add material translations. It requires reference_key, original, translation, and language. A successful request returns a code of 200 and the number of synced translations. ```json [{"reference_key": "1","original": "testBar","translation": "Test","language": "GR"}] ``` -------------------------------- ### GET /solutions Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Retrieves all solutions configured in WorkorderApp. ```APIDOC ## GET /solutions ### Description Retrieves all solutions configured in WorkorderApp. ### Method GET ### Endpoint /solutions ### Response #### Success Response (200) - **code** (integer) - The HTTP status code. - **messages** (array) - An array of messages. - **response** (array) - An array of solution objects. - **code** (string) - The unique code for the solution. - **description** (string) - The description of the solution. - **app_enabled** (string) - Indicates if the solution should be visible in the app ('0' or '1'). #### Response Example ```json { "code": 200, "messages": [], "response": [ {"code": "HARD_RESET", "description": "Hard reset", "app_enabled": "0"}, {"code": "SOFT_RESET", "description": "Soft reset", "app_enabled": "0"}, {"code": "Update", "description": "Update", "app_enabled": "0"} ] } ``` ``` -------------------------------- ### Add Suppliers POST Request Example (Missing Required Field) Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Example JSON payload for the POST /suppliers endpoint demonstrating a missing required field (sup_code). ```json [{"sup_name":"Pirelli","sup_image":""},{"sup_code":"002","sup_name":"Volkswagen","sup_image":""}] ``` -------------------------------- ### Get Categories by Filter (GET) Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Retrieves a list of material categories based on provided filters. Requires a customer token and software token. Optional 'key' and 'value' parameters can be used for filtering. ```json { "code": 200, "messages": [], "response": [ { "cat_code": "001", "cat_name": "Ijzerwaren", "cat_display": "1", "cat_cat_code": "" }, { "cat_code": "001-002", "cat_name": "Schroefjes", "cat_display": "0", "cat_cat_code": "001" }, { "cat_code": "001-003", "cat_name": "Boutjes", "cat_display": "0", "cat_cat_code": "001" } ] } ``` -------------------------------- ### Example JSON for Workperiods Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index This snippet shows an example of how the 'Workperiods' array should be structured in JSON format. It includes details such as begin time, total time, work remarks, work date, end time, travel duration, employee number, and hour type. ```json { "Workperiods": [ { "BeginTime": "08:30", "TotalTime": "03:45", "WorkRemark": "", "WorkDate": "26-09-2013", "EndTime": "12:15", "Travel": "1", "EmployeeNr": "11", "HourType": "001" } ] } ``` -------------------------------- ### Get Object Parts [GET] - WorkorderApp API Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index This snippet displays the successful response for the 'Get object parts' endpoint. It returns an array of object parts, including detailed information such as object code, part code, serial number, installation date, warranty details, and various free field values. This is used to fetch specific object part records. ```json { "code": 200, "messages": [], "response": [ { "opr_obj_code": "Object 1", "opr_prt_code": "001", "opr_serial_number": "65644456", "opr_description": "", "opr_timestamp_installation": "2018-10-11", "opr_warranty_months": "24", "opr_timestamp_warranty_expires": "2020-10-11", "opr_amount": "4", "val_value_1": "Free field 1 value", "val_value_2": "Free field 1 value" "val_value_3": null, "val_value_4": null, "val_value_5": null, "val_value_6": null, "val_value_7": null, "val_value_8": null, "val_value_9": null, "val_value_10": null, "val_value_11": null, "val_value_12": null, "val_value_13": null, "val_value_14": null, "val_value_15": null, "val_value_16": null, "val_value_17": null, "val_value_18": null, "val_value_19": null, "val_value_20": null } ] } ``` -------------------------------- ### Get Regions GET Response (JSON) Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index This snippet represents a successful GET request response for retrieving region data. It returns a JSON object containing a code, messages, and a response array of region objects. ```json {"code":200,"messages":[],"response":[{"reg_code":"1","reg_name":"Utrecht 32-33","reg_zip_start":"3200","reg_zip_end":"3500","reg_city":"","reg_country":""},{"reg_code":"2","reg_name":"Utrecht","reg_zip_start":"0","reg_zip_end":"0","reg_city":"Utrecht","reg_country":""}]} ``` -------------------------------- ### Get Parts [GET] - WorkorderApp API Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index This snippet shows the response structure for the 'Get parts' endpoint. It returns a list of parts, each with details like part code, name, supplier code, value, and image URL. This endpoint is useful for retrieving all available part information. ```json { "code": 200, "messages": [], "response": [ { "prt_code": "PRT001", "prt_name": "Remschijf", "prt_sup_code": "001", "prt_value": "80.00", "prt_image": "" } ] } ``` -------------------------------- ### Get Materials from WorkorderApp Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Retrieves a list of materials from WorkorderApp. The response contains an array of material objects, each with details like code, description, price, and unit. ```json { "code": 200, "messages": [], "response": [ {"code":"00001","description":"Omschrijving 1","price":"4,55","unit":"M2"}, {"code":"00012","description":"Omschrijving 2","price":"2,50","unit":"M2"} ] } ``` -------------------------------- ### Get Materials API Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Retrieves a list of all available materials from WorkOrderApp. ```APIDOC ## GET /materials ### Description Retrieves a list of all available materials from WorkOrderApp. ### Method GET ### Endpoint /materials ### Response #### Success Response (200) - **code** (integer) - The status code of the operation. - **messages** (array) - An array of messages. - **response** (array) - An array of material objects. #### Response Example ```json { "code": 200, "messages": [], "response": [ { "code": "00001", "description": "Omschrijving 1", "price": "4,55", "unit": "M2" }, { "code": "00012", "description": "Omschrijving 2", "price": "2,50", "unit": "M2" } ] } ``` ``` -------------------------------- ### POST /solutions Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Adds solution data to WorkorderApp. The response indicates the number of solutions successfully synced. ```APIDOC ## POST /solutions ### Description Adds solution data to WorkorderApp. The response indicates the number of solutions successfully synced. ### Method POST ### Endpoint /solutions ### Parameters #### Request Body - **code** (string) - Required - The unique code for the solution. - **description** (string) - Required - The description of the solution. - **app_enabled** (string) - Optional - Indicates if the solution should be visible in the app ('0' or '1'). ### Request Example ```json [ {"code": "HARD_RESET", "description": "Hard reset", "app_enabled": "0"}, {"code": "SOFT_RESET", "description": "Soft reset", "app_enabled": "0"}, {"code": "Update", "description": "Update", "app_enabled": "0"} ] ``` ### Response #### Success Response (200) - **code** (integer) - The HTTP status code. - **messages** (array) - An array of messages. - **response** (integer) - The number of solutions synced. #### Response Example ```json { "code": 200, "messages": [], "response": 3 } ``` #### Error Responses - **1051** (Required field missing) - **1009** (Unable to parse body) - **1008** (Unable to fetch body) ``` -------------------------------- ### GET /object/?token={token}&software_token={software_token}&key={key}&value={value} Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index This API is used to fetch objects based on a filter. Filters can be provided by adding a key and values array to the URL. Single or multiple filters can be applied. ```APIDOC ## GET /object/ ### Description Fetches objects based on specified filters. Filters can be applied using key-value pairs in the query parameters. Multiple filters can be specified by using array notation for keys and values. ### Method GET ### Endpoint `/object/` ### Query Parameters - **token** (string) - Required - WorkorderApp customer token. - **software_token** (string) - Required - WorkorderApp external software token. - **key** (array) - Optional - Filter column. Can be any of the allowed parameters. - **value** (array) - Optional - Filter value. ### Request Example ``` GET /object/?token=0f24d1e07c8609c0fb111fbcc168f9aaa&software_token=c316c4532fa7cccdcd572491d9552f80945a51366&key[]=obj_code&value[]=Object 2 ``` ### Response #### Success Response (200) - **code** (integer) - The status code of the response. - **messages** (array) - An array of messages related to the response. - **response** (array) - An array of object data matching the filters. - **obj_code** (string) - The unique code of the object. - **obj_sup_code** (string) - The supplier code of the object. - **obj_debiteur_nummer** (string) - The debtor number associated with the object. - **obj_adr_code** (string) - The address code of the object. - **obj_obj_code** (string) - The object code of the object. - **obj_image** (string) - The URL of the object's image. - **obj_description** (string) - The description of the object. - **obj_price** (string) - The price of the object. - **obj_floor_level** (string) - The floor level of the object. - **obj_location** (string) - The location of the object. - **obj_latitude** (string) - The latitude coordinate of the object. - **obj_longitude** (string) - The longitude coordinate of the object. - **obj_type** (string) - The type of the object. - **obj_model** (string) - The model of the object. - **obj_brand** (string) - The brand of the object. - **obj_date_warranty_expires** (string) - The warranty expiration date. - **obj_serialnumber** (string) - The serial number of the object. - **obj_date_last_inspection** (string) - The last inspection date. - **obj_date_installation** (string) - The installation date. - **obj_freefield_1** to **obj_freefield_20** (string) - Free fields for additional data. - **obj_created** (string) - The creation date. - **obj_modified** (string) - The modification date. #### Response Example ```json { "code": 200, "messages": [], "response": [ { "obj_code": "Object 2", "obj_sup_code": "gfgd", "obj_debiteur_nummer": "4_548a427a-45e8-4f05-9eff-36c8dd742942", "obj_adr_code": "", "obj_obj_code": "ghd", "obj_image": "no-image.png", "obj_description": "Object 2", "obj_price": "0.00", "obj_floor_level": "0", "obj_location": "", "obj_latitude": null, "obj_longitude": null, "obj_type": "", "obj_model": "", "obj_brand": "sdfds", "obj_date_warranty_expires": "2017-03-01", "obj_serialnumber": "dsfs", "obj_date_last_inspection": "2017-03-01", "obj_date_installation": "2017-03-01", "obj_freefield_1": "Merk x", "obj_freefield_2": "Model y ", "obj_freefield_3": "11-12-2016", "obj_freefield_4": "", "obj_freefield_5": "", "obj_freefield_6": "", "obj_freefield_7": "", "obj_freefield_8": "", "obj_freefield_9": "", "obj_freefield_10": "", "obj_freefield_11": "", "obj_freefield_12": "", "obj_freefield_13": "", "obj_freefield_14": "", "obj_freefield_15": "", "obj_freefield_16": "", "obj_freefield_17": "", "obj_freefield_18": "", "obj_freefield_19": "12", "obj_freefield_20": "", "obj_created": "0000-00-00 00:00:00", "obj_modified": "2017-03-02 11:10:44" } ] } ``` ``` -------------------------------- ### Get Parts Source: https://documenter.getpostman.com/view/3100119/UVRDG5v7/index Retrieves a list of parts with their associated details. ```APIDOC ## GET /parts ### Description Retrieves a list of parts with their associated details. ### Method GET ### Endpoint /parts ### Response #### Success Response (200) - **code** (integer) - The status code of the response. - **messages** (array) - An array of messages related to the response. - **response** (array) - An array of part objects. - **prt_code** (string) - The code of the part. - **prt_name** (string) - The name of the part. - **prt_sup_code** (string) - The supplier code of the part. - **prt_value** (string) - The value of the part. - **prt_image** (string) - The image URL of the part. #### Response Example ```json { "code": 200, "messages": [], "response": [ { "prt_code": "PRT001", "prt_name": "Remschijf", "prt_sup_code": "001", "prt_value": "80.00", "prt_image": "" } ] } ``` ```