GET api/data/query?RefId={RefId}&ReferenceNumber={ReferenceNumber}&MinUploadOrder={MinUploadOrder}&MinUploadDate={MinUploadDate}&MaxUploadDate={MaxUploadDate}&MinReadDate={MinReadDate}&MaxReadDate={MaxReadDate}&Sender_OrganizationNumber={Sender_OrganizationNumber}&Recipient_OrganizationNumber={Recipient_OrganizationNumber}&Folders={Folders}&IncludedFileExtensions={IncludedFileExtensions}&ExcludedFileExtensions={ExcludedFileExtensions}&IncludedTagsAny={IncludedTagsAny}&IncludedTagsAll={IncludedTagsAll}&ExcludedTags={ExcludedTags}&ListLength={ListLength}

Returns list of messages matching seach criteria given by query parameters.

Request Information

URI Parameters

Name	Description	Type	Additional information
RefId	RefId property of searched message. If set, at most one record will be returned.	globally unique identifier	None.
ReferenceNumber	Reference number of searched message. Optional. If set, all returned records will have this Reference number.	string	None.
MinUploadOrder	Lower bound od UploadOrder property. Optional. If set, all returned records will have UploadOrder property equal or greater then given MinUploadOrder parameter.	integer	None.
MinUploadDate	Lower bound od UploadDate property. Optional. If set, all returned records will have UploadDate property equal or greater then given MinUploadDate parameter.	date	None.
MaxUploadDate	Upper bound od UploadDate property. Optional. If set, all returned records will have UploadDate property less then given MaxUploadDate parameter.	date	None.
MinReadDate	Lower bound od ReadDate property. Optional. If set, all returned records will have ReadDate property equal or greater then given MinReadDate parameter.	date	None.
MaxReadDate	Upper bound od ReadDate property. Optional. If set, all returned records will have ReadDate property less then given MaxReadDate parameter.	date	None.
Sender_OrganizationNumber		string	None.
Recipient_OrganizationNumber		string	None.
Folders	Comma separated list of searched folders. Optional. If not set, default value "inbox,outbox,deleted" is used. Allowed values are { inbox \| outbox \| deleted \| own }.	string	None.
IncludedFileExtensions	Comma separated list of searched file extensions. Optional. Extensions are stored without leading period (for example zip, isdoc, isdocx, xml and so on).	string	None.
ExcludedFileExtensions	Comma separated list of file extensions to excluded from result set. Optional. Extensions are stored without leading period (for example zip, isdoc, isdocx, xml and so on).	string	None.
IncludedTagsAny	Comma separated list of tags of searched messages. Optional. If message has any of searched tags, will be included in result set.	string	None.
IncludedTagsAll	Comma separated list of tags of searched messages. Optional. Message must have all tags to be included in result set.	string	None.
ExcludedTags	Comma separated list of excluded tags of searched messages. Optional. If message has any of excluded tags, will be excluded from result set.	string	None.
ListLength	Maximal length of list to be returned. Optional. If not set all records matching search criteria will be returned.	integer	None.

Body Parameters

None.

Response Information

Resource Description

Returns list of messages matching seach criteria given by query parameters.

Collection of MessageViewModel

Name	Description	Type	Additional information
RefId	Referential id.	globally unique identifier	None.
Sender_OrganizationNumber		string	String length: inclusive between 0 and 32
Recipient_OrganizationNumber		string	String length: inclusive between 0 and 32
Recipient_RegisteredMailAddress		string	None.
UploadDate		date	None.
Matter		string	String length: inclusive between 0 and 255
FileName		string	String length: inclusive between 0 and 255
ContentType		string	String length: inclusive between 0 and 255
ContentLength		integer	None.
IsRead		boolean	None.
RowVersion		Collection of byte	None.
UploadOrder		integer	None.
ReferenceNumber		string	String length: inclusive between 0 and 50
ReadDate		date	None.
SenderMessageKey		string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "RefId": "15c837f7-c75d-40f5-b1fe-a35299cbc1ac",
    "Sender_OrganizationNumber": "sample string 2",
    "Recipient_OrganizationNumber": "sample string 3",
    "Recipient_RegisteredMailAddress": "sample string 4",
    "UploadDate": "2024-05-05T01:11:09.3016929+02:00",
    "Matter": "sample string 6",
    "FileName": "sample string 7",
    "ContentType": "sample string 8",
    "ContentLength": 9,
    "IsRead": true,
    "RowVersion": "QEA=",
    "UploadOrder": 11,
    "ReferenceNumber": "sample string 12",
    "ReadDate": "2024-05-05T01:11:09.3016929+02:00",
    "SenderMessageKey": "sample string 13"
  },
  {
    "RefId": "15c837f7-c75d-40f5-b1fe-a35299cbc1ac",
    "Sender_OrganizationNumber": "sample string 2",
    "Recipient_OrganizationNumber": "sample string 3",
    "Recipient_RegisteredMailAddress": "sample string 4",
    "UploadDate": "2024-05-05T01:11:09.3016929+02:00",
    "Matter": "sample string 6",
    "FileName": "sample string 7",
    "ContentType": "sample string 8",
    "ContentLength": 9,
    "IsRead": true,
    "RowVersion": "QEA=",
    "UploadOrder": 11,
    "ReferenceNumber": "sample string 12",
    "ReadDate": "2024-05-05T01:11:09.3016929+02:00",
    "SenderMessageKey": "sample string 13"
  }
]