Request and response formats

The QuickBooks Online PHP SDK supports serialization of requests and responses to XML format, and compression of data to Gzip and Deflate formats. This collectively helps to reduce the size of request and response messages exchanged across networks, which in turn improves the performance of synchronous service calls to QuickBooks Online. For more information, see Making calls with the REST API.

The SDK allows you to set the serialization and compression format in the config file. If the custom configuration is not defined, the SDK uses the default values to serialize and compress the request and response data. The PHP SDK supports only XML serialization.

You can define either the compression or serialization value alone and let the SDK use the default value for the undefined feature. Setting the compression value to none leaves the data uncompressed. The following code sample shows how to set the serialization format of requests and responses to XML and compression to Gzip:

1
2
3
4
5
6
7
8

<intuit>
   <ipp>
      <message>
         <request serializationFormat="Xml" compressionFormat="GZip" />
         <response serializationFormat="Xml" compressionFormat="GZip"/>
      </message>
   </ipp>
</intuit>