Jump to

• Request
• Response
• Examples

Gets all Assurance Levels for the agent

get

/oaa-policy/assuranceLevel/v1

Request

Query Parameters

• agentid(required): string
  Identifier of the agent.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

AssuranceLevels retrieved successfully.

Body ()

Root Schema : AssuranceLevelsResponse

Type: object

Contains a list of a user's assurance levels.

Show Source

• assuranceLevels: array assuranceLevels
  Array of assurance levels
• message: object AssuranceLevelsAPIResponse
  Response for the assurance level API.
• pageInfo: object Pagination2
  Object determines pagination of results.

{
    "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"
        }
    }
}

Nested Schema : assuranceLevels

Type: array

Array of assurance levels

Show Source

• Array of: object schema
  Details for a single assurance level.

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

Nested Schema : AssuranceLevelsAPIResponse

Type: object

Response for the assurance level API.

Show Source

• responseCode: string
• responseMessage: string

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

Nested Schema : Pagination2

Type: object

Object determines pagination of results.

Show Source

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

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

Nested Schema : schema

Type: object

Details for a single assurance level.

Show Source

• agentid(required): string
  Agent identifier to which the assurance level belongs
• description(required): string
  Description of the assurance level
• id: string
  Assurance level identifier
• name(required): string
  Name of the assurance level

{
    "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 Response

Unauthorized

405 Response

Invalid input

Body ()

Root Schema : AssuranceLevelsAPIResponse

Type: object

Response for the assurance level API.

Show Source

• responseCode: string
• responseMessage: string

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

500 Response

Internal server error

503 Response

Service Unavailable

Back to Top

Examples

The following example shows a sample request and response for retrieving all assurance level for agent.

cURL Command to Retrieve Assurance Level in JSON Format

curl --location --request GET '<PolicyUrl>/oaa-policy/assuranceLevel/v1?agentid=dede64d3-1d6a-42e9-89e1-714e88f8967c' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

Sample Response in JSON Format

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

cURL Command to Retrieve Assurance Level in XML Format

curl --location --request GET '<PolicyUrl>/oaa-policy/assuranceLevel/v1?agentid=dede64d3-1d6a-42e9-89e1-714e88f8967c' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

Sample Response in XML Format

<?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>

Back to Top