Jump to

• Request
• Response
• Examples

Get Collections Users

get

/bcws/webresources/v1.0/collections/users

Gets the list of users who have the permission to start, modify, and cancel collections for your customers.

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 users was returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object user

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

Nested Schema : user

Type: object

Show Source

• extension: object extension
  The extended attributes.
• userName: string
  The user name.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "userName":{
            "type":"string",
            "description":"The user name."
        }
    },
    "xml":{
        "name":"user"
    }
}

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 list of users with collections permissions 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/users'

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,
      "userName": "superUser1"
   }
]

Back to Top