Geographic
CBSAs (Complete List)
Request URL
GET Formulary/v1/Geographic/CBSAs
URI Parameters
No parameters are required for this Resource URI.
Resource Description of Response Object
CBSAsResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| CBSAs | Collection of CBSA |
Optional |
Available Response Formats & Sample Data
{
"CBSAs": [
{
"CBSAId": 1,
"Name": "sample string 2",
"ShortName": "sample string 3",
"Population": 4
},
{
"CBSAId": 1,
"Name": "sample string 2",
"ShortName": "sample string 3",
"Population": 4
}
]
}
<CBSAsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/geographic">
<CBSAs>
<CBSA>
<CBSAId>1</CBSAId>
<Name>sample string 2</Name>
<Population>4</Population>
<ShortName>sample string 3</ShortName>
</CBSA>
<CBSA>
<CBSAId>1</CBSAId>
<Name>sample string 2</Name>
<Population>4</Population>
<ShortName>sample string 3</ShortName>
</CBSA>
</CBSAs>
</CBSAsResponse>
Build Request
No parameters are required for this Resource URI.
Request URL
GET Formulary/v1/Geographic/CBSAs
Status
Response Details
CBSA (by ZipCode)
Request URL
GET Formulary/v1/Geographic/CBSAs
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| ZipCode |
The CBSA wherein the ZipCode resides |
integer |
Required |
Resource Description of Response Object
CBSAResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| CBSA | CBSA |
Optional |
Available Response Formats & Sample Data
{
"CBSA": {
"CBSAId": 1,
"Name": "sample string 2",
"ShortName": "sample string 3",
"Population": 4
}
}
<CBSAResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/geographic">
<CBSA>
<CBSAId>1</CBSAId>
<Name>sample string 2</Name>
<Population>4</Population>
<ShortName>sample string 3</ShortName>
</CBSA>
</CBSAResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| ZipCode |
The CBSA wherein the ZipCode resides |
integer |
Required |
Request URL
GET Formulary/v1/Geographic/CBSAs?ZipCode=ZipCode
Status
Response Details
US States (Complete List)
Request URL
GET Formulary/v1/Geographic/States
URI Parameters
No parameters are required for this Resource URI.
Resource Description of Response Object
StatesResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| States | Collection of State |
Optional |
Available Response Formats & Sample Data
{
"States": [
{
"StateId": "sample string 1",
"Name": "sample string 2",
"Population": 3
},
{
"StateId": "sample string 1",
"Name": "sample string 2",
"Population": 3
}
]
}
<StatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/geographic">
<States>
<State>
<Name>sample string 2</Name>
<Population>3</Population>
<StateId>sample string 1</StateId>
</State>
<State>
<Name>sample string 2</Name>
<Population>3</Population>
<StateId>sample string 1</StateId>
</State>
</States>
</StatesResponse>
Build Request
No parameters are required for this Resource URI.
Request URL
GET Formulary/v1/Geographic/States
Status
Response Details
Zip Codes (Complete List)
Request URL
GET Formulary/v1/Geographic/Zips
URI Parameters
No parameters are required for this Resource URI.
Resource Description of Response Object
ZipsResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| Zips | Collection of Zip |
Optional |
Available Response Formats & Sample Data
{
"Zips": [
{
"ZipCode": 1,
"StateId": "sample string 2",
"CBSAId": 1
},
{
"ZipCode": 1,
"StateId": "sample string 2",
"CBSAId": 1
}
]
}
<ZipsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/geographic">
<Zips>
<Zip>
<CBSAId>1</CBSAId>
<StateId>sample string 2</StateId>
<ZipCode>1</ZipCode>
</Zip>
<Zip>
<CBSAId>1</CBSAId>
<StateId>sample string 2</StateId>
<ZipCode>1</ZipCode>
</Zip>
</Zips>
</ZipsResponse>
Build Request
No parameters are required for this Resource URI.
Request URL
GET Formulary/v1/Geographic/Zips
Status
Response Details
Client Territories
Request URL
GET Formulary/v1/Geographic/ClientTerritories
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| ZipCode |
The Territories wherein the ZipCode resides |
integer |
Optional |
| ProductId |
The Territories where the Product Id is defined |
integer |
Optional |
Resource Description of Response Object
ClientTerritoriesResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| ClientTerritories | Collection of ClientTerritoryResponse |
Optional |
Available Response Formats & Sample Data
{
"ClientTerritories": [
{
"TerritoryId": 1,
"Name": "sample string 2",
"ProductIds": [
1,
2
]
},
{
"TerritoryId": 1,
"Name": "sample string 2",
"ProductIds": [
1,
2
]
}
]
}
<ClientTerritoriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MMIT.Api.WebApplication.Models.Formulary.Geographic">
<ClientTerritories>
<ClientTerritoryResponse>
<Name>sample string 2</Name>
<ProductIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</ProductIds>
<TerritoryId>1</TerritoryId>
</ClientTerritoryResponse>
<ClientTerritoryResponse>
<Name>sample string 2</Name>
<ProductIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</ProductIds>
<TerritoryId>1</TerritoryId>
</ClientTerritoryResponse>
</ClientTerritories>
</ClientTerritoriesResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| ZipCode |
The Territories wherein the ZipCode resides |
integer |
Optional |
|
| ProductId |
The Territories where the Product Id is defined |
integer |
Optional |
Request URL
GET Formulary/v1/Geographic/ClientTerritories?ZipCode=ZipCode&ProductId=ProductId
Status
Response Details