| 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 |
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/SherpaFavoritesByFolder HTTP/1.1
Host: api.vitalware.com
Content-Type: application/json
Content-Length: length
{"folderName":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}}