How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
- Application Reference:
com.hornbill.suppliermanager - Scope:
Entity - SupplierMembers - Class:
Entity - Required Privilege Level:
user - Required Rights: Group B - canViewSupplierMembers
Description
This flowcode operation gets details of all members for the supplier provided.
Request Parameters
The getSupplierMembers API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.
| Name | Type | Required | Description |
|---|---|---|---|
supplierId |
xs:integer |
Yes | The primary key of the supplier. |
searchFilter |
xs:string |
No | Search criteria for supplier members. |
rowStart |
xs:integer |
Yes | Row Start for Paging. |
rowLimit |
xs:integer |
Yes | Page Size. |
Response Parameters
| Name | Type | Description |
|---|---|---|
outcome |
xs:string |
The outcome of the flowcode operation. |
totalRecordCount |
xs:integer |
The total number of members that match the specified supplier. |
supplierMembers |
xs:string |
A JSON string of supplier members. |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.suppliermanager/SupplierMembers' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.suppliermanager/SupplierMembers","@method":"getSupplierMembers","params":{"supplierId":1,"searchFilter":"xs:string","rowStart":1,"rowLimit":1}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("supplierId", "xs:integer")
hornbillAPI.SetParam("searchFilter", "xs:string")
hornbillAPI.SetParam("rowStart", "xs:integer")
hornbillAPI.SetParam("rowLimit", "xs:integer")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.suppliermanager/SupplierMembers", "getSupplierMembers")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.suppliermanager/SupplierMembers";
const payload = {
"@service": "apps/com.hornbill.suppliermanager/SupplierMembers",
"@method": "getSupplierMembers",
"params": {
"supplierId": 1,
"searchFilter": "xs:string",
"rowStart": 1,
"rowLimit": 1
}
};
fetch(endpoint, {
method: 'POST',
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
},
body: JSON.stringify(payload)
}).then(res => res.json())
.then(res => console.log(res));
const axios = require('axios');
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.suppliermanager/SupplierMembers";
const payload = {
"@service": "apps/com.hornbill.suppliermanager/SupplierMembers",
"@method": "getSupplierMembers",
"params": {
"supplierId": 1,
"searchFilter": "xs:string",
"rowStart": 1,
"rowLimit": 1
}
};
const axiosConfig = {
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
};
axios.post(endpoint, payload, axiosConfig)
.then((res) => {
console.log("RESPONSE RECEIVED: ", res);
})
.catch((err) => {
console.log("AXIOS ERROR: ", err);
})
$endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.suppliermanager/SupplierMembers";
$payload = (object) [
'@service' => 'apps/com.hornbill.suppliermanager/SupplierMembers',
'@method' => 'getSupplierMembers',
'params' => (object) [
'supplierId' => 'xs:integer',
'searchFilter' => 'xs:string',
'rowStart' => 'xs:integer',
'rowLimit' => 'xs:integer',
]
];
$headers = [
'Authorization: ESP-APIKEY yourHornbillAPIKey',
'Content-Type: application/json'
];
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;
$Endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.suppliermanager/SupplierMembers"
$Body = @{
"@service" = "apps/com.hornbill.suppliermanager/SupplierMembers"
"@method" = "getSupplierMembers"
params = @{
supplierId = "xs:integer"
searchFilter = "xs:string"
rowStart = "xs:integer"
rowLimit = "xs:integer"
}
}
$Header = @{
"Authorization" = "ESP-APIKEY yourHornbillAPIKey"
}
$Parameters = @{
Method = "POST"
Uri = $Endpoint
Headers = $Header
Body = ($Body | ConvertTo-Json)
ContentType = "application/json"
}
Invoke-RestMethod @Parameters
import requests
import json
endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.suppliermanager/SupplierMembers"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.suppliermanager/SupplierMembers",
"@method":"getSupplierMembers",
"params":{
"supplierId":"xs:integer",
"searchFilter":"xs:string",
"rowStart":"xs:integer",
"rowLimit":"xs:integer",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document