Resources

Parents

The Parents resource allows for the retrieval of Parent information. A Parent may be a Controller (i.e., the one who controls the Formulary Coverage decision making), a Payer (Ex. Aetna, Inc.), or a PBM (Ex. Express Scripts).


Parents Search (using filter criteria)

Parents Search (using filter criteria)

Request URL

GET Formulary/v1/Parents

URI Parameters

Name	Description	Type	Required / Optional
Name	The Parent name that contains this string of characters	string	Optional
ParentTypeId	The Parents with the given ParentType	integer	Optional
StateId	The US State where the Parent has Plans in service	string	Optional
CBSAId	The CBSA (Service Area) where the Parent has Plans in service	integer	Optional
TerritoryId	The Territory Id where the Plan is covered	integer	Optional
ParentId	The Id of the Parent to be returned	integer	Optional
LivesTypeId	The Id to override the types of lives used (Default: 4)	integer	Optional

Resource Description of Response Object

ParentsResponse

Name	Description	Type	Required / Optional
Parents		Collection of Parent	Optional

{
  "Parents": [
    {
      "ParentId": 1,
      "ParentTypeId": 64,
      "Name": "sample string 3",
      "ShortName": "sample string 4"
    },
    {
      "ParentId": 1,
      "ParentTypeId": 64,
      "Name": "sample string 3",
      "ShortName": "sample string 4"
    }
  ]
}

<ParentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/parents">
  <Parents>
    <Parent>
      <Name>sample string 3</Name>
      <ParentId>1</ParentId>
      <ParentTypeId>64</ParentTypeId>
      <ShortName>sample string 4</ShortName>
    </Parent>
    <Parent>
      <Name>sample string 3</Name>
      <ParentId>1</ParentId>
      <ParentTypeId>64</ParentTypeId>
      <ShortName>sample string 4</ShortName>
    </Parent>
  </Parents>
</ParentsResponse>

Build Request

Parameters
Headers

Name	Description	Type	Required / Optional
Name	The Parent name that contains this string of characters	string	Optional
ParentTypeId	The Parents with the given ParentType	integer	Optional
StateId	The US State where the Parent has Plans in service	string	Optional
CBSAId	The CBSA (Service Area) where the Parent has Plans in service	integer	Optional
TerritoryId	The Territory Id where the Plan is covered	integer	Optional
ParentId	The Id of the Parent to be returned	integer	Optional
LivesTypeId	The Id to override the types of lives used (Default: 4)	integer	Optional

Request URL

GET Formulary/v1/Parents?Name=Name&ParentTypeId=ParentTypeId&StateId=StateId&CBSAId=CBSAId&TerritoryId=TerritoryId&ParentId=ParentId&LivesTypeId=LivesTypeId

Status

Response Details

Data
Headers