GET api/Franchisee/GetFranchisee?FranchiseeId={FranchiseeId}

Returns a Franchisee object

Request Information

URI Parameters

Name	Description	Type	Additional information
FranchiseeId		integer	Required

Body Parameters

None.

Response Information

Resource Description

A franchisee object

BO.Models.Franchisees.Franchisee

Name	Type	Additional information
Master	string	None.
FranchiseeId	integer	None.
Name	string	None.
ContactName	string	None.
UserName	string	None.
Phone	string	None.
Mobile	string	None.
Email	string	None.
IsMaster	boolean	None.
MasterId	integer	None.
ABN	string	None.
Active	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "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:

<Franchisee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BO.Models.Franchisees">
  <ABN>sample string 10</ABN>
  <Active>true</Active>
  <ContactName>sample string 3</ContactName>
  <Email>sample string 7</Email>
  <FranchiseeId>1</FranchiseeId>
  <IsMaster>true</IsMaster>
  <MasterId>9</MasterId>
  <Mobile>sample string 6</Mobile>
  <Name>sample string 2</Name>
  <Phone>sample string 5</Phone>
  <UserName>sample string 4</UserName>
</Franchisee>