Reference for https://rest.interfax.net/outbound/batches?lastID={LASTID}&limit={LIMIT}&sortOrder={SORTORDER}&allUsers={ALLUSERS}
HTTP Method: GET
| Message direction | Format | Body |
|---|---|---|
| Request | N/A | The Request body is empty. |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example response Xml body:
<ArrayOfBatchHead>
<BatchHead>
<batchHeadId>9223372036854775807</batchHeadId>
<userId>String content</userId>
<numOfTransactions>2147483647</numOfTransactions>
<submitTime>1999-05-31T11:20:00</submitTime>
<replyEmail>String content</replyEmail>
<reference>String content</reference>
<pagesSubmitted>32767</pagesSubmitted>
<senderCSID>String content</senderCSID>
<pageSize>String content</pageSize>
<pageOrientation>String content</pageOrientation>
<pageResolution>String content</pageResolution>
<renderingQuality>String content</renderingQuality>
<pageHeader>String content</pageHeader>
<attemptsToPerform>32767</attemptsToPerform>
</BatchHead>
<BatchHead>
<batchHeadId>9223372036854775807</batchHeadId>
<userId>String content</userId>
<numOfTransactions>2147483647</numOfTransactions>
<submitTime>1999-05-31T11:20:00</submitTime>
<replyEmail>String content</replyEmail>
<reference>String content</reference>
<pagesSubmitted>32767</pagesSubmitted>
<senderCSID>String content</senderCSID>
<pageSize>String content</pageSize>
<pageOrientation>String content</pageOrientation>
<pageResolution>String content</pageResolution>
<renderingQuality>String content</renderingQuality>
<pageHeader>String content</pageHeader>
<attemptsToPerform>32767</attemptsToPerform>
</BatchHead>
</ArrayOfBatchHead>
The following is an example response Json body:
[{
"batchHeadId":9223372036854775807,
"userId":"String content",
"numOfTransactions":2147483647,
"submitTime":"\/Date(928149600000+0000)\/",
"replyEmail":"String content",
"reference":"String content",
"pagesSubmitted":32767,
"senderCSID":"String content",
"pageSize":"String content",
"pageOrientation":"String content",
"pageResolution":"String content",
"renderingQuality":"String content",
"pageHeader":"String content",
"attemptsToPerform":32767
}]
The following is the response Xml Schema:
<xs:schema elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="ArrayOfBatchHead" nillable="true" type="ArrayOfBatchHead" />
<xs:complexType name="ArrayOfBatchHead">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="BatchHead" nillable="true" type="BatchHead" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="BatchHead">
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" name="batchHeadId" type="xs:long" />
<xs:element minOccurs="0" maxOccurs="1" name="userId" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="numOfTransactions" type="xs:int" />
<xs:element minOccurs="1" maxOccurs="1" name="submitTime" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="replyEmail" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="reference" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="pagesSubmitted" type="xs:short" />
<xs:element minOccurs="0" maxOccurs="1" name="senderCSID" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="pageSize" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="pageOrientation" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="pageResolution" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="renderingQuality" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="pageHeader" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="attemptsToPerform" type="xs:short" />
</xs:sequence>
</xs:complexType>
</xs:schema>