Reference for https://rest.interfax.net/outbound/batches/{ID}
Url: https://rest.interfax.net/outbound/batches/{ID}
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:
<BatchHeadStat> <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> <totalOK>2147483647</totalOK> <totalFailed>2147483647</totalFailed> <totalInProcess>2147483647</totalInProcess> </BatchHeadStat>
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,
"totalOK":2147483647,
"totalFailed":2147483647,
"totalInProcess":2147483647
}
The following is the response Xml Schema:
<xs:schema elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="BatchHeadStat" nillable="true" type="BatchHeadStat" />
<xs:complexType name="BatchHeadStat">
<xs:complexContent mixed="false">
<xs:extension base="BatchHead">
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" name="totalOK" type="xs:int" />
<xs:element minOccurs="1" maxOccurs="1" name="totalFailed" type="xs:int" />
<xs:element minOccurs="1" maxOccurs="1" name="totalInProcess" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</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>