POST brandedprogram/prequel/submit/{accountId}/{year}

Request Information

URI Parameters

Name	Description	Type	Additional information
accountId		globally unique identifier	Required
year		string	Required

Body Parameters

EntitySaveModel

Name	Type	Additional information
Id	string	None.
EntityName	string	None.
EntityId	string	None.
DisplayName	string	None.
PrimaryImage	PrimaryImage	None.
Cells	Collection of CellInfoModel	None.
RelationshipChanges	Collection of RelationshipChangeModel	None.
ImportExportRegionChanges	Collection of ImportExportRegionChangeModel	None.
BrandedProgramProductSales	Collection of BrandedProductSalesModel	None.
CountryProductSales	Collection of CountryProductSalesModel	None.
PromotedProducts	Collection of PromotedProductsModel	None.
MarketingPlanExpenses	Collection of MarketingPlanActivityModel	None.
AddNew	boolean	None.
isAmendment	boolean	None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<EntitySaveModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FoodExport.Web.Services.Models">
  <AddNew>true</AddNew>
  <BrandedProgramProductSales>
    <BrandedProductSalesModel>
      <Id>19a170ed-7096-4e5f-a19c-bcb62231a17d</Id>
      <ProgramYear>3</ProgramYear>
      <TotalDomesticSales>1</TotalDomesticSales>
      <TotalExportSales>1</TotalExportSales>
      <Year>sample string 2</Year>
    </BrandedProductSalesModel>
    <BrandedProductSalesModel>
      <Id>19a170ed-7096-4e5f-a19c-bcb62231a17d</Id>
      <ProgramYear>3</ProgramYear>
      <TotalDomesticSales>1</TotalDomesticSales>
      <TotalExportSales>1</TotalExportSales>
      <Year>sample string 2</Year>
    </BrandedProductSalesModel>
  </BrandedProgramProductSales>
  <Cells>
    <CellInfoModel>
      <ClassId>sample string 3</ClassId>
      <EarlyBound>true</EarlyBound>
      <Id>sample string 1</Id>
      <TargetEntityType>sample string 4</TargetEntityType>
      <Text>sample string 2</Text>
    </CellInfoModel>
    <CellInfoModel>
      <ClassId>sample string 3</ClassId>
      <EarlyBound>true</EarlyBound>
      <Id>sample string 1</Id>
      <TargetEntityType>sample string 4</TargetEntityType>
      <Text>sample string 2</Text>
    </CellInfoModel>
  </Cells>
  <CountryProductSales>
    <CountryProductSalesModel>
      <Id>595f1b51-8ec8-4ac7-a37f-77780621d144</Id>
      <ProgramYear>3</ProgramYear>
      <SalesNotIncreasedComments>sample string 4</SalesNotIncreasedComments>
      <TotalSales>1</TotalSales>
      <Year>sample string 2</Year>
    </CountryProductSalesModel>
    <CountryProductSalesModel>
      <Id>595f1b51-8ec8-4ac7-a37f-77780621d144</Id>
      <ProgramYear>3</ProgramYear>
      <SalesNotIncreasedComments>sample string 4</SalesNotIncreasedComments>
      <TotalSales>1</TotalSales>
      <Year>sample string 2</Year>
    </CountryProductSalesModel>
  </CountryProductSales>
  <DisplayName>sample string 4</DisplayName>
  <EntityId>sample string 3</EntityId>
  <EntityName>sample string 2</EntityName>
  <Id>sample string 1</Id>
  <ImportExportRegionChanges>
    <ImportExportRegionChangeModel>
      <CurrentlyExporting>true</CurrentlyExporting>
      <CurrentlyImporting>true</CurrentlyImporting>
      <EntityId>sample string 2</EntityId>
      <Id>sample string 1</Id>
      <InterestedInExporting>true</InterestedInExporting>
      <InterestedInImporting>true</InterestedInImporting>
    </ImportExportRegionChangeModel>
    <ImportExportRegionChangeModel>
      <CurrentlyExporting>true</CurrentlyExporting>
      <CurrentlyImporting>true</CurrentlyImporting>
      <EntityId>sample string 2</EntityId>
      <Id>sample string 1</Id>
      <InterestedInExporting>true</InterestedInExporting>
      <InterestedInImporting>true</InterestedInImporting>
    </ImportExportRegionChangeModel>
  </ImportExportRegionChanges>
  <MarketingPlanExpenses>
    <MarketingPlanActivityModel>
      <BrandedReimbursementRate>1</BrandedReimbursementRate>
      <Checked>true</Checked>
      <CountryActivityId>f6c2ed27-66c6-47a5-adba-66d08502301c</CountryActivityId>
      <Description>sample string 4</Description>
      <EligibleExpense>5</EligibleExpense>
      <ExpenseId>a3d67f53-2fd6-4ce1-b2c0-1684f5bf9b4f</ExpenseId>
      <IsForeignTradeShowsMissions>true</IsForeignTradeShowsMissions>
      <PromotionPlan>sample string 3</PromotionPlan>
    </MarketingPlanActivityModel>
    <MarketingPlanActivityModel>
      <BrandedReimbursementRate>1</BrandedReimbursementRate>
      <Checked>true</Checked>
      <CountryActivityId>f6c2ed27-66c6-47a5-adba-66d08502301c</CountryActivityId>
      <Description>sample string 4</Description>
      <EligibleExpense>5</EligibleExpense>
      <ExpenseId>a3d67f53-2fd6-4ce1-b2c0-1684f5bf9b4f</ExpenseId>
      <IsForeignTradeShowsMissions>true</IsForeignTradeShowsMissions>
      <PromotionPlan>sample string 3</PromotionPlan>
    </MarketingPlanActivityModel>
  </MarketingPlanExpenses>
  <PrimaryImage>
    <CellId>sample string 4</CellId>
    <ContentType>sample string 2</ContentType>
    <FileName>sample string 1</FileName>
    <PrimaryImageBase64>sample string 3</PrimaryImageBase64>
  </PrimaryImage>
  <PromotedProducts>
    <PromotedProductsModel>
      <BrandName>sample string 3</BrandName>
      <Checked>true</Checked>
      <NewToMarket>true</NewToMarket>
      <ProductId>26d2ec42-94bc-4454-82be-e8420eb294b6</ProductId>
      <ProductSubSubType>sample string 6</ProductSubSubType>
      <ProductSubType>sample string 5</ProductSubType>
      <ProductType>sample string 4</ProductType>
      <PromotedProductId>8049d14c-193a-4b3d-8f83-614422126eef</PromotedProductId>
    </PromotedProductsModel>
    <PromotedProductsModel>
      <BrandName>sample string 3</BrandName>
      <Checked>true</Checked>
      <NewToMarket>true</NewToMarket>
      <ProductId>26d2ec42-94bc-4454-82be-e8420eb294b6</ProductId>
      <ProductSubSubType>sample string 6</ProductSubSubType>
      <ProductSubType>sample string 5</ProductSubType>
      <ProductType>sample string 4</ProductType>
      <PromotedProductId>8049d14c-193a-4b3d-8f83-614422126eef</PromotedProductId>
    </PromotedProductsModel>
  </PromotedProducts>
  <RelationshipChanges>
    <RelationshipChangeModel>
      <EntityId>2d39cd84-85b8-4e7d-a376-66ee1b7dc757</EntityId>
      <Id>sample string 1</Id>
      <RelationshipName>sample string 3</RelationshipName>
      <Status>sample string 2</Status>
      <TargetEntityType>sample string 4</TargetEntityType>
    </RelationshipChangeModel>
    <RelationshipChangeModel>
      <EntityId>2d39cd84-85b8-4e7d-a376-66ee1b7dc757</EntityId>
      <Id>sample string 1</Id>
      <RelationshipName>sample string 3</RelationshipName>
      <Status>sample string 2</Status>
      <TargetEntityType>sample string 4</TargetEntityType>
    </RelationshipChangeModel>
  </RelationshipChanges>
  <isAmendment>true</isAmendment>
</EntitySaveModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EntityReference

Name	Description	Type	Additional information
Id		string	None.
Name		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "Name": "sample string 2"
}

application/xml, text/xml

Sample:

<EntityReference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FoodExport.Web.Services.Models">
  <Id>sample string 1</Id>
  <Name>sample string 2</Name>
</EntityReference>