PUT api/Products/SaveProductMap

Update an existing Product Map if the ID passed exists or create a new product map.

Request Information

URI Parameters

None.

Body Parameters

The product map object to be updated or created.

APIProductMap
NameDescriptionTypeAdditional information
MapID

integer

None.
MapDescription

string

None.
MapProductList

Collection of Object

None.

Request Formats

application/json, text/json

Sample: 
{"MapID":0,"MapDescription":"","MapProductList":[{"PLU":"","ProductDescription":"","TicketDescription":"","GiftAidProduct":false,"GiftAidPortion":0.0,"Adults":0,"Children":0,"CategoryCode":0,"CategoryName":"","SubCategory":"","Department":"","PriceDescription":"","Price":0.0,"OnHand":0.0,"ProductImage":"","Notes":"","IsKit":false,"LowestKitItemPLU":"","Quantity":0,"SeatReservationID":0,"GiftVoucherReference":"","Donation":false,"ProductUDFs":null}]}

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<APIProductMap xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MapID>0</MapID>
  <MapDescription />
  <MapProductList>
    <APIProduct>
      <PLU />
      <ProductDescription />
      <TicketDescription />
      <GiftAidProduct>false</GiftAidProduct>
      <GiftAidPortion>0</GiftAidPortion>
      <Adults>0</Adults>
      <Children>0</Children>
      <CategoryCode>0</CategoryCode>
      <CategoryName />
      <SubCategory />
      <Department />
      <PriceDescription />
      <Price>0</Price>
      <OnHand>0</OnHand>
      <ProductImage />
      <Notes />
      <IsKit>false</IsKit>
      <LowestKitItemPLU />
      <Quantity>0</Quantity>
      <SeatReservationID>0</SeatReservationID>
      <GiftVoucherReference />
      <Donation>false</Donation>
    </APIProduct>
  </MapProductList>
</APIProductMap>

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample: 
{"Result":"SUCCESS","Message":"The Product Map: Test Map has been saved under ID: 001"}

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<InformationResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>SUCCESS</Result>
  <Message>The Product Map: Test Map has been saved under ID: 001</Message>
</InformationResponse>