This method returns list of categories for a specific business channel custom fields. The client makes a GET request providing input parameters BusinessChannelID, LangID and CompanyID 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 BUSINESS CHANNEL CUSTOM FIELDS AND CATEGORIES | |
| HTTP METHOD | GET | |
| RESPONSE TYPE | XML | |
| URL | https://api.csm.next4biz.net/services/CustomFieldService/{CompanyID}/getCategoryCustomField.json/{businessChannelID}/{langID} | https://api.csm.next4biz.net/services/CustomFieldService/{CompanyID}/getCategoryCustomField.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"?>
<ArrayOfCategory>
<Category>
<CategoryID>{CategoryID}</CategoryID>
<CategoryName>{CategoryName}</CategoryName>
<ParentCategoryID>{ParentCategoryID}</ParentCategoryID>
<CustomFields>
<CustomField CustomFieldID="{CustomFieldID}">
<CustomFieldName>{CustomFieldName}</CustomFieldName>
<CustomFieldValue/>
<CustomFieldValueID>{CustomFieldValueID}</CustomFieldValueID>
<CustomFieldValues/>
<IssueID>{IssueID}</IssueID>
<IsRequiredOnIssueEntry xsi:nil="true"/>
<IsRequiredOnIssueForward xsi:nil="true"/>
<IsRequiredOnIssueResolve xsi:nil="true"/>
<IsRequiredOnIssueRespond xsi:nil="true"/>
<IsRequiredOnIssueClose xsi:nil="true"/>
<IsRequiredOnIssueCancel xsi:nil="true"/>
</CustomField>
</CustomFields>
</Category>
</ArrayOfCategory>
{
"Category": {
"CategoryID": "{CategoryID}",
"CategoryName": "{CategoryName}",
"ParentCategoryID": "{ParentCategoryID}",
"CustomFields": {
"CustomField": {
"CustomFieldID": "{CustomFieldID}",
"CustomFieldName": "{CustomFieldName}",
"CustomFieldValue": {},
"CustomFieldValueID": "{CustomFieldValueID}",
"CustomFieldValues": {},
"IssueID": "{IssueID}",
"IsRequiredOnIssueEntry": {},
"IsRequiredOnIssueForward": {},
"IsRequiredOnIssueResolve": {},
"IsRequiredOnIssueRespond": {},
"IsRequiredOnIssueClose": {},
"IsRequiredOnIssueCancel": {}
}
}
}
}