5.3　APIの記述形式

各APIで説明する項目を次に示します。ただし，APIによっては説明の無い項目もあります。

機能

APIの機能について説明します。

実行権限

APIを実行できる権限およびロールを示します。

APIのバージョン

APIのバージョンを示します。

形式

APIのリクエスト形式およびレスポンス形式について説明しています。

パラメーター

リクエストのメッセージボディーに指定するパラメーターについて説明します。

ステータスコード

httpプロトコルまたはhttpsプロトコルを使用してAPIを実行したあとのステータスコードについて説明します。APIを実行する前にエラーになった場合のステータスコードについては，「5.2.5(1)　ステータスコード」を参照してください。

戻り値

APIが返却する戻り値の情報について説明します。

使用例

APIを使用するためのリクエスト例およびレスポンス例について説明します。

ただし，ここでは，httpプロトコルを使用している場合の例を記載します。httpsプロトコルを使用する場合は，「HTTP」を「HTTPS」に読み替えてください。