Bridging
The Bridging as a Service resource allows the retrieval of Plan details using the MMIT Bridging services.
Plan Details (by BIN, PCN, Group, Channel)
GET BridgingasaService/v1/PlanDetails
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| BIN |
The BIN that matches the Plan. Can be used in conjunction with PCN and Group. |
string |
Required |
| PCN |
The PCN that matches the Plan. Can be used in conjunction with BIN and Group. |
string |
Optional |
| Group |
The Group that matches the Plan. Can be used in conjunction with BIN and PCN. |
string |
Optional |
| InboundId |
Unique Client Key |
string |
Optional |
| PlanType |
Type of the plan. |
string |
Optional |
| PlanName |
The Name of the plan. |
string |
Optional |
| Channel |
The Name of the Channel of the Plan used to filter the response. |
string |
Optional |
| State |
Name of the state. |
string |
Optional |
| RelationalMapping |
Pass 1 if you want the top plan with 1:1 relationship. (Defaults to 0) |
integer |
Default value is 0 |
Resource Description of Response Object
PlanDetailResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| PlanDetails | Collection of PlanDetail |
Optional |
Available Response Formats & Sample Data
{
"PlanDetails": [
{
"BIN": "sample string 1",
"PCN": "sample string 2",
"Group": "sample string 3",
"PlanId": 4,
"PlanName": "sample string 5",
"State": "sample string 6",
"Channel": "sample string 7"
},
{
"BIN": "sample string 1",
"PCN": "sample string 2",
"Group": "sample string 3",
"PlanId": 4,
"PlanName": "sample string 5",
"State": "sample string 6",
"Channel": "sample string 7"
}
]
}
<PlanDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/bridging/plandetails">
<PlanDetails xmlns:d2p1="http://api.mmitnetwork.com/bridging/plandetail">
<d2p1:PlanDetail>
<d2p1:BIN>sample string 1</d2p1:BIN>
<d2p1:Channel>sample string 7</d2p1:Channel>
<d2p1:Group>sample string 3</d2p1:Group>
<d2p1:PCN>sample string 2</d2p1:PCN>
<d2p1:PlanId>4</d2p1:PlanId>
<d2p1:PlanName>sample string 5</d2p1:PlanName>
<d2p1:State>sample string 6</d2p1:State>
</d2p1:PlanDetail>
<d2p1:PlanDetail>
<d2p1:BIN>sample string 1</d2p1:BIN>
<d2p1:Channel>sample string 7</d2p1:Channel>
<d2p1:Group>sample string 3</d2p1:Group>
<d2p1:PCN>sample string 2</d2p1:PCN>
<d2p1:PlanId>4</d2p1:PlanId>
<d2p1:PlanName>sample string 5</d2p1:PlanName>
<d2p1:State>sample string 6</d2p1:State>
</d2p1:PlanDetail>
</PlanDetails>
</PlanDetailResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| BIN |
The BIN that matches the Plan. Can be used in conjunction with PCN and Group. |
string |
Required |
|
| PCN |
The PCN that matches the Plan. Can be used in conjunction with BIN and Group. |
string |
Optional |
|
| Group |
The Group that matches the Plan. Can be used in conjunction with BIN and PCN. |
string |
Optional |
|
| InboundId |
Unique Client Key |
string |
Optional |
|
| PlanType |
Type of the plan. |
string |
Optional |
|
| PlanName |
The Name of the plan. |
string |
Optional |
|
| Channel |
The Name of the Channel of the Plan used to filter the response. |
string |
Optional |
|
| State |
Name of the state. |
string |
Optional |
|
| RelationalMapping |
Pass 1 if you want the top plan with 1:1 relationship. (Defaults to 0) |
integer |
Default value is 0 |
Request URL
GET BridgingasaService/v1/PlanDetails?BIN=BIN&PCN=PCN&Group=Group&InboundId=InboundId&PlanType=PlanType&PlanName=PlanName&Channel=Channel&State=State&RelationalMapping=RelationalMapping
Status
Response Details