dxp-ux
Modem Reset
POST:/reset
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/resetURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y (for business) |
| channelId | string | Channel to business: Expected Value: "APP" | Y(PR), N/A(LC) |
| lob | string | It defines the Line of Business . Example : FIXED | Y(PR), N/A(LC) |
Data Model - Request
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| name | string | Name of the modem reset device | N(LC) |
| relatedParty[] | array | Related Entity reference. A related party defines party or party role linked to a specific entity. | Y(LC) |
| relatedParty[].id | string | unique identifier | Y(LC) |
| relatedParty.name | string | Name of the relatedParty | Y(LC) |
relatedParty[] subResource - request and response Data Model
| name | value | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| AccountNumber | string | Unique identifier of the customer’s account used to validate the modem reset request. | Y(LC) | LC: { "id": "50491929", "name": "AccountNumber" } |
| ServiceNumber | string | Identifier of the customer’s specific service associated with the modem that needs to be reset. | Y(LC) | LC: { "id": "DA0001823802", "name": "ServiceNumber" } |
Data Model - Response
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| id | string | Unique identifier of the modem‑reset request or resource instance returned by the system. | Y(LC) |
| resourceStatus | string | Indicates the execution status of the modem‑reset operation | Y(LC) |
| administrativeState | string | Shows the current administrative state of the modem resource | Y(LC) |
| resourceCharacteristic[] | array | List of characteristics describing the modem resource involved in the reset. | Y(LC) |
| resourceCharacteristic[].id | string | Identifier of the resource characteristic | Y(LC) |
| resourceCharacteristic[].name | string | Name of the characteristic | Y(LC) |
| resourceCharacteristic[].value | any | value of the characteristic | Y(LC) |
| resourceCharacteristic[].valueType | string | valueType of the characteristic value | N(LC) |
| resourceCharacteristic[].characteristicRelationship[] | array | Relationships that provide additional metadata about the modem | N(LC) |
| resourceCharacteristic[].characteristicRelationship[].id | string | Identifier referencing the related characteristic value | N(LC) |
| resourceCharacteristic[].characteristicRelationship[].'@type' | string | Type of related characteristic | N(LC) |
| resourceCharacteristic[].'@type' | string | Specifies the type/category of the modem resource | N(LC) |
| relatedParty[] | array | Contains account and service entities associated with the modem reset request. | Y(LC) |
| relatedParty[].id | string | Identifier of the related party | Y(LC) |
| relatedParty.name | string | Defines whether the identifier refers to a service number or account number. | Y(LC) |
| relatedParty.'@type' | string | Defines whether the identifier refers to a service number or account number. | N(LC) |
characteristicRelationship[] subResource -request Data Model
| @type | value | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| serialNo | string | Serial number of the modem associated with the reset request. | N(LC) | LC: { "id": "6802B84562E8", "@type": "serialNo" } |
| requestId | string | Unique identifier of the modem‑reset request used for tracking and correlation. | N(LC) | LC: { "id": "2c0e9c303277f35f0c4b6dfba1cef5dd", "@type": "requestId" } |
| operationCode | string | Code that indicates the type of operation performed | N(LC) | LC: { "id": "ivr_result#resolve.ivr.util", "@type": "operationCode" } |
Key Considerations :
- Please refer the examples from the following URL - DXP UX - POST Reset
LC Implementation:
- This usecase is used to reset the modem devices for FIXED customers.
- This is implemented for the following businessIds: AG,BB,GD,JM,LC,TT,VC
- Input body will contain service number and account number.
- Equipments for account level and service level are retrieved from cerillion API.
- After equipment/device validation, request is sent to RESOLVE to reset the Modem.