Working with Sparse Response Descriptions

The Sparse Response Description (SRD) parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call. An SRD is a SOAP string (which must be a JSON object), in which you specify the elements you want returned. The following example uses the Transaction.fetchByAccount() method, where transactions is the name of the returned data element.

'{"transactions": [ 
 "VID", "merchantTransactionId", "amount", "currency", "timestamp", 
 {"transactionItems": ["sku", "name","price","quantity", "taxType"]}, 
 "statusLog" 
 ]}' 

With this SRD, any transaction object returned will contain just the VID, merchantTransactionId, amount, currency, and timestamp, and two complex sub-items: transactionItemsand statusLog. The transactionItems will be limited to sku, name, price, quantity, and taxType will be complete. Note that some fields are required, either practically or by the WSDL, and will be returned regardless of the SRD. A Transaction object, for example, will always return the VID and the merchantTransactionId. A TransactionItem object will always return name, price, quantity, and itemType. A null SRD element will return the complete response. Parent topic:Support for Development

Home

Guides

APIs