Therefore Web API Programming Interface 1.0

ValidateFields

Scroll

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/ValidateFields

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ValidateFields

Validates values for a specified index data fields (for search and edit).

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ValidateFields

Element Name	Element Type	Restrictions	Description
■ parameters
□ CaseDefinitionNo	xs:int	nillable	Set the case definition number. If you set CaseDefinitionNo then the CategoryNo should not be set.
□ CategoryNo	xs:int	nillable	Set the category number. If you set CategoryNo then the CaseDefinitionNo should not be set.
□ Fields		mandatory nillable	Sets data for the fields to validate.
≡ WSValidateFieldRequest		list nillable
■ FieldNoToValidate	xs:int	mandatory	Sets number of the field.
□ FieldValueToValidate	xs:string	mandatory nillable	Sets field value for validation.
□ RowNoTag	xs:int	nillable	Sets a row number tag to be returned in the result. For non-table fields don't set it or set it to null. Use it to map validation error on a table field/row.
■ IgnoreMandatoryfields	xs:boolean		Sets to True to ignore mandatory fields.
■ IsQueryMode	xs:boolean		Sets to True to validate field value for search. Set to False (default) value to validate field value for editing/updateing.
■ ReturnSuccessfullResults	xs:boolean		Sets to True to return sucessfull validation result items in the response together with the validation error items.

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ValidateFieldsResponse

Element Name	Element Type	Restrictions	Description
■ parameters
□ Fields		nillable	Gets validation result.
≡ WSValidateFieldResult		list nillable
■ FieldNo	xs:int		Gets number of the field.
□ ErrorMessage	xs:string	nillable	Gets validation error message if IsValid is False.
■ IsValid	xs:boolean		Returns True if field value is valid.
□ RowNoTag	xs:int	nillable	Gets row number tag from the request. Use it to map validation error on a table field/row.

Legend: