Create a Note
/bcws/webresources/v1.0/notes
Request
There are no request parameters for this operation.
- application/xml
- application/json
- notes
- accountId
- For new notes only, you must also include the type and subtype parameters
object
-
extension: object
extension
The extended attributes.
-
notes: object
Notes
object
object
-
accountId(required): string
The ID of the account associated with the note.
-
amount: number
The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
-
billId: string
The ID of the bill associated with the note.
-
billUnitId: string
The ID of the bill unit associated with the note.
-
closedDate: string
(date-time)
The date and time the note was resolved.
-
comments: array
comments
The list of comments associated with the note.
-
count: integer
(int32)
The number of comments associated with the note.
-
domainId: integer
(int32)
The domain ID associated with the note.
-
effectiveDate: string
(date-time)
The date and time the comment was posted.
-
eventId: string
The ID of the event associated with the note.
-
extension: object
extension
The extended attributes.
-
header: string
The header associated with the note.
-
id: string
The ID.
-
itemId: string
The ID of the item associated with the note.
-
reasonId: integer
(int32)
The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
-
serviceId: string
The service ID associated with the note.
-
status: number
The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
-
subType: integer
(int32)
The note's subtype. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
-
type: integer
(int32)
The note's type. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
array
-
Array of:
object Comments
The list of comments associated with the note.
object
object
-
comment(required): string
The comment.
-
csrAccountId: string
The CSR's account ID.
-
csrFirstName: string
The CSR's first name.
-
csrLastName: string
The CSR's last name.
-
csrLoginId: string
The login ID associated with the CSR.
-
entryDate: string
(date-time)
The date and time the comment was entered by the CSR.
-
externalUser: string
The external user.
-
trackingId: string
The tracking ID.
- notes
- accountId
- For new notes only, you must also include the type and subtype parameters
object
-
extension: object
extension
The extended attributes.
-
notes: object
Notes
object
object
-
accountId(required): string
The ID of the account associated with the note.
-
amount: number
The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
-
billId: string
The ID of the bill associated with the note.
-
billUnitId: string
The ID of the bill unit associated with the note.
-
closedDate: string
(date-time)
The date and time the note was resolved.
-
comments: array
comments
The list of comments associated with the note.
-
count: integer
(int32)
The number of comments associated with the note.
-
domainId: integer
(int32)
The domain ID associated with the note.
-
effectiveDate: string
(date-time)
The date and time the comment was posted.
-
eventId: string
The ID of the event associated with the note.
-
extension: object
extension
The extended attributes.
-
header: string
The header associated with the note.
-
id: string
The ID.
-
itemId: string
The ID of the item associated with the note.
-
reasonId: integer
(int32)
The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
-
serviceId: string
The service ID associated with the note.
-
status: number
The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
-
subType: integer
(int32)
The note's subtype. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
-
type: integer
(int32)
The note's type. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
array
-
Array of:
object Comments
The list of comments associated with the note.
object
object
-
comment(required): string
The comment.
-
csrAccountId: string
The CSR's account ID.
-
csrFirstName: string
The CSR's first name.
-
csrLastName: string
The CSR's last name.
-
csrLoginId: string
The login ID associated with the CSR.
-
entryDate: string
(date-time)
The date and time the comment was entered by the CSR.
-
externalUser: string
The external user.
-
trackingId: string
The tracking ID.
Response
- application/xml
- application/json
201 Response
object
-
extension: object
extension
The extended attributes.
-
notes: object
Notes
object
object
-
accountId(required): string
The ID of the account associated with the note.
-
amount: number
The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
-
billId: string
The ID of the bill associated with the note.
-
billUnitId: string
The ID of the bill unit associated with the note.
-
closedDate: string
(date-time)
The date and time the note was resolved.
-
comments: array
comments
The list of comments associated with the note.
-
count: integer
(int32)
The number of comments associated with the note.
-
domainId: integer
(int32)
The domain ID associated with the note.
-
effectiveDate: string
(date-time)
The date and time the comment was posted.
-
eventId: string
The ID of the event associated with the note.
-
extension: object
extension
The extended attributes.
-
header: string
The header associated with the note.
-
id: string
The ID.
-
itemId: string
The ID of the item associated with the note.
-
reasonId: integer
(int32)
The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
-
serviceId: string
The service ID associated with the note.
-
status: number
The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
-
subType: integer
(int32)
The note's subtype. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
-
type: integer
(int32)
The note's type. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
array
-
Array of:
object Comments
The list of comments associated with the note.
object
object
-
comment(required): string
The comment.
-
csrAccountId: string
The CSR's account ID.
-
csrFirstName: string
The CSR's first name.
-
csrLastName: string
The CSR's last name.
-
csrLoginId: string
The login ID associated with the CSR.
-
entryDate: string
(date-time)
The date and time the comment was entered by the CSR.
-
externalUser: string
The external user.
-
trackingId: string
The tracking ID.
500 Response
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.