ケーススタディ HAL大阪　API一覧

FORMAT: 1A

ケーススタディ HAL大阪　API一覧

Group BOCCO × 目標ボタンAPI

ユーザー登録 [/signup]

ユーザー情報の登録、およびサインインするためのAPI

サインアップ [POST]

ユーザー情報の登録を行います。

Request (applicaition/json)
- Attribute
  - name: sample
  - pass: password
Response 200 (application/json)
- Attribute
  - success: ユーザー登録を行いました。
Response 400 (application/json)
- Attribute
  - error: 登録済みのユーザー名です。

サインイン [/signin]

サインイン [POST]

登録されているユーザー情報を元にサインインを行います。

Request (applicaition/json)
- Attribute
  - name: sample
  - pass: password
Response 200 (application/json)
- Attribute
  - token: sample
Response 400 (application/json)
- Attribute
  - error: ログインエラー

ユーザー削除 [/user]

ユーザー削除[DELETE]

登録されているユーザー情報を削除します。

Request
- Headers
```
  Authorization: token
```
Response 200 (application/json)
- Attribute
  - success: ユーザー情報を削除しました。
Response 400 (application/json)
- Attribute
  - error: ログインエラー

子供情報設定 [/child/{child_id}]

子供情報追加[POST]

子供の誕生日と性別、ニックネームを設定します。

Request(application/json)
- Headers
```
  Authorization: token
```
- Attributes
  - nickname: sample
  - birthday : 2000-01-01
  - sex : 0 (number) - 1:男、2:女
Response 200 (application/json)
- Attribute
  - child_id: 1 (number)
Response 400 (application/json)
- Attribute
  - error: ログインエラー

子供情報取得[GET]

子供ID,誕生日,ニックネーム,性別の一覧を取得します。

Request(application/json)
- Headers
```
  Authorization: token
```
Response 200 (application/json)
- Attributes
  - children (array)
    - (object)
      - child_id: 1 (number)
      - birthday: 2016-10-01T09:00:00+09:00
      - nickname: sample
      - sex: 0 (number) - 0:男、1:女
    - (object)
      - child_id: 2 (number)
      - birthday: 2017-03-19T09:00:00+09:00
      - nickname: index
      - sex: 1 (number) - 0:男、1:女
Response 400 (application/json)
- Attribute
  - error: ログインエラー

子供情報削除[DELETE]

登録されている子どもIDの情報を削除します。

Parameters
- child_id: 1
Request
- Headers
```
  Authorization: token
```
Response 200 (application/json)
- Attribute
  - success: 削除しました。
Response 400 (application/json)
- Attribute
  - error: ログインエラー

デバイス [/device/{device_id}]

デバイスID発行[POST]

新規登録するデバイスIDの発行を行います。

Request(application/json)
- Headers
```
  Authorization: token
```
- Attribute
  - goal_id: sample
Response 200 (application/json)
- Attribute
  - pin: 0000
Response 400 (application/json)
- Attribute
  - error: ログインエラー

デバイス一覧取得[GET]

現在登録されているデバイスIDの一覧を取得します。

Request(application/json)
- Headers
```
  Authorization: token
```
Response 200 (application/json)
- Attributes
  - devices (array)
    - (object)
      - child_id :1 (number)
      - nickname: sample
      - child_devices (array)
        
        sample,
        
        index
    - (object)
      - child_id: 2 (number)
      - nickname: test
      - child_devices (array)
        
        test,
        
        buf
Response 400 (application/json)
- Attribute
  - error: ログインエラー

デバイスID削除[DELETE]

登録されているデバイスIDを削除します。

Parameters
- device_id: sample
Request
- Headers
```
  Authorization: token
```
Response 200 (application/json)
- Attribute
  - success: ボタンIDを削除しました。
Response 400 (application/json)
- Attribute
  - error: ログインエラー

BOCCOAPI [/bocco]

BOCCOAPI設定[POST]

BOCCOAPIに登録したメールアドレスと、パスワードの入力

Request
- Headers
```
  Authorization: token
```
- Attribute
  - email: [email protected]
  - key : sample - APIkey
  - pass: abc123
Response 200 (application/json)
- Attribute
  - success: メールアドレスとパスワードを登録しました。
Response 400 (application/json)
- Attribute
  - error: ログインエラー

BOCCOAPI設定の取得[GET]

BOCCOAPIに登録したメールアドレスの取得

Request
- Headers
```
  Authorization: token
```
Response 200 (application/json)
- Attribute
  - email: [email protected]
Response 400 (application/json)
- Attribute
  - error: ログインエラー

BOCCOAPI削除[DELETE]

BOCCOAPIに登録したメールアドレスと、パスワードの削除

Request
- Headers
```
  Authorization: token
```
Response 200 (application/json)
- Attribute
  - success: メールアドレスとパスワードを削除しました。
Response 400 (application/json)
- Attribute
  - error: ログインエラー

目標 [/goal/{goal_id}]

目標登録[POST]

目標の新規追加を行います。

Request (application/json)
- Headers
```
  Authorization: token
```
- Attribute
  - child_id: 1 (number)
  - content: practice
  - criteria: 20 (number) - 達成目標数
  - deadline : 2018-07-01 - 達成期日(なければ空)
Response 200 (application/json)
- Attribute
  - goal_id: sample
Response 400 (application/json)
- Attribute
  - error: ログインエラー

ボタン登録[PUT]

使用するdevice_idを登録します

Request (application/json)
- Headers
```
  Authorization: token
```
- Attribute
  - goal_id: sample
  - device_id: sample
Response 200 (application/json)
- Attribute
  - success: 登録しました。
Response 400 (application/json)
- Attribute
  - error: ログインエラー

目標取得[GET]

登録されている目標と実行回数を取得します。

Request
- Headers
```
  Authorization: token
```
Response 200 (application/json)
- Attributes
  - goals(array)
    - (object)
      - child_id: 1 (number)
      - nickname: nicname
      - child_goals(array)
        
        (object)
        
        created_at: 2018-06-21T13:35:08+09:00
        
        goal_id : test - 目標ID
        
        device_id : sample
        
        run : 5 (number) - 目標実行数
        
        content: practice - 目標名称
        
        criteria: 20 (number) - 達成目標数
        
        deadline : 2018-07-11T13:35:08+09:00 - 達成期日(なければ空)
        
        status : 0 (number) - 達成状況(0:未実行、1:実行中、2:達成済み、3:達成失敗)
        
        updated_at: 2018-06-21T13:37:21+09:00,
        
        (object)
        
        created_at: 2018-06-21T13:35:08+09:00
        
        goal_id : sample
        
        device_id : hoge
        
        run : 5 (number)
        
        content: index
        
        criteria: 30 (number)
        
        deadline : なし
        
        status : 0 (number) - 達成状況(0:未実行、1:実行中、2:達成済み、3:達成失敗)
        
        updated_at: 2018-06-21T13:37:21+09:00,
    - (object)
      - child_id: 2 (number)
      - nickname: sample
      - child_goals(array)
        
        (object)
        
        created_at: 2018-06-21T13:35:08+09:00
        
        goal_id : index - 目標ID
        
        device_id : index
        
        run : 5 (number) - 目標実行数
        
        content: practice - 目標名称
        
        criteria: 20 (number) - 達成目標数
        
        deadline : 2018-07-11T13:35:08+09:00 - 達成期日(なければ空)
        
        status : 0 (number) - 達成状況(0:未実行、1:実行中、2:達成済み、3:達成失敗)
        
        updated_at: 2018-06-21T13:37:21+09:00,
Response 400 (application/json)
- Attribute
  - error: ログインエラー

目標削除[DELETE]

登録されている目標を削除します。

Parameters
- goal_id : sample
Request
- Headers
```
  Authorization: token
```
Response 200 (application/json)
- Attribute
  - success: 目標を削除しました。
Response 400 (application/json)
- Attribute
  - error: ログインエラー

目標達成承認/非承認 [/approval]

達成数変更 [PUT]

目標実行数を変更します。

Request (application/json)
- Headers
```
  Authorization: token
```
- Attribute
  - goal_id: sample
  - approval : 1 (number) - 増減値
Response 200 (application/json)
- Attribute
  - success: 目標達成を承認しました。
Response 400 (application/json)
- Attribute
  - error: ログインエラー

メッセージ [/message/{goal_id}/{message_call}]

メッセージ登録[POST]

オリジナルメッセージの登録を行います。

Request (application/json)
- Headers
```
  Authorization: token
```
- Attribute
  - goal_id: sample
  - message_call : 5 (number) - メッセージ出力条件
  - message: practice
Response 200 (application/json)
- Attribute
  - success: メッセージを編集しました。
Response 400 (application/json)
- Attribute
  - error: ログインエラー

メッセージ取得[GET]

登録されているメッセージとメッセージ出力条件を取得します。

Request
- Headers
```
  Authorization: token
```
Response 200 (application/json)
- Attributes
  - messages(array)
    - (object)
      - child_id: 1 (number)
      - nickname: sample
      - child_messages(array)
        
        (object)
        
        goal_id: sample
        
        content: practice
        
        message_call: 2 (number)
        
        message: practice
        
        (object)
        
        goal_id: index
        
        content: test
        
        message_call: 5 (number)
        
        message: sample
    - (object)
      - child_id: 2 (number)
      - nickname: index
      - child_messages(array)
        
        (object)
        
        goal_id: buf
        
        content: sample
        
        message_call: 3 (number)
        
        message: sample
        
        (object)
        
        goal_id: hoge
        
        content: test
        
        message_call: 10 (number)
        
        message: hoge
Response 400 (application/json)
- Attribute
  - error: ログインエラー

メッセージ削除[DELETE]

オリジナルメッセージの削除を行います。

Parameters
- goal_id: sample
- message_call: 5 (number)
Request (application/json)
- Headers
```
  Authorization: token
```
Response 200 (application/json)
- Attribute
  - success: メッセージを削除しました。
Response 400 (application/json)
- Attribute
  - error: ログインエラー

Group ICリーダー&ボタン側API

デバイス [/thing/registration]

デバイス登録[POST]

デバイスIDと各デバイスとの紐付けを行います。

Request (applicaition/json)
- Attribute
  - pin: 0000
Response 200 (application/json)
Attribute
- device_id: sample
Response 400 (application/json)
- Attribute
  - error: pinが見つかりません。

プッシュ回数増加 [/thing/button]

ボタンプッシュ[PUT]

目標ボタンが押された回数を記録します。

Request (applicaition/json)
- Attribute
  - device_id: sample
Response 200 (application/json)
- Attribute
  - angle: 72 (number)
Response 400 (application/json)
- Attribute
  - error: 目標IDが見つかりません。

Name		Name	Last commit message	Last commit date
Latest commit History 30 Commits
.circleci		.circleci
cmd		cmd
controller		controller
docs		docs
middleware		middleware
model		model
public/css		public/css
router		router
service		service
src		src
vendor		vendor
.editorconfig		.editorconfig
.gitignore		.gitignore
Dockerfile		Dockerfile
README.md		README.md
config.yml.template		config.yml.template
dredd.yml		dredd.yml
main.go		main.go
makefile		makefile
package-lock.json		package-lock.json
package.json		package.json
webpack.config.js		webpack.config.js

HAL-RO-Developer/caseTeamB_server

Folders and files

Latest commit

History

Repository files navigation

ケーススタディ HAL大阪 API一覧

Group BOCCO × 目標ボタンAPI

ユーザー登録 [/signup]

サインアップ [POST]

サインイン [/signin]

サインイン [POST]

ユーザー削除 [/user]

ユーザー削除[DELETE]

子供情報設定 [/child/{child_id}]

子供情報追加[POST]

子供情報取得[GET]

子供情報削除[DELETE]

デバイス [/device/{device_id}]

デバイスID発行[POST]

デバイス一覧取得[GET]

デバイスID削除[DELETE]

BOCCOAPI [/bocco]

BOCCOAPI設定[POST]

BOCCOAPI設定の取得[GET]

BOCCOAPI削除[DELETE]

目標 [/goal/{goal_id}]

目標登録[POST]

ボタン登録[PUT]

目標取得[GET]

目標削除[DELETE]

目標達成承認/非承認 [/approval]

達成数変更 [PUT]

メッセージ [/message/{goal_id}/{message_call}]

メッセージ登録[POST]

メッセージ取得[GET]

メッセージ削除[DELETE]

Group ICリーダー&ボタン側API

デバイス [/thing/registration]

デバイス登録[POST]

プッシュ回数増加 [/thing/button]

ボタンプッシュ[PUT]

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

ケーススタディ HAL大阪　API一覧

Packages