Introduction

• This is the example page for markdown represetation.

Signup API

• Sign up the service using id, password

Resource URL

• http://127.0.0.1/api/signup

Request Parameters

name	type	mandatory	memo
id	string	O	email
password	string	O
nickname	string	O

Example

curl http://127.0.0.1/api/signin?id=test@gmail.com&password=1234 

import requests
payload = {"id":"test@gmail.com", "password":"1234", "nickname":"sarada"}
r = requests.post("http://127.0.0.1/api/signup", data=payload)

Response - JSON

name	type	mandatory	memo
meta		O	Meta Info
status	int	O	HTTP Status Code
msg	string	O	HTTP Status Message

Response 200 OK

{
  "meta": {
    "status" : 200,
    "msg": "OK"
  }
}

Response 500 Internal Server Error

{
  "meta": {
    "status" : 500, 
    "msg": "Internal Server Error"
  }
}

Signin API

• Signin the service using id, password

Resource URL

• http://127.0.0.1/api/signin

Request Parameter

name	type	mandatory	memo
id	string	O	email
password	string	O

Example

curl http://127.0.0.1/api/signin?id=test@gmail.com&password=1234 

import requests
r = requests.get("http://127.0.0.1/api/signin?id=test@gmail.com&password=1234")

HttpClient httpclient = new DefaultHttpClient();
HttpGet httpget = new HttpGet("http://127.0.0.1/api/signin?id=test@gmail.com&password=1234");
HttpResponse response = httpclient.execute(httpget);

Response - JSON

name	type	mandatory	memo
meta		O	Meta Info
status	int	O	HTTP Status Code
msg	string	O	HTTP Status Message

Response 200 OK

{
  "meta": {
    "status" : 200,
    "msg": "OK"
  }
}

Response 500 Internal Server Error

{
  "meta": {
    "status" : 500,
    "msg": "Internal Server Error"
  }
}

Notice API

• Get notice from notice database.

Resource URL

• http://qlemon.net:8000/fcal/api/notice

API Endpoint

http://qlemon.net:8000/fcal/api/notice

Request Parameters

name	type	mandatory	memo
page	int	option	Page Number, default(1)

Request Example:

curl http://127.0.0.1/notice?page=1

import requests
r = requests.get("http://127.0.0.1/notice?page=1")

HttpClient httpclient = new DefaultHttpClient();
HttpGet httpget = new HttpGet("http://127.0.0.1/notice?page=1");
HttpResponse response = httpclient.execute(httpget);

Response - JSON

name	type	mandatory	memo
meta		required	meta info
msg	string	required	http status messsage, if not 200 OK.
data		required	payload
count	int	required	count of items
page	int	required	request page number
total_count	int	required	total data count
total_page	int	required	total page count
item	list	required
id	int	required	notice number(sequence)
title	string	required	title
article	string	required	body
type	int	required	type
icon_type	int	required	icon type
date	datetime	required	datetime

Response paramter Example:

{
  "data": {
    "count": 1,
    "item": [
      {
        "article": "Hello",
        "date": 201509091530,
        "icon_type": 0,
        "id": 1,
        "title": "시험버전 공지사항",
        "type": 0
      }
    ],
    "page": 1,
    "total_count": 1,
    "total_page": 1
  },
  "meta": {
    "msg": "Success"
  }
}

Notice.jp API

• 通知データベースからの通知を取得します。

リソースのURL

• http://qlemon.net:8000/fcal/api/notice

APIエンドポイント

http://qlemon.net:8000/fcal/api/notice

リクエストParameters

名前	タイプ	必須	メモ
page	int	オプション	ページ番号、デフォルト（1）

リクエスト例：

curl http://127.0.0.1/notice?page=1

import requests
r = requests.get("http://127.0.0.1/notice?page=1")

HttpClient httpclient = new DefaultHttpClient();
HttpGet httpget = new HttpGet("http://127.0.0.1/notice?page=1");
HttpResponse response = httpclient.execute(httpget);

レスポンス- JSON

名前	タイプ	必須	メモ
meta		必要	メタ情報
msg	string	必要	http status messsage, if not 200 OK.
data		必要	ペイロード
count	int	必要	アイテムの数
page	int	必要	リクエストページ番号
total_count	int	必要	総データ数
total_page	int	必要	total page count
item	list	必要
id	int	必要	notice number(sequence)
title	string	必要	タイトル
article	string	必要	body
type	int	必要	type
icon_type	int	必要	icon type
date	datetime	必要	datetime

Response paramter Example:

{
  "data": {
    "count": 1,
    "item": [
      {
        "article": "Hello",
        "date": 201509091530,
        "icon_type": 0,
        "id": 1,
        "title": "体験版のお知らせ",
        "type": 0
      }
    ],
    "page": 1,
    "total_count": 1,
    "total_page": 1
  },
  "meta": {
    "msg": "Success"
  }
}

Notice.fr API

• Obtenez un avis de préavis base de données.

Ressource URL

• Http://qlemon.net:8000/fcal/api/notice

Endpoint API

http://qlemon.net:8000/fcal/api/notice

Demander Parmeters

Nom	Type	obligatoire	mémo
page	int	Option	Numéro de page, par défaut (1)

Demande Exemple:

curl http://127.0.0.1/notice?page=1

import requests
r = requests.get("http://127.0.0.1/notice?page=1")

HttpClient httpclient = new DefaultHttpClient();
HttpGet httpget = new HttpGet("http://127.0.0.1/notice?page=1");
HttpResponse response = httpclient.execute(httpget);

Réponse - JSON

Nom	Type	obligatoire	mémo
méta		nécessaire	méta info
msg	chaîne	nécessaire	état http messsage, sinon 200 OK.
data		nécessaire	charge
compter	int	nécessaire	nombre d'éléments
page	int	nécessaire	la page demande Nombre
total_count	int	nécessaire	nombre total de données
total_page	int	nécessaire	nombre total de pages
article	Liste	nécessaire
id	int	nécessaire	préavis nombre (séquence)
Titre	chaîne	nécessaire	Titre
article	chaîne	nécessaire	corps
Type	int	nécessaire	Type
icon_type	int	nécessaire	type d'icône
date	datetime	nécessaire	datetime

Paramètre Réponse Exemple:

{
  "data": {
    "compter": 1,
    "item": [
      {
        "article": "Bonjour",
        "date": 201509091530,
        "icon_type": 0,
        "id": 1,
        "Titre": "Avis de procès",
        "type": 0
      }
    ],
    "page": 1,
    "total_count": 1,
    "total_page": 1
  },
  "méta": {
    "msg": "Success"
  }
}