CellularPlanSearch
Use the CellularPlanSearch operation to search through PhoneDog's complete catalog of cell phone rate plans currently available through wireless providers in the United States.
Request parameters
Request parameters specify the terms of your request and control the output data that is returned to you. The following parameters can be used with this operation.
| Operation |
The operation you want PWS to perform |
Yes |
CellularPlanSearch |
| ApiKey |
Your ApiKey - used to authorize your request |
Yes |
|
| AgentId |
Your AgentId - used to authorize your request |
Yes |
|
| ProviderId |
Use up to 10 comma-separated id's of the available provider id's to limit the result of cell phone rate plans to certain providers (Cell phone carrier). |
No |
Valid value:
|
| PriceFrom |
Use the pricefrom parameter to limit your results to cell phone rate plans with a certain starting price (monthly or pre-paid rate). E.g. passing the value 50 would return rate plans costing $50 or more. |
No |
Valid value:
- Any numeric value from
-1000 to 10000 (can also include up to two decimals) |
| PriceTo |
Use the priceto parameter to limit your results to cell phone rate plans up to a certain final price (monthly or pre-paid rate). Use the priceto parameter together with the pricefrom parameter to limit your results to show only rate plans within a certain price range. |
No |
Valid value:
- Any numeric value from
-1000 to 10000 (can also include up to two decimals) |
| MinutesFrom |
Use the minutesfrom parameter to limit your results to cell phone rate plans with a certain minimum amount of included minutes. |
No |
Valid value:
- Any numeric value from 0 to 10000
|
| MinutesTo |
Use the minutesto paramter to limit your results to cell phone rate plans with a certain maximum amount of included minutes |
No |
Valid value:
- Any numeric value from 0 to 10000
|
| Sort |
Use the sort parameter to specify how your results will be ordered. |
No |
Valid value:
(default value if not set is "provider") |
| PageIndex |
The pageindex parameter allows you to create a paginated list of search results. This parameter returns the specified page. The first page containing 10 cell phone rate plans will be returned if left blank. |
No |
Valid value:
|
| PageSize |
Optionally you may choose to change the amount of results per page using the pagesize parameter. |
No |
Valid value:
|