VitalWare API

<back to all web services

SherpaFavoritesByFolder

The following routes are available for this service:
GET POST/sherpaFavoritesByFolderGet favorites for the specified folder
GET POST/sherpaFavoritesByFolder/{folderName}Get favorites for the specified folderFolder Name can be directly within the URL as part of the path
Parameters:
NameParameterData TypeRequiredDescription
folderNamepathstringNoThe folder name to get favorites for

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

HTTP + CSV

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

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

{"folderName":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"request":{"folderName":"String"},"result":[{"id":0,"label":"String","value":"String","folderName":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String"}]}}