ST | Reason Codes
Version 0.0.10
Endpoint
GET
/msapi/pno/cpopoffer/pno/cpopoffer/v1/generic-entity/reason-codes
Copy
Reason codes will be returned for specified filter action
Query Parameters
- channelstringRequiredEnum: [SelfService, ATTR, ECOMM, BACKOFF]Channel name of client.Length: 100
- filterActionstringRequiredEnum: [resume, cancel, terminate, suspend, change, swap, add]Order actions to filter (can be multiple, comma separated).Length: 100
- productTypestringRequiredEnum: [WBB, BB, BSSeWireless, BSSEBroadband]Type of product.Length: 100
- statestringEnum: [AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY]Alpha code of the state where the reasonCode is applicable.Length: 5
- metaDatabooleanBoolean indicator if metadata will be included in the response.
- fieldsstringEnum: [ALL, chargeCode, GracePeriodForNRF, feeToApply, suspendPerYear]List of fields to be filtered.Length: 10
- ctnstringCustomer telephone number. e.g. 7876758046Length: 100
- customerTypestringType of the customer e.g : Consumer,smallBusinessLength: 100
- paymentReasonCodestringReason of the payment E.g: cancel,terminateLength: 100
- subscriberStatusstringStatus of the subscriber E.g: ActiveLength: 100
- subscriberActivationDatestringEpoch time where reason is effective (defaults to current time if not passed). eg 1652799175Length: 100
- deviceTypestringType of the deviceLength: 100
- effectiveDatestringEpoch time where reason is effective (defaults to current time if not passed). eg 1652799175Length: 100
- filterMetaDatastringEnum: [%7B%22Amend%22%3A%22Y%22%7D]Dynamic filtering on metadata when metadata is set to trueLength: 500
Header Parameters
- X-ATT-ClientIdstringRequiredDomain ID of calling application. e.g. MyATT-MAS,ccmuleLength: 100
- idpctx-appnamestringRequiredEnd UI application name. eg SF-SALES,onlineservices,myATTNativeLength: 100
- idpctx-linkedwirelessaccnumsstringExisting Customer's Wireless Account Number in ACC flow. e.g: 177068635919Length: 100
- idpctx-acctinfocusstringExisting Customer's BAN focus. e.g: 177068635919Length: 100
Body Parameters
Responses
OK.. Returns success response
Body
application/json
- objectGeneric Entity Entry
- idstringRequiredRequired=true, The unique ID of the Generic Entity Entry. e.g. ff1f96e8-704e-4d97-92c6-35008ec1c0ac
- fieldarray of objectsRequired
Required=true, List of key-value pair associated with Generic Entity Entry.
List of key-value pair associated with Generic Element Entry