OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

UpdateOnlineCustomer

For a given OnlineCustomerID, this method will update online customer information. Only populated input fields will be updated.

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.securefreedom.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/UpdateOnlineCustomer"

<?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>
    <UpdateOnlineCustomer xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <Request>
        <OnlineCustomerID>int</OnlineCustomerID>
        <RepNumber>string</RepNumber>
        <Firstname>string</Firstname>
        <Lastname>string</Lastname>
        <Company>string</Company>
        <BillStreet1>string</BillStreet1>
        <BillStreet2>string</BillStreet2>
        <BillCity>string</BillCity>
        <BillState>string</BillState>
        <BillPostalCode>string</BillPostalCode>
        <BillCounty>string</BillCounty>
        <BillCountry>string</BillCountry>
        <ShipStreet1>string</ShipStreet1>
        <ShipStreet2>string</ShipStreet2>
        <ShipCity>string</ShipCity>
        <ShipState>string</ShipState>
        <ShipPostalCode>string</ShipPostalCode>
        <ShipCounty>string</ShipCounty>
        <ShipCountry>string</ShipCountry>
        <TaxID>string</TaxID>
        <TaxID2>string</TaxID2>
        <Phone1>string</Phone1>
        <Phone2>string</Phone2>
        <Phone3>string</Phone3>
        <Phone4>string</Phone4>
        <Phone5>string</Phone5>
        <Phone6>string</Phone6>
        <Password>string</Password>
        <Email>string</Email>
        <CustomerTypeID>int</CustomerTypeID>
        <StatusTypeID>int</StatusTypeID>
        <IPAddress>string</IPAddress>
        <PreferredCulture>int</PreferredCulture>
        <BCNumber>int</BCNumber>
        <ReferCustomerDID>string</ReferCustomerDID>
        <DateOfBirth>dateTime</DateOfBirth>
      </Request>
    </UpdateOnlineCustomer>
  </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>
    <UpdateOnlineCustomerResponse xmlns="http://www.securefreedom.com/">
      <UpdateOnlineCustomerResult />
    </UpdateOnlineCustomerResponse>
  </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.securefreedom.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>
    <UpdateOnlineCustomer xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <Request>
        <OnlineCustomerID>int</OnlineCustomerID>
        <RepNumber>string</RepNumber>
        <Firstname>string</Firstname>
        <Lastname>string</Lastname>
        <Company>string</Company>
        <BillStreet1>string</BillStreet1>
        <BillStreet2>string</BillStreet2>
        <BillCity>string</BillCity>
        <BillState>string</BillState>
        <BillPostalCode>string</BillPostalCode>
        <BillCounty>string</BillCounty>
        <BillCountry>string</BillCountry>
        <ShipStreet1>string</ShipStreet1>
        <ShipStreet2>string</ShipStreet2>
        <ShipCity>string</ShipCity>
        <ShipState>string</ShipState>
        <ShipPostalCode>string</ShipPostalCode>
        <ShipCounty>string</ShipCounty>
        <ShipCountry>string</ShipCountry>
        <TaxID>string</TaxID>
        <TaxID2>string</TaxID2>
        <Phone1>string</Phone1>
        <Phone2>string</Phone2>
        <Phone3>string</Phone3>
        <Phone4>string</Phone4>
        <Phone5>string</Phone5>
        <Phone6>string</Phone6>
        <Password>string</Password>
        <Email>string</Email>
        <CustomerTypeID>int</CustomerTypeID>
        <StatusTypeID>int</StatusTypeID>
        <IPAddress>string</IPAddress>
        <PreferredCulture>int</PreferredCulture>
        <BCNumber>int</BCNumber>
        <ReferCustomerDID>string</ReferCustomerDID>
        <DateOfBirth>dateTime</DateOfBirth>
      </Request>
    </UpdateOnlineCustomer>
  </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>
    <UpdateOnlineCustomerResponse xmlns="http://www.securefreedom.com/">
      <UpdateOnlineCustomerResult />
    </UpdateOnlineCustomerResponse>
  </soap12:Body>
</soap12:Envelope>