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 - SupplierContacts - Class:
Entity - Required Privilege Level:
user - Required Rights: Group A - canViewSuppliers; Group B - canCreateSupplierContacts
Description
This flowcode operation creates a new supplier contact.
Request Parameters
The addSupplierContact 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 supplier primary key. |
firstName |
xs:string |
No | The first name of the new supplier contact. |
lastName |
xs:string |
No | The last name of the new supplier contact. |
jobTitle |
xs:string |
No | The job title of the new supplier contact. |
status |
xs:string |
No | The status of the new supplier contact. Accepted values are (status.active,status.archived). If no value is provided, status.active will be used. |
phoneNumber |
xs:string |
No | This is the primary phone number of the new supplier contact. |
phoneNumber2 |
xs:string |
No | This is the secondary phone number of the new supplier contact. |
phoneNumber3 |
xs:string |
No | This is the tertiary phone number of the new supplier contact. |
emailAddress |
xs:string |
No | The primary email address of the new supplier contact. |
emailAddress2 |
xs:string |
No | The secondary email address of the new supplier contact. |
emailAddress3 |
xs:string |
No | The tertiary email address of the new supplier contact. |
notes |
xs:string |
No | Any additional notes for the new supplier contact. |
country |
xs:string |
No | The country of the new supplier contact. |
language |
xs:string |
No | The language of the new supplier contact. |
custom0 |
xs:string |
No | Custom data held against the new supplier contact. |
custom1 |
xs:string |
No | Custom data held against the new supplier contact. |
custom2 |
xs:string |
No | Custom data held against the new supplier contact. |
custom3 |
xs:string |
No | Custom data held against the new supplier contact. |
custom4 |
xs:string |
No | Custom data held against the new supplier contact. |
custom5 |
xs:string |
No | Custom data held against the new supplier contact. |
Response Parameters
| Name | Type | Description |
|---|---|---|
outcome |
xs:string |
The outcome of the flowcode operation. |
supplierContactId |
xs:integer |
The id of the new supplier contact. |
supplierContactName |
xs:string |
The name of the new supplier contact. |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.suppliermanager/SupplierContacts' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.suppliermanager/SupplierContacts","@method":"addSupplierContact","params":{"supplierId":1,"firstName":"xs:string","lastName":"xs:string","jobTitle":"xs:string","status":"xs:string","phoneNumber":"xs:string","phoneNumber2":"xs:string","phoneNumber3":"xs:string","emailAddress":"xs:string","emailAddress2":"xs:string","emailAddress3":"xs:string","notes":"xs:string","country":"xs:string","language":"xs:string","custom0":"xs:string","custom1":"xs:string","custom2":"xs:string","custom3":"xs:string","custom4":"xs:string","custom5":"xs:string"}}'
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("firstName", "xs:string")
hornbillAPI.SetParam("lastName", "xs:string")
hornbillAPI.SetParam("jobTitle", "xs:string")
hornbillAPI.SetParam("status", "xs:string")
hornbillAPI.SetParam("phoneNumber", "xs:string")
hornbillAPI.SetParam("phoneNumber2", "xs:string")
hornbillAPI.SetParam("phoneNumber3", "xs:string")
hornbillAPI.SetParam("emailAddress", "xs:string")
hornbillAPI.SetParam("emailAddress2", "xs:string")
hornbillAPI.SetParam("emailAddress3", "xs:string")
hornbillAPI.SetParam("notes", "xs:string")
hornbillAPI.SetParam("country", "xs:string")
hornbillAPI.SetParam("language", "xs:string")
hornbillAPI.SetParam("custom0", "xs:string")
hornbillAPI.SetParam("custom1", "xs:string")
hornbillAPI.SetParam("custom2", "xs:string")
hornbillAPI.SetParam("custom3", "xs:string")
hornbillAPI.SetParam("custom4", "xs:string")
hornbillAPI.SetParam("custom5", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.suppliermanager/SupplierContacts", "addSupplierContact")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.suppliermanager/SupplierContacts";
const payload = {
"@service": "apps/com.hornbill.suppliermanager/SupplierContacts",
"@method": "addSupplierContact",
"params": {
"supplierId": 1,
"firstName": "xs:string",
"lastName": "xs:string",
"jobTitle": "xs:string",
"status": "xs:string",
"phoneNumber": "xs:string",
"phoneNumber2": "xs:string",
"phoneNumber3": "xs:string",
"emailAddress": "xs:string",
"emailAddress2": "xs:string",
"emailAddress3": "xs:string",
"notes": "xs:string",
"country": "xs:string",
"language": "xs:string",
"custom0": "xs:string",
"custom1": "xs:string",
"custom2": "xs:string",
"custom3": "xs:string",
"custom4": "xs:string",
"custom5": "xs:string"
}
};
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/SupplierContacts";
const payload = {
"@service": "apps/com.hornbill.suppliermanager/SupplierContacts",
"@method": "addSupplierContact",
"params": {
"supplierId": 1,
"firstName": "xs:string",
"lastName": "xs:string",
"jobTitle": "xs:string",
"status": "xs:string",
"phoneNumber": "xs:string",
"phoneNumber2": "xs:string",
"phoneNumber3": "xs:string",
"emailAddress": "xs:string",
"emailAddress2": "xs:string",
"emailAddress3": "xs:string",
"notes": "xs:string",
"country": "xs:string",
"language": "xs:string",
"custom0": "xs:string",
"custom1": "xs:string",
"custom2": "xs:string",
"custom3": "xs:string",
"custom4": "xs:string",
"custom5": "xs:string"
}
};
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/SupplierContacts";
$payload = (object) [
'@service' => 'apps/com.hornbill.suppliermanager/SupplierContacts',
'@method' => 'addSupplierContact',
'params' => (object) [
'supplierId' => 'xs:integer',
'firstName' => 'xs:string',
'lastName' => 'xs:string',
'jobTitle' => 'xs:string',
'status' => 'xs:string',
'phoneNumber' => 'xs:string',
'phoneNumber2' => 'xs:string',
'phoneNumber3' => 'xs:string',
'emailAddress' => 'xs:string',
'emailAddress2' => 'xs:string',
'emailAddress3' => 'xs:string',
'notes' => 'xs:string',
'country' => 'xs:string',
'language' => 'xs:string',
'custom0' => 'xs:string',
'custom1' => 'xs:string',
'custom2' => 'xs:string',
'custom3' => 'xs:string',
'custom4' => 'xs:string',
'custom5' => 'xs:string',
]
];
$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/SupplierContacts"
$Body = @{
"@service" = "apps/com.hornbill.suppliermanager/SupplierContacts"
"@method" = "addSupplierContact"
params = @{
supplierId = "xs:integer"
firstName = "xs:string"
lastName = "xs:string"
jobTitle = "xs:string"
status = "xs:string"
phoneNumber = "xs:string"
phoneNumber2 = "xs:string"
phoneNumber3 = "xs:string"
emailAddress = "xs:string"
emailAddress2 = "xs:string"
emailAddress3 = "xs:string"
notes = "xs:string"
country = "xs:string"
language = "xs:string"
custom0 = "xs:string"
custom1 = "xs:string"
custom2 = "xs:string"
custom3 = "xs:string"
custom4 = "xs:string"
custom5 = "xs:string"
}
}
$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/SupplierContacts"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.suppliermanager/SupplierContacts",
"@method":"addSupplierContact",
"params":{
"supplierId":"xs:integer",
"firstName":"xs:string",
"lastName":"xs:string",
"jobTitle":"xs:string",
"status":"xs:string",
"phoneNumber":"xs:string",
"phoneNumber2":"xs:string",
"phoneNumber3":"xs:string",
"emailAddress":"xs:string",
"emailAddress2":"xs:string",
"emailAddress3":"xs:string",
"notes":"xs:string",
"country":"xs:string",
"language":"xs:string",
"custom0":"xs:string",
"custom1":"xs:string",
"custom2":"xs:string",
"custom3":"xs:string",
"custom4":"xs:string",
"custom5":"xs:string",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document