GET api/Program/GetProgramsByVenueTerm?venueId={venueId}&termId={termId}
Lists all programs for a venue and term
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
venueId |
VenueId from venu |
integer |
Required |
termId |
TermId from term |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
List of programs for a given venue and term
Collection of BO.Models.Programs.ProgramName | Description | Type | Additional information |
---|---|---|---|
ProgramId | integer |
None. |
|
Name | string |
Required |
|
ProgramTypeName | string |
None. |
|
Days | string |
None. |
|
StartDate | date |
None. |
|
EndDate | date |
None. |
|
StartTime | date |
None. |
|
Duration | integer |
None. |
|
Price | decimal number |
None. |
|
VenueId | integer |
None. |
|
Venue | BO.Models.Venues.Venue |
None. |
Response Formats
application/json, text/json
Sample:
[ { "$id": "2", "ProgramId": 1, "Name": "sample string 2", "ProgramTypeName": "sample string 3", "Days": "sample string 4", "StartDate": "2024-11-07T11:00:53.5088328+08:00", "EndDate": "2024-11-07T11:00:53.5088328+08:00", "StartTime": "2024-11-07T11:00:53.5088328+08:00", "Duration": 1, "Price": 8.0, "VenueId": 9, "Venue": { "$id": "3", "VenueId": 1, "Name": "sample string 2", "Suburb": "sample string 3", "StateId": 4, "Postcode": "sample string 5", "Address": "sample string 6", "Phone": "sample string 7", "Email": "sample string 8", "Comment": "sample string 9", "Longitude": "sample string 10", "Latitude": "sample string 11", "FranchiseeId": 12, "Franchisee": { "$id": "4", "Master": "Sydney South West", "FranchiseeId": 1, "Name": "sample string 2", "ContactName": "sample string 3", "UserName": "sample string 4", "Phone": "sample string 5", "Mobile": "sample string 6", "Email": "sample string 7", "IsMaster": true, "MasterId": 9, "ABN": "sample string 10", "Active": true } } }, { "$ref": "2" } ]
application/xml, text/xml
Sample:
<ArrayOfProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BO.Models.Programs"> <Program> <Days>sample string 4</Days> <Duration>1</Duration> <EndDate>2024-11-07T11:00:53.5088328+08:00</EndDate> <Name>sample string 2</Name> <Price>8</Price> <ProgramId>1</ProgramId> <ProgramTypeName>sample string 3</ProgramTypeName> <StartDate>2024-11-07T11:00:53.5088328+08:00</StartDate> <StartTime>2024-11-07T11:00:53.5088328+08:00</StartTime> <Venue xmlns:d3p1="http://schemas.datacontract.org/2004/07/BO.Models.Venues"> <d3p1:Address>sample string 6</d3p1:Address> <d3p1:Comment>sample string 9</d3p1:Comment> <d3p1:Email>sample string 8</d3p1:Email> <d3p1:Franchisee xmlns:d4p1="http://schemas.datacontract.org/2004/07/BO.Models.Franchisees"> <d4p1:ABN>sample string 10</d4p1:ABN> <d4p1:Active>true</d4p1:Active> <d4p1:ContactName>sample string 3</d4p1:ContactName> <d4p1:Email>sample string 7</d4p1:Email> <d4p1:FranchiseeId>1</d4p1:FranchiseeId> <d4p1:IsMaster>true</d4p1:IsMaster> <d4p1:MasterId>9</d4p1:MasterId> <d4p1:Mobile>sample string 6</d4p1:Mobile> <d4p1:Name>sample string 2</d4p1:Name> <d4p1:Phone>sample string 5</d4p1:Phone> <d4p1:UserName>sample string 4</d4p1:UserName> </d3p1:Franchisee> <d3p1:FranchiseeId>12</d3p1:FranchiseeId> <d3p1:Latitude>sample string 11</d3p1:Latitude> <d3p1:Longitude>sample string 10</d3p1:Longitude> <d3p1:Name>sample string 2</d3p1:Name> <d3p1:Phone>sample string 7</d3p1:Phone> <d3p1:Postcode>sample string 5</d3p1:Postcode> <d3p1:StateId>4</d3p1:StateId> <d3p1:Suburb>sample string 3</d3p1:Suburb> <d3p1:VenueId>1</d3p1:VenueId> </Venue> <VenueId>9</VenueId> </Program> <Program> <Days>sample string 4</Days> <Duration>1</Duration> <EndDate>2024-11-07T11:00:53.5088328+08:00</EndDate> <Name>sample string 2</Name> <Price>8</Price> <ProgramId>1</ProgramId> <ProgramTypeName>sample string 3</ProgramTypeName> <StartDate>2024-11-07T11:00:53.5088328+08:00</StartDate> <StartTime>2024-11-07T11:00:53.5088328+08:00</StartTime> <Venue xmlns:d3p1="http://schemas.datacontract.org/2004/07/BO.Models.Venues"> <d3p1:Address>sample string 6</d3p1:Address> <d3p1:Comment>sample string 9</d3p1:Comment> <d3p1:Email>sample string 8</d3p1:Email> <d3p1:Franchisee xmlns:d4p1="http://schemas.datacontract.org/2004/07/BO.Models.Franchisees"> <d4p1:ABN>sample string 10</d4p1:ABN> <d4p1:Active>true</d4p1:Active> <d4p1:ContactName>sample string 3</d4p1:ContactName> <d4p1:Email>sample string 7</d4p1:Email> <d4p1:FranchiseeId>1</d4p1:FranchiseeId> <d4p1:IsMaster>true</d4p1:IsMaster> <d4p1:MasterId>9</d4p1:MasterId> <d4p1:Mobile>sample string 6</d4p1:Mobile> <d4p1:Name>sample string 2</d4p1:Name> <d4p1:Phone>sample string 5</d4p1:Phone> <d4p1:UserName>sample string 4</d4p1:UserName> </d3p1:Franchisee> <d3p1:FranchiseeId>12</d3p1:FranchiseeId> <d3p1:Latitude>sample string 11</d3p1:Latitude> <d3p1:Longitude>sample string 10</d3p1:Longitude> <d3p1:Name>sample string 2</d3p1:Name> <d3p1:Phone>sample string 7</d3p1:Phone> <d3p1:Postcode>sample string 5</d3p1:Postcode> <d3p1:StateId>4</d3p1:StateId> <d3p1:Suburb>sample string 3</d3p1:Suburb> <d3p1:VenueId>1</d3p1:VenueId> </Venue> <VenueId>9</VenueId> </Program> </ArrayOfProgram>