確認チェック区分情報取得

POST

/api_v1_system_confirmcheck/info

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \
-d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \
"https://api.next-engine.org/api_v1_system_confirmcheck/info"

• ネクストエンジン API ゲートウェイ

Request Body ^required

Media type application/x-www-form-urlencoded

ネクストエンジン API 共通リクエストパラメータ

object

access_token

required

OAuth2 アクセストークン (必須)

string

refresh_token

OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)

string

wait_flag

同期実行フラグ。“1” 指定で処理完了を待つ

string

Allowed values: 0 1

fields

取得するフィールドをカンマ区切りで指定 (search 系のみ)

string

offset

検索開始位置 (search 系のみ)

integer

limit

取得件数 (search 系のみ)

integer

>= 1

Responses

200

実行結果 (result が success / error / redirect のいずれか)

Media type application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string

string

Array<object>

Array<object>

object

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

data

Array<object>

object

confirm_check_id

確認チェック区分 / 文字列型

string | integer | number | boolean | null

confirm_check_name

確認チェック名 / 文字列型

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "result": "success",
  "count": "3",
  "data": [
    {
      "confirm_check_id": "0",
      "confirm_check_name": "確認必要なし（非表示）"
    },
    {
      "confirm_check_id": "1",
      "confirm_check_name": "確認必要（表示）"
    },
    {
      "confirm_check_id": "2",
      "confirm_check_name": "確認済（表示）"
    }
  ],
  "access_token": "xxxxxxxxxxx",
  "access_token_end_date": "2017-04-13 18:24:53",
  "refresh_token": "xxxxxxxxxxx",
  "refresh_token_end_date": "2017-04-15 18:24:53"
}

4XX

クライアントエラー (HTTP ステータス自体は 200 + result=error で返ることが多い)

Media type application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string

string

Array<object>

Array<object>

object

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

Example

{
  "result": "success"
}