Bookmarks

Last Updated 7/1/2015

The Illinois workNet bookmarks API enables adding booksmarks to a user's account. An app using this API must have access to the user GUID (RowId from the user table),.

Conventions in this Document

Text in bold is required. Text in italics should be substituted with the value of a parameter.

All URIs are relative to https://apps.illinoisworknet.com/providersApi

Bookmark API

Find existing Bookmark

Determines if a bookmark has already been saved. Uses object with userGuid, and url
POST
/api/bookmark/find
UserGuid
GUID of the User to search the bookmarks of
Url
Bookmark URL to search for

Found:

      {
        Successful: true
        Message: ""
        Bookmark: 
        {
          Id: 90
          UserId: 487
          UserGuid: null
          Category: "IOER"
          Title: "TEST ADD 01-15"
          Url: "https://ioer.ilsharedlearning.org/Search"
          IsInternalUrl: false
          Created: "2015-01-16T18:40:13.667"
          LastUpdated: "2015-01-16T18:40:13.667"
        }
      }

Not Found:

      {
        Successful: false
        Message: "Bookmark not found"
        Bookmark: null
      }

Add a new Bookmark

Adds the bookmark to the user's account
POST
/api/Bookmark
UserGuid
GUID of the User to search the bookmarks of
Url
Bookmark URL to search for
Category
Title of the category to add the bookmark to
Title
Title of the bookmark
IsInternalUrl
boolean indicating whether or not to use a relative (to workNet) URL
      {
        Message: "Bookmark was added."
        Successful: true
      }

Delete a Bookmark

Deletes the bookmark from the user's account
DELETE
/api/Bookmark/
UserGuid
GUID of the User to search the bookmarks of
Url
Bookmark URL to delete

Success:

      {
        Successful: true
        Message: "Bookmark was removed."
      }

Failure:

      {
        Successful: false
        Message: "The requested bookmark was not found."
      }

Get a user's Bookmarks

Get all bookmarks for a User. Returns a collection of Bookmark objects.
GET
/api/Bookmark/GetAll?userGuid={UserGuid}
UserGuid
GUID of the User to get the bookmarks of