/hoseassemblies 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
getHoseAssemblies
Code samples
const headers = {
Accept: "application/json",
};
fetch("https://goldleaf.app/api/v1/hoseassemblies", {
method: "GET",
headers: headers,
})
.then(function (res) {
return res.json();
})
.then(function (body) {
console.log(body);
});
GET /hoseassemblies
Gets hose assemblies
Retrieves a list of hose assemblies with optional search filters
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| search.customerName | query | string | false | An optional string parameter for customer name within search. |
| search.partNumberWithRevision | query | string | false | An optional string parameter for part number with revision within search. |
| search.customerPartNumber | query | string | false | An optional string parameter for customer part number within search. |
| search.customerRevision | query | string | false | An optional string parameter for customer revision within search. |
| search.hosePartNumber | query | string | false | An optional string parameter for hose part number within search. |
| search.end1PartNumber | query | string | false | An optional string parameter for end1 part number within search. |
| search.end2PartNumber | query | string | false | An optional string parameter for end2 part number within search. |
| search.length | query | string | false | An optional string parameter for length within search. |
| search.description | query | string | false | An optional string parameter for description within search. |
| search.comments | query | string | false | An optional string parameter for comments within search. |
| search.hoseBrand | query | string | false | An optional string parameter for hose brand within search. |
| search.commonSearch | query | string | false | An optional string parameter for common search within search. |
| search.status | query | string | false | An optional string parameter for status within search. |
| partNumber | query | string | false | An optional string parameter for part number. |
| status | query | array[string] | false | An optional array of strings for status. |
| customerOrgId | query | string(mongo-id) | false | An optional MongoDB ID for customer organization. |
| hoseAssemblyId | query | string(mongo-id) | false | An optional MongoDB ID for hose assembly. |
| workOrderId | query | string(mongo-id) | false | An optional MongoDB ID for work order. |
| onlyCustomer | query | boolean | false | An optional boolean parameter to filter only customer-specific items. |
Example responses
500 Response
{
"type": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | An array of hoses | None |
| 500 | Internal Server Error | Server error | string |
