Cards

The FormTrak resource allows the retrieval of a list of FormTrak cards by product and state or CBSA, or the retrieval of a specific card image (default is PNG format).


FormTrak cards by ProductId and State or CBSA

FormTrak card image

FormTrak cards by ProjectId


FormTrak cards by ProductId and State or CBSA


Request URL
GET FormTrak/v1/Cards


URI Parameters

NameDescription Type Required / Optional
ProductId

The Id of the Product

integer

Required

StateId

The two-letter state abbreviation, or 'US' for National

string

Optional

CBSAId

The 5-digit CBSA code

integer

Optional

TerritoryId

The Territory Id

integer

Optional


Resource Description of Response Object

FormTrakResponse
NameDescription Type Required / Optional
Cards

Collection of Card

Optional


Available Response Formats & Sample Data

{
  "Cards": [
    {
      "CardId": 1,
      "CardTitle": "sample string 2",
      "CardDescription": "sample string 3",
      "TemplateName": "sample string 4",
      "ThumbnailUrl": "sample string 5"
    },
    {
      "CardId": 1,
      "CardTitle": "sample string 2",
      "CardDescription": "sample string 3",
      "TemplateName": "sample string 4",
      "ThumbnailUrl": "sample string 5"
    }
  ]
}
<FormTrakResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formtrak">
  <Cards>
    <Card>
      <CardDescription>sample string 3</CardDescription>
      <CardId>1</CardId>
      <CardTitle>sample string 2</CardTitle>
      <TemplateName>sample string 4</TemplateName>
      <ThumbnailUrl>sample string 5</ThumbnailUrl>
    </Card>
    <Card>
      <CardDescription>sample string 3</CardDescription>
      <CardId>1</CardId>
      <CardTitle>sample string 2</CardTitle>
      <TemplateName>sample string 4</TemplateName>
      <ThumbnailUrl>sample string 5</ThumbnailUrl>
    </Card>
  </Cards>
</FormTrakResponse>

Build Request


NameDescription Input Value Type Required / Optional
ProductId

The Id of the Product

integer

Required

StateId

The two-letter state abbreviation, or 'US' for National

string

Optional

CBSAId

The 5-digit CBSA code

integer

Optional

TerritoryId

The Territory Id

integer

Optional





Request URL

GET FormTrak/v1/Cards?ProductId=ProductId&StateId=StateId&CBSAId=CBSAId&TerritoryId=TerritoryId

Status

Response Details

            
            

FormTrak card image


Request URL
GET FormTrak/v1/Cards/{CardId}


URI Parameters

NameDescription Type Required / Optional
CardId

The Id of the Card

integer

Required


Resource Description of Response Object

A file stream. The default format is PNG. To specify a different format, change the request header Content-Type. Valid values are application/pdf, image/jpeg, image/gif, or image/png."

HttpResponseMessage
NameDescription Type Required / Optional
Version

Version

Optional

Content

HttpContent

Optional

StatusCode

HttpStatusCode

Optional

ReasonPhrase

string

Optional

Headers

Collection of Object

Optional

RequestMessage

HttpRequestMessage

Optional

IsSuccessStatusCode

boolean

Optional


Available Response Formats & Sample Data


Build Request


NameDescription Input Value Type Required / Optional
CardId

The Id of the Card

integer

Required





Request URL

GET FormTrak/v1/Cards/CardId

Status

Response Details

            
            

FormTrak cards by ProjectId


Request URL
GET FormTrak/v1/cards/CardsProjects


URI Parameters

NameDescription Type Required / Optional
ProjectId

The id of the project.

integer

Required

CardCreationDate

Date of Card Creation. Please enter in the format: YYYY-MM-DD

date

Optional


Resource Description of Response Object

/>

FormTrakCardProjectResponse
NameDescription Type Required / Optional
CardProjects

Collection of CardProject

Optional


Available Response Formats & Sample Data

{
  "CardProjects": [
    {
      "CardId": 1,
      "CardTitle": "sample string 2",
      "CardDescription": "sample string 3",
      "TemplateName": "sample string 4",
      "ThumbnailUrl": "sample string 5",
      "TerritoryMappingId": "sample string 7",
      "TerritoryType": "sample string 8",
      "ProjectId": 9,
      "ProductId": 10,
      "CreationDate": "sample string 11"
    },
    {
      "CardId": 1,
      "CardTitle": "sample string 2",
      "CardDescription": "sample string 3",
      "TemplateName": "sample string 4",
      "ThumbnailUrl": "sample string 5",
      "TerritoryMappingId": "sample string 7",
      "TerritoryType": "sample string 8",
      "ProjectId": 9,
      "ProductId": 10,
      "CreationDate": "sample string 11"
    }
  ]
}
<FormTrakCardProjectResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formtrak">
  <CardProjects>
    <CardProject>
      <CardDescription>sample string 3</CardDescription>
      <CardId>1</CardId>
      <CardTitle>sample string 2</CardTitle>
      <CreationDate>sample string 11</CreationDate>
      <ProductId>10</ProductId>
      <ProjectId>9</ProjectId>
      <TemplateName>sample string 4</TemplateName>
      <TerritoryMappingId>sample string 7</TerritoryMappingId>
      <TerritoryType>sample string 8</TerritoryType>
      <ThumbnailUrl>sample string 5</ThumbnailUrl>
    </CardProject>
    <CardProject>
      <CardDescription>sample string 3</CardDescription>
      <CardId>1</CardId>
      <CardTitle>sample string 2</CardTitle>
      <CreationDate>sample string 11</CreationDate>
      <ProductId>10</ProductId>
      <ProjectId>9</ProjectId>
      <TemplateName>sample string 4</TemplateName>
      <TerritoryMappingId>sample string 7</TerritoryMappingId>
      <TerritoryType>sample string 8</TerritoryType>
      <ThumbnailUrl>sample string 5</ThumbnailUrl>
    </CardProject>
  </CardProjects>
</FormTrakCardProjectResponse>

Build Request


NameDescription Input Value Type Required / Optional
ProjectId

The id of the project.

integer

Required

CardCreationDate

Date of Card Creation. Please enter in the format: YYYY-MM-DD

date

Optional





Request URL

GET FormTrak/v1/cards/CardsProjects?ProjectId=ProjectId&CardCreationDate=CardCreationDate

Status

Response Details