Jump to

• Request
• Response
• Examples

Update Service And ERAs

put

/bcws/webresources/v1.0/services/serviceAndEras

Updates a service login and its associated service ERAs.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• profiles: array profiles
• service: object Discriminator: @class
  Discriminator: { "propertyName":"@class" }

{
    "type":"object",
    "properties":{
        "service":{
            "$ref":"#/components/schemas/ServiceBase"
        },
        "profiles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProfileBase"
            }
        }
    },
    "xml":{
        "name":"updateServiceAndEras"
    }
}

Nested Schema : profiles

Type: array

Show Source

• Array of: object Discriminator: @class
  Discriminator: { "propertyName":"@class" }

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProfileBase"
    }
}

Nested Schema : Discriminator: @class

Type: object

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

• accountRef: object ResourceRef
• aliasList: array aliasList
  The list of aliases associated with the service.
• balanceGroupRef: object ResourceRef
• balGrpIndex: integer (int32)
  The balance group index.
• creationDate: string (date-time)
  The date and time the service type was created.
• effectiveDate: string (date-time)
• extension: object extension
  The extended attributes.
• id: object ResourceRef
• lastModified: string (date-time)
  The date and time the service was last modified.
• lastStatusChange: string (date-time)
  The date and time of the last status change.
• lastStatusComment: string
  The comment associated with the last status change.
• lifeCycleState: integer (int32)
  The current life cycle state.
• login(required): string
  The login associated with the service.
• name: string
  The name of the service.
• nameinfoObj: object ResourceRef
• password(required): string
  The password associated with the service.
• passwordExpiration: string (date-time)
  The date and time the password expires.
• passwordStatus: integer (int32)
  The current status of the password.
• pendingDeferredActionsCount: integer (int32)
  The number of deferred actions that are pending for the service.
• serviceAccessLevel: string
  The service access level.
• status: integer (int32)
  The status.
• statusFlags: integer (int32)
  The status flags.
• subscriptionServiceRef: object ResourceRef
• svcExpLastNotiOffset: string
  The notification offset.
• svcExpLastNotiT: string (date-time)
  The last notification time.

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Nested Schema : Discriminator: @class

Type: object

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

• accountObj: object ResourceRef
• creationDate: string (date-time)
  The date and time the profile was created.
• effectiveDate: string (date-time)
  The date and time the profile is effective from.
• extension: object extension
  The extended attributes.
• id: object ResourceRef
• multiValued: boolean
  Whether the profile has multiple values (true) or not (false).
• name: string
  The name of the profile.
• parentName: string
  The name of the parent profile.
• selected: boolean
  Whether the profile is selected (true) or not (false).
• serviceObj: object ResourceRef

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : aliasList

Type: array

The list of aliases associated with the service.

Show Source

• Array of: object AliasList
  The list of aliases associated with the service.

{
    "type":"array",
    "description":"The list of aliases associated with the service.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : AliasList

Type: object

The list of aliases associated with the service.

Show Source

• elem: integer (int32)
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "elem":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of aliases associated with the service."
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• profiles: array profiles
• service: object Discriminator: @class
  Discriminator: { "propertyName":"@class" }

{
    "type":"object",
    "properties":{
        "service":{
            "$ref":"#/components/schemas/ServiceBase"
        },
        "profiles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProfileBase"
            }
        }
    },
    "xml":{
        "name":"updateServiceAndEras"
    }
}

Nested Schema : profiles

Type: array

Show Source

• Array of: object Discriminator: @class
  Discriminator: { "propertyName":"@class" }

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProfileBase"
    }
}

Nested Schema : Discriminator: @class

Type: object

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

• accountRef: object ResourceRef
• aliasList: array aliasList
  The list of aliases associated with the service.
• balanceGroupRef: object ResourceRef
• balGrpIndex: integer (int32)
  The balance group index.
• creationDate: string (date-time)
  The date and time the service type was created.
• effectiveDate: string (date-time)
• extension: object extension
  The extended attributes.
• id: object ResourceRef
• lastModified: string (date-time)
  The date and time the service was last modified.
• lastStatusChange: string (date-time)
  The date and time of the last status change.
• lastStatusComment: string
  The comment associated with the last status change.
• lifeCycleState: integer (int32)
  The current life cycle state.
• login(required): string
  The login associated with the service.
• name: string
  The name of the service.
• nameinfoObj: object ResourceRef
• password(required): string
  The password associated with the service.
• passwordExpiration: string (date-time)
  The date and time the password expires.
• passwordStatus: integer (int32)
  The current status of the password.
• pendingDeferredActionsCount: integer (int32)
  The number of deferred actions that are pending for the service.
• serviceAccessLevel: string
  The service access level.
• status: integer (int32)
  The status.
• statusFlags: integer (int32)
  The status flags.
• subscriptionServiceRef: object ResourceRef
• svcExpLastNotiOffset: string
  The notification offset.
• svcExpLastNotiT: string (date-time)
  The last notification time.

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Nested Schema : Discriminator: @class

Type: object

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

• accountObj: object ResourceRef
• creationDate: string (date-time)
  The date and time the profile was created.
• effectiveDate: string (date-time)
  The date and time the profile is effective from.
• extension: object extension
  The extended attributes.
• id: object ResourceRef
• multiValued: boolean
  Whether the profile has multiple values (true) or not (false).
• name: string
  The name of the profile.
• parentName: string
  The name of the parent profile.
• selected: boolean
  Whether the profile is selected (true) or not (false).
• serviceObj: object ResourceRef

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : aliasList

Type: array

The list of aliases associated with the service.

Show Source

• Array of: object AliasList
  The list of aliases associated with the service.

{
    "type":"array",
    "description":"The list of aliases associated with the service.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : AliasList

Type: object

The list of aliases associated with the service.

Show Source

• elem: integer (int32)
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "elem":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of aliases associated with the service."
}

Back to Top

Response

200 Response

The service and ERAs were updated successfully.

500 Response

An internal service error occurred.

Back to Top

Examples

This example shows how to update a specified service's login and ERAs 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/version/services/serviceAndEras -H 'content-type: application/json' -d @file.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.
• file.json is the JSON file that specifies the service to update.

Example of Request Body

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

{
   "service": {
      "@class": "com.oracle.communications.brm.cc.model.ServiceBase",
      "accountRef": {
         "id": "0.0.0.1+-account+1607269" 
      },
      "id": {
         "id": "0.0.0.1+-service-ip+1610885"
      },
      "login": "login"
   },
   "profiles": []
}

Example of Response Body

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

Back to Top