OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

UpdateRepPrefPlacement

This method will allows representative's preferred placement to be updated. Note: The placement position context can change depending upon the genealogy type of the client. It is suggested to contact ByDesign concerning the correct placement type to use and how it correlates to the placement during enrollment.

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

<?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>
    <UpdateRepPrefPlacement xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <RepPrefPlacement>
        <PlacementRepDID>string</PlacementRepDID>
        <PlacementBCDID>string</PlacementBCDID>
        <BCDID>string</BCDID>
        <PlacementPosition>string</PlacementPosition>
      </RepPrefPlacement>
      <RepDID>string</RepDID>
    </UpdateRepPrefPlacement>
  </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>
    <UpdateRepPrefPlacementResponse xmlns="http://www.securefreedom.com/">
      <UpdateRepPrefPlacementResult>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </UpdateRepPrefPlacementResult>
    </UpdateRepPrefPlacementResponse>
  </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>
    <UpdateRepPrefPlacement xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <RepPrefPlacement>
        <PlacementRepDID>string</PlacementRepDID>
        <PlacementBCDID>string</PlacementBCDID>
        <BCDID>string</BCDID>
        <PlacementPosition>string</PlacementPosition>
      </RepPrefPlacement>
      <RepDID>string</RepDID>
    </UpdateRepPrefPlacement>
  </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>
    <UpdateRepPrefPlacementResponse xmlns="http://www.securefreedom.com/">
      <UpdateRepPrefPlacementResult>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </UpdateRepPrefPlacementResult>
    </UpdateRepPrefPlacementResponse>
  </soap12:Body>
</soap12:Envelope>