PP | Submit Order
Version 0.0.10
Endpoint
POST
/msapi/productoffermanagementms/v3/product/submitchange
Copy
This API is used to submit the order containing the chosen add-on.
Header Parameters
- Content-TypestringRequiredProvides the info on the content type (e.g. application/json)
- authorizationstringRequiredBasic Authorization header used for microServices authentication and authorization. If not passed IDP microservice framework will return 401/403 accordingly.
- idp-trace-idstringRequiredTransaction ID. Generally its injected by Gateway.
- idpctx-session-idstringRequiredUnique Session ID. Generally its injected by Gateway.
- idpctx-callcontextstringInform downstream mS what context the API is being invoked from (e.g. Customer, App, Agent). This will be injected by Gateway/MuleGateway/AppGateway
- idpctx-user-typestringRequiredvalue = registered ; to be used for authenticated users. value = guest ; to be used for unauthenticated users or external clients. (Injected by Gateway. If not passed by Gateway, need to be passed by calling App)
- idpctx-customerstatestringvalue = authenticated, unauthenticated (Injected by Gateway. If not passed by Gateway, need to be passed by calling App)
- x-att-clientidstringRequiredClient Id from calling App (Injected by Gateway. If not passed by Gateway, need to be passed by calling App) Open a Dependency w/ CAMS to onboard your Client Id (e.g. fibermanagementexpms, nimbus, myatt-mas)
- idpctx-linkedbsseaccnumsstringThe list of BSSe account numbers linked to customer's SLID as populated by Gateway or by client. It's required when ProductType in request is WIRELESSBROADBAND and for BSSEBroadband requests
- idp-dealercodestringRequiredUser that is identified and credited for performing the transaction. For Agent flow, would be the assisting Agent ID. For Self Care, App needs to provide the ID that will be credited for the transaction. (e.g. ECARE), for non agent flow it should be default (e.g. default)
- idp-agentidstringUser that is identified and credited for performing the transaction. For Agent flow, would be the assisting Agent ID. For Self Care, App needs to provide the ID that will be credited for the transaction. (e.g. ECARE, default) Sample Value: ECare (Services Self Care)
- idp-channelstringRequiredBusiness segment (e.g. online)
- idpctx-appnamestringRequiredApp Name from calling Client. (Injected by Gateway. If not passed by Gateway, need to be passed by calling App). CAMS doesn't validate this request header. Please check with P&O team for valid values (e.g. onlineservices)
- idpctx-uuidstringUUID, Derived from validateToken (Injected by Gateway. If not passed by Gateway, need to be passed by calling App)
- idpctx-loggedInidstringLogged in ID, Derived from validateToken response
Body Parameters
- Requiredcan be ONE OF the following schemas:
- schema#0object
- schema#1object
- schema#2object
Responses
OK
Body
application/json
- objectRequired
- contentobject