Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Description

Required

Default

Pattern

episode

Allows to filter the files by given episode id. May contain multiple values separated by a comma

(tick)



dataType

Allows to filter the files by the type of data they contain. Parameter may contain multiple values separated by a comma

(error)



before

Allows to filter the files that have the end date metadata set to before the given date. Should be formatted as date-time - RFC3339

(error)



after

Allows to filter the files that have the start date metadata set to after the given date. Should be formatted as date-time - RFC3339

(error)



offset

Number of results skipped from the beginning

(error)



limit

Maximum number of returned results

(error)



Responses

Status Code: 200
Message: Request was successful. Response contains a list of episode elements (episode file metadata)

...

Code Block
titleResponse Schema
collapsetrue
{
  "description" : "Invalid time format of 'before' or 'after' parameters"
}
        

...

Examples

https://episodesplatform.eu/api/epos/episode-elements?episode=CZORSZTYN&dataType=Miniseed%20Signal&before=2023-12-31&after=1996-01-01&limit=5&offset=10

downloadFile

Status
subtlefalse
colourYellow
titlepost

...

Name

Description

Required

Default

Pattern

fileId

ID of the file to be download. The ID is displayed within the file metadata (obtained from the /api/epos/episode-elements/ endpoint)

(tick)



Responses

Status Code: 200
Message: The download request was successful

...

category

Allows to filter the returned applications by category. May contain multiple values separated by a comma

(error)



Responses

Status Code: 200
Message: Request was successful. Response contains a list of application descriptions matching the query criteria

...

Name

Description

Required

Default

Pattern

impactingFactor

Allows to filter the episodes by impacting or inducing factor relevant to the registrations collected into the episode. May contain multiple values separated by a comma

(error)



Responses

Status Code: 200
Message: Request was successful. Response contains a list of episode descriptions matching the query criteria

...