GET api/Products/ProductListByCategory/{productCategory}/{visitDate}/{personID}/{accountCode}

Gets a product list associated with the given Product Category name.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
productCategory

Used to state the product category

string

Required

visitDate

Used to state visit date to check for seasonal price discounts.

date

None.

personID

Used to state the person ID to check for customer price discounts.

integer

Default value is 0

accountCode

Used to state the account code to check for account price discounts.

string

Default value is

Body Parameters

None.

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:
[{"ID":0,"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,"TicketCapacity":0,"TicketAvailability":0,"Barcode":"","Diminishing":true,"Discontinued":false,"InActive":false,"StockInUse":true}]

application/xml, text/xml

Sample:
<?xml version="1.0" encoding="utf-16"?>
<APIProducts xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <APIProduct>
    <ID>0</ID>
    <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>
    <TicketCapacity>0</TicketCapacity>
    <TicketAvailability>0</TicketAvailability>
    <Barcode />
    <Diminishing>true</Diminishing>
    <Discontinued>false</Discontinued>
    <InActive>false</InActive>
    <StockInUse>true</StockInUse>
  </APIProduct>
</APIProducts>