Skip to content

schedules.md

Latest commit

 

History

History
202 lines (167 loc) · 4.85 KB

schedules.md

File metadata and controls

202 lines (167 loc) · 4.85 KB

schedules API

スケジュール一覧取得 API

リクエスト

GET /api/schedules

レスポンス

成功時

param type description
schedule[].id number スケジュール ID
schedule[].title string タイトル
schedule[].company_id string 会社 ID
schedule[].company_name string 会社名
schedule[].url array url
schedule[].note string メモ
schedule[].start Date 日程（ISO 8601 形式)
schedule[].end Date 日程（ISO 8601 形式) 
{
    "schedule": [
        {
            "id": number,
            "title": string,
            "company_id": number,
            "company_name": string,
            "url":string,
            "note": string,
            "start": Date,
            "end": Date,
        },
        ...
    ]
}

スケジュール取得 API

リクエスト

GET /api/schedules/{schedule_id}

レスポンス

成功時

param type description
id number スケジュール ID
title string タイトル
company_id string 会社 ID
company_name string 会社名
url array url
note string メモ
start Date 日程（ISO 8601 形式)
end Date 日程（ISO 8601 形式) 
{
    "id": number,
    "title": string,
    "company_id": number,
    "company_name": string,
    "url":string,
    "note": string,
    "start": Date,
    "end": Date,
}

スケジュール追加 API

リクエスト

POST /api/schedules
param type description
title string タイトル
company_id string 会社 ID
company_name string 会社名
url array url
note string メモ
start Date 日程（ISO 8601 形式)
end Date 日程（ISO 8601 形式) 
{
    "title": string,
    "company_id": number,
    "company_name": string,
    "url":string,
    "note": string,
    "start": Date,
    "end": Date,
}

レスポンス

param type description
id number スケジュール ID
title string タイトル
company_id string 会社 ID
company_name string 会社名
url array url
note string メモ
start Date 日程（ISO 8601 形式)
end Date 日程（ISO 8601 形式) 
{
    "id": number,
    "title": string,
    "company_id": number,
    "company_name": string,
    "url":string,
    "note": string,
    "start": Date,
    "end": Date,
}

スケジュール編集 API

リクエスト

POST /api/schedules/{schedule_id}
param type description
title string タイトル
company_id string 会社 ID
company_name string 会社名
url array url
note string メモ
start Date 日程（ISO 8601 形式)
end Date 日程（ISO 8601 形式) 
{
    "title": string,
    "company_id": number,
    "company_name": string,
    "url":string,
    "note": string,
    "start": Date,
    "end": Date,
}

レスポンス

param type description
id number スケジュール ID
title string タイトル
company_id string 会社 ID
company_name string 会社名
url array url
note string メモ
start Date 日程（ISO 8601 形式)
end Date 日程（ISO 8601 形式) 
{
    "id": number,
    "title": string,
    "company_id": number,
    "company_name": string,
    "url":string,
    "note": string,
    "start": Date,
    "end": Date,
}

スケジュール削除 API

リクエスト

DELETE /api/schedules/{schedule_id}

レスポンス

204 No Content