Set Composite Custom Field Reference Values
Set Composite Custom Field Reference Values

This method adds composite custom field reference values. The client makes a POST request providing Request body in either xml or json format and input parameter LangID in the request url. The output will be either in json or xml format depending on the request type. Response returns list of Composite Custom Field Reference Values that add is success.

Custom sub field count in the system should be equal to Request Body sub field count. Otherwise, the result is: <?xml version=”1.0″ encoding=”utf-8″?> <string>Please check the number of subfield provided.</string>
Name Value
REST-API METHOD SET COMPOSITE CUSTOM FIELD REFERENCE VALUES
HTTP METHOD POST
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/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
POST
REQUEST BODY
                                    
                                        <CompositeCustomField CustomFieldID="{CustomFieldID}">
	<CompositeCustomFieldReferences>
		<CompositeCustomFieldReference>
			<CompositeCustomFieldReferenceValues>
				<CustomSubField CustomSubFieldID="{CustomSubFieldID}">
					<CustomSubFieldValues>
						<CustomFieldReferenceValue>
							<CustomFieldReferenceValueText>{ValueText}</CustomFieldReferenceValueText>
						</CustomFieldReferenceValue>
					</CustomSubFieldValues>
				</CustomSubField>
				<CustomSubField CustomSubFieldID="{CustomSubFieldID}">
					<CustomSubFieldValues>
						<CustomFieldReferenceValue>
							<CustomFieldReferenceValueText>{ValueText}</CustomFieldReferenceValueText>
						</CustomFieldReferenceValue>
					</CustomSubFieldValues>
				</CustomSubField>
				<CustomSubField CustomSubFieldID="{CustomSubFieldID}">
					<CustomSubFieldValues>
						<CustomFieldReferenceValue>
							<CustomFieldReferenceValueText>{ValueText}</CustomFieldReferenceValueText>
						</CustomFieldReferenceValue>
					</CustomSubFieldValues>
				</CustomSubField>
			</CompositeCustomFieldReferenceValues>
		</CompositeCustomFieldReference>
	</CompositeCustomFieldReferences>
</CompositeCustomField>                                    
                                
                                                                        
                                        {
    "CustomFieldID": "{CustomFieldID}",
    "CompositeCustomFieldReferences": {
        "CompositeCustomFieldReference": {
            "CompositeCustomFieldReferenceValues": {
                "CustomSubField": [
                    {
                        "CustomSubFieldID": "{CustomSubFieldID}",
                        "CustomSubFieldValues": {
                            "CustomFieldReferenceValue": {
                                "CustomFieldReferenceValueText": "{ValueText}"
                            }
                        }
                    },
                    {
                        "CustomSubFieldID": "{CustomSubFieldID}",
                        "CustomSubFieldValues": {
                            "CustomFieldReferenceValue": {
                                "CustomFieldReferenceValueText": "{ValueText}"
                            }
                        }
                    },
                    {
                        "CustomSubFieldID": "{CustomSubFieldID}",
                        "CustomSubFieldValues": {
                            "CustomFieldReferenceValue": {
                                "CustomFieldReferenceValueText": "{ValueText}"
                            }
                        }
                    }
                ]
            }
        }
    }
}                                    
                                                                    
RESPONSE BODY
If operation is succesful “Success”. If Custom sub field count in the system is not EQUAL to Request Body sub field count. Please check the number of subfield provided.
                                    
                                        <?xml version="1.0" encoding="utf-8"?>
<string>result message</string>                                    
                                
                                                                        
                                        {
    "0": "result message"
}