VitalWare API

SherpaFavoritesByFolder

The following routes are available for this service:
GET POST	/sherpaFavoritesByFolder	Get favorites for the specified folder
GET POST	/sherpaFavoritesByFolder/{folderName}	Get favorites for the specified folder	Folder Name can be directly within the URL as part of the path

Parameters:
Name	Parameter	Data Type	Required	Description
folderName	path	string	No	The folder name to get favorites for

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/SherpaFavoritesByFolder HTTP/1.1 
Host: api.vitalware.com 
Content-Type: application/xml
Content-Length: length

<SherpaFavoritesByFolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
  <folderName>String</folderName>
</SherpaFavoritesByFolder>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SherpaFavoritesByFolderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <request>
    <folderName>String</folderName>
  </request>
  <result>
    <SherpaFavoriteResult>
      <folderName>String</folderName>
      <id>0</id>
      <label>String</label>
      <value>String</value>
    </SherpaFavoriteResult>
  </result>
</SherpaFavoritesByFolderResponse>