soap
Click here for a complete list of operations.
GetTemplates
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/GetTemplates"
<?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>
<GetTemplates xmlns="http://removethebackground.com/">
<contactEmail>string</contactEmail>
<contactAPIkey>string</contactAPIkey>
</GetTemplates>
</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>
<GetTemplatesResponse xmlns="http://removethebackground.com/">
<GetTemplatesResult>
<Templates>
<Template>
<TemplateId>int</TemplateId>
<ContactId>int</ContactId>
<TemplateName>string</TemplateName>
<Prices xsi:nil="true" />
<IsCombinedImages>boolean</IsCombinedImages>
<TemplateLabelId>int</TemplateLabelId>
<IsRecreateDetail>boolean</IsRecreateDetail>
<ColorAdjustment>boolean</ColorAdjustment>
<ColorAdjustmentSetting>string</ColorAdjustmentSetting>
<ColorAdjustmentComment>string</ColorAdjustmentComment>
<ColorMatching>boolean</ColorMatching>
<ColorMatchingSetting>string</ColorMatchingSetting>
<ColorMatchComment>string</ColorMatchComment>
</Template>
<Template>
<TemplateId>int</TemplateId>
<ContactId>int</ContactId>
<TemplateName>string</TemplateName>
<Prices xsi:nil="true" />
<IsCombinedImages>boolean</IsCombinedImages>
<TemplateLabelId>int</TemplateLabelId>
<IsRecreateDetail>boolean</IsRecreateDetail>
<ColorAdjustment>boolean</ColorAdjustment>
<ColorAdjustmentSetting>string</ColorAdjustmentSetting>
<ColorAdjustmentComment>string</ColorAdjustmentComment>
<ColorMatching>boolean</ColorMatching>
<ColorMatchingSetting>string</ColorMatchingSetting>
<ColorMatchComment>string</ColorMatchComment>
</Template>
</Templates>
</GetTemplatesResult>
</GetTemplatesResponse>
</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>
<GetTemplates xmlns="http://removethebackground.com/">
<contactEmail>string</contactEmail>
<contactAPIkey>string</contactAPIkey>
</GetTemplates>
</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>
<GetTemplatesResponse xmlns="http://removethebackground.com/">
<GetTemplatesResult>
<Templates>
<Template>
<TemplateId>int</TemplateId>
<ContactId>int</ContactId>
<TemplateName>string</TemplateName>
<Prices xsi:nil="true" />
<IsCombinedImages>boolean</IsCombinedImages>
<TemplateLabelId>int</TemplateLabelId>
<IsRecreateDetail>boolean</IsRecreateDetail>
<ColorAdjustment>boolean</ColorAdjustment>
<ColorAdjustmentSetting>string</ColorAdjustmentSetting>
<ColorAdjustmentComment>string</ColorAdjustmentComment>
<ColorMatching>boolean</ColorMatching>
<ColorMatchingSetting>string</ColorMatchingSetting>
<ColorMatchComment>string</ColorMatchComment>
</Template>
<Template>
<TemplateId>int</TemplateId>
<ContactId>int</ContactId>
<TemplateName>string</TemplateName>
<Prices xsi:nil="true" />
<IsCombinedImages>boolean</IsCombinedImages>
<TemplateLabelId>int</TemplateLabelId>
<IsRecreateDetail>boolean</IsRecreateDetail>
<ColorAdjustment>boolean</ColorAdjustment>
<ColorAdjustmentSetting>string</ColorAdjustmentSetting>
<ColorAdjustmentComment>string</ColorAdjustmentComment>
<ColorMatching>boolean</ColorMatching>
<ColorMatchingSetting>string</ColorMatchingSetting>
<ColorMatchComment>string</ColorMatchComment>
</Template>
</Templates>
</GetTemplatesResult>
</GetTemplatesResponse>
</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/GetTemplates?contactEmail=string&contactAPIkey=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"?>
<TemplatesResponse xmlns="http://removethebackground.com/">
<Templates>
<Template>
<TemplateId>int</TemplateId>
<ContactId>int</ContactId>
<TemplateName>string</TemplateName>
<Prices>
<Price d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Price d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Prices>
<IsCombinedImages>boolean</IsCombinedImages>
<TemplateLabelId>int</TemplateLabelId>
<IsRecreateDetail>boolean</IsRecreateDetail>
<ColorAdjustment>boolean</ColorAdjustment>
<ColorAdjustmentSetting>string</ColorAdjustmentSetting>
<ColorAdjustmentComment>string</ColorAdjustmentComment>
<ColorMatching>boolean</ColorMatching>
<ColorMatchingSetting>string</ColorMatchingSetting>
<ColorMatchComment>string</ColorMatchComment>
</Template>
<Template>
<TemplateId>int</TemplateId>
<ContactId>int</ContactId>
<TemplateName>string</TemplateName>
<Prices>
<Price d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Price d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Prices>
<IsCombinedImages>boolean</IsCombinedImages>
<TemplateLabelId>int</TemplateLabelId>
<IsRecreateDetail>boolean</IsRecreateDetail>
<ColorAdjustment>boolean</ColorAdjustment>
<ColorAdjustmentSetting>string</ColorAdjustmentSetting>
<ColorAdjustmentComment>string</ColorAdjustmentComment>
<ColorMatching>boolean</ColorMatching>
<ColorMatchingSetting>string</ColorMatchingSetting>
<ColorMatchComment>string</ColorMatchComment>
</Template>
</Templates>
</TemplatesResponse>
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/GetTemplates HTTP/1.1 Host: api.pixelz.com Content-Type: application/x-www-form-urlencoded Content-Length: length contactEmail=string&contactAPIkey=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<TemplatesResponse xmlns="http://removethebackground.com/">
<Templates>
<Template>
<TemplateId>int</TemplateId>
<ContactId>int</ContactId>
<TemplateName>string</TemplateName>
<Prices>
<Price d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Price d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Prices>
<IsCombinedImages>boolean</IsCombinedImages>
<TemplateLabelId>int</TemplateLabelId>
<IsRecreateDetail>boolean</IsRecreateDetail>
<ColorAdjustment>boolean</ColorAdjustment>
<ColorAdjustmentSetting>string</ColorAdjustmentSetting>
<ColorAdjustmentComment>string</ColorAdjustmentComment>
<ColorMatching>boolean</ColorMatching>
<ColorMatchingSetting>string</ColorMatchingSetting>
<ColorMatchComment>string</ColorMatchComment>
</Template>
<Template>
<TemplateId>int</TemplateId>
<ContactId>int</ContactId>
<TemplateName>string</TemplateName>
<Prices>
<Price d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Price d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Prices>
<IsCombinedImages>boolean</IsCombinedImages>
<TemplateLabelId>int</TemplateLabelId>
<IsRecreateDetail>boolean</IsRecreateDetail>
<ColorAdjustment>boolean</ColorAdjustment>
<ColorAdjustmentSetting>string</ColorAdjustmentSetting>
<ColorAdjustmentComment>string</ColorAdjustmentComment>
<ColorMatching>boolean</ColorMatching>
<ColorMatchingSetting>string</ColorMatchingSetting>
<ColorMatchComment>string</ColorMatchComment>
</Template>
</Templates>
</TemplatesResponse>