GET api/Venues/GetActiveVenuesByFranchisee?franchiseeId={franchiseeId}

Get all active venues for franchisee

Request Information

URI Parameters

Name	Description	Type	Additional information
franchiseeId		integer	Required

Body Parameters

None.

Response Information

Resource Description

List of venues

Collection of BO.Models.Venues.Venue

Name	Type	Additional information
VenueId	integer	None.
Name	string	None.
Suburb	string	None.
StateId	integer	None.
Postcode	string	None.
Address	string	None.
Phone	string	None.
Email	string	None.
Comment	string	None.
Longitude	string	None.
Latitude	string	None.
FranchiseeId	integer	None.
Franchisee	BO.Models.Franchisees.Franchisee	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$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
    }
  },
  {
    "$ref": "2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfVenue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BO.Models.Venues">
  <Venue>
    <Address>sample string 6</Address>
    <Comment>sample string 9</Comment>
    <Email>sample string 8</Email>
    <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>
    </Franchisee>
    <FranchiseeId>12</FranchiseeId>
    <Latitude>sample string 11</Latitude>
    <Longitude>sample string 10</Longitude>
    <Name>sample string 2</Name>
    <Phone>sample string 7</Phone>
    <Postcode>sample string 5</Postcode>
    <StateId>4</StateId>
    <Suburb>sample string 3</Suburb>
    <VenueId>1</VenueId>
  </Venue>
  <Venue>
    <Address>sample string 6</Address>
    <Comment>sample string 9</Comment>
    <Email>sample string 8</Email>
    <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>
    </Franchisee>
    <FranchiseeId>12</FranchiseeId>
    <Latitude>sample string 11</Latitude>
    <Longitude>sample string 10</Longitude>
    <Name>sample string 2</Name>
    <Phone>sample string 7</Phone>
    <Postcode>sample string 5</Postcode>
    <StateId>4</StateId>
    <Suburb>sample string 3</Suburb>
    <VenueId>1</VenueId>
  </Venue>
</ArrayOfVenue>