APIの説明形式を説明します。
機能説明
APIの機能を説明します。
リクエストURI
/rbaserver/API名
リクエストパラメーター
リクエストパラメーターを表形式で記述します。
パラメーター名 | 必須 | 項目 | 項目説明 |
|---|---|---|---|
リクエストパラメーター名 | ○：必須項目 | 説明 | 各パラメーターの説明 |
型 | パラメーターの型 | ||
設定内容 | パラメーターの設定内容 |
リクエストボディ
リクエストのボディについて説明します。
リクエストのサンプル
リクエストのサンプルを説明します。
レスポンス
APIのレスポンスを説明します。
《ステータスコード》
ステータスコードについて説明します。
《XML》
レスポンスをXML形式で説明します。
《要素》
XMLの各要素を表形式で説明します。
レスポンスのサンプル
レスポンスのサンプルを説明します。
