Web API Response


The Web API sends a response to let you know the status of each entry submitted.

This Solution provides an example. (6531)






The Web API sends a response to let you know the status of each entry submitted.

This example is a Sales Order Line Item (SOLI) Import called "test" (see the escaped url on line 2). It successfully created Sales Order Numbers 8566 and 8567 (SONo on lines 8 and 16). It failed to create the third.

"id" is the submitted name/value that is mapped to Customer PO # or Order # (required to identify each order). If your request maps "web_order" the reply will contain "web_order".

"status" is the result of the nested transaction that handles each object--in this case an order. When the result is "Success" the response includes additional results--a unique id (UID), Sales Order Number (SONo), Customer Listing (CustLisg), and Total (Ttl). When the result is "Failure" there are no additional results.

"exceptions" are included where they occur--in the response or within objects.

"source" is the name and number of a Solution that explains where the exception comes from. With thousands of possible exceptions this is an import part to know first.

"text" is the exception message, including any error code [in brackets] and message--in this case what displays in an alert when an import cannot find an item to use.



Related:

Alerted (6528)