Class GetProductOfferingsRequest

A request to find product offerings

Inheritance
System.Object
GetProductOfferingsRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: EC.ProductsAndPricing.ServiceContract.Product
Assembly: EC.ProductsAndPricing.ServiceContract.dll
Syntax
[VersionedRoute(1, VersionedRouteHttpVerb.Get, "product/offerings")]
[PageableContract(3UL)]
public class GetProductOfferingsRequest : IReturn<GetProductOfferingsResponse>

Properties

View Source

DivisionId

The division id to return, ignored if WithSchools is specified

Declaration
public DivisionId DivisionId { get; set; }
Property Type: DivisionId
View Source

IncludeDates

If true the offerings will include start dates and offering dates.

Declaration
public bool? IncludeDates { get; set; }
Property Type: System.Nullable<System.Boolean>
View Source

IncludePrices

If true the offerings will include unit prices.

Declaration
public bool? IncludePrices { get; set; }
Property Type: System.Nullable<System.Boolean>
View Source

IncludeProducts

If true the offerings will include information about the product that is offered.

Declaration
public bool? IncludeProducts { get; set; }
Property Type: System.Nullable<System.Boolean>
View Source

IncludeSchools

If true the offerings will include information about the school the product is offered at.

Declaration
public bool? IncludeSchools { get; set; }
Property Type: System.Nullable<System.Boolean>
View Source

WithDatesAfter

Only return products with offering/start dates after this date. If null then return products regardless of the date

Declaration
public Date? WithDatesAfter { get; set; }
Property Type: System.Nullable<Date>
View Source

WithDatesBefore

Only return products with offering/start dates before this date. If null then return products regardless of the date

Declaration
public Date? WithDatesBefore { get; set; }
Property Type: System.Nullable<Date>
View Source

WithProducts

A list of product codes to return offerings for. If empty then all products are returned

Declaration
public string[] WithProducts { get; set; }
Property Type: System.String[]
View Source

WithProductTypes

Only return products of these types. If empty then products of all types are returned.

Declaration
public ProductType[] WithProductTypes { get; set; }
Property Type: ProductType[]
View Source

WithSchools

A list of school codes to return offerings for. If empty then all schools are returned

Declaration
public string[] WithSchools { get; set; }
Property Type: System.String[]