Veetro Web Service Methods Web Service

Veetro Web Service Methods

Click here for a complete list of operations.

GetNotationSearchResult

[Permission: Employee]
Returns Discussion Notations

Test

The test form is only available for requests from the local machine.

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

<?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>
    <GetNotationSearchResult xmlns="http://schema.veetro.com">
      <args>
        <StartIndex>int</StartIndex>
        <FetchSize>int</FetchSize>
        <LastNotationID>int</LastNotationID>
        <NotationID_Parent>int</NotationID_Parent>
        <NotationID_Previous>int</NotationID_Previous>
        <Keyword>string</Keyword>
        <Filter>All or REQUEST or FOLLOWING or INCLUDES_ME or LIKED_BY_ME or TRENDING or FROM_ME or Hidden_Only or Declined_Only or Completed_Only</Filter>
        <IncludeLastRR>boolean</IncludeLastRR>
        <IncludeLastReply>boolean</IncludeLastReply>
        <RootOnly>boolean</RootOnly>
        <EntityID>int</EntityID>
        <PeriodFrom>string</PeriodFrom>
        <PeriodTo>string</PeriodTo>
        <EntryID>int</EntryID>
        <LeadID>int</LeadID>
        <InvoiceID>int</InvoiceID>
        <ArticleID>int</ArticleID>
        <CommentID>int</CommentID>
        <Sort>Replies_Newest_First or Replies_Unread_First or Replies_Oldest_First or Requests_Only_Unread_First or Requests_Only_Newest_First or Requests_Only_Oldest_First or Replies_Most_First or Replies_Least_First or Requests_Most_First or Requests_Least_First or Likes_Most_First or Likes_Least_First</Sort>
        <CurrentThread>int</CurrentThread>
        <PermaLink>int</PermaLink>
        <UnreadOnly>boolean</UnreadOnly>
        <Owner>int</Owner>
        <IsSideBarQuery>boolean</IsSideBarQuery>
        <IsBottomAlertQuery>boolean</IsBottomAlertQuery>
        <IncludePlainTextNote>boolean</IncludePlainTextNote>
      </args>
    </GetNotationSearchResult>
  </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>
    <GetNotationSearchResultResponse xmlns="http://schema.veetro.com">
      <GetNotationSearchResultResult>
        <NotationCounts>
          <NotationCount>
            <Type>Requests or Following or IncludeMe or LikedByMe or FromMe or AllTopics</Type>
            <Count>int</Count>
          </NotationCount>
          <NotationCount>
            <Type>Requests or Following or IncludeMe or LikedByMe or FromMe or AllTopics</Type>
            <Count>int</Count>
          </NotationCount>
        </NotationCounts>
        <Threads>
          <NotationThread>
            <Notations xsi:nil="true" />
            <RootNotation xsi:nil="true" />
            <AllEmployeesIncluded xsi:nil="true" />
            <IsHide>boolean</IsHide>
            <SourceFrom>string</SourceFrom>
          </NotationThread>
          <NotationThread>
            <Notations xsi:nil="true" />
            <RootNotation xsi:nil="true" />
            <AllEmployeesIncluded xsi:nil="true" />
            <IsHide>boolean</IsHide>
            <SourceFrom>string</SourceFrom>
          </NotationThread>
        </Threads>
        <SourceFrom>string</SourceFrom>
      </GetNotationSearchResultResult>
    </GetNotationSearchResultResponse>
  </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>
    <GetNotationSearchResult xmlns="http://schema.veetro.com">
      <args>
        <StartIndex>int</StartIndex>
        <FetchSize>int</FetchSize>
        <LastNotationID>int</LastNotationID>
        <NotationID_Parent>int</NotationID_Parent>
        <NotationID_Previous>int</NotationID_Previous>
        <Keyword>string</Keyword>
        <Filter>All or REQUEST or FOLLOWING or INCLUDES_ME or LIKED_BY_ME or TRENDING or FROM_ME or Hidden_Only or Declined_Only or Completed_Only</Filter>
        <IncludeLastRR>boolean</IncludeLastRR>
        <IncludeLastReply>boolean</IncludeLastReply>
        <RootOnly>boolean</RootOnly>
        <EntityID>int</EntityID>
        <PeriodFrom>string</PeriodFrom>
        <PeriodTo>string</PeriodTo>
        <EntryID>int</EntryID>
        <LeadID>int</LeadID>
        <InvoiceID>int</InvoiceID>
        <ArticleID>int</ArticleID>
        <CommentID>int</CommentID>
        <Sort>Replies_Newest_First or Replies_Unread_First or Replies_Oldest_First or Requests_Only_Unread_First or Requests_Only_Newest_First or Requests_Only_Oldest_First or Replies_Most_First or Replies_Least_First or Requests_Most_First or Requests_Least_First or Likes_Most_First or Likes_Least_First</Sort>
        <CurrentThread>int</CurrentThread>
        <PermaLink>int</PermaLink>
        <UnreadOnly>boolean</UnreadOnly>
        <Owner>int</Owner>
        <IsSideBarQuery>boolean</IsSideBarQuery>
        <IsBottomAlertQuery>boolean</IsBottomAlertQuery>
        <IncludePlainTextNote>boolean</IncludePlainTextNote>
      </args>
    </GetNotationSearchResult>
  </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>
    <GetNotationSearchResultResponse xmlns="http://schema.veetro.com">
      <GetNotationSearchResultResult>
        <NotationCounts>
          <NotationCount>
            <Type>Requests or Following or IncludeMe or LikedByMe or FromMe or AllTopics</Type>
            <Count>int</Count>
          </NotationCount>
          <NotationCount>
            <Type>Requests or Following or IncludeMe or LikedByMe or FromMe or AllTopics</Type>
            <Count>int</Count>
          </NotationCount>
        </NotationCounts>
        <Threads>
          <NotationThread>
            <Notations xsi:nil="true" />
            <RootNotation xsi:nil="true" />
            <AllEmployeesIncluded xsi:nil="true" />
            <IsHide>boolean</IsHide>
            <SourceFrom>string</SourceFrom>
          </NotationThread>
          <NotationThread>
            <Notations xsi:nil="true" />
            <RootNotation xsi:nil="true" />
            <AllEmployeesIncluded xsi:nil="true" />
            <IsHide>boolean</IsHide>
            <SourceFrom>string</SourceFrom>
          </NotationThread>
        </Threads>
        <SourceFrom>string</SourceFrom>
      </GetNotationSearchResultResult>
    </GetNotationSearchResultResponse>
  </soap12:Body>
</soap12:Envelope>