OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

CreateOnlineSignup

This method is step #1 in creating a representative. Essentially, an online signup is a temporary record that holds a potential representatives information. One can enter the below information for a potential representative and create a signup order to go alone with it. There are other methods that one can use in order to finish creating a representative such as CreateRep, but it is strongly suggested to look through most methods in this webservice prior to attempting to create a representative.

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/CreateOnlineSignup"

<?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>
    <CreateOnlineSignup xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineSignupRecord>
        <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>
        <Phone1>string</Phone1>
        <Phone2>string</Phone2>
        <Phone3>string</Phone3>
        <Phone4>string</Phone4>
        <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>
      </OnlineSignupRecord>
    </CreateOnlineSignup>
  </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>
    <CreateOnlineSignupResponse xmlns="http://www.securefreedom.com/">
      <CreateOnlineSignupResult>int</CreateOnlineSignupResult>
    </CreateOnlineSignupResponse>
  </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>
    <CreateOnlineSignup xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <OnlineSignupRecord>
        <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>
        <Phone1>string</Phone1>
        <Phone2>string</Phone2>
        <Phone3>string</Phone3>
        <Phone4>string</Phone4>
        <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>
      </OnlineSignupRecord>
    </CreateOnlineSignup>
  </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>
    <CreateOnlineSignupResponse xmlns="http://www.securefreedom.com/">
      <CreateOnlineSignupResult>int</CreateOnlineSignupResult>
    </CreateOnlineSignupResponse>
  </soap12:Body>
</soap12:Envelope>