API Documentation

Routes and Conventions

Collection URLs: /plural-resource

A Collection URL will return a collection of resource object representations.

e.g. /users returns a collection of all User objects
Element URLs: /plural-resource/{id}, where {id} is an application unique integer

An Element URL will return a single resource object representation, based on the id attribute.

e.g. /users/1 returns the single User object, whose id is 1

The API represented 3 resources: Users, Projects, and Files, where: