API to allow existing applications and loyalty schemes to interface with the benchmark system to allow the creation of initial installation records.
\nTo Access these endpoints a bearer token must be specified using the Authorization header. The personal access tokens can be genrerated within the benchmark portal.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"248247","collectionId":"7d862b87-6456-444a-b0bf-c46fa946b1f2","publishedId":"SztG3mKL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"BD2B18"},"publishDate":"2020-11-20T10:37:39.000Z"},"item":[{"name":"Get Manufacturers","id":"42078174-1561-426a-8c70-4025361df214","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/api/manufacturer/manufacturers","description":"Fetch all of the available brands in the system. Use the ID number returned in order to filter and search for available boilers.
\n","urlObject":{"path":["api","manufacturer","manufacturers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"42078174-1561-426a-8c70-4025361df214"},{"name":"Get Brands","id":"7849e1e1-8ce9-47c1-bf99-817cd6a323ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/api/manufacturer/brands?manufacturer_id={manufacturer_id}","description":"Fetch all of the available brands in the system. Use the ID number returned in order to filter and search for available boilers.
\n","urlObject":{"path":["api","manufacturer","brands"],"host":["{{url}}"],"query":[{"key":"manufacturer_id","value":"{manufacturer_id}"}],"variable":[]}},"response":[],"_postman_id":"7849e1e1-8ce9-47c1-bf99-817cd6a323ed"},{"name":"Get Boiler Models","id":"ebed03d3-a7e3-457b-bc95-928e2de9d308","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/api/manufacturer/boiler-models?brand_id={brand_id}","description":"Fetch all of the available boiler models for a brand_id.
\n","urlObject":{"path":["api","manufacturer","boiler-models"],"host":["{{url}}"],"query":[{"description":{"content":"The integer value of the boiler brand
\n","type":"text/plain"},"key":"brand_id","value":"{brand_id}"}],"variable":[]}},"response":[],"_postman_id":"ebed03d3-a7e3-457b-bc95-928e2de9d308"},{"name":"Register New Boiler Install","id":"ede705aa-aa98-47b1-8c82-7ff07be05e5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"}],"body":{"mode":"formdata","formdata":[{"description":"Integer vale of the brand
\n","key":"brand_id","type":"text","value":"1"},{"key":"boiler_id","value":"38","description":"Integer value of the boiler model
\n","type":"text"},{"key":"serial_number","value":"123123","description":"Validated against the brand rule set
\n","type":"text"},{"key":"engineer_id","value":"9610f4cb-c0b9-40ba-992d-fd6c1c55e079","description":"Required
\n","type":"text"}]},"url":"{{url}}/api/manufacturer/install","description":"Allows the initial registration of a boiler installation to be started from an external application. If successful the system will provide with a 200 message an a reference code that should be used on the benchmark application to allow the engineer to continue with the completion of the installation record. If any data is invalid, a 422 code is presented with the payload displaying the validation error messages.
\n","urlObject":{"path":["api","manufacturer","install"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ede705aa-aa98-47b1-8c82-7ff07be05e5b"},{"name":"Get Install Status","id":"9bd63144-d605-49b5-814d-cfd599798435","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{url}}/api/manufacturer/status?serial_number={serial_number}","description":"Get the install status of a boiler via the boiler serial number. Endpoint will return a status of 0 for incomplete and 1 for complete.
\n","urlObject":{"path":["api","manufacturer","status"],"host":["{{url}}"],"query":[{"description":{"content":"String Value
\n","type":"text/plain"},"key":"serial_number","value":"{serial_number}"}],"variable":[]}},"response":[],"_postman_id":"9bd63144-d605-49b5-814d-cfd599798435"},{"name":"Get Install Status bulk","id":"0ca9acc6-b616-4dbc-97e1-8695c9c33aee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serial_numbers\": [\n \"35929860846877733700010\",\n \"35929860846877733700020\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/manufacturer/status/bulk","description":"Get the install status of a boiler via the boiler serial number. Endpoint will return a status of 0 for incomplete and 1 for complete.
\n","urlObject":{"path":["api","manufacturer","status","bulk"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ca9acc6-b616-4dbc-97e1-8695c9c33aee"},{"name":"Get Boilers","id":"e2517483-c68b-4d5a-acf3-51a331c1798e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{url}}/api/manufacturer/boilers?serial_number={serial_number}","description":"Get a specific boiler via a serial number
\n","urlObject":{"path":["api","manufacturer","boilers"],"host":["{{url}}"],"query":[{"description":{"content":"String Value
\n","type":"text/plain"},"key":"serial_number","value":"{serial_number}"}],"variable":[]}},"response":[],"_postman_id":"e2517483-c68b-4d5a-acf3-51a331c1798e"},{"name":"Get Installs","id":"d507e954-82fa-465e-84c3-9d65d666d420","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{url}}/api/manufacturer/install/{brand_id}","description":"Get the current installs for a specific brand. The brand specified must be related to the current authenticated manufacturer user else an error will be thrown
\n","urlObject":{"path":["api","manufacturer","install","{brand_id}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d507e954-82fa-465e-84c3-9d65d666d420"},{"name":"Get Engineeer By Gas Safe","id":"f206364d-7df8-4778-8c02-2baa0a28da80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{url}}/api/manufacturer/get-engineeer-by-gas-safe?gas_safe_number={gas safe number}","description":"Retrieve an engineer's UUID by Gas Safe number.
\n","urlObject":{"path":["api","manufacturer","get-engineeer-by-gas-safe"],"host":["{{url}}"],"query":[{"key":"gas_safe_number","value":"{gas safe number}"}],"variable":[]}},"response":[{"id":"86f2744e-4a96-4a96-bfd2-94c2b9b46cbd","name":"Get Engineeer By Gas Safe","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{url}}/api/manufacturer/get-engineeer-by-gas-safe?gas_safe_number={gas safe number}","host":["{{url}}"],"path":["api","manufacturer","get-engineeer-by-gas-safe"],"query":[{"key":"gas_safe_number","value":"{gas safe number}"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Successfully retrieved engineer\",\n \"data\": \"8681fe34-3055-488c-b40f-d29b6b5aac4c\"\n}"}],"_postman_id":"f206364d-7df8-4778-8c02-2baa0a28da80"}],"event":[{"listen":"prerequest","script":{"id":"f27b9718-8831-4778-b3a5-cec698327c00","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"843c9a81-914c-47c9-bf95-17e2ee5f5991","type":"text/javascript","exec":[""]}}]}