Jump to

• Request
• Response
• Examples

Get Friendly Service Names

get

/bcws/webresources/v1.0/services/friendlynames

Gets a list of service types and their associated friendly names from BRM. For example:

"/service/provider => remittance definition"

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The list of service types and their friendly names was returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object serviceDetails

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

Nested Schema : serviceDetails

Type: object

Show Source

• extension: object extension
  The extended attributes.
• friendlyName: string
  The service's friendly name.
• type: string
  The service type.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "type":{
            "type":"string",
            "description":"The service type."
        },
        "friendlyName":{
            "type":"string",
            "description":"The service's friendly name."
        }
    },
    "xml":{
        "name":"serviceDetails"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get the friendly services names defined in BRM 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/services/friendlynames'

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.

[
    {
        "extension": null,
        "type": "/service",
        "friendlyName": "Generic Service"
    },
    {
        "extension": null,
        "type": "/service/admin_client",
        "friendlyName": "Administration Client"
    },
    {
        "extension": null,
        "type": "/service/broadband",
        "friendlyName": "Broadband"
    },
    {
        "extension": null,
        "type": "/service/content",
        "friendlyName": "Content"
    },
    {
        "extension": null,
        "type": "/service/contentprovider",
        "friendlyName": "Content Provider"
    },
    {
        "extension": null,
        "type": "/service/email",
        "friendlyName": "Email"
    },
    {
        "extension": null,
        "type": "/service/fax",
        "friendlyName": "Fax"
    },
    {
        "extension": null,
        "type": "/service/ip",
        "friendlyName": "IP"
    },
    {
        "extension": null,
        "type": "/service/ldap",
        "friendlyName": "LDAP"
    },
    {
        "extension": null,
        "type": "/service/settlement",
        "friendlyName": "Settlement"
    },
    {
        "extension": null,
        "type": "/service/settlement/roaming",
        "friendlyName": "Roaming"
    },
        {
        "extension": null,
        "type": "/service/stream",
        "friendlyName": "Streaming"
    },
    {
        "extension": null,
        "type": "/service/telco",
        "friendlyName": "Telco"
    },
    {
        "extension": null,
        "type": "/service/telco/gprs",
        "friendlyName": "GPRS"
    },
    {
        "extension": null,
        "type": "/service/telco/gprs/roaming",
        "friendlyName": "GPRS Roaming"
    },
    {
        "extension": null,
        "type": "/service/telco/gsm",
        "friendlyName": "GSM"
    },
    {
        "extension": null,
        "type": "/service/telco/gsm/data",
        "friendlyName": "GSM Data"
    },
    {
        "extension": null,
        "type": "/service/telco/gsm/fax",
        "friendlyName": "GSM Fax"
    },
    {
        "extension": null,
        "type": "/service/telco/gsm/roaming",
        "friendlyName": "GSM Roaming"
    },
    {
        "extension": null,
        "type": "/service/telco/gsm/sms",
        "friendlyName": "GSM SMS"
    },
    {
        "extension": null,
        "type": "/service/telco/gsm/telephony",
        "friendlyName": "GSM Telephony"
    },
    {
        "extension": null,
        "type": "/service/telephony",
        "friendlyName": "Telephony"
    },
    {
        "extension": null,
        "type": "/service/vpdn",
        "friendlyName": "Virtual Private Data Network"
    }
]

Back to Top