/crimpfittings/sizes 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:
CrimpFittings
postCrimpFittingSizes
Code samples
const inputBody = '{
"type": "object",
"required": [
"brand",
"hoseSize",
"series"
],
"properties": {
"brand": {
"type": "string",
"description": "The brand of the item."
},
"hoseSize": {
"type": "string",
"description": "The dash size of the hose."
},
"series": {
"type": "array",
"description": "An array of series identifiers.",
"items": {
"type": "string",
"description": "A series identifier."
}
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://goldleaf.app/api/v1/crimpfittings/sizes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /crimpfittings/sizes
Gets available crimp fitting dash sizes
Retrieves all available dash sizes for crimp fittings based on brand, hose size, and series parameters.
Body parameter
{
"type": "object",
"required": ["brand", "hoseSize", "series"],
"properties": {
"brand": {
"type": "string",
"description": "The brand of the item."
},
"hoseSize": {
"type": "string",
"description": "The dash size of the hose."
},
"series": {
"type": "array",
"description": "An array of series identifiers.",
"items": {
"type": "string",
"description": "A series identifier."
}
}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | none |
| » brand | body | string | true | The brand of the item. |
| » hoseSize | body | string | true | The dash size of the hose. |
| » series | body | [string] | true | An array of series identifiers. |
Example responses
500 Response
{
"type": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A sorted array of available dash sizes for the given criteria. | None |
| 401 | Unauthorized | Unauthorized — Brand not allowed for this organization. | None |
| 500 | Internal Server Error | Server error | string |
