GET api/Plans/ById/{id}

Get Plan by Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Id for the Plan

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns a Plan

Plan
NameDescriptionTypeAdditional information
Id

GUID Id for Plan. Assigned by system on Create. [REQUIRED]

globally unique identifier

None.

PlanName

The name of the Plan. [NULL]

string

None.

Description

The description for the Plan. [NULL]

string

None.

LimitedApps

Indicates whether the number of Apps is limited. [REQUIRED]

boolean

None.

AppLimit

Indicates the App limit for the Plan. [NULLABLE]

integer

None.

LimitedLocations

Indicates whether the number of Locations is limited. [REQUIRED]

boolean

None.

LocationLimit

Indicates the Location limit for the Plan. [NULLABLE]

integer

None.

LimitedOffers

Indicates whether the number of Offers is limited. [REQUIRED]

boolean

None.

OfferLimit

Indicates the Offer limit for the Plan. [NULLABLE]

integer

None.

Amount

Indicates how much the Plan costs. [NULLABLE]

integer

None.

WithCall

An indicator used by the Platform. [REQUIRED]

boolean

None.

SortNo

The sort number for each Plan. [REQUIRED]

integer

None.

Billable

Indicates whether the Plan is billable. [REQUIRED]

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "111ba727-fff1-4a85-8c12-9015ef775d6a",
  "PlanName": "sample string 2",
  "Description": "sample string 3",
  "LimitedApps": true,
  "AppLimit": 1,
  "LimitedLocations": true,
  "LocationLimit": 1,
  "LimitedOffers": true,
  "OfferLimit": 1,
  "Amount": 1,
  "WithCall": true,
  "SortNo": 8,
  "Billable": true
}

application/xml, text/xml

Sample:
<Plan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FaceOffers.Entities">
  <Amount>1</Amount>
  <AppLimit>1</AppLimit>
  <Billable>true</Billable>
  <Description>sample string 3</Description>
  <Id>111ba727-fff1-4a85-8c12-9015ef775d6a</Id>
  <LimitedApps>true</LimitedApps>
  <LimitedLocations>true</LimitedLocations>
  <LimitedOffers>true</LimitedOffers>
  <LocationLimit>1</LocationLimit>
  <OfferLimit>1</OfferLimit>
  <PlanName>sample string 2</PlanName>
  <SortNo>8</SortNo>
  <WithCall>true</WithCall>
</Plan>