GET api/Application?portalId={portalId}&statusList={statusList}

Retrieves a list of Participation associated with the contact with the specified portal id.
Possible Service Responses:
200/OK - match found and the list of participation records is in the body of the response.
404/Contact Not Found - no match found for the specified portal id.
404/Roles Not Found - no roles found for the specified contact.
500/Internal Server - unexpected server error, details in the body of the response.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
portalId

The contacts portalid

 System.String

Required
statusList

System.String

Required

Body Parameters

None.

Response Information

Resource Description

IEnumerable of type Participation

Altai.Web.Services.Models.Application
NameDescriptionTypeAdditional information
WebProductNextCategoryId

System.String

None.
Id

System.String

None.
CurrentInvoice

Altai.Web.Services.Models.Invoice

None.
ApplicationStatusText

System.String

None.
Program

Altai.Web.Services.Models.Program

None.
IsComplete

System.Boolean

None.
CanPurchase

System.Boolean

None.
CanSchedule

System.Boolean

None.
AllowRecertification

System.Boolean

None.
CertificationDate

System.DateTime

None.
JCO

System.Boolean

None.
JOP

System.Boolean

None.
TotalExperienceAmount

System.Int32

None.
GlobalExperienceAmount

System.Int32

None.
Country

Altai.Web.Services.Models.Country

None.
Address

System.String

None.
Address2

System.String

None.
City

System.String

None.
StateProvince

Altai.Web.Services.Models.StateProvince

None.
PostalCode

System.String

None.
IsAppNew

System.Boolean

None.
HighestEducationLevel

Altai.Web.Services.Models.OptionSetValue

None.
DegreeEarnedDate

System.DateTime

None.
EmploymentLawRequirement

Altai.Web.Services.Models.OptionSetValue

None.
DegreeSpecialty

System.String

None.
StudentStatus

Altai.Web.Services.Models.OptionSetValue

None.

Response Formats

application/json, text/json

Sample: 
{
  "WebProductNextCategoryId": "sample string 1",
  "Id": "sample string 2",
  "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"
      }
    }
  },
  "ApplicationStatusText": "sample string 3",
  "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"
  },
  "IsComplete": true,
  "CanPurchase": true,
  "CanSchedule": true,
  "AllowRecertification": true,
  "CertificationDate": "2024-11-15T18:38:00.2725576+00:00",
  "JCO": true,
  "JOP": true,
  "TotalExperienceAmount": 11,
  "GlobalExperienceAmount": 12,
  "Country": {
    "Id": "sample string 1",
    "Code": "sample string 2",
    "Name": "sample string 3"
  },
  "Address": "sample string 13",
  "Address2": "sample string 14",
  "City": "sample string 15",
  "StateProvince": {
    "Id": "fa7fe6eb-77b5-4bc7-816c-43e2f7a01f41",
    "Code": "sample string 2",
    "Name": "sample string 3",
    "Country": {
      "Id": "sample string 1",
      "Code": "sample string 2",
      "Name": "sample string 3"
    }
  },
  "PostalCode": "sample string 16",
  "IsAppNew": false,
  "HighestEducationLevel": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "DegreeEarnedDate": "2024-11-15T18:38:00.2725576+00:00",
  "EmploymentLawRequirement": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "DegreeSpecialty": "sample string 17",
  "StudentStatus": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  }
}

application/xml, text/xml

Sample: 
<Application xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
  <Address>sample string 13</Address>
  <Address2>sample string 14</Address2>
  <AllowRecertification>true</AllowRecertification>
  <ApplicationStatusText>sample string 3</ApplicationStatusText>
  <CanPurchase>true</CanPurchase>
  <CanSchedule>true</CanSchedule>
  <CertificationDate>2024-11-15T18:38:00.2725576+00:00</CertificationDate>
  <City>sample string 15</City>
  <Country>
    <Code>sample string 2</Code>
    <Id>sample string 1</Id>
    <Name>sample string 3</Name>
  </Country>
  <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>
  <DegreeEarnedDate>2024-11-15T18:38:00.2725576+00:00</DegreeEarnedDate>
  <DegreeSpecialty>sample string 17</DegreeSpecialty>
  <EmploymentLawRequirement>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </EmploymentLawRequirement>
  <GlobalExperienceAmount>12</GlobalExperienceAmount>
  <HighestEducationLevel>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </HighestEducationLevel>
  <Id>sample string 2</Id>
  <IsComplete>true</IsComplete>
  <JCO>true</JCO>
  <JOP>true</JOP>
  <PostalCode>sample string 16</PostalCode>
  <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>
  <StateProvince>
    <Code>sample string 2</Code>
    <Country>
      <Code>sample string 2</Code>
      <Id>sample string 1</Id>
      <Name>sample string 3</Name>
    </Country>
    <Id>fa7fe6eb-77b5-4bc7-816c-43e2f7a01f41</Id>
    <Name>sample string 3</Name>
  </StateProvince>
  <StudentStatus>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </StudentStatus>
  <TotalExperienceAmount>11</TotalExperienceAmount>
  <WebProductNextCategoryId>sample string 1</WebProductNextCategoryId>
</Application>