Back to top

dotstamp_server

Polls is a simple API allowing consumers to view polls and vote in them.

Resource Group

users/new

ユーザを登録する
POST/users/new

Example URI

POST http://dotstamp.com/api//users/new
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "email": "foo@bar.com",
  "password": "foobar12345"
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": "",
  "userID": 1
}

login/check

ログイン済みを判定する
POST/login/check

Example URI

POST http://dotstamp.com/api//login/check
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "email": "foo@bar.com",
  "password": "foobar12345"
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
true

login/auth

ログインする
POST/login/auth

Example URI

POST http://dotstamp.com/api//login/auth
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "login": true,
  "name": "foo@bar.com"
}

bug

バグを報告する
POST/bug

Example URI

POST http://dotstamp.com/api//bug
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "body": "foo"
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

characters

キャラクタをアップロードする
POST/characters

Example URI

POST http://dotstamp.com/api//characters
Request
HideShow
Headers
Content-Type: multipart/form-data; boundary=---BOUNDARY
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "images": [
    {
      "id": 2,
      "characterID": 1,
      "priority": 1,
      "voiceType": 1,
      "fileName": "1.jpg"
    }
  ]
}

キャラクタを取得する
GET/characters

Example URI

GET http://dotstamp.com/api//characters
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "images": [
    {
      "id": 2,
      "characterID": 1,
      "priority": 1,
      "voiceType": 1,
      "fileName": "1.jpg"
    }
  ]
}

キャラクタを更新する
PUT/characters

Example URI

PUT http://dotstamp.com/api//characters
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 2,
  "voiceType": 1
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

characters/{id}

キャラクタを削除する
DELETE/characters/{id}

Example URI

DELETE http://dotstamp.com/api//characters/2
URI Parameters
HideShow
id
string (required) Example: 2

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "images": [
    {
      "id": 1,
      "characterID": 1,
      "priority": 1,
      "voiceType": 1,
      "fileName": "1.jpg"
    }
  ]
}

contributions/new

投稿を作成する
POST/contributions/new

Example URI

POST http://dotstamp.com/api//contributions/new
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "title": "foo",
  "body": "[{}]",
  "viewStatus": 1,
  "tag": "foo,bar,foobar"
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
1

contributions/{id}

投稿を取得する
GET/contributions/{id}

Example URI

GET http://dotstamp.com/api//contributions/3
URI Parameters
HideShow
id
string (required) Example: 3

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 2,
  "user": {
    "id": 1,
    "name": "foo@bar.com",
    "profileImageID": 0
  },
  "title": "foo",
  "tags": [
    {
      "id": 2,
      "userContributionID": 2,
      "name": "foo,bar,foobar"
    }
  ],
  "body": [
    {
      "priority": 0,
      "body": "",
      "directionType": 0,
      "talkType": 0,
      "character": {
        "id": 0,
        "fileName": "",
        "voiceType": 0
      }
    }
  ],
  "viewStatus": 1,
  "search": "",
  "soundStatus": 0,
  "updatedAt": "2017-07-23T20:17:19+09:00",
  "createdAt": "2017-07-23T20:17:19+09:00",
  "followCount": 0,
  "following": false,
  "soundFile": false,
  "movie": {
    "id": 0,
    "createdAt": "0001-01-01T00:00:00Z",
    "updatedAt": "0001-01-01T00:00:00Z",
    "deletedAt": null,
    "user_contribution_id": 0,
    "movie_type": 0,
    "movie_id": "",
    "movie_status": 0
  }
}

投稿を更新する
PUT/contributions/{id}

Example URI

PUT http://dotstamp.com/api//contributions/3
URI Parameters
HideShow
id
string (required) Example: 3

投稿ID

Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "title": "foo",
  "body": "[{}]",
  "viewStatus": 1
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
1

投稿を削除する
DELETE/contributions/{id}

Example URI

DELETE http://dotstamp.com/api//contributions/3
URI Parameters
HideShow
id
string (required) Example: 3

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
true

contributions/list/{order}

投稿リストを取得する
GET/contributions/list/{order}

Example URI

GET http://dotstamp.com/api//contributions/list/1
URI Parameters
HideShow
order
string (required) Example: 1

ページ

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
[
  {
    "id": 1,
    "user": {
      "id": 1,
      "name": "foo",
      "profileImageID": 1
    },
    "title": "foo",
    "tags": [
      {
        "id": 1,
        "userContributionID": 1,
        "name": 1
      }
    ],
    "followCount": 1,
    "body": null,
    "viewStatus": 1,
    "search": "foo",
    "soundStatus": 1,
    "movie": {
      "user_contribution_id": 1,
      "movie_type": 1,
      "movie_id": "foo",
      "movie_status": 1,
      "createdAt": "2017-04-24T22:45:00+09:00",
      "deletedAt": null,
      "updatedAt": "2017-04-24T22:45:00+09:00"
    },
    "createdAt": "2017-04-24T22:45:00+09:00",
    "updatedAt": "2017-04-24T22:45:00+09:00"
  }
]

contributions/edit/{id}

投稿の編集情報を取得する
GET/contributions/edit/{id}

Example URI

GET http://dotstamp.com/api//contributions/edit/1
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "user": {
    "id": 1,
    "name": "foo",
    "profileImageID": 1
  },
  "title": "foo",
  "tags": [
    {
      "id": 1,
      "userContributionID": 1,
      "name": 1
    }
  ],
  "followCount": 1,
  "body": [
    {
      "priority": 1,
      "body": "foo",
      "directionType": 1,
      "character": {
        "id": 1,
        "fileName": "foo",
        "voiceType": 1
      }
    }
  ],
  "viewStatus": 1,
  "search": "foo",
  "soundStatus": 1,
  "movie": {
    "user_contribution_id": 1,
    "movie_type": 1,
    "movie_id": "foo",
    "movie_status": 1,
    "createdAt": "2017-04-24T22:45:00+09:00",
    "deletedAt": null,
    "updatedAt": "2017-04-24T22:45:00+09:00"
  },
  "createdAt": "2017-04-24T22:45:00+09:00",
  "updatedAt": "2017-04-24T22:45:00+09:00",
  "sound": true,
  "soundFile": true
}

contributions/upload/{?id}

画像をアップロードする
POST/contributions/upload/{?id}

Example URI

POST http://dotstamp.com/api//contributions/upload/?id=1
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": "",
  "path": "1.jpg"
}

follows/{id}

フォローする
POST/follows/{id}

Example URI

POST http://dotstamp.com/api//follows/1
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": "",
  "followCount": 1
}

フォローを削除する
DELETE/follows/{id}

Example URI

DELETE http://dotstamp.com/api//follows/1
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": "",
  "followCount": 0
}

follows/list

フォローリストを取得する
POST/follows/list

Example URI

POST http://dotstamp.com/api//follows/list
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "order": 1,
  "page": 1,
  "limit": 1
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "list": [
    {
      "id": 2,
      "user": {
        "id": 1,
        "name": "foo@bar.com",
        "profileImageID": 0
      },
      "title": "bar",
      "tags": [],
      "followCount": 0,
      "body": null,
      "viewStatus": 1,
      "search": "",
      "soundStatus": 0,
      "movie": {
        "id": 0,
        "createdAt": "0001-01-01T00:00:00Z",
        "updatedAt": "0001-01-01T00:00:00Z",
        "deletedAt": null,
        "user_contribution_id": 0,
        "movie_type": 0,
        "movie_id": "",
        "movie_status": 0
      },
      "updatedAt": "2017-07-23T15:12:52+09:00",
      "createdAt": "2017-07-23T15:12:52+09:00"
    }
  ],
  "count": 1
}

forget_password

パスワード変更を登録する
POST/forget_password

Example URI

POST http://dotstamp.com/api//forget_password
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "email": "foo@bar.com"
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

パスワードを変更する
PUT/forget_password

Example URI

PUT http://dotstamp.com/api//forget_password
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "email": "vHWexIhSOGxjAIjz.t.3o8DN2_cv4ozt3TOb",
  "keyword": "gEyG9YZUN31mLKbA18GFpxVc_h8fGFdtn2dNU9SwqG7uakosOKeNU0we4Ahpvishbf4-",
  "password": "testtest"
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

forget_password/check/{email}/{keyword}

パスワード変更可能を判定する
GET/forget_password/check/{email}/{keyword}

Example URI

GET http://dotstamp.com/api//forget_password/check/rH.Zw7xSMXghDIT_/uXiJ05lV
URI Parameters
HideShow
email
string (required) Example: rH.Zw7xSMXghDIT_

メールアドレス

keyword
string (required) Example: uXiJ05lV

キーワード

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

sounds/{id}

音声を反映する
POST/sounds/{id}

Example URI

POST http://dotstamp.com/api//sounds/1
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

音声を確認する
GET/sounds/{id}

Example URI

GET http://dotstamp.com/api//sounds/1
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "list": [
    {
      "id": 1,
      "createdAt": "2017-07-24T00:42:15+09:00",
      "updatedAt": "2017-07-24T00:42:15+09:00",
      "deletedAt": null,
      "user_contribution_id": 1,
      "priority": 1,
      "talk_type": 1,
      "body": "foo",
      "body_sound": "foo",
      "voice_type": 1,
      "make_status": 0
    }
  ],
  "soundStatus": 2,
  "soundFile": true,
  "movieFile": true,
  "movie": {
    "id": 0,
    "createdAt": "0001-01-01T00:00:00Z",
    "updatedAt": "0001-01-01T00:00:00Z",
    "deletedAt": null,
    "user_contribution_id": 0,
    "movie_type": 0,
    "movie_id": "",
    "movie_status": 0
  }
}

音声を更新する
PUT/sounds/{id}

Example URI

PUT http://dotstamp.com/api//sounds/1
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "soundStatus": 1
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

sounds/{id}/make

音声を作成する
POST/sounds/{id}/make

Example URI

POST http://dotstamp.com/api//sounds/1/make
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

sounds/{id}/reflect

音声を再構築する
POST/sounds/{id}/reflect

Example URI

POST http://dotstamp.com/api//sounds/1/reflect
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "overwrite": true
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

sounds/body

音声文を更新する
PUT/sounds/body

Example URI

PUT http://dotstamp.com/api//sounds/body
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "body": "foo"
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": "",
  "id": 1
}

sounds/voice

音声タイプを更新する
PUT/sounds/voice

Example URI

PUT http://dotstamp.com/api//sounds/voice
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "voiceType": 1
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": "",
  "id": 1
}

sounds/{id}/voice/all

音声タイプを一括更新する
PUT/sounds/{id}/voice/all

Example URI

PUT http://dotstamp.com/api//sounds/1/voice/all
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "voiceType": 1
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

sounds/length

時間を取得する
GET/sounds/length

Example URI

GET http://dotstamp.com/api//sounds/length
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "character": 0.6
}

movies/{id}

動画を作成する
POST/movies/{id}

Example URI

POST http://dotstamp.com/api//movies/1
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

動画を確認する
GET/movies/{id}

Example URI

GET http://dotstamp.com/api//movies/1
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

movies/{id}/upload

動画をアップロードする
POST/movies/{id}/upload

Example URI

POST http://dotstamp.com/api//movies/1/upload
URI Parameters
HideShow
id
string (required) Example: 1

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": "",
  "movieID": "foo"
}

problem

問題を報告する
POST/problem

Example URI

POST http://dotstamp.com/api//problem
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": 1,
  "type": 1
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

profile

画像をアップロードする
POST/profile

Example URI

POST http://dotstamp.com/api//profile
Request
HideShow
Headers
Content-Type: multipart/form-data; boundary=---BOUNDARY
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
"1.jpg"

question

問い合わせる
POST/question

Example URI

POST http://dotstamp.com/api//question
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "email": "foo@bar.com",
  "body": "foo"
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": ""
}

tags/{?id,cid}

タグを追加する
POST/tags/{?id,cid}

Example URI

POST http://dotstamp.com/api//tags/?id=2&cid=1
URI Parameters
HideShow
id
string (optional) Example: 2

ID

cid
string (optional) Example: 1

投稿ID

Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "userContributionId": 1,
  "name": "fooabcccc"
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": "",
  "tags": [
    {
      "id": 1,
      "userContributionID": 1,
      "name": "foo"
    }
  ]
}

タグを削除する
DELETE/tags/{?id,cid}

Example URI

DELETE http://dotstamp.com/api//tags/?id=2&cid=1
URI Parameters
HideShow
id
string (optional) Example: 2

ID

cid
string (optional) Example: 1

投稿ID

Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "warning": false,
  "message": "",
  "tags": [
    {
      "id": 1,
      "userContributionID": 1,
      "name": "foo"
    }
  ]
}

me

取得する
GET/me

Example URI

GET http://dotstamp.com/api//me
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "user": {
    "id": 1,
    "name": "foo",
    "profileImageID": 1
  },
  "profiles": [
    {
      "id": 1,
      "userID": 1,
      "created": "2017-01-01 00:00:00"
    }
  ]
}

保存する
PUT/me

Example URI

PUT http://dotstamp.com/api//me
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "name": "foo"
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "success": true
}

users/contribution/list/

ユーザー投稿を取得する
POST/users/contribution/list/

Example URI

POST http://dotstamp.com/api//users/contribution/list/
Request
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "order": 1,
  "page": 1,
  "limit": 1
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "privtes": [],
  "list": [
    {
      "id": 2,
      "createdAt": "2017-07-23T15:12:52+09:00",
      "updatedAt": "2017-07-23T15:12:52+09:00",
      "deletedAt": null,
      "user_id": 1,
      "title": "bar",
      "view_status": 1
    },
    {
      "id": 1,
      "createdAt": "2017-07-23T15:12:52+09:00",
      "updatedAt": "2017-07-23T15:12:52+09:00",
      "deletedAt": null,
      "user_id": 1,
      "title": "foo",
      "view_status": 1
    }
  ],
  "titles": [
    "bar",
    "foo"
  ],
  "count": 2
}

logout

ログアウトする
POST/logout

Example URI

POST http://dotstamp.com/api//logout
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
true

Generated by aglio on 27 Jul 2017