Create an Event Dispute

post

/bcws/webresources/v1.0/disputes/event

Creates an event dispute.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : billItem
Type: array
The bill item details.
Show Source
Nested Schema : Events
Type: object
The events.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : billItem
Type: object
The bill item details.
Show Source
Nested Schema : aliasList
Type: array
The list of aliases in the bill item.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : transferInto
Type: array
Show Source
Nested Schema : transferOut
Type: array
Show Source
Nested Schema : AliasList
Type: object
The list of aliases associated with the service.
Show Source
Nested Schema : TransferInto
Type: object
Show Source
Nested Schema : TransferOut
Type: object
Show Source
Nested Schema : eventRef
Type: array
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : billItem
Type: array
The bill item details.
Show Source
Nested Schema : Events
Type: object
The events.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : billItem
Type: object
The bill item details.
Show Source
Nested Schema : aliasList
Type: array
The list of aliases in the bill item.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : transferInto
Type: array
Show Source
Nested Schema : transferOut
Type: array
Show Source
Nested Schema : AliasList
Type: object
The list of aliases associated with the service.
Show Source
Nested Schema : TransferInto
Type: object
Show Source
Nested Schema : TransferOut
Type: object
Show Source
Nested Schema : eventRef
Type: array
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Back to Top

Response

201 Response

The event dispute was created successfully.

400 Response

The request isn't valid.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to create an event dispute 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/v1.0/disputes/event/' -H 'content-type: application/json' -d @createDispute.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.
  • createDispute.json is the JSON file that specifies the event dispute to create.

Example of Request Body

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

{
    "amount": 2,
    "percent": 18.15,
    "notes": {
      "amount": 2,
      "domainId": 37,
      "accountId": "0.0.0.1+-account+261506",
      "billUnitId": "0.0.0.1+-billinfo+259970",
      "reasonId": "1",
      "status": 101,
      "comments": [
        {
          "comment": ""
        }
      ]
    },
    "accountRef": {
      "id": "0.0.0.1+-account+261506"
    },
    "taxType": 8,
    "resourceId": 840,
    "events": {
      "eventRef": [
        {
          "id": "0.0.0.1 /event/billing/product/fee/cycle/cycle_forward_monthly 354394587865020610 0"
        }
      ]
    }
  }

Example of Response Body

This following shows the contents of the response body.
{
    "extension": null,
    "reference": {
        "id": "0.0.0.1+-item-dispute+354394587865019072",
        "uri": "http://hostname/bc/webresources/v1.0/disputes/0.0.0.1+-item-dispute+354394587865019072"
    }
}
Back to Top