GET api/program/getsingle

Get a single program by name.

Request Information

URI Parameters

Query String: programName={programName}

Name	Description	Type	Additional information
programName	Name of the program of interest. Required.	string	None.

Body Parameters

None.

Response Information

Resource Description

[HTTP Status 200 - OK] A single program.

Type: Program

Name	Description	Type	Additional information
id	The unique ID of the program.	globally unique identifier	None.
isActive	A flag indicating whether or not the program is active and available for use by members and referrals.	boolean	None.
name		string	None.
type	The type of referral program. 'Web' or 'Form'.	string	None.
title		string	None.
memberOffer	A description of the incentive for the member.	string	None.
referralOffer	A description of the incentive for the referral.	string	None.
directUrl		string	None.
widgetUrl		string	None.

Response Formats

application/json, text/json

Sample:

{
  "id": "8a5b9141-b4e4-456f-914b-1bd96f7f5e95",
  "isActive": true,
  "name": "sample string 3",
  "type": "sample string 4",
  "title": "sample string 5",
  "memberOffer": "sample string 6",
  "referralOffer": "sample string 7",
  "directUrl": "sample string 8",
  "widgetUrl": "sample string 9"
}

application/xml, text/xml

Sample:

<program xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <id>8a5b9141-b4e4-456f-914b-1bd96f7f5e95</id>
  <isActive>true</isActive>
  <name>sample string 3</name>
  <type>sample string 4</type>
  <title>sample string 5</title>
  <memberOffer>sample string 6</memberOffer>
  <referralOffer>sample string 7</referralOffer>
  <directUrl>sample string 8</directUrl>
  <widgetUrl>sample string 9</widgetUrl>
</program>