OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

GenerateAR

This method will manually generate autoresponders dependent upon the type. Depending upon the client's setting, some of these are sent automatically during signup, order creation, and etc.. One will need to check with the client prior to calling this after each signup/order placement/etc. as that may end up with multiple autoresponders being generated.

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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.bydesign.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/GenerateAR"

<?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>
    <GenerateAR xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <ARType>NewRep or NewCustomer or NewOrder or NewMasterOrder or NewLead</ARType>
      <LocaleID>int</LocaleID>
      <Subject>string</Subject>
    </GenerateAR>
  </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>
    <GenerateARResponse xmlns="http://www.securefreedom.com/">
      <GenerateARResult>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </GenerateARResult>
    </GenerateARResponse>
  </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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.bydesign.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:Body>
    <GenerateAR xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <ARType>NewRep or NewCustomer or NewOrder or NewMasterOrder or NewLead</ARType>
      <LocaleID>int</LocaleID>
      <Subject>string</Subject>
    </GenerateAR>
  </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>
    <GenerateARResponse xmlns="http://www.securefreedom.com/">
      <GenerateARResult>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </GenerateARResult>
    </GenerateARResponse>
  </soap12:Body>
</soap12:Envelope>