Service Web Service

Service

Click here for a complete list of operations.

sendAction

Test

The test form is only available for requests from the local machine.

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 /TF.Server/Service.asmx HTTP/1.1
Host: mx.invoiceware.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/sendAction"

<?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:Header>
    <AuthHeader xmlns="http://tempuri.org/">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <sendAction xmlns="http://tempuri.org/">
      <documents>
        <string>string</string>
        <string>string</string>
      </documents>
      <action>
        <Id>int</Id>
        <Description>string</Description>
        <Name>string</Name>
        <Image>string</Image>
        <QueueName>string</QueueName>
        <QueueType>int</QueueType>
        <DocumentExtension>string</DocumentExtension>
        <Visibility>string</Visibility>
        <Form>
          <Name>string</Name>
          <Description>string</Description>
          <Width>int</Width>
          <Height>int</Height>
          <Fields>
            <Field xsi:nil="true" />
            <Field xsi:nil="true" />
          </Fields>
        </Form>
        <ProcessType>int</ProcessType>
        <PostScript>
          <Id>string</Id>
          <Name>string</Name>
          <Description>string</Description>
          <Code>string</Code>
        </PostScript>
        <QueueNameTransform>
          <Id>string</Id>
          <Name>string</Name>
          <Description>string</Description>
          <Code>string</Code>
        </QueueNameTransform>
        <Condition>
          <Id>string</Id>
          <Name>string</Name>
          <Description>string</Description>
          <Code>string</Code>
        </Condition>
      </action>
      <username>string</username>
    </sendAction>
  </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>
    <sendActionResponse xmlns="http://tempuri.org/">
      <sendActionResult>boolean</sendActionResult>
    </sendActionResponse>
  </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 /TF.Server/Service.asmx HTTP/1.1
Host: mx.invoiceware.com
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:Header>
    <AuthHeader xmlns="http://tempuri.org/">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <sendAction xmlns="http://tempuri.org/">
      <documents>
        <string>string</string>
        <string>string</string>
      </documents>
      <action>
        <Id>int</Id>
        <Description>string</Description>
        <Name>string</Name>
        <Image>string</Image>
        <QueueName>string</QueueName>
        <QueueType>int</QueueType>
        <DocumentExtension>string</DocumentExtension>
        <Visibility>string</Visibility>
        <Form>
          <Name>string</Name>
          <Description>string</Description>
          <Width>int</Width>
          <Height>int</Height>
          <Fields>
            <Field xsi:nil="true" />
            <Field xsi:nil="true" />
          </Fields>
        </Form>
        <ProcessType>int</ProcessType>
        <PostScript>
          <Id>string</Id>
          <Name>string</Name>
          <Description>string</Description>
          <Code>string</Code>
        </PostScript>
        <QueueNameTransform>
          <Id>string</Id>
          <Name>string</Name>
          <Description>string</Description>
          <Code>string</Code>
        </QueueNameTransform>
        <Condition>
          <Id>string</Id>
          <Name>string</Name>
          <Description>string</Description>
          <Code>string</Code>
        </Condition>
      </action>
      <username>string</username>
    </sendAction>
  </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>
    <sendActionResponse xmlns="http://tempuri.org/">
      <sendActionResult>boolean</sendActionResult>
    </sendActionResponse>
  </soap12:Body>
</soap12:Envelope>