APIステータスコード
API Status Codes
APIがJSON形式で返すレスポンス内のstatusCodeの値
Status code values in JSON format contained in the responses from APIs
ステータスコード
Status Codes
| ステータスコード Status Codes |
エラーメッセージ Error Messages |
説明 Descriptions |
|---|---|---|
| 100 | なし (空文字) No message (blank) |
正常終了 Successful completion |
| 107 | 該当するデータがありません。 No applicable data |
リクエストされたパラメータに紐付く情報がない場合に発生する。 Occurs when there is no information associated with the requested parameter. |
| 108 | 該当する書類実体がありません。 No substantial documents applicable |
出願番号に紐づく指定された書類実体がない場合に発生する。 Occurs when there is no substantial documents associated with requested application number. |
| 111 | 提供対象外の案件番号のため取得できませんでした。 Unable to retrieve data of unavailable registration number |
リクエストされたパラメータに紐づく平成、令和の案件番号でない場合に発生する。 Occurs when registration number associated with requested parameter does not contain Heisei or Reiwa Era. |
| 203 | 1日のアクセス上限を超過したため閲覧を制限します。 Access Restricted after exceeding daily access limit |
1日のアクセス数が上限値を超えているため、アクセスを制限している。 Access restricted after exceeding daily access limit. |
| 204 | パラメーターの入力された値に問題があります。 Inappropriate value entered in parameter |
アクセス先のAPIのパスパラメーター、リクエストパラメーターに問題がある場合に発生する。 Problems occuring to path parameter and/or request parameter of the API to be accessed. |
| 208 | 「タブ文字、,、 :、|」の文字は利用できません。 Unable to use tab characters, "," , ";" and/or"|". |
パラメーターの値に、「タブ文字、半角カンマ、 半角コロン、半角パイプライン」の文字が入力された場合に発生する。 Occurs when tab characters, "," , ";" and/or"|" are used. |
| 210 | 無効なトークンです。 Invalid token |
認証するためのトークンが無効な場合に発生する。 Occurs when authentication token is invalid. |
| 212 | 無効な認証情報です。 Invalid authentication information |
トークンを取得する情報が無効な場合に発生する。 Occurs when authentication information to retrieve token is invalid. |
| 301 | 指定された特許情報取得APIのURLは存在しません。 URL for Patent information retrieval API designated does not exist. |
アクセス先のAPIが存在しない場合に発生する。 Occurs when the API to be accessed does not exist. |
| 302 | 処理が時間内に終了しないため、タイムアウトになりました。 Process terminated due to timeout |
何らかの理由により処理に時間がかかり、タイムアウトになった。 Timeout caused by prolonged process for some reasons. |
| 303 | アクセスが集中しています。 Concentrated access |
APIサーバーが高負荷状態にある場合に発生する。 Occurs when API server is overloaded. |
| 400 | 無効なリクエストです。 Invalid request |
リクエストが無効な場合に発生する。 Occurs when request is invalid. |
| 999 | 想定外のエラーが発生しました。 Unexpected error occurred. |
サーバーは正常に稼働しているが、何らかの理由でデータが取得できなかった。 Unable to retrieve requested data for some reasons although the server is working properly. |
レスポンス
Responses
| キー項目名 KEY TITLE |
キー名 Key name |
データ型 Data type |
備考 Notes |
|---|---|---|---|
| レスポンス情報 Response information |
result | オブジェクト Object |
APIレスポンス情報 API response information |
| APIステータスコード API status code |
statusCode | オブジェクト Object |
APIステータスコード API status code |
| エラーメッセージ Error message |
errorMessage | 文字列 Character strings |
エラーが発生したときのみ返す。 Returns only when an error occurs |
| 残アクセス数 Remain access count |
remainAccessCount | 文字列 Character strings |
その日にアクセス可能な残り回数を返す。(空白の場合もある) Returns the remaining number of daily accesses available (null possible) |
| 詳細情報データ Detail information data |
data | オブジェクト Object |
APIレスポンスデータ（詳細は、各API仕様書参照） API response data (refer to API specifications) |
レスポンスイメージ
Response image
result: {
"statusCode": "100",
"errorMessage": "",
"remainAccessCount": "199",
"data": {
"applicantAttorney": [
{
"applicantAttorneyCd": "718000266",
"name": "特許庁長官"
}
]
}
}
|