soap Web Service

soap

Click here for a complete list of operations.

AddImageToQueue

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 /soap.asmx HTTP/1.1
Host: api.pixelz.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://removethebackground.com/AddImageToQueue"

<?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>
    <AddImageToQueue xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <developerAPIkey>string</developerAPIkey>
      <templateId>string</templateId>
      <imageURL>string</imageURL>
      <imageURL2>string</imageURL2>
      <imageURL3>string</imageURL3>
      <imageURL4>string</imageURL4>
      <imageURL5>string</imageURL5>
      <colorReferenceFileURL>string</colorReferenceFileURL>
      <additionalResourceFileURL>string</additionalResourceFileURL>
      <additionalResourceFileURLs>
        <string>string</string>
        <string>string</string>
      </additionalResourceFileURLs>
      <imageRequestedDeliveryTimeInHours>string</imageRequestedDeliveryTimeInHours>
      <imageCallbackURL>string</imageCallbackURL>
      <customerImageId>string</customerImageId>
      <productId>string</productId>
      <customerFolder>string</customerFolder>
      <imageDeadlineDateTimeUTC>string</imageDeadlineDateTimeUTC>
      <instruction>string</instruction>
      <colorwayIds>
        <int>int</int>
        <int>int</int>
      </colorwayIds>
      <colorChangeRequests>
        <ColorChangeRequest>
          <colorChangeRequestMarkers>
            <MarkerInfo xsi:nil="true" />
            <MarkerInfo xsi:nil="true" />
          </colorChangeRequestMarkers>
          <customerImageColorID>string</customerImageColorID>
          <outputFileName>string</outputFileName>
        </ColorChangeRequest>
        <ColorChangeRequest>
          <colorChangeRequestMarkers>
            <MarkerInfo xsi:nil="true" />
            <MarkerInfo xsi:nil="true" />
          </colorChangeRequestMarkers>
          <customerImageColorID>string</customerImageColorID>
          <outputFileName>string</outputFileName>
        </ColorChangeRequest>
      </colorChangeRequests>
      <comment>string</comment>
      <markupImageUrl>string</markupImageUrl>
    </AddImageToQueue>
  </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>
    <AddImageToQueueResponse xmlns="http://removethebackground.com/">
      <AddImageToQueueResult>
        <ImageTicket>guid</ImageTicket>
        <IsTrial>boolean</IsTrial>
        <CustomerImageId>string</CustomerImageId>
      </AddImageToQueueResult>
    </AddImageToQueueResponse>
  </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 /soap.asmx HTTP/1.1
Host: api.pixelz.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>
    <AddImageToQueue xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <developerAPIkey>string</developerAPIkey>
      <templateId>string</templateId>
      <imageURL>string</imageURL>
      <imageURL2>string</imageURL2>
      <imageURL3>string</imageURL3>
      <imageURL4>string</imageURL4>
      <imageURL5>string</imageURL5>
      <colorReferenceFileURL>string</colorReferenceFileURL>
      <additionalResourceFileURL>string</additionalResourceFileURL>
      <additionalResourceFileURLs>
        <string>string</string>
        <string>string</string>
      </additionalResourceFileURLs>
      <imageRequestedDeliveryTimeInHours>string</imageRequestedDeliveryTimeInHours>
      <imageCallbackURL>string</imageCallbackURL>
      <customerImageId>string</customerImageId>
      <productId>string</productId>
      <customerFolder>string</customerFolder>
      <imageDeadlineDateTimeUTC>string</imageDeadlineDateTimeUTC>
      <instruction>string</instruction>
      <colorwayIds>
        <int>int</int>
        <int>int</int>
      </colorwayIds>
      <colorChangeRequests>
        <ColorChangeRequest>
          <colorChangeRequestMarkers>
            <MarkerInfo xsi:nil="true" />
            <MarkerInfo xsi:nil="true" />
          </colorChangeRequestMarkers>
          <customerImageColorID>string</customerImageColorID>
          <outputFileName>string</outputFileName>
        </ColorChangeRequest>
        <ColorChangeRequest>
          <colorChangeRequestMarkers>
            <MarkerInfo xsi:nil="true" />
            <MarkerInfo xsi:nil="true" />
          </colorChangeRequestMarkers>
          <customerImageColorID>string</customerImageColorID>
          <outputFileName>string</outputFileName>
        </ColorChangeRequest>
      </colorChangeRequests>
      <comment>string</comment>
      <markupImageUrl>string</markupImageUrl>
    </AddImageToQueue>
  </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>
    <AddImageToQueueResponse xmlns="http://removethebackground.com/">
      <AddImageToQueueResult>
        <ImageTicket>guid</ImageTicket>
        <IsTrial>boolean</IsTrial>
        <CustomerImageId>string</CustomerImageId>
      </AddImageToQueueResult>
    </AddImageToQueueResponse>
  </soap12:Body>
</soap12:Envelope>