GET api/Participations?portalId={portalId}

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

Name	Description	Type	Additional information
portalId	The contacts portalid	System.String	Required

Body Parameters

None.

Response Information

Resource Description

IEnumerable of type Participation

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

Name	Type	Additional information
Id	System.String	None.
CycleStartDate	System.String	None.
CycleEndDate	System.String	None.
StartDate	System.String	None.
JoinDate	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",
    "JoinDate": "sample string 5",
    "EndDate": "sample string 6",
    "PaidThruDate": "sample string 7",
    "BillThruDate": "sample string 8",
    "Status": "sample string 9",
    "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"
    },
    "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 10",
    "WebProductNextCategoryId": "sample string 11",
    "WebCategoryFilterId": "sample string 12",
    "AvailableForRenewal": true,
    "International": true
  },
  {
    "Id": "sample string 1",
    "CycleStartDate": "sample string 2",
    "CycleEndDate": "sample string 3",
    "StartDate": "sample string 4",
    "JoinDate": "sample string 5",
    "EndDate": "sample string 6",
    "PaidThruDate": "sample string 7",
    "BillThruDate": "sample string 8",
    "Status": "sample string 9",
    "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"
    },
    "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 10",
    "WebProductNextCategoryId": "sample string 11",
    "WebCategoryFilterId": "sample string 12",
    "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 8</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 6</EndDate>
    <Id>sample string 1</Id>
    <International>true</International>
    <JoinDate>sample string 5</JoinDate>
    <PaidThruDate>sample string 7</PaidThruDate>
    <ParticipationType>sample string 10</ParticipationType>
    <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>
    <StartDate>sample string 4</StartDate>
    <Status>sample string 9</Status>
    <WebCategoryFilterId>sample string 12</WebCategoryFilterId>
    <WebProductNextCategoryId>sample string 11</WebProductNextCategoryId>
  </Participation>
  <Participation>
    <AvailableForRenewal>true</AvailableForRenewal>
    <BillThruDate>sample string 8</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 6</EndDate>
    <Id>sample string 1</Id>
    <International>true</International>
    <JoinDate>sample string 5</JoinDate>
    <PaidThruDate>sample string 7</PaidThruDate>
    <ParticipationType>sample string 10</ParticipationType>
    <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>
    <StartDate>sample string 4</StartDate>
    <Status>sample string 9</Status>
    <WebCategoryFilterId>sample string 12</WebCategoryFilterId>
    <WebProductNextCategoryId>sample string 11</WebProductNextCategoryId>
  </Participation>
</ArrayOfParticipation>

GET api/Participations?portalId={portalId}

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body