Get Life Cycle States
get
/bcws/webresources/v1.0/services/lifecyclestates
Gets the life cycle states and their allowed state transitions.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The life cycle states were returned successully.
Root Schema : lifeCycleStates
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
servicesWithLifecycleStates: array
servicesWithLifecycleStates
The list of services associated with life cycle states.
-
states: array
states
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : servicesWithLifecycleStates
Type:
array
The list of services associated with life cycle states.
Show Source
-
Array of:
string
The list of services associated with life cycle states.
Nested Schema : State
Type:
Show Source
object
-
allowedTransitionStates: array
allowedTransitionStates
The list of states that a resource can transition to.
-
extension: object
extension
The extended attributes.
-
stateId: integer
(int32)
The ID of the state.
-
stateName(required): string
The name of the state.
Nested Schema : allowedTransitionStates
Type:
array
The list of states that a resource can transition to.
Show Source
-
Array of:
integer(int32)
The list of states that a resource can transition to.
Nested Schema : extension
Type:
object
The extended attributes.
500 Response
An internal server error occurred.
Examples
This example shows how to get a list of life cycle states and transitions that exist in the system 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/lifecyclestates'
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.
{
"extension": null,
"servicesWithLifecycleStates": ["/service/telco/gsm/telephony"],
"states": [
{
"extension": null,
"stateId": 101,
"stateName": "Preactive",
"allowedTransitionStates": [102]
},
{
"extension": null,
"stateId": 102,
"stateName": "Active",
"allowedTransitionStates": [103,105,106,107,108]
},
{
"extension": null,
"stateId": 103,
"stateName": "Recharge Only",
"allowedTransitionStates": [104,102,107,108]
},
{
"extension": null,
"stateId": 104,
"stateName": "Credit Expired",
"allowedTransitionStates": [108,102,107]
},
{
"extension": null,
"stateId": 105,
"stateName": "Dormant",
"allowedTransitionStates": [102,107,108]
},
{
"extension" :null,
"stateId": 106,
"stateName": "Fraud Investigated",
"allowedTransitionStates":[102,107,108]
},
{
"extension": null,
"stateId": 107,
"stateName": "Suspended",
"allowedTransitionStates": [102,108]
},
{
"extension": null,
"stateId": 108,
"stateName": "Closed",
"allowedTransitionStates":[]
}
]
}