The Format Parameter
Most requests to PXWeb support a common parameter named Format, which instructs PXWeb to perform a transformation on the XML result before being delivered to the client program.
The value of this parameter is a three letter code that indicates the final format of the result according to the following table:
| Prefix | Description |
|---|---|
| XML | This is the default value and returns an XML result without any transformation. |
| CSV | A series of rows with comma separated fields. |
| JSN | A JSON representation of contents of the result. |
The base formats are identified by the three letter codes from the above table; however, as more formats are added they will be identified by the three letter code used as a preffix and followed by a code to make them unique like, for example, JSN1 or CSV1.
The specific list of Format codes supported for each report is included at the end of each documentation page.
An XML result is returned in the case of an exception and the client program must verify for this condition before taking any further action with the result.
XML is the only format supported by SOAP requests.