エラー

すべてのエラーレスポンスは同じフィールドを持ちます。statusCodeにHTTPステータス、codeにプログラムで判定するための安定したコード、messageに人が読むためのメッセージが入ります。メッセージは変わることがありますが、コードは変わりません。

{
  "statusCode": 404,
  "code": "not_found",
  "message": "work not found"
}

公開APIを読み取る際に出会うコードは次のとおりです。

• 400invalid_requestパラメーターが欠けている、型が間違っている、または範囲外です。
• 403forbiddenリソースは存在しますが、所有者が非公開にしています。
• 404not_foundこのアドレスには何もありません。
• 429rate_limitedあなたのアドレスからのリクエストが多すぎます。しばらく待ってから再試行してください。
• 500internal_errorこちら側で問題が発生しました。後でもう一度お試しください。
• 503unavailable検索など、操作に必要なサービスが一時的に停止しています。

パラメーターが欠けているか範囲外の場合、レスポンスは400 invalid_requestとなり、issuesに各問題がパラメーター名とともに列挙されます。

{
  "statusCode": 400,
  "code": "invalid_request",
  "message": "The request parameters are not valid.",
  "issues": ["limit: Too big: expected number to be <=50"]
}

2つのカタログ項目が同じ作品だと判明した場合、一方がもう一方に統合されます。古いほうを要求すると301が返り、movedToに新しいID、または新しいメディアとスラッグが入ります。新しいアドレスにリクエストし、保存している情報を更新してください。

HTTP/1.1 301 Moved Permanently

{ "movedTo": "01a0cb02-0a14-7877-911d-5b4dde76df72" }

プロフィールのどの部分を公開するかはメンバーが決めます。非公開のセクションは403を返し、favorites_private、library_private、activity_private、communities_privateなど、そのセクションを示すコードが付きます。ユーザー名を変更したメンバーは404 member_renamedを返し、usernameに新しい名前が入ります。

{
  "statusCode": 403,
  "code": "favorites_private",
  "message": "You are not allowed to do this."
}