GET api/Message/Get?term={term}&fields={fields}&contactForm={contactForm}&hash={hash}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
term

string

Required

fields

SearchFields

Required

contactForm

string

Required

hash

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Message
NameDescriptionTypeAdditional information
Date

string

None.

Id

integer

None.

Readed

boolean

None.

Subject

string

None.

Owner

string

None.

Sender

string

None.

Text

string

None.

Preferences

Collection of Preference

None.

MarketingRegisterEventDate

date

None.

SiteId

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Date": "sample string 1",
    "Id": 2,
    "Readed": true,
    "Subject": "sample string 4",
    "Owner": "sample string 5",
    "Sender": "sample string 6",
    "Text": "sample string 7",
    "Preferences": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "MarketingRegisterEventDate": "2024-05-03T00:37:57.1347308-03:00",
    "SiteId": 8
  },
  {
    "Date": "sample string 1",
    "Id": 2,
    "Readed": true,
    "Subject": "sample string 4",
    "Owner": "sample string 5",
    "Sender": "sample string 6",
    "Text": "sample string 7",
    "Preferences": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "MarketingRegisterEventDate": "2024-05-03T00:37:57.1347308-03:00",
    "SiteId": 8
  }
]

text/xml

Sample:
<ArrayOfMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoLCms.Lib.Communications">
  <Message>
    <Date>sample string 1</Date>
    <Id>2</Id>
    <MarketingRegisterEventDate>2024-05-03T00:37:57.1347308-03:00</MarketingRegisterEventDate>
    <Owner>sample string 5</Owner>
    <Preferences>
      <Preference>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </Preference>
      <Preference>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </Preference>
    </Preferences>
    <Readed>true</Readed>
    <Sender>sample string 6</Sender>
    <SiteId>8</SiteId>
    <Subject>sample string 4</Subject>
    <Text>sample string 7</Text>
  </Message>
  <Message>
    <Date>sample string 1</Date>
    <Id>2</Id>
    <MarketingRegisterEventDate>2024-05-03T00:37:57.1347308-03:00</MarketingRegisterEventDate>
    <Owner>sample string 5</Owner>
    <Preferences>
      <Preference>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </Preference>
      <Preference>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </Preference>
    </Preferences>
    <Readed>true</Readed>
    <Sender>sample string 6</Sender>
    <SiteId>8</SiteId>
    <Subject>sample string 4</Subject>
    <Text>sample string 7</Text>
  </Message>
</ArrayOfMessage>