OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

AddPersonalization

For a given order detail ID, this method will add a personalization text to the detail item. By passing the detail ID, the classification type (1=OnlineOrderDetailID,2=OrderDetailID), the personalization string, and the sequence for which to show the personalizations in, the system will add the personalization to the detail item within the order.

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

<?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>
    <AddPersonalization xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <DetailID>int</DetailID>
      <Classification>OnlineOrder or Order</Classification>
      <Personalization>string</Personalization>
      <Sequence>int</Sequence>
    </AddPersonalization>
  </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>
    <AddPersonalizationResponse xmlns="http://www.securefreedom.com/">
      <AddPersonalizationResult>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </AddPersonalizationResult>
    </AddPersonalizationResponse>
  </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>
    <AddPersonalization xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <DetailID>int</DetailID>
      <Classification>OnlineOrder or Order</Classification>
      <Personalization>string</Personalization>
      <Sequence>int</Sequence>
    </AddPersonalization>
  </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>
    <AddPersonalizationResponse xmlns="http://www.securefreedom.com/">
      <AddPersonalizationResult>
        <RequestID>int</RequestID>
        <Success>int</Success>
        <Message>string</Message>
      </AddPersonalizationResult>
    </AddPersonalizationResponse>
  </soap12:Body>
</soap12:Envelope>