/hoseassemblies/parse 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 Assembly
getHoseAssembliesParse
Code samples
const headers = {
Accept: "application/json",
};
fetch("https://goldleaf.app/api/v1/hoseassemblies/parse?description=type,string", {
method: "GET",
headers: headers,
})
.then(function (res) {
return res.json();
})
.then(function (body) {
console.log(body);
});
GET /hoseassemblies/parse
Parse a hose assembly from a description or Parker code
Attempts to parse a hose assembly from the provided description. If parsing the standard hose assembly format fails, it attempts to parse using a Parker code format. If neither succeeds, an error is returned.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| description | query | string | true | A description string or Parker code representing the hose assembly. |
Example responses
400 Response
{
"type": "object",
"properties": {
"message": {
"type": "string"
},
"details": {
"type": "string"
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully parsed hose assembly | None |
| 400 | Bad Request | Invalid request or parsing failure | Inline |
| 500 | Internal Server Error | Server error | Inline |
Response Schema
Status Code 400
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » message | string | false | none | none |
| » details | string | false | none | none |
Status Code 500
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » message | string | false | none | none |
| » details | string | false | none | none |
