Inbound
Click here for a complete list of operations.
GetDocumentHeader
Get the document header properties by document ID
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /inbound.asmx HTTP/1.1
Host: ws.interfax.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.interfax.net/GetDocumentHeader"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetDocumentHeader xmlns="http://www.interfax.net">
<Username>string</Username>
<Password>string</Password>
<DocumentId>long</DocumentId>
</GetDocumentHeader>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetDocumentHeaderResponse xmlns="http://www.interfax.net">
<GetDocumentHeaderResult>
<Properties>
<DocumentId>long</DocumentId>
<Name>string</Name>
<Reference>string</Reference>
<DocumentType>Any or Inbound or Shared</DocumentType>
<ExternalReference>string</ExternalReference>
<ExternalDocumentType>Inbound or Upload or InboundEmail or InternalUpload</ExternalDocumentType>
</Properties>
<ResultCode>int</ResultCode>
</GetDocumentHeaderResult>
</GetDocumentHeaderResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /inbound.asmx HTTP/1.1
Host: ws.interfax.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetDocumentHeader xmlns="http://www.interfax.net">
<Username>string</Username>
<Password>string</Password>
<DocumentId>long</DocumentId>
</GetDocumentHeader>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetDocumentHeaderResponse xmlns="http://www.interfax.net">
<GetDocumentHeaderResult>
<Properties>
<DocumentId>long</DocumentId>
<Name>string</Name>
<Reference>string</Reference>
<DocumentType>Any or Inbound or Shared</DocumentType>
<ExternalReference>string</ExternalReference>
<ExternalDocumentType>Inbound or Upload or InboundEmail or InternalUpload</ExternalDocumentType>
</Properties>
<ResultCode>int</ResultCode>
</GetDocumentHeaderResult>
</GetDocumentHeaderResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /inbound.asmx/GetDocumentHeader?Username=string&Password=string&DocumentId=string HTTP/1.1 Host: ws.interfax.net
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<HeaderProperties xmlns="http://www.interfax.net">
<Properties>
<DocumentId>long</DocumentId>
<Name>string</Name>
<Reference>string</Reference>
<DocumentType>Any or Inbound or Shared</DocumentType>
<ExternalReference>string</ExternalReference>
<ExternalDocumentType>Inbound or Upload or InboundEmail or InternalUpload</ExternalDocumentType>
</Properties>
<ResultCode>int</ResultCode>
</HeaderProperties>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /inbound.asmx/GetDocumentHeader HTTP/1.1 Host: ws.interfax.net Content-Type: application/x-www-form-urlencoded Content-Length: length Username=string&Password=string&DocumentId=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<HeaderProperties xmlns="http://www.interfax.net">
<Properties>
<DocumentId>long</DocumentId>
<Name>string</Name>
<Reference>string</Reference>
<DocumentType>Any or Inbound or Shared</DocumentType>
<ExternalReference>string</ExternalReference>
<ExternalDocumentType>Inbound or Upload or InboundEmail or InternalUpload</ExternalDocumentType>
</Properties>
<ResultCode>int</ResultCode>
</HeaderProperties>