Skip to content

Latest commit

 

History

History
128 lines (102 loc) · 7.75 KB

README.md

File metadata and controls

128 lines (102 loc) · 7.75 KB

brian

To access the respective API, assume the host is always the same:

http://ec2-54-66-246-123.ap-southeast-2.compute.amazonaws.com/brian/src/public/

Mail

Method API Description Body
POST /mail Send an HTML email To:{string}
ToName:{string}
From:{string}
FromName:{string}
Subject:{string}
Body:{string}

Client

Method API Description Body
GET /conditions List of all conditions
GET /client List of all offenders
GET /client/username/{string} Get details by using username
GET /client/location/{int} List of all offender's from a location
GET /client/region/{int} List of all offender's from a region
GET /client/{int} All information about one offender
POST /client/{int}/update/name Updates names(s) JAID:{int}
FirstName:{string}
LastName:{string}
GET /client/{int}/messages List of all correspondence for one offender
GET /client/{int}/communitywork List of all assigned community work for one offender
GET /client/{int}/location List of all assigned locations for one offender
GET /client/{int}/staff List of all assigned staff for one offender
GET /client/{int}/phone List of all offender's phone numbers for one offender
GET /client/{int}/support List of all offender's support
POST /client/{int}/support Adds a support to an offender Name:{string}
Phone:{int}
email:{string}
Location:{string}
POST /client/{int}/support/{id} Updates support of an offender Name:{string}
Phone:{int}
email:{string}
Location:{string}
GET /client/{int}/order List of all orders for one offender
GET /client/{int}/order/{order_id} Get order details
POST /client/{int}/order/{order_id} Edit order details StartDate:{date}
EndDate:{date}
Status:{string}
GET /client/{int}/condition/order/{order_id} Get all of the conditions from an order
POST /client/{int}/condition/order/{order_id}/condition/{condition_id} Update condition details, 0 = no, 1 = yes StartDate:{date}
EndDate:{date}
Status:{string}
Detail:{string}

Staff

Method API Description Body
GET /staff List of all authenticated CCS staff
GET /staff/location/{id} List of all authenticated CCS staff from a location
GET /staff/{username}/client List of all offenders assigned to CM
GET /staff/{username}/client/location/{id} List of offenders assigned to CM from a location
GET /staff/type/{role} List of all users with a specific role
GET /staff/location/{id}/type/{role} List of specific users from a location
GET /staff/location/{id}/authenticate List of users that need to be authenticated in a location
GET /staff/authenticate List of all users that require authentication
POST /staff/authenticate Sets the authentication of a specific user Username:{string}
LocationID:{int}
Admin:{string}
Status:{0=waiting,1=approved,2=denied}
GET /staff/revoked List of all that have rejected/revoked access
POST /staff/delete Deletes a specific user Username:{string}
LocationID:{int}
GET /staff/region/{id} List of all users from a region (//TODO)
GET /staff/region/{id}/type/{role} List of specific users from a region (//TODO)
--- TODO --- ---
GET /staff/{username} Get details about specific staff
POST /staff/update/email Updates email Username:{string}
email:{string}
POST /staff/update/name Updates names(s) Username:{string}
FirstName:{string}
LastName:{string}
POST /staff/update/location/add Adds a new location Username:{string}
LocationID:{int}
POST /staff/update/location/leave Sets date staff left location Username:{string}
LocationID:{int}
POST /staff/update/location/delete Completely removes staff from location Username:{string}
LocationID:{int}

Users

Method API Description Body
GET /user List of all users
POST /user/new Create a new user Username:{string}
Password:{string}
email:{string}
Role:{string}
Location:{int}
FirstName:{string}
LastName:{string}
GET /user/password/{username} Get the hashed password of a user
POST /user/password Update the password of a user Username:{string}
Password:{string}
POST /user/login Login with hashed password Username:{string}
Password:{string}
GET /user/salt/{username} Returns salt string of a user
POST /user/salt Sets the Salt of a user Username:{string}
Salt:{string}
GET /user/{username} Detailed information about one user (role only?)
POST /user/{username} Assigns a user a specific role Role:{string}
GET /user/type List of all user types
POST /user/delete Deletes a specific user Username:{string}
LocationID:{int}

Location

Method API Description
GET /location List of all locations
GET /location/detail List of all locations, with detail
GET /location/{id} One location, with detail
GET /location/region/{id} List of all locations within a region
GET /location/region/{id}/detail List of all locations within a region, with detail

Region

Method API Description
GET /region List of all regions
GET /region/{id} List of all locations, within a region (same as /location/region/{id})

Area

Method API Description
GET /area List of all areas

Group

Method API Description Body
GET /group List of all groups
GET /group/{int} Get details about a specific group
GET /group/staff/{string} Get all groups belonging to a staff
GET /group/staff/{string}/type/{string} Get all groups belonging to a staff of a specific type
GET /group/staff/{string}/type/{string}/archived Get all groups belonging to a staff of a specific type that are archived
GET /group/type/{string} Get all groups of a type (CW or Other)
GET /group/location/{int} Get all non-archived groups at a location
GET /group/location/{int}/archived Get all groups at a location that are archived
GET /group/location/{int}/type/{string} Get all groups at a location of a specifc type
GET /group/location/{int}/type/{string}/archived Get all groups at a location of a specifc type that are archived
POST /group/new/ Create a new group, returns assoicated group ID if sucessful GroupName:{string}
GroupAuthor:{string}
GroupLocation:{int}
GroupType:{CW, Other}
POST /group/client/add Add an offender to a group GroupID:{int}
GroupType:{string}
LastUpdatedAuthor:{string}
POST /group/client/remove Removes an offender from a group GroupID:{int}
JAID:{int}
LastUpdatedAuthor:{string}
POST /group/archive/ Archives group GroupID:{int}
Archivist:{string}
POST /group/unarchive/ Unarchives group GroupID:{int}
Archivist:{string}