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": "kikuuchi@itcowork.co.jp",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "user_name": "菊内尊雄",
  • "is_admin": false
}

ログイン情報取得API

既にログイン済みの場合、ログイン情報を取得して返却するAPI

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "user_name": "菊内尊雄",
  • "is_admin": false
}

ログアウトAPI

ログアウトに使用するAPI

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
{
  • "user_list": [
    ]
}

ユーザ登録API

ユーザ情報の登録を行うAPI
管理者のみ実行可能

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

ユーザ名

user_name_kana
required
string

ユーザ名（かな）

mail_address
required
string

メールアドレス

password
required
string

パスワード

is_admin
required
boolean

管理者フラグ

default_area_id
required
integer

固有席エリア

Responses

Request samples

Content type
application/json
{
  • "user_name": "山田太郎",
  • "user_name_kana": "やまだたろう",
  • "mail_address": "yamada@itcowork.co.jp",
  • "password": "password",
  • "is_admin": false,
  • "default_area_id": 1
}

Response samples

Content type
application/json
{ }

ユーザ詳細取得API

ユーザIDに紐づく、ユーザの詳細情報を取得し返却するAPI
管理者及びログインユーザ自身の情報のみ実行可能

path Parameters
user_id
required
integer

ユーザID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "user_name": "菊内尊雄",
  • "user_name_kana": "きくうちたかお",
  • "mail_address": "kikuuchi@itcowork.co.jp",
  • "is_admin": false,
  • "default_area_id": 1
}

ユーザ情報更新API

ユーザIDに紐づく、ユーザ情報の更新を行うAPI
管理者及びログインユーザ自身の情報のみ実行可能

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

ユーザ名

user_name_kana
required
string

ユーザ名（かな）

mail_address
required
string

メールアドレス

password
string

パスワード

is_admin
required
boolean

管理者フラグ

default_area_id
required
integer

デフォルトエリア

Responses

Request samples

Content type
application/json
{
  • "user_name": "菊内尊雄",
  • "user_name_kana": "きくうちたかお",
  • "mail_address": "kikuuchi@itcowork.co.jp",
  • "password": "password",
  • "is_admin": false,
  • "default_area_id": 1
}

Response samples

Content type
application/json
{ }

ユーザ削除API

ユーザIDに紐づく、ユーザ情報の削除を行うAPI
管理者のみ実行可能

path Parameters
user_id
required
integer

ユーザID

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
{
  • "area_list": [
    ]
}

エリア登録API

エリア名とデフォルトエリアフラグを登録するAPI
管理者のみ実行可能

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": "自宅",
  • "default_area": true
}

Response samples

Content type
application/json
{ }

エリア詳細取得API

エリアIDに紐づく、エリアの詳細情報を取得し返却するAPI
管理者のみ実行可能

path Parameters
area_id
required
integer

エリアID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "area_name": "2F 開発部屋",
  • "is_default_area": true
}

エリア更新API

エリアIDに紐づく、エリア情報の更新を行うAPI
管理者のみ実行可能

path Parameters
area_id
required
integer

エリアID

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": "2F 開発部屋",
  • "is_default_area": true
}

Response samples

Content type
application/json
{ }

エリア削除API

エリアIDに紐づく、エリア情報の削除を行うAPI
管理者のみ実行可能

path Parameters
area_id
required
integer

エリアID

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

Responses

Response samples

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

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

ホーム画面に表示する、 ログインユーザに紐づく位置情報データの取得を行うAPI

path Parameters
user_id
required
integer

ユーザID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "user_name": "菊内尊雄",
  • "area_name": "1F 開発部屋",
  • "attendance_status": "出社",
  • "user_status": "自席"
}

ユーザ位置情報更新API

ユーザIDに紐づく、ユーザの位置情報の更新を行うAPI
ログインユーザ自身の情報のみ実行可能
「出社」が押された場合、作業場所→デフォルトエリア、ステータス→自席 に変更
「リモート」が押された場合、作業場所→自宅、ステータス→自席 に変更
「退勤」が押された場合、作業場所→なし、ステータス→なし に変更
「出張」が押された場合、作業場所→なし、ステータス→外出中 に変更
「休暇」が押された場合、作業場所→なし、ステータス→なし に変更
※リクエストはどれか一つしか渡されません

path Parameters
user_id
required
string

ユーザID

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

エリアID

attendance_id
integer

勤怠ID

user_status_id
integer

ユーザステータスID

Responses

Request samples

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

Response samples

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