GET v/1/Rest/Public/{client_domain}/PeerToPeer/Pages/{microsite_id}

Get a list of pages for the specified P2P microsite.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
microsite_id

the id of the microsite.

string

Required

client_domain

string

None.

Body Parameters

None.

Response Information

Resource Description

a list of 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-28T07:25:13.5647344-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:25:13.5647344-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-28T07:25:13.5647344-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:25:13.5647344-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>