soap

Click here for a complete list of operations.

GetImageStatus

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
contactEmail:
contactAPIkey:
imageTicket:
customerImageId:

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

<?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>
    <GetImageStatus xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <imageTicket>string</imageTicket>
      <customerImageId>string</customerImageId>
    </GetImageStatus>
  </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>
    <GetImageStatusResponse xmlns="http://removethebackground.com/">
      <GetImageStatusResult>
        <ImageStatus>
          <ImageTicket>guid</ImageTicket>
          <CustomerImageId>string</CustomerImageId>
          <ProductId>string</ProductId>
          <StatusName>string</StatusName>
          <StatusId>int</StatusId>
          <IsPaid>boolean</IsPaid>
          <ThumbnailImageURL>string</ThumbnailImageURL>
          <FinalImagesURL>
            <string>string</string>
            <string>string</string>
          </FinalImagesURL>
        </ImageStatus>
      </GetImageStatusResult>
    </GetImageStatusResponse>
  </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>
    <GetImageStatus xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <imageTicket>string</imageTicket>
      <customerImageId>string</customerImageId>
    </GetImageStatus>
  </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>
    <GetImageStatusResponse xmlns="http://removethebackground.com/">
      <GetImageStatusResult>
        <ImageStatus>
          <ImageTicket>guid</ImageTicket>
          <CustomerImageId>string</CustomerImageId>
          <ProductId>string</ProductId>
          <StatusName>string</StatusName>
          <StatusId>int</StatusId>
          <IsPaid>boolean</IsPaid>
          <ThumbnailImageURL>string</ThumbnailImageURL>
          <FinalImagesURL>
            <string>string</string>
            <string>string</string>
          </FinalImagesURL>
        </ImageStatus>
      </GetImageStatusResult>
    </GetImageStatusResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /soap.asmx/GetImageStatus?contactEmail=string&contactAPIkey=string&imageTicket=string&customerImageId=string HTTP/1.1
Host: api.pixelz.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ImageStatusResponse xmlns="http://removethebackground.com/">
  <ImageStatus>
    <ImageTicket>guid</ImageTicket>
    <CustomerImageId>string</CustomerImageId>
    <ProductId>string</ProductId>
    <StatusName>string</StatusName>
    <StatusId>int</StatusId>
    <IsPaid>boolean</IsPaid>
    <ThumbnailImageURL>string</ThumbnailImageURL>
    <FinalImagesURL>
      <string>string</string>
      <string>string</string>
    </FinalImagesURL>
  </ImageStatus>
</ImageStatusResponse>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /soap.asmx/GetImageStatus HTTP/1.1
Host: api.pixelz.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

contactEmail=string&contactAPIkey=string&imageTicket=string&customerImageId=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ImageStatusResponse xmlns="http://removethebackground.com/">
  <ImageStatus>
    <ImageTicket>guid</ImageTicket>
    <CustomerImageId>string</CustomerImageId>
    <ProductId>string</ProductId>
    <StatusName>string</StatusName>
    <StatusId>int</StatusId>
    <IsPaid>boolean</IsPaid>
    <ThumbnailImageURL>string</ThumbnailImageURL>
    <FinalImagesURL>
      <string>string</string>
      <string>string</string>
    </FinalImagesURL>
  </ImageStatus>
</ImageStatusResponse>