cisco-cvp-ux
Get Customer Details - TMF629 GET
This operation retrieves both B2B and B2C customer detail from Salesforce.
Request
URL
http://[host]:[port]/cisco-cvp-ux/v1/{businessId}/customer/{id}URI Parameter
BusinessId is a part of Base URI which is an enumeration of two-character length representing market/country.
| Name | Type | M/O | Description |
|---|---|---|---|
| businessId | string | M | Business unit identifier.Can be one of: "JM", "PA", "PR", "CL", "CR" |
| id | string | M | ServiceId or SubscriberNumber |
Headers
| name | value | description | required |
|---|---|---|---|
| X-Correlation-ID | string | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b | O |
| lob | string | It defines the Line of Business . Example : PREPAID | O |
| channelId | string | Channel to identify the business group. Eg:ivrB2C | O |
| targetSystem | string | This data type to indicate target system name/id in your request. Example : sfdc | O |
Security Headers
| Name | Type | M/O | Description |
|---|---|---|---|
| client_id | string | M | Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332 |
| client_secret | string | M | Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43fAd324a |
Response
Possible success response
[ 201 ]
B2C Customer Details
{
"id": "21515133",
"href": "https://cwc--uatsfdc.sandbox.my.salesforce.com/0017d00001HV8XUAA1",
"state": "Active",
"account": [
{
"id": "21513636-21515133",
"name": "Extra Three",
"@type": "BillingAccount",
"autopayFlag": "Y"
}
],
"characteristic": [
{
"value": "Customer",
"name": "accountType"
},
{
"value": "Postpaid",
"name": "paymentType"
},
{
"value": "Extra",
"name": "firstName"
},
{
"value": "Three",
"name": "lastName"
},
{
"value": "B2C",
"name": "consumerSegment"
},
{
"value": "PR",
"name": "billingEntity"
},
{
"value": "2001-12-26",
"name": "dateOfBirth"
},
{
"value": "EN",
"name": "language"
},
{
"value": "3333",
"name": "ConsumerPINNumber"
},
{
"value": "Phone",
"name": "customerContactNotificationPreference"
},
{
"value": "false",
"name": "hasFraud"
},
{
"value": "",
"name": "consumerSubType"
}
],
"contactMedium": [
{
"mediumType": "Address",
"preferred": true,
"characteristic": {
"phoneNumber": "5467897688",
"emailAddress": "gfgfgdd@gmail.com",
"contactType": "Primary"
},
"@referredType": "ContactAddress"
}
],
"creditProfile": [
{
"creditRiskRating": "M"
}
],
"relatedParty": [
{
"id": "0017d00001HV8XVAA1",
"@type": "SalesforceBillingAccountRef"
}
]
}B2B Customer Details
{
"id": "40000417",
"href": "https://cwc--uatsfdc.sandbox.my.salesforce.com/0017d00001RHb8XAAT",
"state": "Active",
"account": [
{
"name": "a937d000000D7sY",
"@type": "BillingAccount",
"autopayFlag": "N"
},
{
"id": "41000368-40000417",
"name": "Polo Norte - Norma - PR Primera Billing",
"@type": "BillingAccount",
"autopayFlag": "Y"
},
{
"name": "a937d000000D7Wc",
"@type": "BillingAccount",
"autopayFlag": "N"
},
{
"name": "a937d000000D7Aq",
"@type": "BillingAccount",
"autopayFlag": "N"
},
{
"name": "a937d000000D7FC",
"@type": "BillingAccount",
"autopayFlag": "N"
},
{
"name": "a937d000000D80i",
"@type": "BillingAccount",
"autopayFlag": "N"
},
{
"name": "a937d000000D7Ci",
"@type": "BillingAccount",
"autopayFlag": "N"
},
{
"name": "a937d000000D7Cm",
"@type": "BillingAccount",
"autopayFlag": "N"
},
{
"name": "a937d000000D7Ch",
"@type": "BillingAccount",
"autopayFlag": "N"
}
],
"characteristic": [
{
"value": "Postpaid",
"name": "paymentType"
},
{
"value": "QWBTW",
"name": "firstName"
},
{
"value": "ZISUDMCXBDUUPJZYX",
"name": "lastName"
},
{
"value": "B2B",
"name": "consumerSegment"
},
{
"value": "PR",
"name": "billingEntity"
},
{
"value": "EN",
"name": "language"
},
{
"value": "Phone",
"name": "customerContactNotificationPreference"
},
{
"value": "false",
"name": "hasFraud"
},
{
"value": "SOHO/Small",
"name": "consumerSubType"
}
],
"contactMedium": [
{
"mediumType": "Address",
"preferred": true,
"characteristic": {
"emailAddress": "monica.carena.daytoday@yopmail.com",
"contactType": "Secondary"
},
"@referredType": "ContactAddress"
},
{
"mediumType": "Address",
"preferred": true,
"characteristic": {
"city": "San Juan",
"country": "Puerto Rico",
"street1": "1451 Ashford Avenue",
"phoneNumber": "19394100466",
"emailAddress": "norma.lamprea@cwc.com",
"contactType": "Secondary"
},
"@referredType": "ContactAddress"
}
],
"creditProfile": [
{
"creditRiskRating": "B",
"creditScore": 794
}
],
"relatedParty": [
{
"id": "0017d00001RK2qIAAT",
"@type": "SalesforceBillingAccountRef"
}
]
}