Reply Mapping
Reply Mapping
SLIM CD webservice return blocks and SLIM CD library reply structures both have a standard set of fields/properties that are returned.
reply
response
responsecode
description
responseurl
datablock
The data inside the datablock will vary from web service to web service. Some web services will return a single line of test. Most web services will use the datablock as a wrapper for additional structures of information. See the DESCRIPTION tab on each individual function to identify the data contained in the datablock and the structure of that data. Each library contains the elements inside the datablock. Some of those items may be arrays of information.
Example XML datablock:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
<?xml version="1.0" encoding="utf-8" ?> <reply> <response>Success</response> <responsecode>0</responsecode> <description>OK</description> <responseurl><a href="http://stats.slimcd.com/wswebservices/reports.asmx/GetBatchHistory">http://stats.slimcd.com/wswebservices/reports.asmx/GetBatchHistory</a> </responseurl> <datablock> <Batches> <BatchRecord> <ID>1</ID> <BatchDate>6/15/2005 8:57:00 AM</BatchDate> <MerchantID>999999999999</MerchantID> <BatchNumber>001</BatchNumber> <RecordCount>4</RecordCount> <ResponseCode>GB</ResponseCode> <ResponseText>_ACCEPTED</ResponseText> <Amount>8.0000</Amount> <ErrorCodes /> <ErrorData /> </BatchRecord> <BatchRecord> <ID>2</ID> <BatchDate>6/15/2005 9:08:00 AM</BatchDate> <MerchantID>999999999999</MerchantID> <BatchNumber>002</BatchNumber> <RecordCount>2</RecordCount> <ResponseCode>GB</ResponseCode> <ResponseText>_ACCEPTED</ResponseText> <Amount>8.0000</Amount> <ErrorCodes /> <ErrorData /> </BatchRecord> </Batches> </datablock> </reply> |
Example of a reply object within the library: (Note that datablock has been dropped for brevity)
SlimCD.Reports.GetBatchHistoryReply.response
SlimCD.Reports.GetBatchHistoryReply.responsecode
SlimCD.Reports.GetBatchHistoryReply.description
SlimCD.Reports.GetBatchHistoryReply.responseurl
SlimCD.Reports.GetBatchHistoryReply.Batches (array of BatchRecords)
SlimCD.Reports.GetBatchHistoryReply.Batches[0].BatchRecord.ID
SlimCD.Reports.GetBatchHistoryReply.Batches[0].BatchRecord.MerchantID
SlimCD.Reports.GetBatchHistoryReply.Batches[0].BatchRecord.BatchNumber
Etc…
In most cases, the “datablock” entry has been dropped from the reply structures to shorten the nesting of the data. In cases where the only thing returned in the datablock is a text string (like CloseBatch), the datablock object will be included as a string, with that text as it’s value.