POST api/AdminService/GetMailHistory

Documentation for 'GetMailHistory'.

Request Information

Parameters

NameDescriptionAdditional information
request
Documentation for 'request'.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "EmailTo": "sample string 1",
  "StartRow": 2,
  "EndRow": 3
}

application/xml, text/xml

Sample:
<MailHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.Admin">
  <EmailTo>sample string 1</EmailTo>
  <EndRow>3</EndRow>
  <StartRow>2</StartRow>
</MailHistoryRequest>

application/x-www-form-urlencoded

Sample:

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

Response Information

Response body formats

application/json, text/json

Sample:
{
  "status": "sample string 1",
  "Message": {
    "mailItemsList": [
      {
        "Id": 1,
        "EmailTo": "sample string 2",
        "EmailSubject": "sample string 3",
        "SentOn": "2026-01-11T19:32:09.9058531+00:00",
        "MailType": "sample string 5",
        "EmailFile": "sample string 6",
        "ObjectID": "sample string 7"
      },
      {
        "Id": 1,
        "EmailTo": "sample string 2",
        "EmailSubject": "sample string 3",
        "SentOn": "2026-01-11T19:32:09.9058531+00:00",
        "MailType": "sample string 5",
        "EmailFile": "sample string 6",
        "ObjectID": "sample string 7"
      },
      {
        "Id": 1,
        "EmailTo": "sample string 2",
        "EmailSubject": "sample string 3",
        "SentOn": "2026-01-11T19:32:09.9058531+00:00",
        "MailType": "sample string 5",
        "EmailFile": "sample string 6",
        "ObjectID": "sample string 7"
      }
    ],
    "TotalCount": {
      "RecordCount": 1
    }
  }
}

application/xml, text/xml

Sample:
<ResponseBaseOfListMailHistoryResponseraCNGjCh xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.MessageBase">
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.Admin">
    <d2p1:TotalCount>
      <d2p1:RecordCount>1</d2p1:RecordCount>
    </d2p1:TotalCount>
    <d2p1:mailItemsList>
      <d2p1:MailItems>
        <d2p1:EmailFile>sample string 6</d2p1:EmailFile>
        <d2p1:EmailSubject>sample string 3</d2p1:EmailSubject>
        <d2p1:EmailTo>sample string 2</d2p1:EmailTo>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:MailType>sample string 5</d2p1:MailType>
        <d2p1:ObjectID>sample string 7</d2p1:ObjectID>
        <d2p1:SentOn>2026-01-11T19:32:09.9058531+00:00</d2p1:SentOn>
      </d2p1:MailItems>
      <d2p1:MailItems>
        <d2p1:EmailFile>sample string 6</d2p1:EmailFile>
        <d2p1:EmailSubject>sample string 3</d2p1:EmailSubject>
        <d2p1:EmailTo>sample string 2</d2p1:EmailTo>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:MailType>sample string 5</d2p1:MailType>
        <d2p1:ObjectID>sample string 7</d2p1:ObjectID>
        <d2p1:SentOn>2026-01-11T19:32:09.9058531+00:00</d2p1:SentOn>
      </d2p1:MailItems>
      <d2p1:MailItems>
        <d2p1:EmailFile>sample string 6</d2p1:EmailFile>
        <d2p1:EmailSubject>sample string 3</d2p1:EmailSubject>
        <d2p1:EmailTo>sample string 2</d2p1:EmailTo>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:MailType>sample string 5</d2p1:MailType>
        <d2p1:ObjectID>sample string 7</d2p1:ObjectID>
        <d2p1:SentOn>2026-01-11T19:32:09.9058531+00:00</d2p1:SentOn>
      </d2p1:MailItems>
    </d2p1:mailItemsList>
  </Message>
  <status>sample string 1</status>
</ResponseBaseOfListMailHistoryResponseraCNGjCh>