Competitors
A Product may have Competitors that are on the market.
Competitors (for a ProductId)
Request URL
GET FormTrak/v1/Products/Competitors
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| ProductId |
Id of the Product |
integer |
Required |
| DrugTypeId |
DrugTypeId of the returned Products |
byte |
Optional |
Resource Description of Response Object
Collection of ProductsResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| Products | Collection of Product |
Optional |
Available Response Formats & Sample Data
[
{
"Products": [
{
"ProductId": 1,
"TherapeuticClassId": 2,
"TherapeuticClass": "sample string 3",
"Drug": {
"DrugId": 1,
"DrugTypeId": 64,
"Name": "sample string 3",
"Description": "sample string 4",
"Brand": "sample string 5",
"IsGeneric": true,
"OverTheCounter": true,
"IsOwner": true,
"Logo": "sample string 8",
"ImportantSafetyInformation": "sample string 9",
"Rank": 64
},
"DisplayName": "sample string 4"
},
{
"ProductId": 1,
"TherapeuticClassId": 2,
"TherapeuticClass": "sample string 3",
"Drug": {
"DrugId": 1,
"DrugTypeId": 64,
"Name": "sample string 3",
"Description": "sample string 4",
"Brand": "sample string 5",
"IsGeneric": true,
"OverTheCounter": true,
"IsOwner": true,
"Logo": "sample string 8",
"ImportantSafetyInformation": "sample string 9",
"Rank": 64
},
"DisplayName": "sample string 4"
}
]
},
{
"Products": [
{
"ProductId": 1,
"TherapeuticClassId": 2,
"TherapeuticClass": "sample string 3",
"Drug": {
"DrugId": 1,
"DrugTypeId": 64,
"Name": "sample string 3",
"Description": "sample string 4",
"Brand": "sample string 5",
"IsGeneric": true,
"OverTheCounter": true,
"IsOwner": true,
"Logo": "sample string 8",
"ImportantSafetyInformation": "sample string 9",
"Rank": 64
},
"DisplayName": "sample string 4"
},
{
"ProductId": 1,
"TherapeuticClassId": 2,
"TherapeuticClass": "sample string 3",
"Drug": {
"DrugId": 1,
"DrugTypeId": 64,
"Name": "sample string 3",
"Description": "sample string 4",
"Brand": "sample string 5",
"IsGeneric": true,
"OverTheCounter": true,
"IsOwner": true,
"Logo": "sample string 8",
"ImportantSafetyInformation": "sample string 9",
"Rank": 64
},
"DisplayName": "sample string 4"
}
]
}
]
<ArrayOfProductsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/products">
<ProductsResponse>
<Products>
<Product>
<DisplayName>sample string 4</DisplayName>
<Drug>
<Brand>sample string 5</Brand>
<Description>sample string 4</Description>
<DrugId>1</DrugId>
<DrugTypeId>64</DrugTypeId>
<ImportantSafetyInformation>sample string 9</ImportantSafetyInformation>
<IsGeneric>true</IsGeneric>
<IsOwner>true</IsOwner>
<Logo>sample string 8</Logo>
<Name>sample string 3</Name>
<OverTheCounter>true</OverTheCounter>
<Rank>64</Rank>
</Drug>
<ProductId>1</ProductId>
<TherapeuticClass>sample string 3</TherapeuticClass>
<TherapeuticClassId>2</TherapeuticClassId>
</Product>
<Product>
<DisplayName>sample string 4</DisplayName>
<Drug>
<Brand>sample string 5</Brand>
<Description>sample string 4</Description>
<DrugId>1</DrugId>
<DrugTypeId>64</DrugTypeId>
<ImportantSafetyInformation>sample string 9</ImportantSafetyInformation>
<IsGeneric>true</IsGeneric>
<IsOwner>true</IsOwner>
<Logo>sample string 8</Logo>
<Name>sample string 3</Name>
<OverTheCounter>true</OverTheCounter>
<Rank>64</Rank>
</Drug>
<ProductId>1</ProductId>
<TherapeuticClass>sample string 3</TherapeuticClass>
<TherapeuticClassId>2</TherapeuticClassId>
</Product>
</Products>
</ProductsResponse>
<ProductsResponse>
<Products>
<Product>
<DisplayName>sample string 4</DisplayName>
<Drug>
<Brand>sample string 5</Brand>
<Description>sample string 4</Description>
<DrugId>1</DrugId>
<DrugTypeId>64</DrugTypeId>
<ImportantSafetyInformation>sample string 9</ImportantSafetyInformation>
<IsGeneric>true</IsGeneric>
<IsOwner>true</IsOwner>
<Logo>sample string 8</Logo>
<Name>sample string 3</Name>
<OverTheCounter>true</OverTheCounter>
<Rank>64</Rank>
</Drug>
<ProductId>1</ProductId>
<TherapeuticClass>sample string 3</TherapeuticClass>
<TherapeuticClassId>2</TherapeuticClassId>
</Product>
<Product>
<DisplayName>sample string 4</DisplayName>
<Drug>
<Brand>sample string 5</Brand>
<Description>sample string 4</Description>
<DrugId>1</DrugId>
<DrugTypeId>64</DrugTypeId>
<ImportantSafetyInformation>sample string 9</ImportantSafetyInformation>
<IsGeneric>true</IsGeneric>
<IsOwner>true</IsOwner>
<Logo>sample string 8</Logo>
<Name>sample string 3</Name>
<OverTheCounter>true</OverTheCounter>
<Rank>64</Rank>
</Drug>
<ProductId>1</ProductId>
<TherapeuticClass>sample string 3</TherapeuticClass>
<TherapeuticClassId>2</TherapeuticClassId>
</Product>
</Products>
</ProductsResponse>
</ArrayOfProductsResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| ProductId |
Id of the Product |
integer |
Required |
|
| DrugTypeId |
DrugTypeId of the returned Products |
byte |
Optional |
Request URL
GET FormTrak/v1/Products/Competitors?ProductId=ProductId&DrugTypeId=DrugTypeId
Status
Response Details
Competitors (for a ProductId and ProjectId)
Request URL
GET FormTrak/v1/Projects/{ProjectId}/Products/{ProductId}/Competitors
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| ProductId |
Id of the Product |
integer |
Required |
| ProjectId |
The Id of the Project |
integer |
Required |
| IndicationId |
Indication Id |
integer |
Optional |
| BenefitType |
Enter 'Pharmacy' to include Pharmacy Benefit Level Competitors . Enter 'Medical' to include Medical Benefit Level Competitors and 'Both' to return both. |
string |
Optional |
Resource Description of Response Object
Collection of ProductsResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| Products | Collection of Product |
Optional |
Available Response Formats & Sample Data
[
{
"Products": [
{
"ProductId": 1,
"TherapeuticClassId": 2,
"TherapeuticClass": "sample string 3",
"Drug": {
"DrugId": 1,
"DrugTypeId": 64,
"Name": "sample string 3",
"Description": "sample string 4",
"Brand": "sample string 5",
"IsGeneric": true,
"OverTheCounter": true,
"IsOwner": true,
"Logo": "sample string 8",
"ImportantSafetyInformation": "sample string 9",
"Rank": 64
},
"DisplayName": "sample string 4"
},
{
"ProductId": 1,
"TherapeuticClassId": 2,
"TherapeuticClass": "sample string 3",
"Drug": {
"DrugId": 1,
"DrugTypeId": 64,
"Name": "sample string 3",
"Description": "sample string 4",
"Brand": "sample string 5",
"IsGeneric": true,
"OverTheCounter": true,
"IsOwner": true,
"Logo": "sample string 8",
"ImportantSafetyInformation": "sample string 9",
"Rank": 64
},
"DisplayName": "sample string 4"
}
]
},
{
"Products": [
{
"ProductId": 1,
"TherapeuticClassId": 2,
"TherapeuticClass": "sample string 3",
"Drug": {
"DrugId": 1,
"DrugTypeId": 64,
"Name": "sample string 3",
"Description": "sample string 4",
"Brand": "sample string 5",
"IsGeneric": true,
"OverTheCounter": true,
"IsOwner": true,
"Logo": "sample string 8",
"ImportantSafetyInformation": "sample string 9",
"Rank": 64
},
"DisplayName": "sample string 4"
},
{
"ProductId": 1,
"TherapeuticClassId": 2,
"TherapeuticClass": "sample string 3",
"Drug": {
"DrugId": 1,
"DrugTypeId": 64,
"Name": "sample string 3",
"Description": "sample string 4",
"Brand": "sample string 5",
"IsGeneric": true,
"OverTheCounter": true,
"IsOwner": true,
"Logo": "sample string 8",
"ImportantSafetyInformation": "sample string 9",
"Rank": 64
},
"DisplayName": "sample string 4"
}
]
}
]
<ArrayOfProductsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/products">
<ProductsResponse>
<Products>
<Product>
<DisplayName>sample string 4</DisplayName>
<Drug>
<Brand>sample string 5</Brand>
<Description>sample string 4</Description>
<DrugId>1</DrugId>
<DrugTypeId>64</DrugTypeId>
<ImportantSafetyInformation>sample string 9</ImportantSafetyInformation>
<IsGeneric>true</IsGeneric>
<IsOwner>true</IsOwner>
<Logo>sample string 8</Logo>
<Name>sample string 3</Name>
<OverTheCounter>true</OverTheCounter>
<Rank>64</Rank>
</Drug>
<ProductId>1</ProductId>
<TherapeuticClass>sample string 3</TherapeuticClass>
<TherapeuticClassId>2</TherapeuticClassId>
</Product>
<Product>
<DisplayName>sample string 4</DisplayName>
<Drug>
<Brand>sample string 5</Brand>
<Description>sample string 4</Description>
<DrugId>1</DrugId>
<DrugTypeId>64</DrugTypeId>
<ImportantSafetyInformation>sample string 9</ImportantSafetyInformation>
<IsGeneric>true</IsGeneric>
<IsOwner>true</IsOwner>
<Logo>sample string 8</Logo>
<Name>sample string 3</Name>
<OverTheCounter>true</OverTheCounter>
<Rank>64</Rank>
</Drug>
<ProductId>1</ProductId>
<TherapeuticClass>sample string 3</TherapeuticClass>
<TherapeuticClassId>2</TherapeuticClassId>
</Product>
</Products>
</ProductsResponse>
<ProductsResponse>
<Products>
<Product>
<DisplayName>sample string 4</DisplayName>
<Drug>
<Brand>sample string 5</Brand>
<Description>sample string 4</Description>
<DrugId>1</DrugId>
<DrugTypeId>64</DrugTypeId>
<ImportantSafetyInformation>sample string 9</ImportantSafetyInformation>
<IsGeneric>true</IsGeneric>
<IsOwner>true</IsOwner>
<Logo>sample string 8</Logo>
<Name>sample string 3</Name>
<OverTheCounter>true</OverTheCounter>
<Rank>64</Rank>
</Drug>
<ProductId>1</ProductId>
<TherapeuticClass>sample string 3</TherapeuticClass>
<TherapeuticClassId>2</TherapeuticClassId>
</Product>
<Product>
<DisplayName>sample string 4</DisplayName>
<Drug>
<Brand>sample string 5</Brand>
<Description>sample string 4</Description>
<DrugId>1</DrugId>
<DrugTypeId>64</DrugTypeId>
<ImportantSafetyInformation>sample string 9</ImportantSafetyInformation>
<IsGeneric>true</IsGeneric>
<IsOwner>true</IsOwner>
<Logo>sample string 8</Logo>
<Name>sample string 3</Name>
<OverTheCounter>true</OverTheCounter>
<Rank>64</Rank>
</Drug>
<ProductId>1</ProductId>
<TherapeuticClass>sample string 3</TherapeuticClass>
<TherapeuticClassId>2</TherapeuticClassId>
</Product>
</Products>
</ProductsResponse>
</ArrayOfProductsResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| ProductId |
Id of the Product |
integer |
Required |
|
| ProjectId |
The Id of the Project |
integer |
Required |
|
| IndicationId |
Indication Id |
integer |
Optional |
|
| BenefitType |
Enter 'Pharmacy' to include Pharmacy Benefit Level Competitors . Enter 'Medical' to include Medical Benefit Level Competitors and 'Both' to return both. |
string |
Optional |
Request URL
GET FormTrak/v1/Projects/ProjectId/Products/ProductId/Competitors?IndicationId=IndicationId&BenefitType=BenefitType
Status
Response Details
Competitors (Dual Benefits View)
Request URL
GET FormTrak/v1/Projects/{ProjectId}/Products/{ProductId}/Competitors/DualBenefitsView
URI Parameters
| Name | Description | Type | Required / Optional |
|---|---|---|---|
| ProductId |
Id of the Product |
integer |
Required |
| ProjectId |
The Id of the Project |
integer |
Required |
| IndicationId |
Indication Id |
integer |
Required |
| AnchorDrugBenefitType |
Enter 'Pharmacy' to include Pharmacy Benefit Level Competitors . Enter 'Medical' to include Medical Benefit Level Competitors. |
string |
Required |
| CompareDrugBenefitType |
Enter 'Pharmacy' to include Pharmacy Benefit Level Competitors . Enter 'Medical' to include Medical Benefit Level Competitors. |
string |
Optional |
Resource Description of Response Object
Collection of CompetitorProductsResponse| Name | Description | Type | Required / Optional |
|---|---|---|---|
| Products | Collection of CompetitorProducts |
Optional |
Available Response Formats & Sample Data
[
{
"Products": [
{
"ProductId": 1,
"TherapeuticClassId": 2,
"TherapeuticClass": "sample string 3",
"Drug": {
"DrugId": 1,
"DrugTypeId": 64,
"Name": "sample string 3",
"Description": "sample string 4",
"Brand": "sample string 5",
"IsGeneric": true,
"OverTheCounter": true,
"IsOwner": true,
"Logo": "sample string 8",
"ImportantSafetyInformation": "sample string 9",
"Rank": 64
},
"DisplayName": "sample string 4",
"IndicationId": 5,
"BrandNameBenefitType": "sample string 6",
"CompareDrugBenefitType": "sample string 7"
},
{
"ProductId": 1,
"TherapeuticClassId": 2,
"TherapeuticClass": "sample string 3",
"Drug": {
"DrugId": 1,
"DrugTypeId": 64,
"Name": "sample string 3",
"Description": "sample string 4",
"Brand": "sample string 5",
"IsGeneric": true,
"OverTheCounter": true,
"IsOwner": true,
"Logo": "sample string 8",
"ImportantSafetyInformation": "sample string 9",
"Rank": 64
},
"DisplayName": "sample string 4",
"IndicationId": 5,
"BrandNameBenefitType": "sample string 6",
"CompareDrugBenefitType": "sample string 7"
}
]
},
{
"Products": [
{
"ProductId": 1,
"TherapeuticClassId": 2,
"TherapeuticClass": "sample string 3",
"Drug": {
"DrugId": 1,
"DrugTypeId": 64,
"Name": "sample string 3",
"Description": "sample string 4",
"Brand": "sample string 5",
"IsGeneric": true,
"OverTheCounter": true,
"IsOwner": true,
"Logo": "sample string 8",
"ImportantSafetyInformation": "sample string 9",
"Rank": 64
},
"DisplayName": "sample string 4",
"IndicationId": 5,
"BrandNameBenefitType": "sample string 6",
"CompareDrugBenefitType": "sample string 7"
},
{
"ProductId": 1,
"TherapeuticClassId": 2,
"TherapeuticClass": "sample string 3",
"Drug": {
"DrugId": 1,
"DrugTypeId": 64,
"Name": "sample string 3",
"Description": "sample string 4",
"Brand": "sample string 5",
"IsGeneric": true,
"OverTheCounter": true,
"IsOwner": true,
"Logo": "sample string 8",
"ImportantSafetyInformation": "sample string 9",
"Rank": 64
},
"DisplayName": "sample string 4",
"IndicationId": 5,
"BrandNameBenefitType": "sample string 6",
"CompareDrugBenefitType": "sample string 7"
}
]
}
]
<ArrayOfCompetitorProductsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/FormTrak/products">
<CompetitorProductsResponse>
<Products>
<Product>
<BrandNameBenefitType>sample string 6</BrandNameBenefitType>
<CompareDrugBenefitType>sample string 7</CompareDrugBenefitType>
<DisplayName>sample string 4</DisplayName>
<Drug xmlns:d5p1="http://api.mmitnetwork.com/formulary/products">
<d5p1:Brand>sample string 5</d5p1:Brand>
<d5p1:Description>sample string 4</d5p1:Description>
<d5p1:DrugId>1</d5p1:DrugId>
<d5p1:DrugTypeId>64</d5p1:DrugTypeId>
<d5p1:ImportantSafetyInformation>sample string 9</d5p1:ImportantSafetyInformation>
<d5p1:IsGeneric>true</d5p1:IsGeneric>
<d5p1:IsOwner>true</d5p1:IsOwner>
<d5p1:Logo>sample string 8</d5p1:Logo>
<d5p1:Name>sample string 3</d5p1:Name>
<d5p1:OverTheCounter>true</d5p1:OverTheCounter>
<d5p1:Rank>64</d5p1:Rank>
</Drug>
<IndicationId>5</IndicationId>
<ProductId>1</ProductId>
<TherapeuticClass>sample string 3</TherapeuticClass>
<TherapeuticClassId>2</TherapeuticClassId>
</Product>
<Product>
<BrandNameBenefitType>sample string 6</BrandNameBenefitType>
<CompareDrugBenefitType>sample string 7</CompareDrugBenefitType>
<DisplayName>sample string 4</DisplayName>
<Drug xmlns:d5p1="http://api.mmitnetwork.com/formulary/products">
<d5p1:Brand>sample string 5</d5p1:Brand>
<d5p1:Description>sample string 4</d5p1:Description>
<d5p1:DrugId>1</d5p1:DrugId>
<d5p1:DrugTypeId>64</d5p1:DrugTypeId>
<d5p1:ImportantSafetyInformation>sample string 9</d5p1:ImportantSafetyInformation>
<d5p1:IsGeneric>true</d5p1:IsGeneric>
<d5p1:IsOwner>true</d5p1:IsOwner>
<d5p1:Logo>sample string 8</d5p1:Logo>
<d5p1:Name>sample string 3</d5p1:Name>
<d5p1:OverTheCounter>true</d5p1:OverTheCounter>
<d5p1:Rank>64</d5p1:Rank>
</Drug>
<IndicationId>5</IndicationId>
<ProductId>1</ProductId>
<TherapeuticClass>sample string 3</TherapeuticClass>
<TherapeuticClassId>2</TherapeuticClassId>
</Product>
</Products>
</CompetitorProductsResponse>
<CompetitorProductsResponse>
<Products>
<Product>
<BrandNameBenefitType>sample string 6</BrandNameBenefitType>
<CompareDrugBenefitType>sample string 7</CompareDrugBenefitType>
<DisplayName>sample string 4</DisplayName>
<Drug xmlns:d5p1="http://api.mmitnetwork.com/formulary/products">
<d5p1:Brand>sample string 5</d5p1:Brand>
<d5p1:Description>sample string 4</d5p1:Description>
<d5p1:DrugId>1</d5p1:DrugId>
<d5p1:DrugTypeId>64</d5p1:DrugTypeId>
<d5p1:ImportantSafetyInformation>sample string 9</d5p1:ImportantSafetyInformation>
<d5p1:IsGeneric>true</d5p1:IsGeneric>
<d5p1:IsOwner>true</d5p1:IsOwner>
<d5p1:Logo>sample string 8</d5p1:Logo>
<d5p1:Name>sample string 3</d5p1:Name>
<d5p1:OverTheCounter>true</d5p1:OverTheCounter>
<d5p1:Rank>64</d5p1:Rank>
</Drug>
<IndicationId>5</IndicationId>
<ProductId>1</ProductId>
<TherapeuticClass>sample string 3</TherapeuticClass>
<TherapeuticClassId>2</TherapeuticClassId>
</Product>
<Product>
<BrandNameBenefitType>sample string 6</BrandNameBenefitType>
<CompareDrugBenefitType>sample string 7</CompareDrugBenefitType>
<DisplayName>sample string 4</DisplayName>
<Drug xmlns:d5p1="http://api.mmitnetwork.com/formulary/products">
<d5p1:Brand>sample string 5</d5p1:Brand>
<d5p1:Description>sample string 4</d5p1:Description>
<d5p1:DrugId>1</d5p1:DrugId>
<d5p1:DrugTypeId>64</d5p1:DrugTypeId>
<d5p1:ImportantSafetyInformation>sample string 9</d5p1:ImportantSafetyInformation>
<d5p1:IsGeneric>true</d5p1:IsGeneric>
<d5p1:IsOwner>true</d5p1:IsOwner>
<d5p1:Logo>sample string 8</d5p1:Logo>
<d5p1:Name>sample string 3</d5p1:Name>
<d5p1:OverTheCounter>true</d5p1:OverTheCounter>
<d5p1:Rank>64</d5p1:Rank>
</Drug>
<IndicationId>5</IndicationId>
<ProductId>1</ProductId>
<TherapeuticClass>sample string 3</TherapeuticClass>
<TherapeuticClassId>2</TherapeuticClassId>
</Product>
</Products>
</CompetitorProductsResponse>
</ArrayOfCompetitorProductsResponse>
Build Request
| Name | Description | Input Value | Type | Required / Optional |
|---|---|---|---|---|
| ProductId |
Id of the Product |
integer |
Required |
|
| ProjectId |
The Id of the Project |
integer |
Required |
|
| IndicationId |
Indication Id |
integer |
Required |
|
| AnchorDrugBenefitType |
Enter 'Pharmacy' to include Pharmacy Benefit Level Competitors . Enter 'Medical' to include Medical Benefit Level Competitors. |
string |
Required |
|
| CompareDrugBenefitType |
Enter 'Pharmacy' to include Pharmacy Benefit Level Competitors . Enter 'Medical' to include Medical Benefit Level Competitors. |
string |
Optional |
Request URL
GET FormTrak/v1/Projects/ProjectId/Products/ProductId/Competitors/DualBenefitsView?IndicationId=IndicationId&AnchorDrugBenefitType=AnchorDrugBenefitType&CompareDrugBenefitType=CompareDrugBenefitType
Status
Response Details