OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

GetRepInfo

This method will return information for a representative for its given Rep# or URL. Deprecation Note: This API has been deprecated in favor of our REST API: ~/api/rep/PublicInfo?repDID={repDID}.

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

<?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>
    <GetRepInfo xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <RepNumberOrURL>string</RepNumberOrURL>
    </GetRepInfo>
  </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>
    <GetRepInfoResponse xmlns="http://www.securefreedom.com/">
      <GetRepInfoResult>
        <RepID>int</RepID>
        <RepDID>string</RepDID>
        <Company>string</Company>
        <Firstname>string</Firstname>
        <Lastname>string</Lastname>
        <Email>string</Email>
        <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>
        <Phone1>string</Phone1>
        <Phone2>string</Phone2>
        <PictureFilename>string</PictureFilename>
        <ReplicatedSiteText>string</ReplicatedSiteText>
        <SponsorRepDID>string</SponsorRepDID>
        <SponsorRepCount>int</SponsorRepCount>
        <RepRank>
          <RankID>int</RankID>
          <RankDescription>string</RankDescription>
          <RankAbbreviation>string</RankAbbreviation>
        </RepRank>
        <URL>string</URL>
        <UplineRepDID>string</UplineRepDID>
        <JoinDate>string</JoinDate>
        <RepTypeID>int</RepTypeID>
        <RepType>string</RepType>
        <CustomField1>string</CustomField1>
        <CustomField2>string</CustomField2>
        <CustomField3>string</CustomField3>
        <CustomField4>string</CustomField4>
        <CustomField5>string</CustomField5>
        <CustomField6>string</CustomField6>
      </GetRepInfoResult>
    </GetRepInfoResponse>
  </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>
    <GetRepInfo xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <RepNumberOrURL>string</RepNumberOrURL>
    </GetRepInfo>
  </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>
    <GetRepInfoResponse xmlns="http://www.securefreedom.com/">
      <GetRepInfoResult>
        <RepID>int</RepID>
        <RepDID>string</RepDID>
        <Company>string</Company>
        <Firstname>string</Firstname>
        <Lastname>string</Lastname>
        <Email>string</Email>
        <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>
        <Phone1>string</Phone1>
        <Phone2>string</Phone2>
        <PictureFilename>string</PictureFilename>
        <ReplicatedSiteText>string</ReplicatedSiteText>
        <SponsorRepDID>string</SponsorRepDID>
        <SponsorRepCount>int</SponsorRepCount>
        <RepRank>
          <RankID>int</RankID>
          <RankDescription>string</RankDescription>
          <RankAbbreviation>string</RankAbbreviation>
        </RepRank>
        <URL>string</URL>
        <UplineRepDID>string</UplineRepDID>
        <JoinDate>string</JoinDate>
        <RepTypeID>int</RepTypeID>
        <RepType>string</RepType>
        <CustomField1>string</CustomField1>
        <CustomField2>string</CustomField2>
        <CustomField3>string</CustomField3>
        <CustomField4>string</CustomField4>
        <CustomField5>string</CustomField5>
        <CustomField6>string</CustomField6>
      </GetRepInfoResult>
    </GetRepInfoResponse>
  </soap12:Body>
</soap12:Envelope>