soap


Click here for a complete list of operations.

AddImageNote

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
contactEmail:
contactAPIkey:
developerAPIkey:
imageTicket:
comment:
markingUrl:
addImageNoteType:

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

<?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>
    <AddImageNote xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <developerAPIkey>string</developerAPIkey>
      <imageTicket>string</imageTicket>
      <comment>string</comment>
      <markingUrl>string</markingUrl>
      <addImageNoteType>int</addImageNoteType>
    </AddImageNote>
  </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>
    <AddImageNoteResponse xmlns="http://removethebackground.com/">
      <AddImageNoteResult />
    </AddImageNoteResponse>
  </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>
    <AddImageNote xmlns="http://removethebackground.com/">
      <contactEmail>string</contactEmail>
      <contactAPIkey>string</contactAPIkey>
      <developerAPIkey>string</developerAPIkey>
      <imageTicket>string</imageTicket>
      <comment>string</comment>
      <markingUrl>string</markingUrl>
      <addImageNoteType>int</addImageNoteType>
    </AddImageNote>
  </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>
    <AddImageNoteResponse xmlns="http://removethebackground.com/">
      <AddImageNoteResult />
    </AddImageNoteResponse>
  </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/AddImageNote?contactEmail=string&contactAPIkey=string&developerAPIkey=string&imageTicket=string&comment=string&markingUrl=string&addImageNoteType=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"?>
<AddImageNoteV1Response xmlns="http://removethebackground.com/" />

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

contactEmail=string&contactAPIkey=string&developerAPIkey=string&imageTicket=string&comment=string&markingUrl=string&addImageNoteType=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<AddImageNoteV1Response xmlns="http://removethebackground.com/" />