Skip to content

Commit e0c2887

Browse files
authored
Merge pull request #742 from janedotx/fix/update-policy-query-date-language
Updating policy query parameter language to be clearer.
2 parents 6a67471 + 8206766 commit e0c2887

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

policy/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,10 @@ Authorization is not required and agencies are encouraged to make these endpoint
138138
| Name | Type | Required / Optional | Description |
139139
| ------------ | --------- | --- | ---------------------------------------------- |
140140
| `id` | UUID | Optional | If provided, returns one policy object with the matching UUID; default is to return all policy objects. |
141-
| `start_date` | [timestamp][ts] | Optional | Earliest effective date; default is policies effective as of the request time |
142-
| `end_date` | [timestamp][ts] | Optional | Latest effective date; default is all policies effective in the future |
141+
| `start_date` | [timestamp][ts] | Optional | Beginning date of the queried time range; the default value is the request time |
142+
| `end_date` | [timestamp][ts] | Optional | Ending date of the queried time range; the default value is null, which captures all policies that are effective in the future|
143143

144-
`start_date` and `end_date` are only considered when no `id` parameter is provided.
144+
`start_date` and `end_date` are only considered when no `id` parameter is provided. They should return any policy whose effectiveness overlaps with or is contained with this range. Suppose there's a policy with a `start_date` of 1/1/21 and `end_date` of 1/31/21. Assuming an `end_date` that is null, 12/1/20 and 1/5/21 `start_dates` will return the policy, but 2/10/21 wouldn't. Assuming a `start_date` parameter of say, 11/1/20, then an `end_date` of 12/1/20 wouldn't return the policy, but 1/5/21 and 2/10/21 would. Lastly, a `start_date` of 1/5/21 and `end_date` of 1/6/21 would also return the policy. Please note also that while dates in the format MM:DD:YY are being used here, `start_date` and `end_date` must be numbers representing milliseconds since the Unix epoch time.
145145

146146
Policies will be returned in order of effective date (see schema below), with pagination as in the `agency` and `provider` specs.
147147

0 commit comments

Comments
 (0)