Jump to

• Request
• Response
• Examples

Get Collections Scenarios

get

/bcws/webresources/v1.0/collections/scenarios

Gets all collections scenarios in the system. You can optionally use the id query parameter to get a specific collections scenario.

Request

Query Parameters

• id: string
  The ID of the collections scenario to get.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The collections scenarios were returned successfully.

Body ()

Root Schema : configurations

Type: object

Show Source

• extension: object extension
  The extended attributes.
• flags(required): array flags
  A flag.
• keyvals(required): array keyvals
  A set of key-value pairs.
• mapping(required): array mapping
  A mapping.
• thresholds(required): array thresholds
  A threshold. The minimum required parameters are: key and value.

{
    "required":[
        "flags",
        "keyvals",
        "mapping",
        "thresholds"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "keyvals":{
            "type":"array",
            "description":"A set of key-value pairs.",
            "items":{
                "$ref":"#/components/schemas/Keyvals"
            }
        },
        "flags":{
            "type":"array",
            "description":"A flag.",
            "items":{
                "$ref":"#/components/schemas/Flags"
            }
        },
        "thresholds":{
            "type":"array",
            "description":"A threshold. The minimum required parameters are: <b>key</b> and <b>value</b>.",
            "items":{
                "$ref":"#/components/schemas/Thresholds"
            }
        },
        "mapping":{
            "type":"array",
            "description":"A mapping.",
            "items":{
                "$ref":"#/components/schemas/Mapping"
            }
        }
    },
    "xml":{
        "name":"configurations"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : flags

Type: array

A flag.

Show Source

• Array of: object Flags
  A flag.

{
    "type":"array",
    "description":"A flag.",
    "items":{
        "$ref":"#/components/schemas/Flags"
    }
}

Nested Schema : keyvals

Type: array

A set of key-value pairs.

Show Source

• Array of: object Keyvals
  A set of key-value pairs.

{
    "type":"array",
    "description":"A set of key-value pairs.",
    "items":{
        "$ref":"#/components/schemas/Keyvals"
    }
}

Nested Schema : mapping

Type: array

A mapping.

Show Source

• Array of: object Mapping
  A mapping.

{
    "type":"array",
    "description":"A mapping.",
    "items":{
        "$ref":"#/components/schemas/Mapping"
    }
}

Nested Schema : thresholds

Type: array

A threshold. The minimum required parameters are: key and value.

Show Source

• Array of: object Thresholds
  A threshold. The minimum required parameters are: key and value.

{
    "type":"array",
    "description":"A threshold. The minimum required parameters are: <b>key</b> and <b>value</b>.",
    "items":{
        "$ref":"#/components/schemas/Thresholds"
    }
}

Nested Schema : Flags

Type: object

A flag.

Show Source

• desc(required): string
  A description of the flag.
• key(required): string
  The name of the flag.
• value: boolean
  The value associated with the flag, which can be true or false.
• version: string
  The version of the flag.

{
    "required":[
        "desc",
        "key"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"The name of the flag."
        },
        "value":{
            "type":"boolean",
            "description":"The value associated with the flag, which can be <b>true</b> or <b>false</b>."
        },
        "desc":{
            "type":"string",
            "description":"A description of the flag."
        },
        "version":{
            "type":"string",
            "description":"The version of the flag."
        }
    },
    "description":"A flag."
}

Nested Schema : Keyvals

Type: object

A set of key-value pairs.

Show Source

• desc(required): string
  The key-value pair's description.
• key(required): string
  The key name.
• value(required): string
  The value.
• version: string
  The version of the key-value pair.

{
    "required":[
        "desc",
        "key",
        "value"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"The key name."
        },
        "value":{
            "type":"string",
            "description":"The value."
        },
        "desc":{
            "type":"string",
            "description":"The key-value pair's description."
        },
        "version":{
            "type":"string",
            "description":"The version of the key-value pair."
        }
    },
    "description":"A set of key-value pairs."
}

Nested Schema : Mapping

Type: object

A mapping.

Show Source

• desc(required): string
  The mapping's description.
• key(required): string
  The mapping's key.
• map(required): array map
  A map.
• version: string
  The version of the mapping.

{
    "required":[
        "desc",
        "key",
        "map"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"The mapping's key."
        },
        "map":{
            "type":"array",
            "description":"A map.",
            "items":{
                "$ref":"#/components/schemas/Map"
            }
        },
        "desc":{
            "type":"string",
            "description":"The mapping's description."
        },
        "version":{
            "type":"string",
            "description":"The version of the mapping."
        }
    },
    "description":"A mapping."
}

Nested Schema : map

Type: array

A map.

Show Source

• Array of: object Map
  A map.

{
    "type":"array",
    "description":"A map.",
    "items":{
        "$ref":"#/components/schemas/Map"
    }
}

Nested Schema : Map

Type: object

A map.

Show Source

• id(required): string
  The map ID.
• key(required): string
  The key.

{
    "required":[
        "id",
        "key"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The map ID."
        },
        "key":{
            "type":"string",
            "description":"The key."
        }
    },
    "description":"A map."
}

Nested Schema : Thresholds

Type: object

A threshold. The minimum required parameters are: key and value.

Show Source

• desc(required): string
  The description of the threshold.
• key(required): string
  Unique name for configuration acting as an upper limit for pagination size, number of records to fetch, timeouts, etc.
• value: integer (int32)
  The threshold value.
• version: string
  The version of the threshold.

{
    "required":[
        "desc",
        "key"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Unique name for configuration acting as an upper limit for pagination size, number of records to fetch, timeouts, etc."
        },
        "value":{
            "type":"integer",
            "description":"The threshold value.",
            "format":"int32"
        },
        "desc":{
            "type":"string",
            "description":"The description of the threshold."
        },
        "version":{
            "type":"string",
            "description":"The version of the threshold."
        }
    },
    "description":"A threshold. The minimum required parameters are: <b>key</b> and <b>value</b>."
}

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get the collections scenario with the specified ID by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/collections/scenarios?id=0.0.0.1+-config-collections-scenario+126171'

where:

• hostname is the URL for the Billing Care REST server.
• port is the port for the Billing Care REST server.
• version is the version of the API you're using, such as v1.0.

Example of Response Body

This example shows the contents of the response body in JSON format. Because an ID was specified in the request, only the corresponding scenario is shown. If no ID is specified, a list of all scenarios is returned.

{
    "extension": null,
    "keyvals": [
        {
            "key": "0.0.0.1+-config-collections-scenario+126171",
            "value": "tenDaysLate",
            "desc": "If payment is late by 10 days then move to collections",
            "version": null
        }
    ],
    "flags": [],
    "thresholds": [],
    "mapping": []
}

Back to Top