11.11 リクエストおよびレスポンスのフォーマット
リソースの作成や追加(POST)、変更時の属性値の指定(PATCH)、またはリソースの情報取得(GET)の結果には、JSONのフォーマットを使用します。
サポートする文字コードはUTF-8です。
リクエストの形式
- string型の属性に空文字を指定した場合は、その属性の値は空になります。
- string型以外の属性に空文字を指定した場合は、その属性は指定していないものと見なして処理が続行されます。
- 各APIで指定できる属性以外を指定した場合、その属性は指定していないものと見なして処理が続行されます。
レスポンスの形式
- APIの処理が成功した場合、レスポンスはJSON形式で返ります。
- 処理が失敗した場合、エラーの内容によってはJSON形式ではなくHTML形式でレスポンスが返る場合があります。
プログラム中でHTTPステータスコードを基にエラー処理を行う場合には、レスポンスヘッダのContent-Typeの値をチェックしてください。