OrderQuotationCheck URL
Check for quotation orders then redirect to one of three specified URLs, depending on the results of the check.
URL structure
- http:// host_name/ path/
- The fully qualified name of your Transaction server and the configuration path.
Parameter values
- orderQuotationRelId
- Specifies the ID of the OrderQuotationRel objects to be checked. The default value of this parameter is "*initial*parent.", an OrderQuotationRel abbreviation specifying all of the OrderQuotationRel objects whose type is "initial" and whose parent is one of the current pending orders for the current user. (OrderQuotationRel abbreviations are described in more detail in the help for Order Management subsystem URLs.) This parameter can be repeated.
- outOkOrderQuotationRelIdName
- Specifies the name-value pairs that should be added to the redirection URL. The values of the added name-value pairs are the identifiers of the checked OrderQuotationRel objects that have a child order. This parameter can be repeated.
- outTimeoutOrderQuotationRelIdName
- Specifies the name-value pairs that should be added to the redirection URL. The values of the added name-value pairs are the identifiers of the checked OrderQuotationRel objects that do not yet have child orders but whose timeoutTime attribute values are less than the current time. This parameter can be repeated.
- outWaitOrderQuotationRelIdName
- Specifies the name-value pairs that should be added to the redirection URL. The values of the added name-value pairs are the identifiers of the checked OrderQuotationRel objects that do not yet have child orders but whose timeoutTime attribute values are not less than the current time. This parameter can be repeated.
- okURL
- Specifies the redirection URL that is returned if child orders exist for all the checked OrderQuotationRel objects. This parameter is required.
- waitURL
- Specifies the redirection URL that is returned if some of the checked OrderQuotationRel objects do not yet have child orders but none of them has a timeoutTime less than the current time. The value of this parameter defaults to the value of the okURL parameter.
- timeoutURL
- Specifies the redirection URL that is returned if some of the checked OrderQuotationRel objects do not yet have child orders but have a timeoutTime less than the current time. The value of this parameter defaults to the value of the waitURL parameter.
- errorURL
- Specifies the redirection URL that is returned if some of the checked OrderQuotationRel objects indicate that an error status was returned from the external system requested to provide quotation information less than the current time. This parameter is optional.
Example 1
The following example checks for responses to a previous request for initial quotations for the current shop cart. It redirects to one of four different URLs, depending on whether
- Some responses have indicated that an error occurred
- All responses have been received without error
- Some responses have not been received and their timeout values have been exceeded
- Some responses have not been received but none have timed out yet
The identifiers of the OrderQuotationRel objects that have been received, timed out, or are still waiting are returned in the receivedRelIds, timedoutRelIds, and waitingRelIds response properties.
http://myhostname/webapp/wcs/stores/servlet/OrderQuotationCheck?storeId=1111
&orderQuotationRelId=*initial*parent.
&errorURL=ShowErrorResponse
&okURL=AllResponsesReceived
&timeoutURL=SomeResponsesTimedOut
&waitURL=ShowWaitingMessagePauseAndCheckAgain
&outOKOrderQuotationRelIdName=receivedRelIds
&outTimeoutOrderQuotationRelIdName=timedoutRelIds
&outWaitOrderQuotationRelIdName=waitingRelIds
Example 2
The following example checks for responses to a previous request for final quotations for the shop cart with order identifier 1234. Otherwise, it is the same as Example 1.
http://myhostname/webapp/wcs/stores/servlet/OrderQuotationCheck?storeId=1111
&orderQuotationRelId=*final*parent1234
&errorURL=ShowErrorResponse
&okURL=AllResponsesReceived
&timeoutURL=SomeResponsesTimedOut
&waitURL=ShowWaitingMessagePauseAndCheckAgain
&outOKOrderQuotationRelIdName=receivedRelIds
&outTimeoutOrderQuotationRelIdName=timedoutRelIds
&outWaitOrderQuotationRelIdName=waitingRelIds
Behavior
- If the errorURL parameter was specified and some of the specified OrderQuotationRel objects indicate that an error status was returned from the external system requested to provide quotation information, redirect to the URL specified by the errorURL parameter.
- Otherwise, if all the specified OrderQuotationRel objects indicate a child order, redirect to the URL specified by the okURL parameter.
- Otherwise, if some of the specified OrderQuotationRel objects do not have a child order but have a timeoutTime less than the current time, redirect to the URL specified by the timeoutURL parameter.
- Otherwise, redirect to the URL specified by the waitURL parameter.
- Add name-values pairs to the response properties as specified by the outOkOrderQuotationRelIdName, outTimeoutOrderQuotationRelIdName, and outWaitOrderQuotationRelIdName parameters.
- If some of the specified OrderQuotationRel objects indicate an error status, add name-value pairs to the response properties. The names of the name-value pairs are "failOrderQuotationRelId", and the values are the identifiers of those OrderQuotationRel objects.
Exception conditions
- If the value of the specified input parameter is missing or invalid, the command throws an ECApplicationException with error message _ERR_BAD_MISSING_CMD_PARAMETER and error view GenericApplicationError.