OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

SetSignupPlacement

This method allows one to specify a particular placement for a new online signup (new rep). One can specify the rep number and the BCposition. Depending on the Genealogy of the client one is using, this can values such as 'L' or 'R' or '1','2','3','4' etc. One may need to contact ByDesign in order to find which BCPosition values are accepted for the client one is programming for.

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

<?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>
    <SetSignupPlacement xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <SetPlacementRequest>
        <OnlineSignupID>int</OnlineSignupID>
        <SetPlacement>boolean</SetPlacement>
        <RepNumber>string</RepNumber>
        <Position>string</Position>
      </SetPlacementRequest>
    </SetSignupPlacement>
  </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>
    <SetSignupPlacementResponse xmlns="http://www.securefreedom.com/">
      <SetSignupPlacementResult>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </SetSignupPlacementResult>
    </SetSignupPlacementResponse>
  </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>
    <SetSignupPlacement xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <SetPlacementRequest>
        <OnlineSignupID>int</OnlineSignupID>
        <SetPlacement>boolean</SetPlacement>
        <RepNumber>string</RepNumber>
        <Position>string</Position>
      </SetPlacementRequest>
    </SetSignupPlacement>
  </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>
    <SetSignupPlacementResponse xmlns="http://www.securefreedom.com/">
      <SetSignupPlacementResult>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </SetSignupPlacementResult>
    </SetSignupPlacementResponse>
  </soap12:Body>
</soap12:Envelope>