PromotionalTiers
The FormTrak Coverage resource allows for the retrieval of Formulary Coverage information that has been configured for promotional use. The coverage information can grouped by the Controller and is accompanied by a winning status and percentage. The plans or controllers can also be filtered by a number of parameters. Last, the Coverage Statements by Product endpoint allows for the return of multiple promotional statements per product. Statements are ranked and validated based on rules that can be define per brand.
List of PromotionalTiers
Request URL
GET FormTrak/v1/Projects/{ProjectId}/PromotionalTiers
URI Parameters
Name | Description | Type | Required / Optional |
---|---|---|---|
ProjectId |
The FormTrak projectId the product is associated with. |
integer |
Required |
Resource Description of Response Object
PromotionalTiersResponseName | Description | Type | Required / Optional |
---|---|---|---|
PromotionalTiers | Collection of PromotionalTier |
Optional |
Available Response Formats & Sample Data
{ "PromotionalTiers": [ { "PromotionalTierId": 1, "Name": "sample string 2", "Color": "sample string 3", "Sort": 4 }, { "PromotionalTierId": 1, "Name": "sample string 2", "Color": "sample string 3", "Sort": 4 } ] }
<PromotionalTiersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/coverages"> <PromotionalTiers> <PromotionalTier> <Color>sample string 3</Color> <Name>sample string 2</Name> <PromotionalTierId>1</PromotionalTierId> <Sort>4</Sort> </PromotionalTier> <PromotionalTier> <Color>sample string 3</Color> <Name>sample string 2</Name> <PromotionalTierId>1</PromotionalTierId> <Sort>4</Sort> </PromotionalTier> </PromotionalTiers> </PromotionalTiersResponse>
Build Request
Name | Description | Input Value | Type | Required / Optional |
---|---|---|---|---|
ProjectId |
The FormTrak projectId the product is associated with. |
integer |
Required |