soap
Click here for a complete list of operations.
AddPartnerImageToQueue
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/AddPartnerImageToQueue"
<?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>
<AddPartnerImageToQueue xmlns="http://removethebackground.com/">
<contactEmail>string</contactEmail>
<contactAPIkey>string</contactAPIkey>
<applicationCode>string</applicationCode>
<templateId>string</templateId>
<imageURL>string</imageURL>
<imageURL2>string</imageURL2>
<imageURL3>string</imageURL3>
<imageURL4>string</imageURL4>
<imageURL5>string</imageURL5>
<additionalResourceFileURL>string</additionalResourceFileURL>
<imageRequestedDeliveryTimeInHours>string</imageRequestedDeliveryTimeInHours>
<imageCallbackURL>string</imageCallbackURL>
<customerImageId>string</customerImageId>
<productId>string</productId>
<customerFolder>string</customerFolder>
<imageDeadlineDateTimeUTC>string</imageDeadlineDateTimeUTC>
</AddPartnerImageToQueue>
</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>
<AddPartnerImageToQueueResponse xmlns="http://removethebackground.com/">
<AddPartnerImageToQueueResult>
<ImageTicket>guid</ImageTicket>
<IsTrial>boolean</IsTrial>
<CustomerImageId>string</CustomerImageId>
</AddPartnerImageToQueueResult>
</AddPartnerImageToQueueResponse>
</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>
<AddPartnerImageToQueue xmlns="http://removethebackground.com/">
<contactEmail>string</contactEmail>
<contactAPIkey>string</contactAPIkey>
<applicationCode>string</applicationCode>
<templateId>string</templateId>
<imageURL>string</imageURL>
<imageURL2>string</imageURL2>
<imageURL3>string</imageURL3>
<imageURL4>string</imageURL4>
<imageURL5>string</imageURL5>
<additionalResourceFileURL>string</additionalResourceFileURL>
<imageRequestedDeliveryTimeInHours>string</imageRequestedDeliveryTimeInHours>
<imageCallbackURL>string</imageCallbackURL>
<customerImageId>string</customerImageId>
<productId>string</productId>
<customerFolder>string</customerFolder>
<imageDeadlineDateTimeUTC>string</imageDeadlineDateTimeUTC>
</AddPartnerImageToQueue>
</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>
<AddPartnerImageToQueueResponse xmlns="http://removethebackground.com/">
<AddPartnerImageToQueueResult>
<ImageTicket>guid</ImageTicket>
<IsTrial>boolean</IsTrial>
<CustomerImageId>string</CustomerImageId>
</AddPartnerImageToQueueResult>
</AddPartnerImageToQueueResponse>
</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/AddPartnerImageToQueue?contactEmail=string&contactAPIkey=string&applicationCode=string&templateId=string&imageURL=string&imageURL2=string&imageURL3=string&imageURL4=string&imageURL5=string&additionalResourceFileURL=string&imageRequestedDeliveryTimeInHours=string&imageCallbackURL=string&customerImageId=string&productId=string&customerFolder=string&imageDeadlineDateTimeUTC=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"?> <AddImageResponse xmlns="http://removethebackground.com/"> <ImageTicket>guid</ImageTicket> <IsTrial>boolean</IsTrial> <CustomerImageId>string</CustomerImageId> </AddImageResponse>
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/AddPartnerImageToQueue HTTP/1.1 Host: api.pixelz.com Content-Type: application/x-www-form-urlencoded Content-Length: length contactEmail=string&contactAPIkey=string&applicationCode=string&templateId=string&imageURL=string&imageURL2=string&imageURL3=string&imageURL4=string&imageURL5=string&additionalResourceFileURL=string&imageRequestedDeliveryTimeInHours=string&imageCallbackURL=string&customerImageId=string&productId=string&customerFolder=string&imageDeadlineDateTimeUTC=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <AddImageResponse xmlns="http://removethebackground.com/"> <ImageTicket>guid</ImageTicket> <IsTrial>boolean</IsTrial> <CustomerImageId>string</CustomerImageId> </AddImageResponse>