POST api/BrandedProgram?entityId={entityId}

Request Information

URI Parameters

Name	Description	Type	Additional information
entityId		globally unique identifier	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:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Error getting value from 'YearText' on 'FoodExport.Web.Services.Models.BrandedProductSalesModel'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Error getting value from 'YearText' on 'FoodExport.Web.Services.Models.BrandedProductSalesModel'.

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>fb5dc97e-7bae-4846-af6f-9d87ee7cf9d7</Id>
      <ProgramYear>3</ProgramYear>
      <TotalDomesticSales>1</TotalDomesticSales>
      <TotalExportSales>1</TotalExportSales>
      <Year>sample string 2</Year>
    </BrandedProductSalesModel>
    <BrandedProductSalesModel>
      <Id>fb5dc97e-7bae-4846-af6f-9d87ee7cf9d7</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>48a50d45-5c4f-4651-bbcc-7c522d5ab795</Id>
      <ProgramYear>3</ProgramYear>
      <SalesNotIncreasedComments>sample string 4</SalesNotIncreasedComments>
      <TotalSales>1</TotalSales>
      <Year>sample string 2</Year>
    </CountryProductSalesModel>
    <CountryProductSalesModel>
      <Id>48a50d45-5c4f-4651-bbcc-7c522d5ab795</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>57496d89-60a5-4361-b835-18b74f6a7404</CountryActivityId>
      <Description>sample string 4</Description>
      <EligibleExpense>5</EligibleExpense>
      <ExpenseId>b377dd61-ce74-4c08-bc57-0f2f4d9fed01</ExpenseId>
      <IsForeignTradeShowsMissions>true</IsForeignTradeShowsMissions>
      <PromotionPlan>sample string 3</PromotionPlan>
    </MarketingPlanActivityModel>
    <MarketingPlanActivityModel>
      <BrandedReimbursementRate>1</BrandedReimbursementRate>
      <Checked>true</Checked>
      <CountryActivityId>57496d89-60a5-4361-b835-18b74f6a7404</CountryActivityId>
      <Description>sample string 4</Description>
      <EligibleExpense>5</EligibleExpense>
      <ExpenseId>b377dd61-ce74-4c08-bc57-0f2f4d9fed01</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>9d9d00fa-4b19-43d9-98e9-54ccf9436b7e</ProductId>
      <ProductSubSubType>sample string 6</ProductSubSubType>
      <ProductSubType>sample string 5</ProductSubType>
      <ProductType>sample string 4</ProductType>
      <PromotedProductId>57d09383-abda-431d-bab0-99db844ee4a1</PromotedProductId>
    </PromotedProductsModel>
    <PromotedProductsModel>
      <BrandName>sample string 3</BrandName>
      <Checked>true</Checked>
      <NewToMarket>true</NewToMarket>
      <ProductId>9d9d00fa-4b19-43d9-98e9-54ccf9436b7e</ProductId>
      <ProductSubSubType>sample string 6</ProductSubSubType>
      <ProductSubType>sample string 5</ProductSubType>
      <ProductType>sample string 4</ProductType>
      <PromotedProductId>57d09383-abda-431d-bab0-99db844ee4a1</PromotedProductId>
    </PromotedProductsModel>
  </PromotedProducts>
  <RelationshipChanges>
    <RelationshipChangeModel>
      <EntityId>2fd9a662-57dc-4ab7-9c68-00a9a67b9ca2</EntityId>
      <Id>sample string 1</Id>
      <RelationshipName>sample string 3</RelationshipName>
      <Status>sample string 2</Status>
      <TargetEntityType>sample string 4</TargetEntityType>
    </RelationshipChangeModel>
    <RelationshipChangeModel>
      <EntityId>2fd9a662-57dc-4ab7-9c68-00a9a67b9ca2</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:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'EntitySaveModel'.

Response Information

Resource Description

None.