Jump to

• Request
• Response
• Examples

Get History of a Collections Action

get

/bcws/webresources/v1.0/collections/history/action/{id}

Gets the history for the collections action that matches the specified ID.

Request

Path Parameters

• id(required): string
  The ID of the collections action 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 action history was returned successfully.

Body ()

Root Schema : collectionsActionHistory

Type: object

Show Source

• actionHistory(required): array actionHistory
  The list of collections action activities.
• actionId(required): string
  The ID of the collections action.
• extension: object extension
  The extended attributes.

{
    "required":[
        "actionHistory",
        "actionId"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "actionId":{
            "type":"string",
            "description":"The ID of the collections action."
        },
        "actionHistory":{
            "type":"array",
            "description":"The list of collections action activities.",
            "items":{
                "$ref":"#/components/schemas/ActionHistory"
            }
        }
    },
    "xml":{
        "name":"collectionsActionHistory"
    }
}

Nested Schema : actionHistory

Type: array

The list of collections action activities.

Show Source

• Array of: object ActionHistory
  The list of collections action activities.

{
    "type":"array",
    "description":"The list of collections action activities.",
    "items":{
        "$ref":"#/components/schemas/ActionHistory"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : ActionHistory

Type: object

The list of collections action activities.

Show Source

• agentName(required): string
  The name of the agent that performed the collections action.
• changeDate(required): string (date-time)
  The date and time there was a change to the collections action.
• description(required): string
  The description of the collections action.
• dueDate(required): string (date-time)
  The date and time the collections action is due.
• status: integer (int32)
  The status of the collections action: 0 (Action pending), 1 (Action canceled), 2 (Action completed), or 3 (Action error).

{
    "required":[
        "agentName",
        "changeDate",
        "description",
        "dueDate"
    ],
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The description of the collections action."
        },
        "dueDate":{
            "type":"string",
            "description":"The date and time the collections action is due.",
            "format":"date-time"
        },
        "changeDate":{
            "type":"string",
            "description":"The date and time there was a change to the collections action.",
            "format":"date-time"
        },
        "agentName":{
            "type":"string",
            "description":"The name of the agent that performed the collections action."
        },
        "status":{
            "type":"integer",
            "description":"The status of the collections action: <b>0</b> (Action pending), <b>1</b> (Action canceled), <b>2</b> (Action completed), or <b>3</b> (Action error).",
            "format":"int32"
        }
    },
    "description":"The list of collections action activities."
}

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get the history for a collections action 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/history/action/0.0.0.1+-collections_action-refer_to_outside_agency+258523'

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,
    "actionId": "0.0.0.1+-collections_action-refer_to_outside_agency+258523",
    "actionHistory": [
        {
            "description": "Action updated",
            "dueDate": 1612512000000,
            "changeDate": 1612261730000,
            "agentName": "AgentSmith",
            "status": 1
        },
        {
            "description": "Action scheduled",
            "dueDate": 1612512000000,
            "changeDate": 1612260243000,
            "agentName": "AgentSmith",
            "status": 0
        }
    ]
}

Back to Top