GET api/Program/GetProgram?programId={programId}&franchiseeId={franchiseeId}

Returns a program given a programId

Request Information

URI Parameters

Name	Description	Type	Additional information
programId		integer	Required
franchiseeId	franchiseeId	integer	Required

Body Parameters

None.

Response Information

Resource Description

A program

BO.Models.Programs.Program

Name	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:

{
  "ProgramId": 1,
  "Name": "sample string 2",
  "ProgramTypeName": "sample string 3",
  "Days": "sample string 4",
  "StartDate": "2024-11-07T09:26:14.502421+08:00",
  "EndDate": "2024-11-07T09:26:14.502421+08:00",
  "StartTime": "2024-11-07T09:26:14.502421+08:00",
  "Duration": 1,
  "Price": 8.0,
  "VenueId": 9,
  "Venue": {
    "$id": "2",
    "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": "3",
      "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
    }
  }
}

application/xml, text/xml

Sample:

<Program xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BO.Models.Programs">
  <Days>sample string 4</Days>
  <Duration>1</Duration>
  <EndDate>2024-11-07T09:26:14.502421+08:00</EndDate>
  <Name>sample string 2</Name>
  <Price>8</Price>
  <ProgramId>1</ProgramId>
  <ProgramTypeName>sample string 3</ProgramTypeName>
  <StartDate>2024-11-07T09:26:14.502421+08:00</StartDate>
  <StartTime>2024-11-07T09:26:14.502421+08:00</StartTime>
  <Venue xmlns:d2p1="http://schemas.datacontract.org/2004/07/BO.Models.Venues">
    <d2p1:Address>sample string 6</d2p1:Address>
    <d2p1:Comment>sample string 9</d2p1:Comment>
    <d2p1:Email>sample string 8</d2p1:Email>
    <d2p1:Franchisee xmlns:d3p1="http://schemas.datacontract.org/2004/07/BO.Models.Franchisees">
      <d3p1:ABN>sample string 10</d3p1:ABN>
      <d3p1:Active>true</d3p1:Active>
      <d3p1:ContactName>sample string 3</d3p1:ContactName>
      <d3p1:Email>sample string 7</d3p1:Email>
      <d3p1:FranchiseeId>1</d3p1:FranchiseeId>
      <d3p1:IsMaster>true</d3p1:IsMaster>
      <d3p1:MasterId>9</d3p1:MasterId>
      <d3p1:Mobile>sample string 6</d3p1:Mobile>
      <d3p1:Name>sample string 2</d3p1:Name>
      <d3p1:Phone>sample string 5</d3p1:Phone>
      <d3p1:UserName>sample string 4</d3p1:UserName>
    </d2p1:Franchisee>
    <d2p1:FranchiseeId>12</d2p1:FranchiseeId>
    <d2p1:Latitude>sample string 11</d2p1:Latitude>
    <d2p1:Longitude>sample string 10</d2p1:Longitude>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Phone>sample string 7</d2p1:Phone>
    <d2p1:Postcode>sample string 5</d2p1:Postcode>
    <d2p1:StateId>4</d2p1:StateId>
    <d2p1:Suburb>sample string 3</d2p1:Suburb>
    <d2p1:VenueId>1</d2p1:VenueId>
  </Venue>
  <VenueId>9</VenueId>
</Program>