/{businessId}/checkServiceQualification
[POST]
This use case is to create feasibility budget quote at SAR system
URL
https://nonprod.esb.cloud.lla.com/test/sfdc-ux/sfdc-ux/v1/{businessId}/checkServiceQualification
url Param
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. For this use case CO, HN, CR, DO, SV, GT, WHS. WHS is for wholesale | Y |
| name | type | 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 |
Body Definitions
| name | type | description | required |
|---|
| externalId | string | Salesforce record Id | Y |
| relatedParty[0].name | string | Customer Name | Y |
| relatedParty[0].role | string | Default "customer" | Y |
| relatedParty[0].@referredType | string | Default "Customer" | Y |
| relatedParty[1].name | string | Operator | Y |
| relatedParty[1].role | string | Default "operator" | Y |
| relatedParty[1].@referredType | string | Default "Customer" | Y |
| serviceQualificationItem[].service.name | string | Prodct Name | Y |
| serviceQualificationItem[].service.place[].id | string | City Id | Y |
| serviceQualificationItem[].service.place[].name | string | location | Y |
| serviceQualificationItem[].service.place[].role | string | Default "Address" | Y |
| serviceQualificationItem[].service.relatedEntity[0].name | string | Task Owner | Y |
| serviceQualificationItem[].service.relatedEntity[0].role | string | Default "User" | Y |
| serviceQualificationItem[].service.relatedEntity[0].@referredType | string | Default "Individual" | Y |
| serviceQualificationItem[].service.relatedEntity[1].id | string | Circuit Id | Y |
| serviceQualificationItem[].service.relatedEntity[1].role | string | Default "Circuit" | Y |
| serviceQualificationItem[].service.relatedEntity[1].@referredType | string | Default "Individual" | Y |
| serviceQualificationItem[].service.serviceCharacteristic.name | string | Name of the characteristic | Y |
| serviceQualificationItem[].service.serviceCharacteristic.value | string | Value of the characteristic | Y |
Characteristics
| name | type | description | required |
|---|
| TaskNumber | string | Task Number | Y |
| ChangeCategory | string | Change Category | Y |
| TaskCategory | string | Task Category | Y |
| ChangeId | string | Change Id | Y |
| Extreme | string | Extreme | Y |
Sample Request
{
"externalId": "a632532Tbha",
"relatedParty": [
{
"name": "FINANZAUTO AV LAS AMERICAS",
"role":"customer",
"@referredType": "Customer"
},
{
"name": "Columbus Networks",
"role":"operator",
"@referredType": "Customer"
}
],
"serviceQualificationItem": [
{
"service":
{
"name": "COR-ESTANDAR-ETH-100BT-20-MBPS",
"place": [
{
"id": "826",
"name": "AV. DE LAS AMÉRICAS 50-50 Coordenadas 4.6279681,-74.1098857",
"role": "Address"
}
],
"relatedEntity": [
{
"name": "DANIELA.RAMIREZ",
"role": "User",
"@referredType": "Individual"
},
{
"id": "CI1031554",
"role": "Circuit",
"@referredType": "Individual"
}
],
"serviceCharacteristic": [
{
"name": "TaskNumber",
"value": "T763551"
},
{
"name": "ChangeCategory",
"value": "APV Factibilidad"
},
{
"name": "TaskCategory",
"value": "Site Survey Ext. A"
},
{
"name": "ChangeId",
"value": "C206636"
},
{
"name": "Extreme",
"value": "A"
}
]
}
}
]
}
Sample Response
{
"qualificationResult": "Service Order received",
"externalId": "a632532Tbha",
"relatedParty": [
{
"name": "FINANZAUTO AV LAS AMERICAS",
"role":"customer",
"@referredType": "Customer"
},
{
"name": "Columbus Networks",
"role":"operator",
"@referredType": "Customer"
}
],
"serviceQualificationItem": [
{
"service":
{
"name": "COR-ESTANDAR-ETH-100BT-20-MBPS",
"place": [
{
"id": "826",
"name": "AV. DE LAS AMÉRICAS 50-50 Coordenadas 4.6279681,-74.1098857",
"role": "Address"
}
],
"relatedEntity": [
{
"name": "DANIELA.RAMIREZ",
"role": "User",
"@referredType": "Individual"
},
{
"id": "CI1031554",
"role": "Circuit",
"@referredType": "Individual"
}
],
"serviceCharacteristic": [
{
"name": "TaskNumber",
"value": "T763551"
},
{
"name": "ChangeCategory",
"value": "APV Factibilidad"
},
{
"name": "TaskCategory",
"value": "Site Survey Ext. A"
},
{
"name": "ChangeId",
"value": "C206636"
},
{
"name": "Extreme",
"value": "A"
}
]
}
}
]
}