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

Update Details for a Service

put

/bcws/webresources/v1.0/services/serviceprofile

Updates the service details and profile details for the specified service.

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 : devices
Type: array
The list of devices associated with the service profile.
Show Source
Nested Schema : Discriminator: @class
Type: object
Show Source
Nested Schema : Discriminator: @class
Type: object
Show Source
Nested Schema : Devices
Type: object
The list of devices associated with the service.
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : aliasList
Type: array
The list of aliases associated with the service.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : AliasList
Type: object
The list of aliases associated with the service.
Show Source
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : devices
Type: array
The list of devices associated with the service profile.
Show Source
Nested Schema : Discriminator: @class
Type: object
Show Source
Nested Schema : Discriminator: @class
Type: object
Show Source
Nested Schema : Devices
Type: object
The list of devices associated with the service.
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : aliasList
Type: array
The list of aliases associated with the service.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : AliasList
Type: object
The list of aliases associated with the service.
Show Source
Back to Top

Response

200 Response

The details were updated successfully.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to update a service's details by submitting a PUT request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X PUT http://hostname:port/bcws/webresources/v1.0/services/serviceprofile -H 'content-type: application/json' -d @updateService.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.
  • updateService.json is the JSON file that specifies the update to make.

Example of Request Body

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

{
   "service": {
      "extension": null,
      "id": {
         "id": "0.0.0.1+-service-ip+159102",
         "uri": null
      },
      "pendingDeferredActionsCount": null,
      "accountRef": {
         "id": "0.0.0.1+-account+156094",
         "uri": null
      },
      "aliasList": [],
      "balanceGroupRef": {
         "id": "0.0.0.1+-balance_group+155774",
         "uri": null
      },
      "creationDate": 1600871014000,
      "effectiveDate": null,
      "lastStatusComment": "",
      "lastStatusChange": 1600871011000,
      "login": "ip_service",
      "lifeCycleState": null,
      "lastModified": 1612339386000,
      "name": "PIN Service Object",
      "password": null,   
      "passwordExpiration": 0,
      "passwordStatus": 0,
      "status": 10100,
      "statusFlags": 0,
      "subscriptionServiceRef": {
         "id": "0.0.0.0++0",
         "uri": null
      },
      "serviceAccessLevel": "1078",
      "balGrpIndex": null,
      "args": [],
      "serviceIp": {
         "compression": 0,
         "ipaddr": null,
         "protocol": 0
      },
      "@class": "com.oracle.communications.brm.cc.model.ServiceIpType"
   },
   "profile": null,
   "devices": []
}

Example of Response Body

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

Back to Top