/hosekits/checkexisting v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Hose Kits
postHoseAssembliesExport
Code samples
const inputBody = '{
"params": {
"partNumber": "HK-1234",
"revision": "A1",
"allowOverwriteUnderEditing": false
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://goldleaf.app/api/v1/hosekits/checkexisting',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /hosekits/checkexisting
Check if a hose kit exists for the organization
Checks whether a hose kit with the given part number and revision already exists for the organization. Optionally allows overwriting kits under editing.
Body parameter
{
"params": {
"partNumber": "HK-1234",
"revision": "A1",
"allowOverwriteUnderEditing": false
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | none |
| » params | body | object | false | none |
| »» partNumber | body | string | true | Part number of the hose kit |
| »» revision | body | string | false | Revision of the hose kit (optional) |
| »» allowOverwriteUnderEditing | body | boolean¦null | false | Whether to allow overwrite of kits currently under editing |
Example responses
200 Response
{
"type": "boolean"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Hose kit existence check result | boolean |
| 500 | Internal Server Error | Internal server error | string |
