soap Web Service

soap

Click here for a complete list of operations.

AddTemplate

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

<?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>
    <AddTemplate xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <templateName>string</templateName>
      <templateOutputFormat>string</templateOutputFormat>
      <deliveryTimeInHour>string</deliveryTimeInHour>
      <backgroundType>string</backgroundType>
      <backgroundColor>string</backgroundColor>
      <backgroundVerticalGradientColor>string</backgroundVerticalGradientColor>
      <resizeType>string</resizeType>
      <resizeUnit>string</resizeUnit>
      <resizeHeight>string</resizeHeight>
      <resizeWidth>string</resizeWidth>
      <resizeMinSize>string</resizeMinSize>
      <resizeMaxSize>string</resizeMaxSize>
      <marginType>string</marginType>
      <marginTop>string</marginTop>
      <marginBottom>string</marginBottom>
      <marginLeft>string</marginLeft>
      <marginRight>string</marginRight>
      <marginVerticalAlignment>string</marginVerticalAlignment>
      <shadowType>string</shadowType>
      <isCombinedImages>string</isCombinedImages>
      <callbackUrl>string</callbackUrl>
      <comment>string</comment>
      <isKeptMannequin>string</isKeptMannequin>
      <isKeptModel>string</isKeptModel>
    </AddTemplate>
  </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>
    <AddTemplateResponse xmlns="http://removethebackground.com/">
      <AddTemplateResult>
        <TemplateId>int</TemplateId>
        <TemplatePrice Currency="string" />
      </AddTemplateResult>
    </AddTemplateResponse>
  </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>
    <AddTemplate xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <templateName>string</templateName>
      <templateOutputFormat>string</templateOutputFormat>
      <deliveryTimeInHour>string</deliveryTimeInHour>
      <backgroundType>string</backgroundType>
      <backgroundColor>string</backgroundColor>
      <backgroundVerticalGradientColor>string</backgroundVerticalGradientColor>
      <resizeType>string</resizeType>
      <resizeUnit>string</resizeUnit>
      <resizeHeight>string</resizeHeight>
      <resizeWidth>string</resizeWidth>
      <resizeMinSize>string</resizeMinSize>
      <resizeMaxSize>string</resizeMaxSize>
      <marginType>string</marginType>
      <marginTop>string</marginTop>
      <marginBottom>string</marginBottom>
      <marginLeft>string</marginLeft>
      <marginRight>string</marginRight>
      <marginVerticalAlignment>string</marginVerticalAlignment>
      <shadowType>string</shadowType>
      <isCombinedImages>string</isCombinedImages>
      <callbackUrl>string</callbackUrl>
      <comment>string</comment>
      <isKeptMannequin>string</isKeptMannequin>
      <isKeptModel>string</isKeptModel>
    </AddTemplate>
  </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>
    <AddTemplateResponse xmlns="http://removethebackground.com/">
      <AddTemplateResult>
        <TemplateId>int</TemplateId>
        <TemplatePrice Currency="string" />
      </AddTemplateResult>
    </AddTemplateResponse>
  </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/AddTemplate?contactEmail=string&contactAPIkey=string&templateName=string&templateOutputFormat=string&deliveryTimeInHour=string&backgroundType=string&backgroundColor=string&backgroundVerticalGradientColor=string&resizeType=string&resizeUnit=string&resizeHeight=string&resizeWidth=string&resizeMinSize=string&resizeMaxSize=string&marginType=string&marginTop=string&marginBottom=string&marginLeft=string&marginRight=string&marginVerticalAlignment=string&shadowType=string&isCombinedImages=string&callbackUrl=string&comment=string&isKeptMannequin=string&isKeptModel=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"?>
<NewTemplateResponse xmlns="http://removethebackground.com/">
  <TemplateId>int</TemplateId>
  <TemplatePrice Currency="string" />
</NewTemplateResponse>

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

contactEmail=string&contactAPIkey=string&templateName=string&templateOutputFormat=string&deliveryTimeInHour=string&backgroundType=string&backgroundColor=string&backgroundVerticalGradientColor=string&resizeType=string&resizeUnit=string&resizeHeight=string&resizeWidth=string&resizeMinSize=string&resizeMaxSize=string&marginType=string&marginTop=string&marginBottom=string&marginLeft=string&marginRight=string&marginVerticalAlignment=string&shadowType=string&isCombinedImages=string&callbackUrl=string&comment=string&isKeptMannequin=string&isKeptModel=string

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

<?xml version="1.0" encoding="utf-8"?>
<NewTemplateResponse xmlns="http://removethebackground.com/">
  <TemplateId>int</TemplateId>
  <TemplatePrice Currency="string" />
</NewTemplateResponse>

Parameter	Value
contactEmail:
contactAPIkey:
templateName:
templateOutputFormat:
deliveryTimeInHour:
backgroundType:
backgroundColor:
backgroundVerticalGradientColor:
resizeType:
resizeUnit:
resizeHeight:
resizeWidth:
resizeMinSize:
resizeMaxSize:
marginType:
marginTop:
marginBottom:
marginLeft:
marginRight:
marginVerticalAlignment:
shadowType:
isCombinedImages:
callbackUrl:
comment:
isKeptMannequin:
isKeptModel: