soap


Click here for a complete list of operations.

GetProductIdsList

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
contactEmail:
contactAPIkey:
page:
productIdsPerPage:

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

<?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>
    <GetProductIdsList xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <page>string</page>
      <productIdsPerPage>string</productIdsPerPage>
    </GetProductIdsList>
  </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>
    <GetProductIdsListResponse xmlns="http://removethebackground.com/">
      <GetProductIdsListResult>
        <ProductIds>
          <ProductIdStatistic>
            <ProductId>string</ProductId>
            <DoneCount>int</DoneCount>
            <TodoCount>int</TodoCount>
          </ProductIdStatistic>
          <ProductIdStatistic>
            <ProductId>string</ProductId>
            <DoneCount>int</DoneCount>
            <TodoCount>int</TodoCount>
          </ProductIdStatistic>
        </ProductIds>
      </GetProductIdsListResult>
    </GetProductIdsListResponse>
  </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>
    <GetProductIdsList xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <page>string</page>
      <productIdsPerPage>string</productIdsPerPage>
    </GetProductIdsList>
  </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>
    <GetProductIdsListResponse xmlns="http://removethebackground.com/">
      <GetProductIdsListResult>
        <ProductIds>
          <ProductIdStatistic>
            <ProductId>string</ProductId>
            <DoneCount>int</DoneCount>
            <TodoCount>int</TodoCount>
          </ProductIdStatistic>
          <ProductIdStatistic>
            <ProductId>string</ProductId>
            <DoneCount>int</DoneCount>
            <TodoCount>int</TodoCount>
          </ProductIdStatistic>
        </ProductIds>
      </GetProductIdsListResult>
    </GetProductIdsListResponse>
  </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/GetProductIdsList?contactEmail=string&contactAPIkey=string&page=string&productIdsPerPage=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"?>
<ProductIdsListResponse xmlns="http://removethebackground.com/">
  <ProductIds>
    <ProductIdStatistic>
      <ProductId>string</ProductId>
      <DoneCount>int</DoneCount>
      <TodoCount>int</TodoCount>
    </ProductIdStatistic>
    <ProductIdStatistic>
      <ProductId>string</ProductId>
      <DoneCount>int</DoneCount>
      <TodoCount>int</TodoCount>
    </ProductIdStatistic>
  </ProductIds>
</ProductIdsListResponse>

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

contactEmail=string&contactAPIkey=string&page=string&productIdsPerPage=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ProductIdsListResponse xmlns="http://removethebackground.com/">
  <ProductIds>
    <ProductIdStatistic>
      <ProductId>string</ProductId>
      <DoneCount>int</DoneCount>
      <TodoCount>int</TodoCount>
    </ProductIdStatistic>
    <ProductIdStatistic>
      <ProductId>string</ProductId>
      <DoneCount>int</DoneCount>
      <TodoCount>int</TodoCount>
    </ProductIdStatistic>
  </ProductIds>
</ProductIdsListResponse>