POST v/1/Rest/Public/{client_domain}/PeerToPeer/Pages

Search for pages 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.

SearchPeerToPeerPagesParameters
NameDescriptionTypeAdditional information
Microsite_Id

integer

None.

Page_Id

integer

None.

Team_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:
{
  "Microsite_Id": 1,
  "Page_Id": 1,
  "Team_Id": 1,
  "DateCreatedFrom": "2023-01-28T08:46:52.1798553-05:00",
  "DateCreatedTo": "2023-01-28T08:46:52.1798553-05:00",
  "PageStartFrom": 1,
  "PageSize": 1,
  "OrderByField": "sample string 1",
  "OrderByDirection": 1
}

application/xml, text/xml

Sample:
<SearchPeerToPeerPagesParameters 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-28T08:46:52.1798553-05:00</DateCreatedFrom>
  <DateCreatedTo>2023-01-28T08:46:52.1798553-05:00</DateCreatedTo>
  <Microsite_Id>1</Microsite_Id>
  <Page_Id>1</Page_Id>
  <Team_Id>1</Team_Id>
</SearchPeerToPeerPagesParameters>

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 'SearchPeerToPeerPagesParameters'.

Response Information

Resource Description

the list of matching pages.

GetPeerToPeerPagesResponse
NameDescriptionTypeAdditional information
Pages

Collection of PeerToPeerPageRecord

None.

QueryRecordCount

integer

None.

Successful

boolean

None.

Error

PublicApiError

None.

Response Formats

application/json, text/json

Sample:
{
  "Pages": [
    {
      "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-28T08:46:52.1954555-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-28T08:46:52.1954555-05:00",
      "Id": 5
    }
  ],
  "QueryRecordCount": 1,
  "Successful": true,
  "Error": {
    "Code": 0,
    "Message": "sample string 1"
  }
}

application/xml, text/xml

Sample:
<GetPeerToPeerPagesResponse 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>
  <Pages>
    <PeerToPeerPageRecord>
      <Id>5</Id>
      <DateCreated>2023-01-28T08:46:52.1954555-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-28T08:46:52.1954555-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>
  </Pages>
</GetPeerToPeerPagesResponse>