GET api/Programs?type={type}

Retrieves all Programs in the system of a specified type
Possible Service Responses:
200/OK - match found and list of roles record is in the body of the response.
404/Roles Not Found - no match found for the specified role type.
500/Internal Server - unexpected server error, details in the body of the response.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
type

The type of programs to return. Example "Membership, "Subscription", etc.

 System.String

Required

Body Parameters

None.

Response Information

Resource Description

List of Programs

System.Collections.Generic.IEnumerable`1[Altai.Web.Services.Models.Program]
NameDescriptionTypeAdditional information
Id

System.String

None.
Name

System.String

None.
ShortName

System.String

None.
Type

System.String

None.
ProgramGroup

System.String

None.
BillingTermLength

System.Int32

None.
ActivePriceListId

System.String

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "ShortName": "sample string 3",
    "Type": "sample string 4",
    "ProgramGroup": "sample string 5",
    "BillingTermLength": 6,
    "ActivePriceListId": "sample string 7"
  },
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "ShortName": "sample string 3",
    "Type": "sample string 4",
    "ProgramGroup": "sample string 5",
    "BillingTermLength": 6,
    "ActivePriceListId": "sample string 7"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
  <Program>
    <ActivePriceListId>sample string 7</ActivePriceListId>
    <BillingTermLength>6</BillingTermLength>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
    <ProgramGroup>sample string 5</ProgramGroup>
    <ShortName>sample string 3</ShortName>
    <Type>sample string 4</Type>
  </Program>
  <Program>
    <ActivePriceListId>sample string 7</ActivePriceListId>
    <BillingTermLength>6</BillingTermLength>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
    <ProgramGroup>sample string 5</ProgramGroup>
    <ShortName>sample string 3</ShortName>
    <Type>sample string 4</Type>
  </Program>
</ArrayOfProgram>