Jump to

• Request
• Response
• Examples

Assign a Collections Agent to a Bill Unit

post

/bcws/webresources/v1.0/collections/assignagent

Assigns the specified collections agent to the bill unit.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountRef: object ResourceRef
• billunitRef: object ResourceRef
• collectionAgent(required): string
  The collections agent.
• extension: object extension
  The extended attributes.
• scenarioRef: object ResourceRef

{
    "required":[
        "collectionAgent"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billunitRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "scenarioRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "collectionAgent":{
            "type":"string",
            "description":"The collections agent."
        }
    },
    "xml":{
        "name":"AssignCollectionsAgent"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• accountRef: object ResourceRef
• billunitRef: object ResourceRef
• collectionAgent(required): string
  The collections agent.
• extension: object extension
  The extended attributes.
• scenarioRef: object ResourceRef

{
    "required":[
        "collectionAgent"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billunitRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "scenarioRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "collectionAgent":{
            "type":"string",
            "description":"The collections agent."
        }
    },
    "xml":{
        "name":"AssignCollectionsAgent"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Back to Top

Response

200 Response

The collections agent was successfully assigned to the bill unit.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to assign a collections agent to a bill unit by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X POST 'http://hostname:port/bcws/webresources/version/collections/assignagent' -H 'content-type: application/json' -d @assignAgent.json

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.
• assignAgent.json is the JSON file that specifies the details of the collections agent to assign.

Example of Request Body

This example shows the contents of the assignAgent.json file sent as the request body.

{
   "accountRef": {
      "id": "0.0.0.1+-account+130964"
   },
   "billunitRef": {
      "id": "0.0.0.1+-billinfo+62901"
   },
   "collectionAgent": "AgentSmith"
}

Example of Response Body

If successful, the response code 200 is returned with true in the response body.

Back to Top