POST api/Reciepe
Request Information
URI Parameters
None.
Body Parameters
ReciepeInsertUpdateRequestModelName | Description | Type | Additional information |
---|---|---|---|
ReciepeID | integer |
None. |
|
ReciepeCode | string |
Required Max length: 50 |
|
ReciepeName | string |
Required Max length: 250 |
|
RecipeDescription | string |
None. |
|
CostPrice | decimal number |
Required |
|
SalePrice | decimal number |
Required |
|
ProfitPercentage | decimal number |
None. |
|
Category | integer |
None. |
|
SubCategory | integer |
None. |
|
SubCategory2 | integer |
None. |
|
SubCategory3 | integer |
None. |
|
UserID | integer |
Required |
|
APIKey | string |
None. |
|
RecipeItems | Collection of RecipeItemRequestModel |
None. |
Request Formats
application/json, text/json, text/plain, text/html
Sample:
{ "reciepeID": 1, "reciepeCode": "sample string 1", "reciepeName": "sample string 2", "recipeDescription": "sample string 3", "costPrice": 4.0, "salePrice": 5.0, "profitPercentage": 6.0, "category": 7, "subCategory": 1, "subCategory2": 1, "subCategory3": 1, "userID": 8, "apiKey": "sample string 9", "recipeItems": [ { "recipeItemID": 1, "ingredientID": 1, "qty": 2.0, "cost": 3.0, "uomid": 4, "totalPrice": 5.0 }, { "recipeItemID": 1, "ingredientID": 1, "qty": 2.0, "cost": 3.0, "uomid": 4, "totalPrice": 5.0 } ] }
application/xml, text/xml
Sample:
<ReciepeInsertUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"> <APIKey>sample string 9</APIKey> <Category>7</Category> <CostPrice>4</CostPrice> <ProfitPercentage>6</ProfitPercentage> <ReciepeCode>sample string 1</ReciepeCode> <ReciepeID>1</ReciepeID> <ReciepeName>sample string 2</ReciepeName> <RecipeDescription>sample string 3</RecipeDescription> <RecipeItems> <RecipeItemRequestModel> <Cost>3</Cost> <IngredientID>1</IngredientID> <Qty>2</Qty> <RecipeItemID>1</RecipeItemID> <TotalPrice>5</TotalPrice> <UOMID>4</UOMID> </RecipeItemRequestModel> <RecipeItemRequestModel> <Cost>3</Cost> <IngredientID>1</IngredientID> <Qty>2</Qty> <RecipeItemID>1</RecipeItemID> <TotalPrice>5</TotalPrice> <UOMID>4</UOMID> </RecipeItemRequestModel> </RecipeItems> <SalePrice>5</SalePrice> <SubCategory>1</SubCategory> <SubCategory2>1</SubCategory2> <SubCategory3>1</SubCategory3> <UserID>8</UserID> </ReciepeInsertUpdateRequestModel>
multipart/form-data
Sample:
<ReciepeInsertUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><APIKey>sample string 9</APIKey><Category>7</Category><CostPrice>4</CostPrice><ProfitPercentage>6</ProfitPercentage><ReciepeCode>sample string 1</ReciepeCode><ReciepeID>1</ReciepeID><ReciepeName>sample string 2</ReciepeName><RecipeDescription>sample string 3</RecipeDescription><RecipeItems><RecipeItemRequestModel><Cost>3</Cost><IngredientID>1</IngredientID><Qty>2</Qty><RecipeItemID>1</RecipeItemID><TotalPrice>5</TotalPrice><UOMID>4</UOMID></RecipeItemRequestModel><RecipeItemRequestModel><Cost>3</Cost><IngredientID>1</IngredientID><Qty>2</Qty><RecipeItemID>1</RecipeItemID><TotalPrice>5</TotalPrice><UOMID>4</UOMID></RecipeItemRequestModel></RecipeItems><SalePrice>5</SalePrice><SubCategory>1</SubCategory><SubCategory2>1</SubCategory2><SubCategory3>1</SubCategory3><UserID>8</UserID></ReciepeInsertUpdateRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CommonResponseDataModelName | Description | Type | Additional information |
---|---|---|---|
ReturnID | integer |
Required |
|
Message | string |
Required |
|
Successful | boolean |
Required |
|
Code | integer |
None. |
|
TotalRecord | integer |
None. |
Response Formats
application/json, text/json, text/plain, text/html
Sample:
{ "returnID": 1, "message": "sample string 2", "successful": true, "code": 4, "totalRecord": 5 }
application/xml, text/xml
Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"> <Code>4</Code> <Message>sample string 2</Message> <ReturnID>1</ReturnID> <Successful>true</Successful> <TotalRecord>5</TotalRecord> </CommonResponseDataModel>
multipart/form-data
Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>