API docs by Redocly

新人研修プロジェクト (1.0.0)

Download OpenAPI specification:Download

認証系フォルダー

ログインAPI

ログインするためのAPI

Request Body schema: application/json
mail_address
required
string

メールアドレス

password
required
string

パスワード

Responses

Request samples

Content type
application/json
{
  • "mail_address": "miho.hatanaka@itcowork.co.jp",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "id": 21,
  • "user_name": "畑中美穂",
  • "is_adimin": false
}

ログイン情報取得API

すでにログイン済みの場合、ログイン情報を取得するAPI

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 21,
  • "user_name": "畑中美穂",
  • "is_adimn": false
}

ログアウトAPI

ログアウトを行うためのAPI

header Parameters
Accept
string
Example: application/json
Request Body schema: multipart/form-data
object

Responses

Response samples

Content type
application/json
{ }

ユーザ系フォルダー

ユーザ一覧取得API

ユーザ一覧を取得するためのAPI
管理者フラグがtrueの場合のみ実行可能

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "user_list": [
    ]
}

ユーザ登録API

ユーザ情報を登録するためのAPI
管理者フラグがtrueの場合のみ実行可能

header Parameters
Accept
string
Example: application/json
Request Body schema: application/json
user_name
required
string <= 255 characters

ユーザ名

user_name_kana
required
string <= 255 characters

ユーザ名（かな）

mail_address
required
string <= 255 characters

メールアドレス

password
required
string <= 255 characters

パスワード

is_admin
required
boolean
Default: false

管理者フラグ

default_area_id
required
integer
Default: 1

デフォルトエリアID

Responses

Request samples

Content type
application/json
{
  • "user_name": "鈴木瑞帆",
  • "user_name_kana": "すずきみづほ",
  • "mail_address": "mizuho.suzuki@itcowork.co.jp",
  • "password": "mizuho",
  • "is_admin": false,
  • "default_area_id": 2
}

Response samples

Content type
application/json
{ }

ユーザ詳細取得API

ユーザIDに紐づく詳細な情報を取得するためのAPI
管理者フラグがtrue、またはログインしているユーザIDが一致する場合のみ実行可能

path Parameters
user_id
required
integer
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 33,
  • "user_name": "鈴木瑞帆",
  • "user_name_kana": "すずきみづほ",
  • "mail_address": "mizuho.suzuki@itcowork.co.jp",
  • "is_admin": false,
  • "default_area_id": 2
}

ユーザ情報更新API

ユーザIDに紐づく情報を更新するためのAPI
管理者フラグがtrue、またはログインしているユーザIDが一致する場合のみ実行可能

path Parameters
user_id
required
integer
header Parameters
Accept
string
Example: application/json
Request Body schema: application/json
user_name
required
string <= 255 characters

ユーザ名

user_name_kana
required
string <= 255 characters

ユーザ名（かな）

mail_address
required
string <= 255 characters

メールアドレス

password
string <= 255 characters

パスワード

is_admin
required
boolean
Default: false

管理者フラグ

default_area_id
required
integer
Default: 1

デフォルトエリアID

Responses

Request samples

Content type
application/json
{
  • "user_name": "鈴木瑞帆",
  • "user_name_kana": "すずきみづほ",
  • "mail_address": "mizuho.suzuki@itcowork.co.jp",
  • "password": "mizuho",
  • "is_admin": false,
  • "default_area_id": 4
}

Response samples

Content type
application/json
{ }

ユーザ削除API

ユーザIDに紐づく情報を削除するためのAPI
管理者フラグがtrueの場合のみ実行可能

path Parameters
user_id
required
integer
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

エリア系フォルダー

エリア登録API

エリア情報を登録するためのAPI
管理者フラグがtrueの場合のみ実行可能

header Parameters
Accept
string
Example: application/json
Request Body schema: application/json
area_name
required
string

エリア名

is_default_area
required
boolean

デフォルト指定フラグ

Responses

Request samples

Content type
application/json
{
  • "area_name": "1F会議室",
  • "is_default_area": false
}

Response samples

Content type
application/json
{ }

エリア一覧取得API

エリア区分の一覧を取得するAPI

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "area_list": [
    ]
}

エリア詳細取得API

指定したエリアIDのエリア詳細情報を取得するAPI
管理者フラグがtrueのとき実行できる

path Parameters
area_id
required
integer
header Parameters
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
""

Response samples

Content type
application/json
{
  • "id": 4,
  • "area_name": "1F会議室",
  • "is_default_area": false
}

エリア更新API

指定したエリアIDのエリア情報を更新するAPI
管理者フラグがtrueのとき実行できる

path Parameters
area_id
required
integer
header Parameters
Accept
string
Example: application/json
Request Body schema: application/json
area_name
required
string

エリア名

is_default_area
required
boolean

デフォルト指定フラグ

Responses

Request samples

Content type
application/json
{
  • "area_name": "1F会議室",
  • "is_default_area": true
}

Response samples

Content type
application/json
{ }

エリア削除API

指定したエリアIDのエリア情報を削除するAPI
管理者フラグがtrueのとき実行できる

path Parameters
area_id
required
integer
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

勤怠系フォルダー

勤怠状況一覧取得API

勤怠状況区分の一覧情報を取得するためのAPI

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "attendance_list": [
    ]
}

ユーザステータス系フォルダー

ユーザステータス一覧取得API

ユーザの作業状態の区分を一覧取得するAPI

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "user_status_list": [
    ]
}

位置情報系フォルダー

ユーザ位置情報一覧取得API

データベースに登録されているユーザの位置情報の一覧を取得するAPI

header Parameters
Accept
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
""

Response samples

Content type
application/json
{
  • "user_location_list": [
    ]
}

ユーザ位置情報更新API

ユーザIDに紐づく、勤怠状況、作業場所、ステータスを更新するためのAPI
ユーザ自身の情報のみ更新することが可能
作業場所とステータスは個別で変更することができるが、勤怠状況を変更するとエリアとステータスが一括で変更される
「出社」が押された場合は、作業場所→ユーザのデフォルトの作業場所、ステータス→「在席」
「リモート」が押された場合は、作業場所→「自宅」、ステータス→なし
「退勤」もしくは「休暇」が押された場合は、作業場所・ステータス→なし
「出張」が押された場合は、作業場所→なし、ステータス→「外出中」
※勤怠状況、作業場所、ステータスのリクエストは1つしか渡すことができない

path Parameters
user_id
required
integer
header Parameters
Accept
string
Example: application/json
Request Body schema: application/json
attendance_id
integer <= 127
Default: 1

勤怠状況ID

area_id
integer <= 127
Default: 1

エリアID

user_status_id
integer <= 127
Default: 1

ユーザステータスID

Responses

Request samples

Content type
application/json
{
  • "attendance_id": 1,
  • "user_status_id": 1,
  • "area_id": 1
}

Response samples

Content type
application/json
{
  • "attendance_status": "出社",
  • "area_name": "2F開発部屋",
  • "user_status": "外出中"
}

ユーザ位置情報詳細取得API

ユーザIDに紐づく位置情報の詳細を取得するためのAPI
ホーム画面内で使用される
ログインしているユーザのIDと一致する情報のみ実行可能

path Parameters
user_id
required
integer
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 35,
  • "user_name": "畑中美穂",
  • "attendance_status": "出社",
  • "area_name": "2F開発部屋",
  • "user_status": "在席"
}