n some environments, it is required that an end-user provide a valid reason for having violated certain warnings.

To support this common business situation, it is proposed that a warning block be added to the Update Response Body Format that will give the server a clear way of indicating warnings separately from errors. Additionally, a new request argument is proposed for the Optional Request Arguments section. The new request argument will be called WarningResponse. It will allow a response to be provided by an end-user.

3.1 Add warning-block to the Update Response Body Format

The warning-block is designed to allow the server to send back warnings (errors which will not prevent a record from being saved to the database). For consistency, it will be created identically to the error-block with the addition of a single field.

The warning-block is defined as follows:

warning-block ::= <WARNINGBLOCK>CRLF
                 1*(<WARNINGDATA>field<delimiter>warning-
num<delimiter>warning-offset<delimiter>warning-text<delimiter>response-
required</WARNINGDATA>CRLF)
                 </WARNINGBLOCK>CRLF

A Warning Block is returned when there is a problem with one or more of the fields that did not prevent the record from being saved to the database. It contains the field name, a warning number, some additional text about the warning (warning-text), where in the field data the warning occurred (warning-offset) and an indicator whether an end-user response to this warning is requested or required. The delimiter will be the same delimiter as the one defined for the error-block.

field ::= SQLFIELDNAME

This is the field name that generated the warning.

warning-num ::= 1*5DIGIT

This is the host warning number. This number, along with the warning-text, MAY be displayed to an end-user when looking at the corresponding field in the client application.

warning-offset ::= 1*5DIGIT

This is the offset into the field data that was sent by the client application to the server. It indicates at what character in the field data the problem was encountered. This number is set to zero ("0") if the offset of the error is unknown.

error-text ::= *256ALPHANUM

This is the warning text generated by the host to assist an end-user in determining the problem with the field data. This text is associated with the warning-num.

response-required ::= 0 | 1 | 2

This indicates whether an end- user response to this warning is requested or required as follows:

	0	-	No response is requested
	1	-	A response is requested
	2	-	A response is mandatory

If the response is mandatory, the client MUST send the end-user response for the specific warning-num in the WarningResponse request argument in order for this record to be successfully saved to the database.

3.2 Add WarningResponse to the Optional Request Arguments

This is a key-value pair indicating the responses which were provided for each warning-num that had the response-required field set to 1 or 2.

The key-value MUST be formatted as follows:

warning-num = warning-response *(field-delimiter warning-num = warning-response)

The definitions of the key-value pair fields are:

warning-num ::= 1*5DIGIT

This is the host warning number that was returned in the Update Response Body Format.

user-response ::= *256ALPHANUM

This is the text that the end-user entered in response to the specified warning. If a warning-num has been indicated as a response required of 2, then this string MUST NOT be null.

3.3 Additional Reply Codes

20211 WarningResponse was not given for all warnings that indicated a response-required value of 2.