spec.md

FORMAT: 1A

Data Structures

UserInfo (object)

• id : users/152d7c4e-e4f6-45a7-befa-cbc9e0aacb1c (string) - ID
• name : test_user_1 (string) - 名前
• email : test_user_1@example.com (string) - メールアドレス
• last_modified : 2014-11-11T08:40:51.620Z (string) - 最終更新日時
• icon_media_key : media/icons/29eb22b8-a953-4ec3-84b1-46b746e13071 (string) - プロフィール画像のキー

ProjectType (enum, fixed) - プロジェクトの会計種別

Members

• soft - ソフトウェア会計
• hard - ハードウェア会計

ProjectInfo (object)

• id : projects/9e7710bf-e864-44f9-aa7f-fe5f589317ae (string) - ID
• title : エレラボAPI構築PJ (string) - タイトル
• description : エレラボ管理画面のAPIを作る。 (string) - 説明
• type (ProjectType) - 会計種別
• leader (UserInfo) - 申請者
• approver (UserInfo) - 承認者
• passed_yen : 2000 (number) - 返金/配給済額
• used_yen : 3000 (number) - 実支払い額
• budget_est_yen : 8000 (number) - 予算概要額
• budget_max_yen : 10000 (number) - 予算上限額
• closed : false (boolean) - 完了したかどうか
• approved : true (boolean) - 承認されたかどうか

PurchaseInfo

• id : purchases/b8780093-fe3e-4f76-8ab2-678e68b02ad8 (string) - ID
• title : サーバー管理費 (string) - タイトル
• description : 利用しているAWSでドメイン名を管理するために必要な経費です。 (string) - タイトル
• project_id : projects/9e7710bf-e864-44f9-aa7f-fe5f589317ae (string) - プロジェクトのID
• evidence_media_keys : media/evidences/8ea313b7-1172-4c35-bd9f-cf5d63429518 , media/evidences/fbc9517e-814e-4568-b9b8-d3b038942931 (array[string], required, fixed-type) - レシート/商品等証拠となる画像一覧
• returned : false (boolean) - 返金されたかどうか
• approved : true (boolean) - 承認されたかどうか

Group ユーザ管理

関連するID一覧

• users/{uuid4}
• media/icons/{uuid4}

認証処理 [/sign_in]

サインインする [POST]

• user_email (string) - ユーザーの名前

• password (string) - パスワード

• Request (application/json)

    {
        "user_email": "test_user_1@example.com",
        "password": "hogehoge"
    }
  

• Response 200 (application/json)

  • Attributes
    • user (UserInfo)

• Response 400 (plain/text)

    Invalid Argument
  

サインアウトする [DELETE]

• Response 200 (plain/text)

    OK
  

• Response 401 (plain/text)

    Unauthorized
  

ユーザー全体の管理 [/users/]

ユーザーの一覧を取得する [GET]

• Response 200 (application/json)

  • Attributes
    • users (array[UserInfo], required, fixed-type) - ユーザー一覧

新しいユーザーを作成する [POST]

• Request (application/json)

    {
        "user.name": "test_user_3",
        "user.email": "test_user_3@example.com",
        "user.password": "fugafuga"
    }
  

• Response 200 (application/json)

  • Attributes
    • user (UserInfo)

ユーザー単体の管理 [/users/{user_id}]

ユーザーの情報を取得する [GET]

• Parameters

  • user_id (string)

• Response 200 (application/json)

  • Attributes
    • user_info (UserInfo)

• Response 401 (plain/text)

    Unauthorized
  

ユーザーの情報を更新する [PUT]

• Parameters

  • user_id (string)

• Request (application/json)

    {
        "password": "mogemoge",
        "icon_media_key": "media/icons/eb5f6ab6-1e94-4e47-8502-d3cb4f3ea74f"
    }
  

• Response 200 (application/json)

  • Attributes
    • user_info (UserInfo)
      • icon_media_key : media/icons/eb5f6ab6-1e94-4e47-8502-d3cb4f3ea74f

• Response 401 (plain/text)

    Unauthorized
  

ユーザーを削除する [DELETE]

• Parameters

  • user_id (string)

• Response 200 (plain/text)

    OK
  

Group プロジェクト

関連するID一覧

• projects/{uuid4}
• purchases/{uuid4}

プロジェクト全体のコントロール [/projects]

プロジェクトの一覧を取得する [GET]

• Response 200 (application/json)

  • Attributes
    • projects (array[ProjectInfo], required, fixed-type) - プロジェクト一覧

新しいプロジェクトを作成する [POST]

• Request

    {
        "title": "test_project_1",
        "manager_id": "users/b688f1c0-5b6b-49fb-a7d4-52113fb1dd88",
        "description", "エレラボのAPIを作成する。",
        "budget": 10000,
        "completion_date": "2014-11-18"
    }
  

• Response 200 (application/json)

  • Attributes
    • project (ProjectInfo)

プロジェクト単体の管理 [/projects/{project_id}]

プロジェクトの情報を取得する [GET]

• Parameters

  • project_id (string)

• Response 200 (application/json)

  • Attributes
    • projects (array[ProjectInfo], required, fixed-type) - プロジェクト一覧

プロジェクトを更新する [PUT]

• Parameters

  • project_id (string)

• Request

    {
        "project.title": "エレラボAPI構築プロジェクト",
    }
  

• Response 200 (application/json)

  • Attributes
    • project (ProjectInfo)
      • title : エレラボAPI構築プロジェクト

プロジェクトを削除する [DELETE]

• Parameters

  • project_id (string)

• Response 200 (plain/text)

    OK
  

プロジェクトの購入の管理 [/projects/{project_id}/purchases]

プロジェクトに関する購入の一覧を取得する [GET]

• Parameters

  • project_id (string)

• Response 200 (application/json)

  • Attributes
    • purchases (array[PurchaseInfo], required, fixed-type) - 購入一覧

プロジェクトに新しい購入を作成する [POST]

• Parameters

  • project_id (string)

• Request

    {
        "title": "test_project_1",
        "description", "エレラボのAPIを作成する。",
        "amount": 10000,
    }
  

• Response 200 (application/json)

  • Attributes
    • purchase (PurchaseInfo)

Group 購入

関連するID一覧

• purchases/{uuid4}
• media/evidences/{uuid4}

購入全体のコントロール [/purchases]

管理購入の一覧を取得する [GET]

• Response 200 (application/json)

  • Attributes
    • purchases (array[PurchaseInfo], required, fixed-type) - 購入一覧

新しい購入を作成する [POST]

• Request

    {
        "title": "test_purchase_1",
        "description", "エレラボのAPIを作成する。"
        "project_id", "projects/9e7710bf-e864-44f9-aa7f-fe5f589317ae"
    }
  

• Response 200 (application/json)

  • Attributes
    • purchase (PurchaseInfo)
      • title : test_purchase_1
      • description : エレラボのAPIを作成する。
      • id : purchases/b8780093-fe3e-4f76-8ab2-678e68b02ad8
      • project_id : projects/9e7710bf-e864-44f9-aa7f-fe5f589317ae

購入単体の管理 [/purchases/{purchase_id}]

購入の情報を取得する [GET]

• Parameters

  • purchase_id (string)

• Response 200 (application/json)

  • Attributes
    • purchase (PurchaseInfo) - 購入一覧

購入を更新する [PUT]

• Parameters

  • purchase_id (string)

• Request

    {
        "title": "エレラボAPI構築購入",
    }
  

• Response 200 (application/json)

  • Attributes
    • purchase (PurchaseInfo)
      • title : エレラボAPI構築購入

購入を削除する [DELETE]

• Parameters

  • purchase_id (string)

• Response 200 (plain/text)

    OK