- 15.5
Description
The ServicesManager endpoint provides the API consumer with access to methods pertaining to available services and related data objects. The endpoint allows consumers to view the services available at structures stored in M4.
Methods
| URL | base/ServicesManager/GetQualifiedServices | ||
|---|---|---|---|
| Action | POST | ||
| Description | Returns the services available at a specific structure. | ||
| Parameters | |||
| Name | Required? | Type | Description |
| ServLocTable | Yes | String | The name of the table ServicesManager searches for structures. Always use "Structure". |
| ServLocLink | Yes | Integer | The ID of an M4 Structure. |
| Sample JSON Package | |||
{
"ServLocTable":"Structure",
"ServLocLink": 1080
}
|
|||
| Returns | A JSON list of Service Type objects | ||
| Sample Return Object | |||
[
{
"ServLocTable": "Structure",
"ServLocLink": 1080,
"ServingArea": "API Test Serving Area",
"ServiceTypes": [
{
"ServiceName": "Copper ADSL2",
"Description": "Copper ADSL2",
"MaxDistance": 14000,
"MaxDrop": 0,
"IsCircuitType": false,
"HasOpticalService": false,
"IsManaged": false,
"SpeedDown": 3,
"SpeedUp": 0.512,
"ListOrder": 0
},
{
"ServiceName": "Copper ADSL2",
"Description": "Copper ADSL2",
"MaxDistance": 17000,
"MaxDrop": 0,
"IsCircuitType": false,
"HasOpticalService": false,
"IsManaged": false,
"SpeedDown": 1.5,
"SpeedUp": 0.512,
"ListOrder": 0
},
{
"ServiceName": "Copper ADSL2",
"Description": "Copper ADSL2",
"MaxDistance": 19000,
"MaxDrop": 0,
"IsCircuitType": false,
"HasOpticalService": false,
"IsManaged": false,
"SpeedDown": 0.768,
"SpeedUp": 0.512,
"ListOrder": 0
},
{
"ServiceName": "Copper ADSL2",
"Description": "Copper ADSL2",
"MaxDistance": 20000,
"MaxDrop": 0,
"IsCircuitType": false,
"HasOpticalService": false,
"IsManaged": false,
"SpeedDown": 0.512,
"SpeedUp": 0.256,
"ListOrder": 0
},
{
"ServiceName": "Copper ADSL2",
"Description": "Copper ADSL2",
"MaxDistance": 21000,
"MaxDrop": 0,
"IsCircuitType": false,
"HasOpticalService": false,
"IsManaged": false,
"SpeedDown": 0.256,
"SpeedUp": 0.256,
"ListOrder": 0
},
{
"ServiceName": "Copper ADSL2",
"Description": "Copper ADSL2",
"MaxDistance": 14000,
"MaxDrop": 0,
"IsCircuitType": false,
"HasOpticalService": false,
"IsManaged": false,
"SpeedDown": 3,
"SpeedUp": 0.512,
"ListOrder": 0
},
{
"ServiceName": "Copper ADSL2",
"Description": "Copper ADSL2",
"MaxDistance": 17000,
"MaxDrop": 0,
"IsCircuitType": false,
"HasOpticalService": false,
"IsManaged": false,
"SpeedDown": 1.5,
"SpeedUp": 0.512,
"ListOrder": 0
},
{
"ServiceName": "Copper ADSL2",
"Description": "Copper ADSL2",
"MaxDistance": 19000,
"MaxDrop": 0,
"IsCircuitType": false,
"HasOpticalService": false,
"IsManaged": false,
"SpeedDown": 0.768,
"SpeedUp": 0.512,
"ListOrder": 0
},
{
"ServiceName": "Copper ADSL2",
"Description": "Copper ADSL2",
"MaxDistance": 20000,
"MaxDrop": 0,
"IsCircuitType": false,
"HasOpticalService": false,
"IsManaged": false,
"SpeedDown": 0.512,
"SpeedUp": 0.256,
"ListOrder": 0
},
{
"ServiceName": "Copper ADSL2",
"Description": "Copper ADSL2",
"MaxDistance": 21000,
"MaxDrop": 0,
"IsCircuitType": false,
"HasOpticalService": false,
"IsManaged": false,
"SpeedDown": 0.256,
"SpeedUp": 0.256,
"ListOrder": 0
}
]
}
]
|
|||
| Business Rules | |||
Any violations of these business rules result in an appropriate error message being returned to the API consumer.
|
|||