Jump to

• Request
• Response

Retrieve one config element: SD.sti-response-treatment-config

get

https://cloud-native-SBC-IP/config/v1/sd/sti-response-treatment-config/{ElementKey}

Retrieve one config element: SD.sti-response-treatment-config

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Query Parameters

• revision-id: string
  Integer value of saved revision, or 'latest', 'active' to show the running config, or 'staging' to show complete configuration to be activated

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: StiResponseTreatmentConfig

Body ()

Root Schema : schema

Type: object

configure STI Response treatment config for STIR/SHAKEN

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• name(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of sti response treatment config
• sti-response-treatment-entries: array sti-response-treatment-entries
  verstat and reason code mapping for sti response

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of sti response treatment config",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "sti-response-treatment-entries":{
            "description":"verstat and reason code mapping for sti response",
            "items":{
                "$ref":"#/components/schemas/StiResponseTreatmentEntries"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure STI Response treatment config for STIR/SHAKEN",
    "type":"object"
}

Nested Schema : sti-response-treatment-entries

Type: array

verstat and reason code mapping for sti response

Show Source

• Array of: object StiResponseTreatmentEntries
  list of entries of sti responses for STI Verification

{
    "description":"verstat and reason code mapping for sti response",
    "items":{
        "$ref":"#/components/schemas/StiResponseTreatmentEntries"
    },
    "type":"array"
}

Nested Schema : StiResponseTreatmentEntries

Type: object

list of entries of sti responses for STI Verification

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• reason-code: integer (int32)
  Minimum Value: 0

  Maximum Value: 599

  403/428/436/437/438/custom-code
• role: string
  Allowed Values: [ "STI-VS" ]
• sip-reason-code: integer (int32)
  Minimum Value: 0

  Maximum Value: 699

  reason code should be in range of 4xx-6xx
• sip-reason-text: string
  sip reason text can be any valid string, that is included in the final response
• verstat(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  The possible values are 'No-TN-Validation', 'TN-Validation-Passed', 'TN-Validation-Failed' or any custom string.

{
    "required":[
        "verstat"
    ],
    "properties":{
        "verstat":{
            "description":"The possible values are 'No-TN-Validation', 'TN-Validation-Passed', 'TN-Validation-Failed' or any custom string.",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "reason-code":{
            "description":"403/428/436/437/438/custom-code",
            "format":"int32",
            "maximum":599,
            "minimum":0,
            "type":"integer"
        },
        "role":{
            "$ref":"#/components/schemas/StirShakenRoleConstraintEnum"
        },
        "sip-reason-code":{
            "description":"reason code should be in range of 4xx-6xx",
            "format":"int32",
            "maximum":699,
            "minimum":0,
            "type":"integer"
        },
        "sip-reason-text":{
            "description":"sip reason text can be any valid string, that is included in the final response",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of entries of sti responses for STI Verification",
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top