Help Page Home

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

Get a list of pages for the current microsite you are on in P2P.

Request Information

URI Parameters

Name	Description	Type	Additional information
client_domain		string	None.

Body Parameters

None.

Response Information

Resource Description

GetPeerToPeerPagesResponse

Name	Type	Additional 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": "2024-12-26T10:06:09.0485763-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": "2024-12-26T10:06:09.0485763-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>2024-12-26T10:06:09.0485763-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>2024-12-26T10:06:09.0485763-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>