/hoseassembly/{hoseAssemblyId}/customers/update 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
postHoseAssemblyIdCustomerUpdate
Code samples
const inputBody = '{
"type": "object",
"properties": {
"params": {
"type": "object",
"required": [
"customerId"
],
"properties": {
"customerId": {
"type": "string",
"description": "The ID of the customer."
},
"_id": {
"type": "string",
"description": "Optional customer-specific hose assembly ID."
},
"orgPartNumber": {
"type": "string",
"description": "Optional organization-specific part number."
},
"orgRevision": {
"type": "string",
"description": "Optional organization-specific revision."
},
"name": {
"type": "string",
"description": "Optional display name for the customer hose assembly."
}
}
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json'
};
fetch('https://goldleaf.app/api/v1/hoseassembly/{hoseAssemblyId}/customers/update',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /hoseassembly/{hoseAssemblyId}/customers/update
Update customer-specific hose assembly properties
Updates customer assembly properties for a given hose assembly. Requires a valid customer ID. You may optionally provide _id to update a specific customer assembly record.
Body parameter
{
"type": "object",
"properties": {
"params": {
"type": "object",
"required": ["customerId"],
"properties": {
"customerId": {
"type": "string",
"description": "The ID of the customer."
},
"_id": {
"type": "string",
"description": "Optional customer-specific hose assembly ID."
},
"orgPartNumber": {
"type": "string",
"description": "Optional organization-specific part number."
},
"orgRevision": {
"type": "string",
"description": "Optional organization-specific revision."
},
"name": {
"type": "string",
"description": "Optional display name for the customer hose assembly."
}
}
}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| hoseAssemblyId | path | string | true | The ID of the hose assembly to update. |
| body | body | object | true | none |
| » params | body | object | false | none |
| »» customerId | body | string | true | The ID of the customer. |
| »» _id | body | string | false | Optional customer-specific hose assembly ID. |
| »» orgPartNumber | body | string | false | Optional organization-specific part number. |
| »» orgRevision | body | string | false | Optional organization-specific revision. |
| »» name | body | string | false | Optional display name for the customer hose assembly. |
Example responses
500 Response
{
"type": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Customer hose assembly updated successfully | None |
| 500 | Internal Server Error | Server error | string |
