When searching for a program offering, many of the calls accept the as_of parameter, which is a composite parameter with a start and and end date/time and a mode. This parameter controls which results are returned based on registration dates of the offering.
If you only care to return results that are available for registration at the time of the api call, then you can skip this section as the default is to return results that are available for registration as of the time of the api call (while taking into account the time zone of the client).
Example with mode ‘registration_occurs_between’ (default)
Use this mode if you want to include results where registration is open for any registration group at any time between the start date/time and end date/time:
/v3/programs/offerings?as_of={start:2010-01-01T13:30:00,end:2010-05-01T08:30:00,mode:registration_occurs_between}
This translates to “return offerings that are open for registration for any registration group at any time between 1/1/2010 @ 1:30PM and 5/1/2010 @ 8:30AM” in whatever timezone the client is configured for in Daxko Operations.
Note that the format of the time is ‘2010-01-01T13:30:00’ and NOT ‘2010-01-01T13:30:00Z’ (omits the Z).
Example with mode ‘registration_starts_between’
Use this mode if you want to restrict the results based on when registration opens for at least 1 registration group:
/v3/programs/offerings?as_of={start:2010-01-01T13:30:00,end:2010-05-01T08:30:00,mode:registration_starts_between}
This translates to “return offerings where registration starts for at least 1 registration group between 1/1/2010 @ 1:30PM and 5/1/2010 @ 8:30AM” in whatever timezone the client is configured for in Daxko Operations.
Note that the format of the time is ‘2010-01-01T13:30:00’ and NOT ‘2010-01-01T13:30:00Z’ (omits the Z).
Notes
- If you omit the parameter, then the calls will default to returning offerings that are open for registration now (as of the client’s configured timezone).
- UTC time is not supported for this parameter. For example, use the format of ‘2010-01-01T08:00:00’ instead of ‘2010-01-01T08:00:00Z’.
- In program set-up, registration start/end dates are entered and stored without any timezone calculations performed.
- If a start time of ‘8:00 AM’ is entered in program set-up, then ‘8:00 AM’ will be returned from api calls that return this data. If as_of={start:YYYY-MM-DDT08:00:00,end:YYYY-MM-DDT08:00:00} is used, then this will match the stored registration date of 8:00 AM.