GET /api/{version}/notice/submission/search

Searches all (published and non published) notice submissions of the eSender based on the parameter provided.

Requires Authorization

The endpoint requires a Basic Auth in the http authorization header. For example "Basic 2YotnFZFEjr1zCsicMWpAA"

Request Information

URI Parameters

None.

NameDescriptionTypeFormatMax lengthExample
status

The status of the notice

string

See Status

n/a

PUBLISHED

receivedFrom

The start date of the range of notice based on received_at

string

yyyy/mm/dd

10

2021/10/15

receivedTo

The end date of the range of notice based on received_at

string

yyyy/mm/dd

10

2021/10/25

noDocExt

The No Doc Ext of the notice

string

yyyy-nn-nnnnnn

14

2021-01-000001

pageSize

Indicates the size of the paginated result list

int

^[0-9]{2}$

50

07

page

Indicates the page number of the paginated result list

int

n/a

n/a

17

sort

Indicates the field and the order of the sorting of the paginated result list, valid fields include:

  • form
  • no_doc_ext
  • received_at
  • status
  • submission_id

Valid sort orders include:

  • ASC
  • DESC

string

[a-zA-Z_,]+

73

submission_id,ASC

Body Parameters

None.

Request Formats

application/x-www-form-urlencoded

Sample:
/api/latest/notice/submission/search?receivedFrom=2021/10/15&receivedTo=2021/10/25		

Response Information

Resource Description

A PageResult object containing details of the search result.

Response Formats

In the case of successful response a PageResult object is returned in JSON format.

application/json, text/json

Sample:
{
  "content":[
    {
      "submission_id": "20180912-000004",
      "received_at": "2015-06-17T08:10:04Z",
      "status": "RECEIVED",
      "reason_code": null,
      "status_updated_at": "2015-06-17T08:10:04Z",
      "no_doc_ext": null,
      "form": null,
      "languages": [],
      "publication_info": null,
      "technical_validation_report": null,
      "validation_rules_report": null,
      "quality_control_report": null,
      "ref_submission_id": null,
      "ref_no_doc_ojs": null
   }
  "first": true,
  "last": true,
  "number": 0,
  "number_of_elements": 1,
  "total_pages": 1,
  "total_elements": 1,
  "size": 1,
  "sort": "submission_id,ASC"
}
			

In the case the wrong parameter name provided.

application/json, text/json

Sample:
{
  "timestamp": "2018-01-05T08:51:38Z",
  "status": 400,
  "error": "Bad Request",
  "message": "Request parameters unknown",
  "path": "/api/latest/notice/submission/search",
  "exception": "Request parameter 'statuses' is not recognised, allowed parameters are: status, receivedFrom, receivedTo, noDocExt, pageSize, page, sort "
}
			

In the case the Accept header is provided and set with a value different than ‘application/json’.

application/json, text/json

Sample:
{
  "timestamp": "2017-01-10T10:03:30Z",
  "status": 406,
  "error": "Not Acceptable",
  "message": "Not acceptable value for ‘Accept’ header. Only ‘application/json’ format is supported",
  "path": "/api/latest/notice/submission/search"
}
			

In the case the limit of sent notices has been reached on production, qualification or simulation endpoint for this day.

application/json, text/json

Sample:
{
  "timestamp": "2017-12-05T07:57:29Z",
  "status": 422,
  "error": "Unprocessable Entity",
  "message": "Limit of sent notices per day reached",
  "path": "/api/latest/notice/submit",
  "exception": "The limit of 5000 sent notice(s) in production today has been reached for eSender ABC12"
}