Back to top

Web Desgin Course Common Test

WEBデザインコースで実施する全学年共通テストのAPI仕様。


Webooks API

Webデザインコースで管理している貸出書籍に関するデータを取得できるAPI

Books

書籍一覧

WEBデザインコースの貸出書籍一覧が取得できます。

書籍一覧取得
GET/api/v1/webooks/books

Example URI

GET https://click.ecc.ac.jp/ecc/sakakura/wdct/api/v1/webooks/books
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "vertion": "1.1",
  "data": [
    {
      "id": 1,
      "name": "Web Design",
      "category": "デザイン",
      "room": "2403",
      "state": 1
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "vertion": {
      "type": "string"
    },
    "data": {
      "type": "array"
    }
  }
}

書籍一覧絞り込み

書籍一覧取得
GET/api/v1/webooks/books/search{?name,category,room,state}

Example URI

GET https://click.ecc.ac.jp/ecc/sakakura/wdct/api/v1/webooks/books/search?name=Web Design&category=デザイン&room=2403&state=1
URI Parameters
HideShow
name
string (required) Example: Web Design

書籍名

category
string (required) Example: デザイン

カテゴリー名

room
string (required) Example: 2403

教室名

state
integer (required) Example: 1

貸出状態

Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "vertion": "1.1",
  "data": [
    {
      "id": 1,
      "name": "Web Design",
      "category": "デザイン",
      "room": "2403",
      "state": 1
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "vertion": {
      "type": "string"
    },
    "data": {
      "type": "array"
    }
  }
}

書籍詳細

WEBデザインコースのクラス時間割が取得できます。

書籍詳細取得
GET/api/v1/books/{id}

Example URI

GET https://click.ecc.ac.jp/ecc/sakakura/wdct/api/v1/books/1
URI Parameters
HideShow
id
integer (required) Example: 1

ID番号

Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "vertion": "1.1",
  "data": {
    "id": 1,
    "name": "Web Design",
    "category": "デザイン",
    "room": "2403",
    "state": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "vertion": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "ID"
        },
        "name": {
          "type": "string",
          "description": "書籍名"
        },
        "category": {
          "type": "string",
          "description": "書籍カテゴリー"
        },
        "room": {
          "type": "string",
          "description": "書籍の配置教室"
        },
        "state": {
          "type": "number",
          "description": "貸出ステータス"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  }
}

Categories

書籍カテゴリー一覧

WEBデザインコースの貸出書籍のカテゴリー一覧が取得できます。

書籍カテゴリー一覧取得
GET/api/v1/webooks/categories

Example URI

GET https://click.ecc.ac.jp/ecc/sakakura/wdct/api/v1/webooks/categories
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "vertion": "1.1",
  "data": [
    {
      "id": 1,
      "name": "デザイン"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "vertion": {
      "type": "string"
    },
    "data": {
      "type": "array"
    }
  }
}

Makers

書籍カテゴリー一覧

WEBデザインコースの貸出書籍の出版社一覧が取得できます。

書籍出版社一覧取得
GET/api/v1/webooks/makers

Example URI

GET https://click.ecc.ac.jp/ecc/sakakura/wdct/api/v1/webooks/makers
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "vertion": "1.1",
  "data": [
    {
      "id": 1,
      "name": "O'Reilly Japan"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "vertion": {
      "type": "string"
    },
    "data": {
      "type": "array"
    }
  }
}

Rooms

書籍カテゴリー一覧

貸出書籍を置いている教室一覧が取得できます。

教室一覧取得
GET/api/v1/webooks/rooms

Example URI

GET https://click.ecc.ac.jp/ecc/sakakura/wdct/api/v1/webooks/rooms
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
  "vertion": "1.1",
  "data": [
    {
      "id": 1,
      "name": "2403"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "vertion": {
      "type": "string"
    },
    "data": {
      "type": "array"
    }
  }
}

Generated by aglio on 01 Feb 2024