Getting Categories With Custom Fields
Getting Categories With Custom Fields
Name Value
REST-API METHOD GETTING CATEGORIES WITH CUSTOM FIELDS
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/jsonAuthorization: Basic {base64 encoded username:password} Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 Content-Type: application/xml
  • XML
  • JSON
ENDPOINT DEFINITION
GET
RESPONSE BODY
                                    
                                        <ArrayOfCategory
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Category>
		<CategoryID>{CategoryID}</CategoryID>
		<CategoryName>{CategoryName}</CategoryName>
		<ParentCategoryID>{ParentCategoryID}</ParentCategoryID>
		<CustomFields>
			<CustomField CustomFieldID="{CustomFieldID}">
				<CustomFieldName>{CustomFieldName}</CustomFieldName>
				<CustomFieldValueID>{CustomFieldValueID}</CustomFieldValueID>
				<CustomFieldValues>
					<CustomFieldReferenceValue CustomFieldReferenceValueID="{CustomFieldReferenceValueID}">
						<CustomFieldReferenceValueText>{CustomFieldReferenceValueText}</CustomFieldReferenceValueText>
					</CustomFieldReferenceValue>
					<CustomFieldReferenceValue CustomFieldReferenceValueID="{CustomFieldReferenceValueID}">
						<CustomFieldReferenceValueText>{CustomFieldReferenceValueText}</CustomFieldReferenceValueText>
					</CustomFieldReferenceValue>
				</CustomFieldValues>
				<IssueID>{IssueID}</IssueID>
				<IsRequiredOnIssueEntry>{IsRequiredOnIssueEntry}</IsRequiredOnIssueEntry>
				<IsRequiredOnIssueForward>{IsRequiredOnIssueForward}</IsRequiredOnIssueForward>
				<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}",
                "CustomFieldValueID": "{CustomFieldValueID}",
                "CustomFieldValues": {
                    "CustomFieldReferenceValue": [
                        {
                            "CustomFieldReferenceValueID": "{CustomFieldReferenceValueID}",
                            "CustomFieldReferenceValueText": "{CustomFieldReferenceValueText}"
                        },
                        {
                            "CustomFieldReferenceValueID": "{CustomFieldReferenceValueID}",
                            "CustomFieldReferenceValueText": "{CustomFieldReferenceValueText}"
                        }
                    ]
                },
                "IssueID": "{IssueID}",
                "IsRequiredOnIssueEntry": [
                    "{IsRequiredOnIssueEntry}",
                    {}
                ],
                "IsRequiredOnIssueForward": [
                    "{IsRequiredOnIssueForward}",
                    {}
                ],
                "IsRequiredOnIssueResolve": {},
                "IsRequiredOnIssueRespond": {},
                "IsRequiredOnIssueClose": {},
                "IsRequiredOnIssueCancel": {}
            }
        }
    }
}