OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

UpdateOnlineSignup

For a given OnlineSignupID, this method will update online signup 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.bydesign.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/UpdateOnlineSignup"

<?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>
    <UpdateOnlineSignup xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <Request>
        <OnlineSignupID>int</OnlineSignupID>
        <SponsorRepNumber>string</SponsorRepNumber>
        <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>
        <ReplicatedURL>string</ReplicatedURL>
        <ReplicatedText>string</ReplicatedText>
        <Password>string</Password>
        <Email>string</Email>
        <RepTypeID>int</RepTypeID>
        <DateOfBirth>dateTime</DateOfBirth>
        <IPAddress>string</IPAddress>
        <PreferredCulture>int</PreferredCulture>
        <PayoutMethodID>int</PayoutMethodID>
        <RomanizedName>string</RomanizedName>
      </Request>
    </UpdateOnlineSignup>
  </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>
    <UpdateOnlineSignupResponse xmlns="http://www.securefreedom.com/">
      <UpdateOnlineSignupResult />
    </UpdateOnlineSignupResponse>
  </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>
    <UpdateOnlineSignup xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <Request>
        <OnlineSignupID>int</OnlineSignupID>
        <SponsorRepNumber>string</SponsorRepNumber>
        <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>
        <ReplicatedURL>string</ReplicatedURL>
        <ReplicatedText>string</ReplicatedText>
        <Password>string</Password>
        <Email>string</Email>
        <RepTypeID>int</RepTypeID>
        <DateOfBirth>dateTime</DateOfBirth>
        <IPAddress>string</IPAddress>
        <PreferredCulture>int</PreferredCulture>
        <PayoutMethodID>int</PayoutMethodID>
        <RomanizedName>string</RomanizedName>
      </Request>
    </UpdateOnlineSignup>
  </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>
    <UpdateOnlineSignupResponse xmlns="http://www.securefreedom.com/">
      <UpdateOnlineSignupResult />
    </UpdateOnlineSignupResponse>
  </soap12:Body>
</soap12:Envelope>