ジャンプ先

• リクエスト
• レスポンス
• 例

保証レベルを取得する

get

/oaa-policy/assuranceLevel/v1/{levelId}

リクエスト

パス・パラメータ

• levelId(required): string
  保証レベルの識別子。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/xml
• application/json

200レスポンス

保証レベル情報を取得しました

本文()

ルート・スキーマ: AssuranceLevelsResponse

型: object

ユーザーの保証レベルのリストが含まれます。

ソースの表示

• assuranceLevels: array assuranceLevels
  保証レベルの配列
• message: object AssuranceLevelsAPIResponse
  保証レベルAPIに対するレスポンス。
• pageInfo: object Pagination2
  オブジェクトは結果のページ区切りを決定します。

{
    "type":"object",
    "description":"Contains a list of a user's assurance levels.",
    "properties":{
        "assuranceLevels":{
            "type":"array",
            "description":"Array of assurance levels",
            "items":{
                "$ref":"#/components/schemas/AssuranceLevel"
            }
        },
        "pageInfo":{
            "$ref":"#/components/schemas/Pagination2"
        },
        "message":{
            "$ref":"#/components/schemas/AssuranceLevelsAPIResponse"
        }
    }
}

ネストされたスキーマ: assuranceLevels

型: array

保証レベルの配列

ソースの表示

• Array of: object schema
  単一の保証レベルの詳細。

{
    "type":"array",
    "description":"Array of assurance levels",
    "items":{
        "$ref":"#/components/schemas/AssuranceLevel"
    }
}

ネストされたスキーマ: AssuranceLevelsAPIResponse

型: object

保証レベルAPIに対するレスポンス。

ソースの表示

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "description":"Response for the assurance level API.",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: Pagination2

型: object

オブジェクトは結果のページ区切りを決定します。

ソースの表示

• pageNum: number
• pageSize: number
• totalRecords: number

{
    "description":"Object determines pagination of results.",
    "type":"object",
    "properties":{
        "pageNum":{
            "type":"number"
        },
        "pageSize":{
            "type":"number"
        },
        "totalRecords":{
            "type":"number"
        }
    }
}

ネストされたスキーマ: schema

型: object

単一の保証レベルの詳細。

ソースの表示

• agentid(required): string
  保証レベルが属するエージェント識別子
• description(required): string
  保証レベルの説明
• id: string
  保証レベル識別子
• name(required): string
  保証レベルの名前

{
    "type":"object",
    "description":"Details for a single assurance level.",
    "required":[
        "name",
        "description",
        "agentid"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Assurance level identifier"
        },
        "name":{
            "type":"string",
            "description":"Name of the assurance level"
        },
        "description":{
            "type":"string",
            "description":"Description of the assurance level"
        },
        "agentid":{
            "type":"string",
            "description":"Agent identifier to which the assurance level belongs"
        }
    }
}

401レスポンス

未認可

405レスポンス

無効な入力

本文()

ルート・スキーマ: AssuranceLevelsAPIResponse

型: object

保証レベルAPIに対するレスポンス。

ソースの表示

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "description":"Response for the assurance level API.",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る

例

次の例は、保証レベルを取得するサンプルのリクエストとレスポンスを示します。

JSON形式で保証レベルを取得するcURLコマンド

curl --location --request GET '<PolicyUrl>/oaa-policy/assuranceLevel/v1/AssuranceLevel1' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

JSON形式のサンプル・レスポンス

{
    "assuranceLevels": [
        {
            "id": "AssuranceLevel1",
            "name": "AssuranceLevel1",
            "description": "Assurance Level 1",
            "agentid": "dede64d3-1d6a-42e9-89e1-714e88f8967c"
        }
    ],
    "message": {
        "responseCode": "200",
        "responseMessage": "Assurance level information."
    }
}

XML形式で保証レベルを取得するcURLコマンド

curl --location --request GET '<PolicyUrl>/oaa-policy/assuranceLevel/v1/AssuranceLevel1' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

XML形式のサンプル・レスポンス

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <AssuranceLevelsResponse>
     <assuranceLevels>
         <id>AssuranceLevel1</id>
         <name>AssuranceLevel1</name>
         <description>Assurance Level 1</description>
         <agentid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentid>
     </assuranceLevels>
     <message>
         <responseCode>200</responseCode>
         <responseMessage>Assurance level information.</responseMessage>
     </message>
 </AssuranceLevelsResponse>

先頭に戻る