GET api/Participations?portalId={portalId}&statusCode={statusCode}&programCategory={programCategory}&fromCache={fromCache}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
portalId

System.String

Required
statusCode

System.Int32

Required
programCategory

System.Int32

Required
fromCache

System.Boolean

Required

Body Parameters

None.

Response Information

Resource Description

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

System.String

None.
CycleStartDate

System.String

None.
CycleEndDate

System.String

None.
StartDate

System.String

None.
EndDate

System.String

None.
PaidThruDate

System.String

None.
BillThruDate

System.String

None.
Status

System.String

None.
Program

Altai.Web.Services.Models.Program

None.
CurrentInvoice

Altai.Web.Services.Models.Invoice

None.
ParticipationType

System.String

None.
WebProductNextCategoryId

System.String

None.
WebCategoryFilterId

System.String

None.
AvailableForRenewal

System.Boolean

None.
International

System.Boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "sample string 1",
    "CycleStartDate": "sample string 2",
    "CycleEndDate": "sample string 3",
    "StartDate": "sample string 4",
    "EndDate": "sample string 5",
    "PaidThruDate": "sample string 6",
    "BillThruDate": "sample string 7",
    "Status": "sample string 8",
    "Program": {
      "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",
      "BachelorsDegreeMonthsRequired": 8,
      "DoctorateDegreeMonthsRequired": 9,
      "HighSchoolMonthsRequired": 10,
      "MastersDegreeMonthsRequired": 11
    },
    "CurrentInvoice": {
      "ShoppingCartId": "sample string 1",
      "BalanceDue": 2.0,
      "TotalAmount": 3.0,
      "Number": "sample string 4",
      "Id": "sample string 5",
      "Date": "sample string 6",
      "StatusReason": 7,
      "BillToAddress": {
        "Name": "sample string 1",
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "EmailAddress": "sample string 4",
        "Telephone": "sample string 5",
        "Address": {
          "Id": "sample string 1",
          "Street1": "sample string 2",
          "Street2": "sample string 3",
          "City": "sample string 4",
          "StateOrProvince": "sample string 5",
          "PostalCode": "sample string 6",
          "Country": "sample string 7",
          "AddressType": "sample string 8"
        }
      },
      "ShipToAddress": {
        "Name": "sample string 1",
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "EmailAddress": "sample string 4",
        "Telephone": "sample string 5",
        "Address": {
          "Id": "sample string 1",
          "Street1": "sample string 2",
          "Street2": "sample string 3",
          "City": "sample string 4",
          "StateOrProvince": "sample string 5",
          "PostalCode": "sample string 6",
          "Country": "sample string 7",
          "AddressType": "sample string 8"
        }
      }
    },
    "ParticipationType": "sample string 9",
    "WebProductNextCategoryId": "sample string 10",
    "WebCategoryFilterId": "sample string 11",
    "AvailableForRenewal": true,
    "International": true
  },
  {
    "Id": "sample string 1",
    "CycleStartDate": "sample string 2",
    "CycleEndDate": "sample string 3",
    "StartDate": "sample string 4",
    "EndDate": "sample string 5",
    "PaidThruDate": "sample string 6",
    "BillThruDate": "sample string 7",
    "Status": "sample string 8",
    "Program": {
      "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",
      "BachelorsDegreeMonthsRequired": 8,
      "DoctorateDegreeMonthsRequired": 9,
      "HighSchoolMonthsRequired": 10,
      "MastersDegreeMonthsRequired": 11
    },
    "CurrentInvoice": {
      "ShoppingCartId": "sample string 1",
      "BalanceDue": 2.0,
      "TotalAmount": 3.0,
      "Number": "sample string 4",
      "Id": "sample string 5",
      "Date": "sample string 6",
      "StatusReason": 7,
      "BillToAddress": {
        "Name": "sample string 1",
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "EmailAddress": "sample string 4",
        "Telephone": "sample string 5",
        "Address": {
          "Id": "sample string 1",
          "Street1": "sample string 2",
          "Street2": "sample string 3",
          "City": "sample string 4",
          "StateOrProvince": "sample string 5",
          "PostalCode": "sample string 6",
          "Country": "sample string 7",
          "AddressType": "sample string 8"
        }
      },
      "ShipToAddress": {
        "Name": "sample string 1",
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "EmailAddress": "sample string 4",
        "Telephone": "sample string 5",
        "Address": {
          "Id": "sample string 1",
          "Street1": "sample string 2",
          "Street2": "sample string 3",
          "City": "sample string 4",
          "StateOrProvince": "sample string 5",
          "PostalCode": "sample string 6",
          "Country": "sample string 7",
          "AddressType": "sample string 8"
        }
      }
    },
    "ParticipationType": "sample string 9",
    "WebProductNextCategoryId": "sample string 10",
    "WebCategoryFilterId": "sample string 11",
    "AvailableForRenewal": true,
    "International": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfParticipation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
  <Participation>
    <AvailableForRenewal>true</AvailableForRenewal>
    <BillThruDate>sample string 7</BillThruDate>
    <CurrentInvoice>
      <BalanceDue>2</BalanceDue>
      <BillToAddress>
        <Address>
          <AddressType>sample string 8</AddressType>
          <City>sample string 4</City>
          <Country>sample string 7</Country>
          <Id>sample string 1</Id>
          <PostalCode>sample string 6</PostalCode>
          <StateOrProvince>sample string 5</StateOrProvince>
          <Street1>sample string 2</Street1>
          <Street2>sample string 3</Street2>
        </Address>
        <EmailAddress>sample string 4</EmailAddress>
        <FirstName>sample string 2</FirstName>
        <LastName>sample string 3</LastName>
        <Name>sample string 1</Name>
        <Telephone>sample string 5</Telephone>
      </BillToAddress>
      <Date>sample string 6</Date>
      <Id>sample string 5</Id>
      <Number>sample string 4</Number>
      <ShipToAddress>
        <Address>
          <AddressType>sample string 8</AddressType>
          <City>sample string 4</City>
          <Country>sample string 7</Country>
          <Id>sample string 1</Id>
          <PostalCode>sample string 6</PostalCode>
          <StateOrProvince>sample string 5</StateOrProvince>
          <Street1>sample string 2</Street1>
          <Street2>sample string 3</Street2>
        </Address>
        <EmailAddress>sample string 4</EmailAddress>
        <FirstName>sample string 2</FirstName>
        <LastName>sample string 3</LastName>
        <Name>sample string 1</Name>
        <Telephone>sample string 5</Telephone>
      </ShipToAddress>
      <ShoppingCartId>sample string 1</ShoppingCartId>
      <StatusReason>7</StatusReason>
      <TotalAmount>3</TotalAmount>
    </CurrentInvoice>
    <CycleEndDate>sample string 3</CycleEndDate>
    <CycleStartDate>sample string 2</CycleStartDate>
    <EndDate>sample string 5</EndDate>
    <Id>sample string 1</Id>
    <International>true</International>
    <PaidThruDate>sample string 6</PaidThruDate>
    <ParticipationType>sample string 9</ParticipationType>
    <Program>
      <ActivePriceListId>sample string 7</ActivePriceListId>
      <BachelorsDegreeMonthsRequired>8</BachelorsDegreeMonthsRequired>
      <BillingTermLength>6</BillingTermLength>
      <DoctorateDegreeMonthsRequired>9</DoctorateDegreeMonthsRequired>
      <HighSchoolMonthsRequired>10</HighSchoolMonthsRequired>
      <Id>sample string 1</Id>
      <MastersDegreeMonthsRequired>11</MastersDegreeMonthsRequired>
      <Name>sample string 2</Name>
      <ProgramGroup>sample string 5</ProgramGroup>
      <ShortName>sample string 3</ShortName>
      <Type>sample string 4</Type>
    </Program>
    <StartDate>sample string 4</StartDate>
    <Status>sample string 8</Status>
    <WebCategoryFilterId>sample string 11</WebCategoryFilterId>
    <WebProductNextCategoryId>sample string 10</WebProductNextCategoryId>
  </Participation>
  <Participation>
    <AvailableForRenewal>true</AvailableForRenewal>
    <BillThruDate>sample string 7</BillThruDate>
    <CurrentInvoice>
      <BalanceDue>2</BalanceDue>
      <BillToAddress>
        <Address>
          <AddressType>sample string 8</AddressType>
          <City>sample string 4</City>
          <Country>sample string 7</Country>
          <Id>sample string 1</Id>
          <PostalCode>sample string 6</PostalCode>
          <StateOrProvince>sample string 5</StateOrProvince>
          <Street1>sample string 2</Street1>
          <Street2>sample string 3</Street2>
        </Address>
        <EmailAddress>sample string 4</EmailAddress>
        <FirstName>sample string 2</FirstName>
        <LastName>sample string 3</LastName>
        <Name>sample string 1</Name>
        <Telephone>sample string 5</Telephone>
      </BillToAddress>
      <Date>sample string 6</Date>
      <Id>sample string 5</Id>
      <Number>sample string 4</Number>
      <ShipToAddress>
        <Address>
          <AddressType>sample string 8</AddressType>
          <City>sample string 4</City>
          <Country>sample string 7</Country>
          <Id>sample string 1</Id>
          <PostalCode>sample string 6</PostalCode>
          <StateOrProvince>sample string 5</StateOrProvince>
          <Street1>sample string 2</Street1>
          <Street2>sample string 3</Street2>
        </Address>
        <EmailAddress>sample string 4</EmailAddress>
        <FirstName>sample string 2</FirstName>
        <LastName>sample string 3</LastName>
        <Name>sample string 1</Name>
        <Telephone>sample string 5</Telephone>
      </ShipToAddress>
      <ShoppingCartId>sample string 1</ShoppingCartId>
      <StatusReason>7</StatusReason>
      <TotalAmount>3</TotalAmount>
    </CurrentInvoice>
    <CycleEndDate>sample string 3</CycleEndDate>
    <CycleStartDate>sample string 2</CycleStartDate>
    <EndDate>sample string 5</EndDate>
    <Id>sample string 1</Id>
    <International>true</International>
    <PaidThruDate>sample string 6</PaidThruDate>
    <ParticipationType>sample string 9</ParticipationType>
    <Program>
      <ActivePriceListId>sample string 7</ActivePriceListId>
      <BachelorsDegreeMonthsRequired>8</BachelorsDegreeMonthsRequired>
      <BillingTermLength>6</BillingTermLength>
      <DoctorateDegreeMonthsRequired>9</DoctorateDegreeMonthsRequired>
      <HighSchoolMonthsRequired>10</HighSchoolMonthsRequired>
      <Id>sample string 1</Id>
      <MastersDegreeMonthsRequired>11</MastersDegreeMonthsRequired>
      <Name>sample string 2</Name>
      <ProgramGroup>sample string 5</ProgramGroup>
      <ShortName>sample string 3</ShortName>
      <Type>sample string 4</Type>
    </Program>
    <StartDate>sample string 4</StartDate>
    <Status>sample string 8</Status>
    <WebCategoryFilterId>sample string 11</WebCategoryFilterId>
    <WebProductNextCategoryId>sample string 10</WebProductNextCategoryId>
  </Participation>
</ArrayOfParticipation>