Veetro Web Service Methods


Click here for a complete list of operations.

SetUserBookmark

[Permission: Any Authenticated]
Updates an item's bookmarked status

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
type:
primaryKey:
isBookmarked:
listIndex:

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 /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/SetUserBookmark"

<?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>
    <SetUserBookmark xmlns="http://schema.veetro.com">
      <type>Entry or Notation or Message or Document or Invoice or Transaction or Entity or Lead or BlogPost or Blog or InvoiceItem or CatalogItem or Proposal or Article or Activity or CatalogItemCategory or SupportCaseType or MailQueue or Calendar or CustomView or Report or ReportWidgetCategory or Template</type>
      <primaryKey>int</primaryKey>
      <isBookmarked>boolean</isBookmarked>
      <listIndex>int</listIndex>
    </SetUserBookmark>
  </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>
    <SetUserBookmarkResponse xmlns="http://schema.veetro.com" />
  </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 /xml HTTP/1.1
Host: admin.worketc.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>
    <SetUserBookmark xmlns="http://schema.veetro.com">
      <type>Entry or Notation or Message or Document or Invoice or Transaction or Entity or Lead or BlogPost or Blog or InvoiceItem or CatalogItem or Proposal or Article or Activity or CatalogItemCategory or SupportCaseType or MailQueue or Calendar or CustomView or Report or ReportWidgetCategory or Template</type>
      <primaryKey>int</primaryKey>
      <isBookmarked>boolean</isBookmarked>
      <listIndex>int</listIndex>
    </SetUserBookmark>
  </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>
    <SetUserBookmarkResponse xmlns="http://schema.veetro.com" />
  </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 /xml/SetUserBookmark?type=string&primaryKey=string&isBookmarked=string&listIndex=string HTTP/1.1
Host: admin.worketc.com
HTTP/1.1 200 OK

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /xml/SetUserBookmark HTTP/1.1
Host: admin.worketc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

type=string&primaryKey=string&isBookmarked=string&listIndex=string
HTTP/1.1 200 OK