1. REST API Reference for Billing Care
  2. Tasks
  3. Notes

Create a Note

post

/bcws/webresources/v1.0/notes

Creates a new note or adds a follow-up comment to an existing note.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
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/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
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

Supported Media Types

201 Response

The note was created successfully.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
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

500 Response

An internal server error occurred.
Back to Top

Examples

These examples show how to create a new note and add a comment to an existing note 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/bcws/webresources/version/notes -H 'content-type: application/json' -d @noteCreate.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.
  • noteCreate.json is the JSON file that specifies the note or comment to add.

Example of Request Body for Creating a New Note

This example shows the contents of the noteCreate.json file sent as the request body to create a new note. 

{
   "notes": {
      "accountId": "0.0.0.1+-account+85712",
      "type": 100,
      "subType": 105,
      "comments": [
         {
            "comment": "Customer called to inquire about delay in service setup."
         }
      ]
   }
}

Example of Response Body for Creating a New Note

This example shows the contents of the response body in JSON format.

{
   "extension": null,
   "notes": {
      "extension": null,
      "id": "0.0.0.1+-note+256058",
      "accountId": "0.0.0.1+-account+85712",
      "amount": null,
      "billUnitId": null,
      "billId": null,
      "closedDate": null,
      "count": null,
      "effectiveDate": null,
      "eventId": null,
      "header": null,
      "itemId": null,
      "subType": 105,
      "type": 100,
      "domainId": null,
      "reasonId": null,
      "serviceId": null,
      "status": null,
      "comments": [
         {
            "csrLoginId": "HeadCSR",
            "csrFirstName": "Alia",
            "csrLastName": "Abadi",
            "csrAccountId": "1234",
            "externalUser": "CSR Portal",
            "comment": "Customer called to inquire about delay in service setup.",
            "trackingId": null,
            "entryDate": null
         }
      ]
   }
}

Example of Request Body for Adding a New Comment

This example shows the contents of the noteCreate.json file sent as the request body to add a new comment to an existing note. 

{
   "notes": {
      "accountId": "0.0.0.1+-account+123217",
      "id": "0.0.0.1+-note+257803",
      "comments": [
         {
            "csrLoginId": "HeadCSR",
            "csrFirstName": "Alia",
            "csrLastName": "Abadi",
            "csrAccountId": "1234",
            "externalUser": "CSR Portal",
            "comment": "Customer called to complain about payment reversal."
         }
      ]
   }
}

Example of Response Body for Adding a New Comment

This shows an example of the contents of the response body in JSON format.

{
   "extension": null,
   "notes": {
      "extension": null,
      "id": "0.0.0.1+-note+257803",
      "accountId": "0.0.0.1+-account+123217",
      "amount": null,
      "billUnitId": null,
      "billId": null,
      "closedDate": null,
      "count": null,
      "effectiveDate": null,
      "eventId": null,
      "header": null,
      "itemId": null,
      "subType": null,
      "type": null,
      "domainId": null,
      "reasonId": null,
      "serviceId": null,
      "status": null,
      "comments": [
         {  
            "csrLoginId": "HeadCSR",
            "csrFirstName": "Alia",
            "csrLastName": "Abadi",
            "csrAccountId": "1234",
            "externalUser": "CSR Portal",
            "comment": "Customer called to complain about payment reversal.",
            "trackingId": null,
            "entryDate": null
         }
      ]
   }
}

You can use the other GET requests for notes to review the new comment in context with other comments for the note.

Back to Top