GET api/programs

Get a list of referral programs. The offset and count parameters can be used to specify the set of programs.

Request Information

URI Parameters

Query String: programId={programId}&offset={offset}&count={count}

NameDescriptionTypeAdditional information
programId

Id of the program of interest. Optional.

string

None.

offset

Starting index (0 based) of the programs. Optional.

integer

Default value is 0

count

Count of programs returned. Optional.

integer

Default value is 2147483647

Body Parameters

None.

Response Information

Resource Description

[HTTP Status 200 - OK] A set of referral programs.

Type: ProgramSet

NameDescriptionTypeAdditional information
programs

Collection of Program

None.

offset

Starting index (0 based) of the elements in the set.

integer

None.

total

Total number of elements in the set.

integer

None.

message

The message provides more information about the results of the client's request. Review this field for error information.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "offset": 1,
  "total": 2,
  "programs": [
    {
      "id": "532f8eb1-0490-43ae-804d-938d5a97cc83",
      "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"
    },
    {
      "id": "532f8eb1-0490-43ae-804d-938d5a97cc83",
      "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"
    }
  ],
  "message": "sample string 3"
}

application/xml, text/xml

Sample:
<ProgramSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <offset>1</offset>
  <total>2</total>
  <message>sample string 3</message>
  <programs>
    <program>
      <id>532f8eb1-0490-43ae-804d-938d5a97cc83</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>
    <program>
      <id>532f8eb1-0490-43ae-804d-938d5a97cc83</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>
  </programs>
</ProgramSet>