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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"email": "foo@bar.com",
"password": "foobar12345"
}
Response
200
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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"email": "foo@bar.com",
"password": "foobar12345"
}
Response
200
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
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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"body": "foo"
}
Response
200
Headers
Content-Type: application/json; charset=utf-8
Body
{
"warning": false,
"message": ""
}
characters ¶
キャラクタをアップロードするPOST/characters
Example URI
POST http://dotstamp.com/api//characters
Request
Headers
Content-Type: multipart/form-data; boundary=---BOUNDARY
Response
200
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
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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"id": 2,
"voiceType": 1
}
Response
200
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
- id
string
(required) Example: 2投稿ID
Response
200
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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"title": "foo",
"body": "[{}]",
"viewStatus": 1,
"tag": "foo,bar,foobar"
}
Response
200
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
- id
string
(required) Example: 3投稿ID
Response
200
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
- id
string
(required) Example: 3投稿ID
Request
Headers
Content-Type: application/json; charset=utf-8
Body
{
"title": "foo",
"body": "[{}]",
"viewStatus": 1
}
Response
200
Headers
Content-Type: application/json; charset=utf-8
Body
1
投稿を削除するDELETE/contributions/{id}
Example URI
DELETE http://dotstamp.com/api//contributions/3
URI Parameters
- id
string
(required) Example: 3投稿ID
Response
200
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
- order
string
(required) Example: 1ページ
Response
200
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
- id
string
(required) Example: 1投稿ID
Response
200
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/search ¶
検索するPOST/contributions/search
Example URI
POST http://dotstamp.com/api//contributions/search
Request
Headers
Content-Type: application/json; charset=utf-8
Body
{
"search": "foo",
"order": 1,
"page": 1,
"limit": 1
}
Response
200
Headers
Content-Type: application/json; charset=utf-8
Body
{
"list": [
{
"id": 1,
"user": {
"id": 1,
"name": "foo@bar.com",
"profileImageID": 0
},
"title": "foo",
"tags": [
{
"id": 1,
"userContributionID": 1,
"name": "foo,bar,foobar"
}
],
"followCount": 0,
"body": null,
"viewStatus": 1,
"search": "foo,bar",
"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
}
contributions/upload/{?id} ¶
画像をアップロードするPOST/contributions/upload/{?id}
Example URI
POST http://dotstamp.com/api//contributions/upload/?id=1
URI Parameters
- id
string
(required) Example: 1投稿ID
Response
200
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
- id
string
(required) Example: 1投稿ID
Response
200
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
- id
string
(required) Example: 1投稿ID
Response
200
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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"order": 1,
"page": 1,
"limit": 1
}
Response
200
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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"email": "foo@bar.com"
}
Response
200
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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"email": "vHWexIhSOGxjAIjz.t.3o8DN2_cv4ozt3TOb",
"keyword": "gEyG9YZUN31mLKbA18GFpxVc_h8fGFdtn2dNU9SwqG7uakosOKeNU0we4Ahpvishbf4-",
"password": "testtest"
}
Response
200
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
string
(required) Example: rH.Zw7xSMXghDIT_メールアドレス
- keyword
string
(required) Example: uXiJ05lVキーワード
Response
200
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
- id
string
(required) Example: 1投稿ID
Response
200
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
- id
string
(required) Example: 1投稿ID
Response
200
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
- id
string
(required) Example: 1投稿ID
Request
Headers
Content-Type: application/json; charset=utf-8
Body
{
"soundStatus": 1
}
Response
200
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
- id
string
(required) Example: 1投稿ID
Response
200
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
- id
string
(required) Example: 1投稿ID
Request
Headers
Content-Type: application/json; charset=utf-8
Body
{
"overwrite": true
}
Response
200
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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"id": 1,
"body": "foo"
}
Response
200
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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"id": 1,
"voiceType": 1
}
Response
200
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
- id
string
(required) Example: 1投稿ID
Request
Headers
Content-Type: application/json; charset=utf-8
Body
{
"voiceType": 1
}
Response
200
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
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
- id
string
(required) Example: 1投稿ID
Response
200
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
- id
string
(required) Example: 1投稿ID
Response
200
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
- id
string
(required) Example: 1投稿ID
Response
200
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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"id": 1,
"type": 1
}
Response
200
Headers
Content-Type: application/json; charset=utf-8
Body
{
"warning": false,
"message": ""
}
profile ¶
画像をアップロードするPOST/profile
Example URI
POST http://dotstamp.com/api//profile
Request
Headers
Content-Type: multipart/form-data; boundary=---BOUNDARY
Response
200
Headers
Content-Type: application/json; charset=utf-8
Body
"1.jpg"
question ¶
問い合わせるPOST/question
Example URI
POST http://dotstamp.com/api//question
Request
Headers
Content-Type: application/json; charset=utf-8
Body
{
"email": "foo@bar.com",
"body": "foo"
}
Response
200
Headers
Content-Type: application/json; charset=utf-8
Body
{
"warning": false,
"message": ""
}
me ¶
取得するGET/me
Example URI
GET http://dotstamp.com/api//me
Response
200
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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"name": "foo"
}
Response
200
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
Headers
Content-Type: application/json; charset=utf-8
Body
{
"order": 1,
"page": 1,
"limit": 1
}
Response
200
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
}