Off2shore API allows you to register, track, administer vessels, personel and equipment for offshore operations

Resources

Companies
Company records

Resource Description
GET /api/v1/companies Get a list of companies
GET /api/v1/companies/:id Get data on a specific company
POST /api/v1/companies Create a company
PUT /api/v1/companies/:id Modify a company
DELETE /api/v1/companies/:id Delete a company

Professions
Professions

Resource Description
GET /api/v1/professions List all professions

Project locations
Project Locations administration

Resource Description
GET /api/v1/project_locations Show all locations

Projects

Resource Description

Registrations
User registration

Resource Description
POST /api/v1/users/sign_up Create a new user

Roles
Roles

Resource Description
GET /api/v1/roles List all Roles

Sessions
User sessions

Resource Description
POST /api/v1/users/sign_in Sign user in
DELETE /api/v1/users/sign_out Sign user out

User companies
User Company glue record

Resource Description
GET /api/v1/user_companies Get a list of user company records
GET /api/v1/user_companies/:id Get data on a specific user company record
POST /api/v1/user_companies Create a user company record
PUT /api/v1/user_companies/:id Update a user company record
DELETE /api/v1/user_companies/:id Delete a user company record

Users
User administration

Resource Description
GET /api/v1/users Show all users
GET /api/v1/users/:id Show user
PUT /api/v1/users/:id Update user
DELETE /api/v1/users/:id Delete a user

Vessel crews
Vessel crew

Resource Description
GET /api/v1/vessel_crews Show all vessel crews (still need to add limitation to params[:vessel_id] here)
GET /api/v1/vessel_crew/:id Show a specific vessel crewmember
POST /api/v1/vessel_crews/:id Create a vessel crewmember
PUT /api/v1/vessel_crew/:id Update a vessel crewmember
DELETE /api/v1/vessel_crew/:id Delete a vessel crewmember

Vessel form definitions

Resource Description
GET /api/v1/vessel_form_definitions all form definitions (for your company)
GET /api/v1/vessel_form_definition/:id show a specific form definitions
POST /api/v1/vessel_form_definitions Create a form definitions
PUT /api/v1/vessel_form_definition/:id Update a form definition
DELETE /api/v1/vessel_form_definition/:id Delete a specific form definition

Vessel kpis
Vessel KPI

Resource Description
GET /api/v1/vessel_kpis Get vessel KPIs
POST /api/v1/vessel_kpis Create a vessel KPI
PUT /api/v1/vessel_kpis/:id Update a vessel KPI, pass id in URL
DELETE /api/v1/vessel_kpis/:id Delete a vessel KPI, pass id in URL

Vessel question answers
Vessel question answers

Resource Description
GET /api/v1/vessel_question_answers Show all question answers
GET /api/v1/vessel_question_answer/:id Show a specific question answers
POST /api/v1/vessel_question_answers Create an answer
PUT /api/v1/vessel_question_answer/:id Update an answer, wrap the answer in a vessel_question_answers hash.
DELETE /api/v1/vessel_question_answer/:id Delete an answer.

Vessel question definition options

Resource Description
GET /api/v1/vessel_question_definition_options Get options for a certain question

Vessel question definitions

Resource Description
GET /api/v1/vessel_question_definitions all question definitions (for a certain form)
GET /api/v1/vessel_question_definition/:id Show a specific vessel question
POST /api/v1/vessel_question_definitions Create a vessel question
PUT /api/v1/vessel_question_definition/:id Update a vessel question
DELETE /api/v1/vessel_question_definition/:id Delete a specific vessel question

Vessels
Vessel administration

Resource Description
GET /api/v1/vessels Show all vessels
GET /api/v1/vessels/:id Show a specific vessel