Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TOP-203 add in support for start_time, end_time and day filters in ORUK #59

Conversation

apricot13
Copy link
Member

Deprecates (unofficially) the days parameter in favour of day, start_time,end_time combo

Services can be filtered by start time, end, time and day

https://developers.openreferraluk.org/API-Implementation/

Time Search
A time search finds ervices are running at a certain time/day. The search takes three parameters: start_time, end_time and day. Multiple sets of these parameters can be used but there must be the same number of each.

The start_time and end_time parameters are in the HH:MM format. Where HH is the hours from 00 to 23 and MM is the minutes from 00 to 59.

The day parameters represent each day in the following format: SU,MO,TU,WE,TH,FR,SA

This search is done using an OR operator, which means one of the time sets must be matched.

Example time searches
An example of a call using multiple sets.

/services?start_time=10:00&end_time=16:00&day=MO&start_time=10:00&end_time=16:00&day=TU

Find all services after 6pm.

/services?start_time=18:00

@apricot13 apricot13 marked this pull request as ready for review September 5, 2024 19:19
@apricot13 apricot13 merged commit fe719bc into develop Sep 5, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant