POST v/1/Rest/Public/{client_domain}/PeerToPeer/Team/Members

Search for team members within a P2P microsite based on the supplied set of parameters.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
client_domain

string

None.

Body Parameters

the search parameters.

SearchPeerToPeerTeamMembersParameters
NameDescriptionTypeAdditional information
Team_Id

integer

None.

Page_Id

integer

None.

DateCreatedFrom

date

None.

DateCreatedTo

date

None.

PageStartFrom

integer

None.

PageSize

integer

None.

OrderByField

string

None.

OrderByDirection

OrderByDirections

None.

Request Formats

application/json, text/json

Sample:
{
  "Team_Id": 1,
  "Page_Id": 1,
  "DateCreatedFrom": "2023-01-28T07:39:55.0500841-05:00",
  "DateCreatedTo": "2023-01-28T07:39:55.0500841-05:00",
  "PageStartFrom": 1,
  "PageSize": 1,
  "OrderByField": "sample string 1",
  "OrderByDirection": 1
}

application/xml, text/xml

Sample:
<SearchPeerToPeerTeamMembersParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OrderByDirection>Ascending</OrderByDirection>
  <OrderByField>sample string 1</OrderByField>
  <PageSize>1</PageSize>
  <PageStartFrom>1</PageStartFrom>
  <DateCreatedFrom>2023-01-28T07:39:55.0500841-05:00</DateCreatedFrom>
  <DateCreatedTo>2023-01-28T07:39:55.0500841-05:00</DateCreatedTo>
  <Page_Id>1</Page_Id>
  <Team_Id>1</Team_Id>
</SearchPeerToPeerTeamMembersParameters>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SearchPeerToPeerTeamMembersParameters'.

Response Information

Resource Description

a list of team members.

GetPeerToPeerTeamMembersResponse
NameDescriptionTypeAdditional information
TeamMembers

Collection of PeerToPeerPageRecord

None.

QueryRecordCount

integer

None.

Successful

boolean

None.

Error

PublicApiError

None.

Response Formats

application/json, text/json

Sample:
{
  "TeamMembers": [
    {
      "Active": true,
      "Fundraiser": {
        "Type": 1,
        "Name": "sample string 1",
        "Id": 2
      },
      "Team": {
        "Captain": {
          "Type": 1,
          "Name": "sample string 1",
          "Id": 2
        },
        "TotalRaised": 1.1,
        "Name": "sample string 2",
        "Id": 3
      },
      "TotalRaised": 2.1,
      "Name": "sample string 3",
      "DateCreated": "2023-01-28T07:39:55.0815284-05:00",
      "Id": 5
    },
    {
      "Active": true,
      "Fundraiser": {
        "Type": 1,
        "Name": "sample string 1",
        "Id": 2
      },
      "Team": {
        "Captain": {
          "Type": 1,
          "Name": "sample string 1",
          "Id": 2
        },
        "TotalRaised": 1.1,
        "Name": "sample string 2",
        "Id": 3
      },
      "TotalRaised": 2.1,
      "Name": "sample string 3",
      "DateCreated": "2023-01-28T07:39:55.0815284-05:00",
      "Id": 5
    }
  ],
  "QueryRecordCount": 1,
  "Successful": true,
  "Error": {
    "Code": 0,
    "Message": "sample string 1"
  }
}

application/xml, text/xml

Sample:
<GetPeerToPeerTeamMembersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <Message>sample string 1</Message>
    <Code>None</Code>
  </Error>
  <Successful>true</Successful>
  <QueryRecordCount>1</QueryRecordCount>
  <TeamMembers>
    <PeerToPeerPageRecord>
      <Id>5</Id>
      <DateCreated>2023-01-28T07:39:55.0815284-05:00</DateCreated>
      <Name>sample string 3</Name>
      <Active>true</Active>
      <Fundraiser>
        <Id>2</Id>
        <Name>sample string 1</Name>
        <Type>Organization</Type>
      </Fundraiser>
      <Team>
        <Id>3</Id>
        <Name>sample string 2</Name>
        <Captain>
          <Id>2</Id>
          <Name>sample string 1</Name>
          <Type>Organization</Type>
        </Captain>
        <TotalRaised>1.1</TotalRaised>
      </Team>
      <TotalRaised>2.1</TotalRaised>
    </PeerToPeerPageRecord>
    <PeerToPeerPageRecord>
      <Id>5</Id>
      <DateCreated>2023-01-28T07:39:55.0815284-05:00</DateCreated>
      <Name>sample string 3</Name>
      <Active>true</Active>
      <Fundraiser>
        <Id>2</Id>
        <Name>sample string 1</Name>
        <Type>Organization</Type>
      </Fundraiser>
      <Team>
        <Id>3</Id>
        <Name>sample string 2</Name>
        <Captain>
          <Id>2</Id>
          <Name>sample string 1</Name>
          <Type>Organization</Type>
        </Captain>
        <TotalRaised>1.1</TotalRaised>
      </Team>
      <TotalRaised>2.1</TotalRaised>
    </PeerToPeerPageRecord>
  </TeamMembers>
</GetPeerToPeerTeamMembersResponse>