search

SciLifeLab-TrainingHub-Platform / TeSS

Training e-Support Service using Ruby on Rails.
Other
0 stars 1 forks source link

API requirements for DC and PM teams #102

Open ninanorgren opened 4 months ago

ninanorgren commented 4 months ago

For compatibility with Datacentre Pathogens portal? and Precision medicine.

From Jan:

Requirements:

Consistent URL: Please ensure the name of the website or subpage header doesn't change since we link to the JSON URL. If the URL would change, the JSON API would not work as expected and the page on our portals would have errors. In case the URL needs to be changed, please inform us in advance so we can prepare the transition on our side as well. JSON Format Updates: Please inform us in advance if there are any upcoming changes to the JSON format. If the format would change, the JSON API would not work as expected and the page on our portals would have errors. (Similar to Requirement 1) DDLS Area Filtering: We need filtering options for areas like Precision Medicine & Diagnostics or Epidemiology and Biology of Infection for both Events and Courses. Learning Objectives: The learning objectives should be made obligatory. The descriptions are usually too long to include on cards on the website. Having a shorter option is much better. Learning objectives fit well, so they should ideally be made obligatory & kept relatively short (max 150 characters?). Standard Format for Location: The location (city) should be given in a standard format to ensure that it doesn't show up inconsistently when used for filtering. This means that it shouldn't be possible to show e.g., 'Visby, Gotland' and then 'Visby' (and we avoid errors with misspelling). Cities should also ideally be shown separated by commas if there are multiple, so that they can be integrated as a list. So, entries such as 'Stockholm, Linköping, Lund, and Gothenburg' would instead show as 'Stockholm, Linköping, Lund, Gothenburg'. Application Deadline Field: It is important that we also include an 'application deadline' field. This is not currently in the API, but many courses (e.g., NBIS courses) have an application deadline. It could be frustrating for users to find a good course for in a few weeks’ time, only to find that it is not open to applications. Perhaps we should also consider a registration URL.

harshita3199 commented 1 week ago

We don't agree with the learning outcome point. We will inform Jan

harshita3199 commented 1 week ago

We need to double check the json field for this task in order to check the city and venue, topic field.