soap Web Service

soap

Click here for a complete list of operations.

GetTemplateSpec

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

<?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>
    <GetTemplateSpec xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <templateId>string</templateId>
    </GetTemplateSpec>
  </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>
    <GetTemplateSpecResponse xmlns="http://removethebackground.com/">
      <GetTemplateSpecResult>
        <Template>
          <Id>int</Id>
          <Name>string</Name>
          <Price Currency="string" />
          <CreatedDate>string</CreatedDate>
          <ModifiedDate>string</ModifiedDate>
          <IsDeleted>boolean</IsDeleted>
          <OutputFormat>string</OutputFormat>
          <DeliveryTimeInHours>int</DeliveryTimeInHours>
          <BackgroundType>int</BackgroundType>
          <BackgroundColor>string</BackgroundColor>
          <BackgroundVerticalGradientColor>string</BackgroundVerticalGradientColor>
          <ResizeType>int</ResizeType>
          <ResizeUnit>int</ResizeUnit>
          <ResizeWidth>int</ResizeWidth>
          <ResizeHeight>int</ResizeHeight>
          <ResizeMaxSize>int</ResizeMaxSize>
          <ResizeMinSize>int</ResizeMinSize>
          <MarginType>int</MarginType>
          <MarginTop>int</MarginTop>
          <MarginBottom>int</MarginBottom>
          <MarginLeft>int</MarginLeft>
          <MarginRight>int</MarginRight>
          <VerticalAlignment>int</VerticalAlignment>
          <ShadowType>int</ShadowType>
          <IsCombinedImages>boolean</IsCombinedImages>
          <ColorAdjustment>boolean</ColorAdjustment>
          <ColorAdjustmentSetting>string</ColorAdjustmentSetting>
          <ColorAdjustmentComment>string</ColorAdjustmentComment>
          <ColorMatching>boolean</ColorMatching>
          <ColorMatchingSetting>string</ColorMatchingSetting>
          <ColorMatchComment>string</ColorMatchComment>
          <CallbackUrl>string</CallbackUrl>
          <CallbackFtp>string</CallbackFtp>
          <Comment>string</Comment>
          <IsKeptMannequin>boolean</IsKeptMannequin>
          <IsKeptModel>boolean</IsKeptModel>
        </Template>
      </GetTemplateSpecResult>
    </GetTemplateSpecResponse>
  </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>
    <GetTemplateSpec xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <templateId>string</templateId>
    </GetTemplateSpec>
  </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>
    <GetTemplateSpecResponse xmlns="http://removethebackground.com/">
      <GetTemplateSpecResult>
        <Template>
          <Id>int</Id>
          <Name>string</Name>
          <Price Currency="string" />
          <CreatedDate>string</CreatedDate>
          <ModifiedDate>string</ModifiedDate>
          <IsDeleted>boolean</IsDeleted>
          <OutputFormat>string</OutputFormat>
          <DeliveryTimeInHours>int</DeliveryTimeInHours>
          <BackgroundType>int</BackgroundType>
          <BackgroundColor>string</BackgroundColor>
          <BackgroundVerticalGradientColor>string</BackgroundVerticalGradientColor>
          <ResizeType>int</ResizeType>
          <ResizeUnit>int</ResizeUnit>
          <ResizeWidth>int</ResizeWidth>
          <ResizeHeight>int</ResizeHeight>
          <ResizeMaxSize>int</ResizeMaxSize>
          <ResizeMinSize>int</ResizeMinSize>
          <MarginType>int</MarginType>
          <MarginTop>int</MarginTop>
          <MarginBottom>int</MarginBottom>
          <MarginLeft>int</MarginLeft>
          <MarginRight>int</MarginRight>
          <VerticalAlignment>int</VerticalAlignment>
          <ShadowType>int</ShadowType>
          <IsCombinedImages>boolean</IsCombinedImages>
          <ColorAdjustment>boolean</ColorAdjustment>
          <ColorAdjustmentSetting>string</ColorAdjustmentSetting>
          <ColorAdjustmentComment>string</ColorAdjustmentComment>
          <ColorMatching>boolean</ColorMatching>
          <ColorMatchingSetting>string</ColorMatchingSetting>
          <ColorMatchComment>string</ColorMatchComment>
          <CallbackUrl>string</CallbackUrl>
          <CallbackFtp>string</CallbackFtp>
          <Comment>string</Comment>
          <IsKeptMannequin>boolean</IsKeptMannequin>
          <IsKeptModel>boolean</IsKeptModel>
        </Template>
      </GetTemplateSpecResult>
    </GetTemplateSpecResponse>
  </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/GetTemplateSpec?contactEmail=string&contactAPIkey=string&templateId=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"?>
<TemplateSpecResponse xmlns="http://removethebackground.com/">
  <Template>
    <Id>int</Id>
    <Name>string</Name>
    <Price Currency="string" />
    <CreatedDate>string</CreatedDate>
    <ModifiedDate>string</ModifiedDate>
    <IsDeleted>boolean</IsDeleted>
    <OutputFormat>string</OutputFormat>
    <DeliveryTimeInHours>int</DeliveryTimeInHours>
    <BackgroundType>int</BackgroundType>
    <BackgroundColor>string</BackgroundColor>
    <BackgroundVerticalGradientColor>string</BackgroundVerticalGradientColor>
    <ResizeType>int</ResizeType>
    <ResizeUnit>int</ResizeUnit>
    <ResizeWidth>int</ResizeWidth>
    <ResizeHeight>int</ResizeHeight>
    <ResizeMaxSize>int</ResizeMaxSize>
    <ResizeMinSize>int</ResizeMinSize>
    <MarginType>int</MarginType>
    <MarginTop>int</MarginTop>
    <MarginBottom>int</MarginBottom>
    <MarginLeft>int</MarginLeft>
    <MarginRight>int</MarginRight>
    <VerticalAlignment>int</VerticalAlignment>
    <ShadowType>int</ShadowType>
    <IsCombinedImages>boolean</IsCombinedImages>
    <ColorAdjustment>boolean</ColorAdjustment>
    <ColorAdjustmentSetting>string</ColorAdjustmentSetting>
    <ColorAdjustmentComment>string</ColorAdjustmentComment>
    <ColorMatching>boolean</ColorMatching>
    <ColorMatchingSetting>string</ColorMatchingSetting>
    <ColorMatchComment>string</ColorMatchComment>
    <CallbackUrl>string</CallbackUrl>
    <CallbackFtp>string</CallbackFtp>
    <Comment>string</Comment>
    <IsKeptMannequin>boolean</IsKeptMannequin>
    <IsKeptModel>boolean</IsKeptModel>
  </Template>
</TemplateSpecResponse>

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

contactEmail=string&contactAPIkey=string&templateId=string

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

<?xml version="1.0" encoding="utf-8"?>
<TemplateSpecResponse xmlns="http://removethebackground.com/">
  <Template>
    <Id>int</Id>
    <Name>string</Name>
    <Price Currency="string" />
    <CreatedDate>string</CreatedDate>
    <ModifiedDate>string</ModifiedDate>
    <IsDeleted>boolean</IsDeleted>
    <OutputFormat>string</OutputFormat>
    <DeliveryTimeInHours>int</DeliveryTimeInHours>
    <BackgroundType>int</BackgroundType>
    <BackgroundColor>string</BackgroundColor>
    <BackgroundVerticalGradientColor>string</BackgroundVerticalGradientColor>
    <ResizeType>int</ResizeType>
    <ResizeUnit>int</ResizeUnit>
    <ResizeWidth>int</ResizeWidth>
    <ResizeHeight>int</ResizeHeight>
    <ResizeMaxSize>int</ResizeMaxSize>
    <ResizeMinSize>int</ResizeMinSize>
    <MarginType>int</MarginType>
    <MarginTop>int</MarginTop>
    <MarginBottom>int</MarginBottom>
    <MarginLeft>int</MarginLeft>
    <MarginRight>int</MarginRight>
    <VerticalAlignment>int</VerticalAlignment>
    <ShadowType>int</ShadowType>
    <IsCombinedImages>boolean</IsCombinedImages>
    <ColorAdjustment>boolean</ColorAdjustment>
    <ColorAdjustmentSetting>string</ColorAdjustmentSetting>
    <ColorAdjustmentComment>string</ColorAdjustmentComment>
    <ColorMatching>boolean</ColorMatching>
    <ColorMatchingSetting>string</ColorMatchingSetting>
    <ColorMatchComment>string</ColorMatchComment>
    <CallbackUrl>string</CallbackUrl>
    <CallbackFtp>string</CallbackFtp>
    <Comment>string</Comment>
    <IsKeptMannequin>boolean</IsKeptMannequin>
    <IsKeptModel>boolean</IsKeptModel>
  </Template>
</TemplateSpecResponse>

Parameter	Value
contactEmail:
contactAPIkey:
templateId: