Skip to content

DigitalFishTW/fishevents-api

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits

bin

bin

 
 

controllers

controllers

 
 

models

models

 
 

public/stylesheets

public/stylesheets

 
 

routes

routes

 
 

.gitignore

.gitignore

 
 

README.md

README.md

 
 

app.js

app.js

 
 

package.json

package.json

 
 

Repository files navigation

#Auth ##Register ###PUT /auth ####Request

{
  username,
  password
}

####Response

HTTP Code
  - 201 Created
  - 226 IM Used
  - 400 Bad Request
  - 500 Internal Server Error

##Login ###GET /auth?username=&password=

####Response

HTTP Code
  - 200 Found
    {
      token
    }
  - 403 Forbidden
  - 500 Internal Server Error

##Get Username ###GET /username?token=

####Response

HTTP Code
  - 200 Found
    {
      username
    }
  - 403 Forbidden
  - 500 Internal Server Error

##Logout ###DELETE /auth?token= ####Response

  - 200 Found
  - 401 Unauthorized
  - 500 Internal Server Error

##Update Password ###PATCH /auth/:old_password?token= ####Request

{
  new_password
}

####Response

HTTP Code
  - 200 OK
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

#Profile ##Add Profile ###PUT /profile?token= ####Request

{
  create_time,
  last_edit,
  name: {
    first,
    middle,
    last
  },
  type,
  email,
  zip,
  address,
  city,
  states,
  country_code,
  birth,
  gender,
  bio,
  licenses: [license_id1, license_id2, license_id3...]
  phones: [{title1, phone1}, {title2, phone2}, {title3, phoen3}...]
}

####Response

HTTP Code
  - 201 Created
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##Get Profile List ###GET /profile?token=&offset=&limit= ####Response

HTTP Code
  - 200 Found
    {
      [
        {Object},
        {Object},
        ...
        {Object}
      ]
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##Get My Profile ###GET /profile/my?token= ####Response

HTTP Code
  - 200 Found
    {
      _id,
      create_time,
      last_edit,
      name: {
        first,
        middle,
        last
      },
      type,
      email,
      zip,
      address,
      city,
      states,
      country_code,
      birth,
      gender,
      bio,
      licenses: [license_id1, license_id2, license_id3...]
      phones: [{title1, phone1}, {title2, phone2}, {title3, phoen3}...]
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##Get One Profile ###GET /profile/:id?token= ####Response

HTTP Code
  - 200 Found
    {
      _id,
      create_time,
      last_edit,
      name: {
        first,
        middle,
        last
      },
      type,
      email,
      zip,
      address,
      city,
      states,
      country_code,
      birth,
      gender,
      bio,
      licenses: [license_id1, license_id2, license_id3...]
      phones: [{title1, phone1}, {title2, phone2}, {title3, phoen3}...]
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##Modify Profile ###PATCH /profile/:id?token＝ ####Request

JSON Patch

####Response

HTTP Code
  - 200 OK
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

#Vessel ##Add New Vessel ###PUT /vessel?token= ####Request

{
  name,
  imo,
  mmsi,
  identify,
  gears: [gear1, gear2, gear3...],
  chars: [char1, char2, char3...],
  radio,
  flag,
  ais_type,
  gross_tonnage,
  deadweight,
  length,
  breadth,
  year,
  status,
  home_port,
  licenses: [license_id1, license_id2, license_id3...]
}

####Response

HTTP Code
  - 201 Created
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##Get Vessel List ###GET /vessel?token=&offset=&limit= ####Response

HTTP Code
  - 200 Found
    {
      [
        {Object},
        {Object},
        ...
        {Object}
      ]
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##Get One Vessel Profile ###GET /vessel/:id?token= ####Response

HTTP Code
  - 200 Found
    {
      _id,
      name,
      imo,
      mmsi,
      identify,
      gears: [gear1, gear2, gear3...],
      chars: [char1, char2, char3...],
      radio,
      flag,
      ais_type,
      gross_tonnage,
      deadweight,
      length,
      breadth,
      year,
      status,
      home_port,
      licenses: [license_id1, license_id2, license_id3...]
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##Modify Vessel ###PATCH /vessel/:id?token＝ ####Request

JSON Patch

####Response

HTTP Code
  - 200 OK
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

#Catch ##Add Catch Record ###PUT /catch?token ####Resquest

{
    date,
    total: {
        weight,
        counts
    },
    selling,
    permit,
    species: {
        profile,
        weight,
        sold,
        pricing
    }
}

####Respopnse

HTTP Code
  - 201 Created
  - 400 Bad Request
  - 500 Internal Server Error

##Get Catch List ###GET /catch?token=&offset=&limit= ####Response

HTTP Code
  - 200 Found
    {
      [
        {Object},
        {Object},
        ...
        {Object}
      ]
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##Get One Catch Detail ###GET /catch/:id?token= ####Response

HTTP Code
  - 200 Found
    {
      _id,
      date,
      total: {
        weight,
        counts
      },
      selling,
      permit,
      species: {
        profile,
        weight,
        sold,
        pricing
      }
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##Modify Catch ###PATCH /catch/:id?token＝ ####Request

JSON Patch

####Response

HTTP Code
  - 200 OK
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

#Track ##Add Track ###PUT /track?token= ####Request

{
  boat,
  path: [{
      time,
      lat,
      long,
      speed
  }],
  catches: [],
  start_at,
  end_at
}

#Response

HTTP Code
  - 201 Created
  - 400 Bad Request
  - 500 Internal Server Error

##GET Track List ###GET /track?token=&offset=&limit= ####Response

HTTP Code
  - 200 Found
    {
      [
        {Object},
        {Object},
        ...
        {Object}
      ]
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##GET One Track ###GET /track/:id?token= ####Response

  - 200 Found
    {
      _id,
      boat,
      path: [{
        time,
        lat,
        long,
        speed
      }],
      catches: [],
      start_at,
      end_at
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##Modify Track ###PATCH /track/:id?token＝ ####Request

JSON Patch

####Response

HTTP Code
  - 200 OK
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

#Permit ##Add Permit ###PUT /permit?token= ####Request

{
  type,
  country_code,
  state,
  id,
  ...
}

#Response

HTTP Code
  - 201 Created
  - 400 Bad Request
  - 500 Internal Server Error

##GET Permit List ###GET /permit?token=&offset=&limit= ####Response

HTTP Code
  - 200 Found
    {
      [
        {Object},
        {Object},
        ...
        {Object}
      ]
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##GET One Permit ###GET /permit/:id?token= ####Response

  - 200 Found
    {
      _id,
      type,
      country_code,
      state,
      id,
      ...
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##Modify permit ###PATCH /permit/:id?token＝ ####Request

JSON Patch

####Response

HTTP Code
  - 200 OK
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

#Fish ##Add Fish Speice ###PUT /fish?token= ####Resquest

{
  sn,
  name: [name_cht, name_eng...],
  chars: [char1, char2, char3...],
  intro
}

####Response

HTTP Code
  - 201 Created
  - 400 Bad Request
  - 500 Internal Server Error

##Get Fish List ###GET /fish?token=&offset=&limit= ####Response

HTTP Code
  - 200 Found
    {
      [
        {Object},
        {Object},
        ...
        {Object}
      ]
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

##GET One Fish ###GET /fish/:id?token= ####Response

  - 200 Found
    {
      sn,
      name: [name_cht, name_eng...],
      chars: [char1, char2, char3...],
      intro
    }
  - 401 Unauthorized
  - 403 Forbidden
  - 500 Internal Server Error

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

4 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages