Get Details for a Service
get
/bcws/webresources/v1.0/services/{id}/serviceprofile
Gets the service details and profile details for the specified service. The service fields and profile fields are configured in the ServiceProfileConfigurations.xml file and mapped to a service type.
Request
Path Parameters
-
id(required): string
The service ID of the specified customer asset.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The details for the service were returned successfully.
Nested Schema : ProfileType
Type:
Show Source
object
-
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
Nested Schema : ServiceType
Type:
Show Source
object
-
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.
-
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
Nested Schema : DeviceType
Type:
Show Source
object
-
description: string
The device type's description.
-
deviceId: string
The device ID.
-
extension: object
extension
The extended attributes.
-
id: object
ResourceRef
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
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.
Nested Schema : extension
Type:
object
The extended attributes.
400 Response
The request isn't valid.
500 Response
An internal server error occurred.
Examples
This example shows how to get the service profile for a given service by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X GET 'http://hostname:port/bcws/webresources/version//services/0.0.0.1+-service-ip+156801/serviceprofile'
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.
Example of Response Body
This example shows the contents of the response body in JSON format.
{
"service": {
"extension": null,
"id": {
"id": "0.0.0.1+-service-ip+156801",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": {
"id": "0.0.0.1+-account+57615",
"uri": null
},
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1600943653000,
"effectiveDate": null,
"lastStatusComment": "",
"lastStatusChange": 1601383372000,
"login": "ip0",
"lifeCycleState": null,
"lastModified": 1608705956000,
"name": "PIN Service Object",
"password": null,
"passwordExpiration": 0,
"passwordStatus": 0,
"status": 10100,
"statusFlags": 0,
"subscriptionServiceRef": {
"id": "0.0.0.0++0",
"uri": null
},
"serviceAccessLevel": "",
"balGrpIndex": null,
"args": [],
"serviceIp": {
"compression": 0,
"ipaddr": null,
"protocol": 0
}
},
"profile": null,
"devices": []
}