soap Web Service

soap

Click here for a complete list of operations.

GetImagesList

Test

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

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

<?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>
    <GetImagesList xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <imageStatus>string</imageStatus>
      <excludeImageStatus>string</excludeImageStatus>
      <productId>string</productId>
      <fromDate>string</fromDate>
      <toDate>string</toDate>
      <page>string</page>
      <imagesPerPage>string</imagesPerPage>
      <sortBy>string</sortBy>
      <isDescending>string</isDescending>
    </GetImagesList>
  </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>
    <GetImagesListResponse xmlns="http://removethebackground.com/">
      <GetImagesListResult>
        <Images>
          <ImageStatus>
            <ImageTicket>guid</ImageTicket>
            <CustomerImageId>string</CustomerImageId>
            <ProductId>string</ProductId>
            <StatusName>string</StatusName>
            <StatusId>int</StatusId>
            <IsPaid>boolean</IsPaid>
            <ThumbnailImageURL>string</ThumbnailImageURL>
            <FinalImagesURL xsi:nil="true" />
          </ImageStatus>
          <ImageStatus>
            <ImageTicket>guid</ImageTicket>
            <CustomerImageId>string</CustomerImageId>
            <ProductId>string</ProductId>
            <StatusName>string</StatusName>
            <StatusId>int</StatusId>
            <IsPaid>boolean</IsPaid>
            <ThumbnailImageURL>string</ThumbnailImageURL>
            <FinalImagesURL xsi:nil="true" />
          </ImageStatus>
        </Images>
      </GetImagesListResult>
    </GetImagesListResponse>
  </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>
    <GetImagesList xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <imageStatus>string</imageStatus>
      <excludeImageStatus>string</excludeImageStatus>
      <productId>string</productId>
      <fromDate>string</fromDate>
      <toDate>string</toDate>
      <page>string</page>
      <imagesPerPage>string</imagesPerPage>
      <sortBy>string</sortBy>
      <isDescending>string</isDescending>
    </GetImagesList>
  </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>
    <GetImagesListResponse xmlns="http://removethebackground.com/">
      <GetImagesListResult>
        <Images>
          <ImageStatus>
            <ImageTicket>guid</ImageTicket>
            <CustomerImageId>string</CustomerImageId>
            <ProductId>string</ProductId>
            <StatusName>string</StatusName>
            <StatusId>int</StatusId>
            <IsPaid>boolean</IsPaid>
            <ThumbnailImageURL>string</ThumbnailImageURL>
            <FinalImagesURL xsi:nil="true" />
          </ImageStatus>
          <ImageStatus>
            <ImageTicket>guid</ImageTicket>
            <CustomerImageId>string</CustomerImageId>
            <ProductId>string</ProductId>
            <StatusName>string</StatusName>
            <StatusId>int</StatusId>
            <IsPaid>boolean</IsPaid>
            <ThumbnailImageURL>string</ThumbnailImageURL>
            <FinalImagesURL xsi:nil="true" />
          </ImageStatus>
        </Images>
      </GetImagesListResult>
    </GetImagesListResponse>
  </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/GetImagesList?contactEmail=string&contactAPIkey=string&imageStatus=string&excludeImageStatus=string&productId=string&fromDate=string&toDate=string&page=string&imagesPerPage=string&sortBy=string&isDescending=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"?>
<ImagesListResponse xmlns="http://removethebackground.com/">
  <Images>
    <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>
    <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>
  </Images>
</ImagesListResponse>

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/GetImagesList HTTP/1.1
Host: api.pixelz.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

contactEmail=string&contactAPIkey=string&imageStatus=string&excludeImageStatus=string&productId=string&fromDate=string&toDate=string&page=string&imagesPerPage=string&sortBy=string&isDescending=string

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

<?xml version="1.0" encoding="utf-8"?>
<ImagesListResponse xmlns="http://removethebackground.com/">
  <Images>
    <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>
    <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>
  </Images>
</ImagesListResponse>

Parameter	Value
contactEmail:
contactAPIkey:
imageStatus:
excludeImageStatus:
productId:
fromDate:
toDate:
page:
imagesPerPage:
sortBy:
isDescending: