POST organization/information
Request Information
URI Parameters
None.
Body Parameters
EntitySaveModel| Name | Description | 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>95338ed4-0d50-4e6a-8ff3-1cc68e207cf6</Id>
<ProgramYear>3</ProgramYear>
<TotalDomesticSales>1</TotalDomesticSales>
<TotalExportSales>1</TotalExportSales>
<Year>sample string 2</Year>
</BrandedProductSalesModel>
<BrandedProductSalesModel>
<Id>95338ed4-0d50-4e6a-8ff3-1cc68e207cf6</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>a3bd161b-f6f1-45da-9730-00fe6cbc5ddf</Id>
<ProgramYear>3</ProgramYear>
<SalesNotIncreasedComments>sample string 4</SalesNotIncreasedComments>
<TotalSales>1</TotalSales>
<Year>sample string 2</Year>
</CountryProductSalesModel>
<CountryProductSalesModel>
<Id>a3bd161b-f6f1-45da-9730-00fe6cbc5ddf</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>1471a52d-adbd-40f9-83ea-62840cc5e725</CountryActivityId>
<Description>sample string 4</Description>
<EligibleExpense>5</EligibleExpense>
<ExpenseId>33c75f82-8b27-489d-8416-b13a4fb399d1</ExpenseId>
<IsForeignTradeShowsMissions>true</IsForeignTradeShowsMissions>
<PromotionPlan>sample string 3</PromotionPlan>
</MarketingPlanActivityModel>
<MarketingPlanActivityModel>
<BrandedReimbursementRate>1</BrandedReimbursementRate>
<Checked>true</Checked>
<CountryActivityId>1471a52d-adbd-40f9-83ea-62840cc5e725</CountryActivityId>
<Description>sample string 4</Description>
<EligibleExpense>5</EligibleExpense>
<ExpenseId>33c75f82-8b27-489d-8416-b13a4fb399d1</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>ec3d984e-1859-47a2-94f4-7012f99c910f</ProductId>
<ProductSubSubType>sample string 6</ProductSubSubType>
<ProductSubType>sample string 5</ProductSubType>
<ProductType>sample string 4</ProductType>
<PromotedProductId>b32c9efa-e129-45ab-b254-2595ffd70c9d</PromotedProductId>
</PromotedProductsModel>
<PromotedProductsModel>
<BrandName>sample string 3</BrandName>
<Checked>true</Checked>
<NewToMarket>true</NewToMarket>
<ProductId>ec3d984e-1859-47a2-94f4-7012f99c910f</ProductId>
<ProductSubSubType>sample string 6</ProductSubSubType>
<ProductSubType>sample string 5</ProductSubType>
<ProductType>sample string 4</ProductType>
<PromotedProductId>b32c9efa-e129-45ab-b254-2595ffd70c9d</PromotedProductId>
</PromotedProductsModel>
</PromotedProducts>
<RelationshipChanges>
<RelationshipChangeModel>
<EntityId>bbf081cf-6fac-4dcf-9616-a4e2c6aed04f</EntityId>
<Id>sample string 1</Id>
<RelationshipName>sample string 3</RelationshipName>
<Status>sample string 2</Status>
<TargetEntityType>sample string 4</TargetEntityType>
</RelationshipChangeModel>
<RelationshipChangeModel>
<EntityId>bbf081cf-6fac-4dcf-9616-a4e2c6aed04f</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>