This method returns list of Custom Fields for a specific company. The client makes a GET request providing input parameters BusinessChannelID , Company ID and LangID in the request url. The output will be either in json or xml format depending on the request type.
| Name | Value | |
|---|---|---|
| REST-API METHOD | GET COMPANY CUSTOM FIELDS BY COMPANY ID | |
| HTTP METHOD | GET | |
| RESPONSE TYPE | XML | |
| URL | https://api.csm.next4biz.net/services/CustomFieldService/{CompanyID}/customField.json/{BusinessChannelID}/{LangID} | https://api.csm.next4biz.net/services/CustomFieldService/{CompanyID}/customField.xml/{BusinessChannelID}/{LangID} |
| REQUEST HEAD | Authorization: Basic {base64 encoded username:password} Accept: text/html,application/xhtml+json,application/json;q=0.9,*/*;q=0.8 Content-Type: application/json | Authorization: Basic {base64 encoded username:password} Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 Content-Type: application/xml |
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCustomField>
<CustomField CustomFieldID="{CustomFieldID}">
<CustomFieldName>{CustomFieldName}</CustomFieldName>
<CustomFieldValueID>{CustomFieldValueID}</CustomFieldValueID>
<CustomFieldValues>
<CustomFieldReferenceValue CustomFieldReferenceValueID="{ID}">
<CustomFieldReferenceValueText>{ValueText}</CustomFieldReferenceValueText>
</CustomFieldReferenceValue>
</CustomFieldValues>
<IssueID>{IssueID}</IssueID>
<IsRequiredOnIssueEntry />
<IsRequiredOnIssueForward />
<IsRequiredOnIssueResolve />
<IsRequiredOnIssueRespond />
<IsRequiredOnIssueClose />
<IsRequiredOnIssueCancel />
</CustomField>
</ArrayOfCustomField>
{
"CustomField": {
"CustomFieldID": "{CustomFieldID}",
"CustomFieldName": "{CustomFieldName}",
"CustomFieldValueID": "{CustomFieldValueID}",
"CustomFieldValues": {
"CustomFieldReferenceValue": {
"CustomFieldReferenceValueID": "{ID}",
"CustomFieldReferenceValueText": "{ValueText}"
}
},
"IssueID": "{IssueID}",
"IsRequiredOnIssueEntry": {},
"IsRequiredOnIssueForward": {},
"IsRequiredOnIssueResolve": {},
"IsRequiredOnIssueRespond": {},
"IsRequiredOnIssueClose": {},
"IsRequiredOnIssueCancel": {}
}
}