POST Api/SystemMessages/Search

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
TextFilter	Filtrowanie w zależności od tekstu. Jeśli null to brak filtrowania.	string	None.
SortOrder	Określa sposób sortowania wyników	MessagesSortEnum	Required
StartDate	Filtruje listę wyników od daty utworzenia.	date	None.
EndDate	Filtruje listę wyników do daty utworzenia.	date	None.
Sender	Filtruje listę wyników według wiadomości od nadawcy.	boolean	None.
Receiver	Filtruje listę wyników według wiadomości od odbiorcy.	boolean	None.
MessageState	Filtruje listę wyników według stanu wiadomości. "null" - wyświetl wszystkie, "0" - odebrane, "1" - nieodebrane	integer	None.
MessageStatus	Filtruje listę wyników według statusu wiadomości. "0" - odbiorca, "1" - nadawca	integer	None.
ItemsPerPage	Ilość obiektów na stronę	integer	None.
CurrentPage	Obecna strona	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "textFilter": "sample string 1",
  "sortOrder": 0,
  "startDate": "2024-05-18T07:53:28.317109+00:00",
  "endDate": "2024-05-18T07:53:28.317109+00:00",
  "sender": true,
  "receiver": true,
  "messageState": 1,
  "messageStatus": 4,
  "itemsPerPage": 5,
  "currentPage": 6
}

multipart/form-data

Sample:

{"textFilter":"sample string 1","sortOrder":0,"startDate":"2024-05-18T07:53:28.317109+00:00","endDate":"2024-05-18T07:53:28.317109+00:00","sender":true,"receiver":true,"messageState":1,"messageStatus":4,"itemsPerPage":5,"currentPage":6}

application/xml, text/xml

Sample:

<MessagesFilter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ItemsPerPage>5</ItemsPerPage>
  <CurrentPage>6</CurrentPage>
  <TextFilter>sample string 1</TextFilter>
  <SortOrder>MessageIdAsc</SortOrder>
  <StartDate />
  <EndDate />
  <Sender>true</Sender>
  <Receiver>true</Receiver>
  <MessageState>1</MessageState>
  <MessageStatus>4</MessageStatus>
</MessagesFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of MessageDto

Name	Type	Additional information
MessageId	integer	Required
ReceiverId	string	None.
SenderId	string	None.
Title	string	None.
Content	string	None.
CreationDate	date	None.
LastAttempt	date	None.
TypeOfMessageId	integer	None.
Phone	string	None.
Email	string	None.
ErrorDesc	string	None.
StartHour	integer	None.
EndHour	integer	None.
ModemId	integer	None.
IsSend	boolean	None.
IsReaded	boolean	None.
OrganizationalUnitId	integer	None.
SenderName	string	None.
SenderSurname	string	None.
SenderDefaultRole	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "messageId": 1,
    "receiverId": "sample string 2",
    "senderId": "sample string 3",
    "title": "sample string 4",
    "content": "sample string 5",
    "creationDate": "2024-05-18T07:53:28.3326966+00:00",
    "lastAttempt": "2024-05-18T07:53:28.3326966+00:00",
    "typeOfMessageId": 7,
    "phone": "sample string 8",
    "email": "sample string 9",
    "errorDesc": "sample string 10",
    "startHour": 1,
    "endHour": 1,
    "modemId": 1,
    "isSend": true,
    "isReaded": true,
    "organizationalUnitId": 1,
    "senderName": "sample string 13",
    "senderSurname": "sample string 14",
    "senderDefaultRole": "sample string 15"
  },
  {
    "messageId": 1,
    "receiverId": "sample string 2",
    "senderId": "sample string 3",
    "title": "sample string 4",
    "content": "sample string 5",
    "creationDate": "2024-05-18T07:53:28.3326966+00:00",
    "lastAttempt": "2024-05-18T07:53:28.3326966+00:00",
    "typeOfMessageId": 7,
    "phone": "sample string 8",
    "email": "sample string 9",
    "errorDesc": "sample string 10",
    "startHour": 1,
    "endHour": 1,
    "modemId": 1,
    "isSend": true,
    "isReaded": true,
    "organizationalUnitId": 1,
    "senderName": "sample string 13",
    "senderSurname": "sample string 14",
    "senderDefaultRole": "sample string 15"
  }
]

multipart/form-data

Sample:

[{"messageId":1,"receiverId":"sample string 2","senderId":"sample string 3","title":"sample string 4","content":"sample string 5","creationDate":"2024-05-18T07:53:28.3326966+00:00","lastAttempt":"2024-05-18T07:53:28.3326966+00:00","typeOfMessageId":7,"phone":"sample string 8","email":"sample string 9","errorDesc":"sample string 10","startHour":1,"endHour":1,"modemId":1,"isSend":true,"isReaded":true,"organizationalUnitId":1,"senderName":"sample string 13","senderSurname":"sample string 14","senderDefaultRole":"sample string 15"},{"messageId":1,"receiverId":"sample string 2","senderId":"sample string 3","title":"sample string 4","content":"sample string 5","creationDate":"2024-05-18T07:53:28.3326966+00:00","lastAttempt":"2024-05-18T07:53:28.3326966+00:00","typeOfMessageId":7,"phone":"sample string 8","email":"sample string 9","errorDesc":"sample string 10","startHour":1,"endHour":1,"modemId":1,"isSend":true,"isReaded":true,"organizationalUnitId":1,"senderName":"sample string 13","senderSurname":"sample string 14","senderDefaultRole":"sample string 15"}]

application/xml, text/xml

Sample:

<ArrayOfMessageDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MessageDto>
    <MessageId>1</MessageId>
    <ReceiverId>sample string 2</ReceiverId>
    <SenderId>sample string 3</SenderId>
    <Title>sample string 4</Title>
    <Content>sample string 5</Content>
    <CreationDate />
    <LastAttempt />
    <TypeOfMessageId>7</TypeOfMessageId>
    <Phone>sample string 8</Phone>
    <Email>sample string 9</Email>
    <ErrorDesc>sample string 10</ErrorDesc>
    <StartHour>1</StartHour>
    <EndHour>1</EndHour>
    <ModemId>1</ModemId>
    <IsSend>true</IsSend>
    <IsReaded>true</IsReaded>
    <OrganizationalUnitId>1</OrganizationalUnitId>
    <SenderName>sample string 13</SenderName>
    <SenderSurname>sample string 14</SenderSurname>
    <SenderDefaultRole>sample string 15</SenderDefaultRole>
  </MessageDto>
  <MessageDto>
    <MessageId>1</MessageId>
    <ReceiverId>sample string 2</ReceiverId>
    <SenderId>sample string 3</SenderId>
    <Title>sample string 4</Title>
    <Content>sample string 5</Content>
    <CreationDate />
    <LastAttempt />
    <TypeOfMessageId>7</TypeOfMessageId>
    <Phone>sample string 8</Phone>
    <Email>sample string 9</Email>
    <ErrorDesc>sample string 10</ErrorDesc>
    <StartHour>1</StartHour>
    <EndHour>1</EndHour>
    <ModemId>1</ModemId>
    <IsSend>true</IsSend>
    <IsReaded>true</IsReaded>
    <OrganizationalUnitId>1</OrganizationalUnitId>
    <SenderName>sample string 13</SenderName>
    <SenderSurname>sample string 14</SenderSurname>
    <SenderDefaultRole>sample string 15</SenderDefaultRole>
  </MessageDto>
</ArrayOfMessageDto>