Help Page Home

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

Search for P2P microsite donations based on the supplied set of parameters.

Request Information

URI Parameters

Name	Description	Type	Additional information
client_domain		string	None.

Body Parameters

the search parameters.

SearchPeerToPeerDonationsParameters

Name	Type	Additional information
Transaction_Id	integer	None.
Page_Id	integer	None.
Team_Id	integer	None.
Microsite_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:

{
  "Transaction_Id": 1,
  "Page_Id": 1,
  "Team_Id": 1,
  "Microsite_Id": 1,
  "DateCreatedFrom": "2024-04-19T06:35:32.9842261-04:00",
  "DateCreatedTo": "2024-04-19T06:35:32.9842261-04:00",
  "PageStartFrom": 1,
  "PageSize": 1,
  "OrderByField": "sample string 1",
  "OrderByDirection": 1
}

application/xml, text/xml

Sample:

<SearchPeerToPeerDonationsParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OrderByDirection>Ascending</OrderByDirection>
  <OrderByField>sample string 1</OrderByField>
  <PageSize>1</PageSize>
  <PageStartFrom>1</PageStartFrom>
  <DateCreatedFrom>2024-04-19T06:35:32.9842261-04:00</DateCreatedFrom>
  <DateCreatedTo>2024-04-19T06:35:32.9842261-04:00</DateCreatedTo>
  <Microsite_Id>1</Microsite_Id>
  <Page_Id>1</Page_Id>
  <Team_Id>1</Team_Id>
  <Transaction_Id>1</Transaction_Id>
</SearchPeerToPeerDonationsParameters>

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

Response Information

Resource Description

the list of matching donations.

GetPeerToPeerDonationsResponse

Name	Type	Additional information
Transactions	Collection of TransactionSummary	None.
QueryRecordCount	integer	None.
Successful	boolean	None.
Error	PublicApiError	None.

Response Formats

application/json, text/json

Sample:

{
  "Transactions": [
    {
      "Date": "2024-04-19T06:35:33.3997946-04:00",
      "Amount": 2.1,
      "Contact": {
        "Type": 1,
        "Name": "sample string 1",
        "Id": 2
      },
      "Id": 3
    },
    {
      "Date": "2024-04-19T06:35:33.3997946-04:00",
      "Amount": 2.1,
      "Contact": {
        "Type": 1,
        "Name": "sample string 1",
        "Id": 2
      },
      "Id": 3
    }
  ],
  "QueryRecordCount": 1,
  "Successful": true,
  "Error": {
    "Code": 0,
    "Message": "sample string 1"
  }
}

application/xml, text/xml

Sample:

<GetPeerToPeerDonationsResponse 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>
  <Transactions>
    <TransactionSummary>
      <Id>3</Id>
      <Amount>2.1</Amount>
      <Contact>
        <Id>2</Id>
        <Name>sample string 1</Name>
        <Type>Organization</Type>
      </Contact>
      <Date>2024-04-19T06:35:33.3997946-04:00</Date>
    </TransactionSummary>
    <TransactionSummary>
      <Id>3</Id>
      <Amount>2.1</Amount>
      <Contact>
        <Id>2</Id>
        <Name>sample string 1</Name>
        <Type>Organization</Type>
      </Contact>
      <Date>2024-04-19T06:35:33.3997946-04:00</Date>
    </TransactionSummary>
  </Transactions>
</GetPeerToPeerDonationsResponse>