Interface

Interface Definition

Routes

/api/v1/categories

Operation	Description
GET	Returns a collection of Categories
POST	Creates a new Category

/api/v1/categories/:id

Operation	Description
DELETE	Removes the Category identified by the given :id
GET	Returns the Category identified by the given :id
PUT	Modifies the Category identified by the given :id

/api/v1/categories/:id/notes

Operation	Description
GET	Returns all the notes belonging to the given Category
POST	Creates a new note in the given Category

/api/v1/categories/:id/notes/:noteId

Operation	Description
DELETE	Removes the identified note from the given Category
GET	Returns the identified note

/api/v1/notes

Operation	Description
GET	Returns a collection of Notes from the default Category
POST	Creates a new Note in the default Category

/api/v1/notes/:id

Operation	Description
DELETE	Removes the Note identified by the given :id
GET	Returns the Note identified by the given :id
PUT	Modifies the Note identified by the given :id

/api/ping

Operation	Description
GET	Sends an affirmative response when the API is reachable

/api/ping/secure

Operation	Description
GET	Sends an affirmative response when the secure API is reachable

Messages

NewCategoryMessage

Property Name	Type	Description
Name	string	The name of the Category to be created

NewNoteMessage

Property Name	Type	Description
Text	string	The text of the Note to be created

CategoryDto

Property Name	Type	Description
Id	Guid	Category object identifier
Name	string	The name of the Category
Created	DateTime	Object creation timestamp
Notes	IList<NoteDto>	Collection of notes belonging to the category
Subscribers	IList<SubscriberDto>	Collection of those subscribed to the category

NoteDto

Property Name	Type	Description
Id	Guid	Note object identifier
Text	string	The text of the Note
Created	DateTime	Object creation timestamp

SubscriberDto

Property Name	Type	Description
Id	Guid	Subscriber object identifier
EmailAddress	string	Subscriber's email address