» Delete Custom Field Value

METHODS

Delete Custom Field Value

This method deletes custom field values. The client makes a PUT request providing Request body in either xml or json format and input parameter BusinessChannelID and LangID in the request url. The output will be either in json or xml format depending on the request type. Response returns success or fail of the operation as boolean.

Please note that if “CustomFieldID” value in CustomField node is not used to find Custom Field, “CustomFieldName” or “FieldCode” value in CustomField node is used and “CustomFieldID” should be 0. Moreover, if “CustomFieldReferenceValueID” value in CustomFieldReferenceValue node is not used to find Custom Field Value, “ValueCode” value in CustomFieldReferenceValue node is used and “CustomFieldReferenceValueID” should be 0.

Name	Value
REST-API METHOD	DELETE CUSTOM FIELD VALUE
HTTP METHOD	PUT
RESPONSE TYPE	XML
URL	https://api.csm.next4biz.net/services/CustomFieldService/{CompanyID}/deleteCustomFieldValue.json/{BusinessChannelID }/{LangID}	https://api.csm.next4biz.net/services/CustomFieldService/{CompanyID}/deleteCustomFieldValue.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
JSON

ENDPOINT DEFINITION

PUT

REQUEST BODY

                                    
                                        <CustomField CustomFieldID="{CustomFieldID}">
	<CustomFieldName>[CustomFieldName}</CustomFieldName>
	<CustomFieldValues>
		<CustomFieldReferenceValue CustomFieldReferenceValueID="{CustomFieldReferenceValueID}">
			<ValueCode>@ValueCode</ValueCode>
		</CustomFieldReferenceValue>
	</CustomFieldValues>
	<FieldCode>@FieldCode</FieldCode>
</CustomField>

                                                                        
                                        {
    "CustomFieldID": "{CustomFieldID}",
    "CustomFieldName": "[CustomFieldName}",
    "CustomFieldValues": {
        "CustomFieldReferenceValue": {
            "CustomFieldReferenceValueID": "{CustomFieldReferenceValueID}",
            "ValueCode": "@ValueCode"
        }
    },
    "FieldCode": "@FieldCode"
}

RESPONSE BODY

                                    
                                        <boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
  {OperationResult}
</boolean>

                                                                        
                                        {
    "0": "\n  {OperationResult}\n"
}