Reference for https://rest-sl.interfax.net/outbound/faxes/{ID}
Url: https://rest-sl.interfax.net/outbound/faxes/{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:
<FaxFull> <id>9223372036854775807</id> <uri>String content</uri> <status>2147483647</status> <userId>String content</userId> <pagesSent>2147483647</pagesSent> <completionTime>1999-05-31T11:20:00</completionTime> <remoteCSID>String content</remoteCSID> <duration>2147483647</duration> <priority>32767</priority> <units>12678967.543233</units> <costPerUnit>12678967.543233</costPerUnit> <attemptsMade>32767</attemptsMade> <submitTime>1999-05-31T11:20:00</submitTime> <contact>String content</contact> <destinationFax>String content</destinationFax> <replyEmail>String content</replyEmail> <subject>String content</subject> <pagesSubmitted>32767</pagesSubmitted> <senderCSID>String content</senderCSID> <attemptsToPerform>32767</attemptsToPerform> <pageSize>String content</pageSize> <pageResolution>String content</pageResolution> <pageOrientation>String content</pageOrientation> <rendering>String content</rendering> <pageHeader>String content</pageHeader> </FaxFull>
The following is an example response Json body:
{
"id":9223372036854775807,
"uri":"String content",
"status":2147483647,
"userId":"String content",
"pagesSent":2147483647,
"completionTime":"\/Date(928149600000+0000)\/",
"remoteCSID":"String content",
"duration":2147483647,
"priority":32767,
"units":12678967.543233,
"costPerUnit":12678967.543233,
"attemptsMade":32767,
"submitTime":"\/Date(928149600000+0000)\/",
"contact":"String content",
"destinationFax":"String content",
"replyEmail":"String content",
"subject":"String content",
"pagesSubmitted":32767,
"senderCSID":"String content",
"attemptsToPerform":32767,
"pageSize":"String content",
"pageResolution":"String content",
"pageOrientation":"String content",
"rendering":"String content",
"pageHeader":"String content"
}
The following is the response Xml Schema:
<xs:schema elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="FaxFull" nillable="true" type="FaxFull" />
<xs:complexType name="FaxFull">
<xs:complexContent mixed="false">
<xs:extension base="FaxSummary">
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" name="submitTime" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="contact" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="destinationFax" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="replyEmail" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="subject" 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="1" maxOccurs="1" name="attemptsToPerform" type="xs:short" />
<xs:element minOccurs="0" maxOccurs="1" name="pageSize" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="pageResolution" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="pageOrientation" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="rendering" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="pageHeader" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="FaxSummary">
<xs:complexContent mixed="false">
<xs:extension base="FaxResults">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" name="userId" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="pagesSent" type="xs:int" />
<xs:element minOccurs="1" maxOccurs="1" name="completionTime" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="remoteCSID" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="duration" type="xs:int" />
<xs:element minOccurs="1" maxOccurs="1" name="priority" type="xs:short" />
<xs:element minOccurs="1" maxOccurs="1" name="units" type="xs:decimal" />
<xs:element minOccurs="1" maxOccurs="1" name="costPerUnit" type="xs:decimal" />
<xs:element minOccurs="1" maxOccurs="1" name="attemptsMade" type="xs:short" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="FaxResults">
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" name="id" type="xs:long" />
<xs:element minOccurs="0" maxOccurs="1" name="uri" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="status" type="xs:int" />
</xs:sequence>
</xs:complexType>
</xs:schema>