ABDEFGHIJKLMNOPQRSTUVWXYZAA
1
EndpointParametersAPI RequiredORUK RequiredDescriptionResponse Schema (Based in https://github.com/openreferral/specification/tree/3.0-dev/schema)Example (Based in https://github.com/openreferral/specification/tree/3.0-dev/examples)ExampleMike's comments
2
/MUSTMUSTReturn information about this API
3
/services/{id}MUSTMUSTRetrieve fully nested service with all related data with specified id.schema/compiled/service.jsonexamples/service_full.jsonExample
4
/servicesMUSTMUSTRetrieve paginated listings of services that only have one-to-one fields in themPaginated list of schema/compiled/service.jsonexamples/service_simple.jsonExample
5
searchOPTIONALFull text searchFollow Shelby's suggestion and rename this "search"
6
pageOPTIONALMUSTPage number of paginated result.
7
taxonomy_term_idOPTIONALSearch for services with particular taxonomy_term
8
taxonomy_idOPTIONALSearch for services which contain any term with this taxonomy
9
organization_idOPTIONALSearch for services which contain services that that this organization provides.
10
modified_afterOPTIONALReturn all services modified on or after this datetime
11
minimalOPTIONALReturn array of just services with just "id" and "modified_date". When using this parameter aim to return all services within one page.
12
fullOPTIONALtrue, false return fully nested service.Paginated list of schema/compiled/service.jsonexamples/service_full.jsonExampleMake this COULD because it will place a heavy load on servers
13
/services.ndjsonOPTIONALRetrieve new line delimited JSON feed that streams all the resultsPaginated list of schema/compiled/service.jsonexamples/service_simple.jsonExample
14
searchOPTIONALFull text searchRename "search". Leave to implementations as to how full the text search is
15
taxonomy_term_idOPTIONALSearch for services with particular taxonomy_term
16
taxonomy_idOPTIONALSearch for services which contain any term with this taxonomy
17
organization_idOPTIONALSearch for services which contain services that that this organization provides.
18
modified_afterOPTIONALReturn all services modified on or after this datetime
19
minimalOPTIONALReturn array of just service "id" and "modified_date". When using this parameter aim to return all services within one call.
20
fullOPTIONALtrue, false return fully nested service.Paginated list of schema/compiled/service.jsonexamples/service_full.jsonExample
21
/taxonomies/{id}OPTIONALMUSTFull information on taxonomyschema/taxonomy.jsonexamples/taxonomy.jsonExample
22
/taxonomiesOPTIONALMUSTPaginated listing of taxonomiesschema/taxonomy.jsonexamples/taxonomy.jsonExample
23
searchOPTIONALFull text search of taxonomiesRename "search". Leave to implementations as to how full the text search is
24
pageOPTIONALMUSTPage number of paginated result.
25
/taxonomy_terms/{id}OPTIONALMUSTFull information on a taxonomy termschema/taxonomy_term.jsonexamples/taxonomy_term.jsonExample
26
/taxonomy_termsOPTIONALMUSTPaginated listing of taxonomy termsschema/taxonomy_term.jsonexamples/taxonomy_term.jsonExampleConsider a parent_term parameter and a top_only parameter to allow drill down a hierarchical taxonoomy
27
searchOPTIONALText search over taxonomy termsRename "search"
28
taxonomy_idOPTIONALRetrieve only taxonomy terms with particular taxonomy
29
top_onlyOPTIONALOnly retrieve taxonomy terms that have not child terms.
30
parent_idOPTIONALRecieve taxonomy terms that have a parent with this id.
31
pageOPTIONALMUSTPage number of paginated result.
32
/organizations/{id}OPTIONALFully nested organization with service array that contains simple information which could only contain the service.id and service.modified_dateschema/compiled/organization.jsonexamples/organization_full.jsonExample
33
full_serviceOPTIONALFully nested organization with service array that contains full information.schema/compiled/organization.jsonexamples/organization_full.jsonExample
34
/organizationsOPTIONALPagenated list of basic Organization information.Paginated list of schema/compiled/organization.jsonexamples/organization_simple.jsonExample
35
searchOPTIONALText search over organization name and description.Rename "search". Leave to implementations as to how fullthe text search is
36
full_serviceOPTIONALFully nested organization with service array that contains full service information.schema/compiled/organization.jsonexamples/organization_full.jsonExample
37
fullOPTIONALContains full nested organization informationPaginated list of schema/compiled/organization.json
38
pageOPTIONALPage number of paginated result.
39
/service_at_locations/{id}OPTIONALMUSTRetrieve fully nested service_at_location with all related data with specified id.schema/compiled/service_at_location.jsonexamples/service_full.jsonExampleMake this SHOULD
40
/service_at_locationsOPTIONALMUSTRetrieve paginated listings of service_at_location that only have one-to-one fields in themPaginated list of schema/compiled/service_at_location.jsonexamples/service_at_location_simple.jsonExampleMake this SHOULD. Concider a post/zip code and proximity paramater
41
searchOPTIONALFull text searchRename "search". Leave to implementations as to how fullthe text search is
42
taxonomy_term_idOPTIONALSearch for services with particular taxonomy_term
43
taxonomy_idOPTIONALSearch for services which contain any term with this taxonomy
44
organization_idOPTIONALSearch for services which contain services that that this organization provides.
45
modified_afterOPTIONALReturn all service_at_locations where the associated service modified on or after this datetime
46
fullOPTIONALtrue, false return fully nested service_at_location.Paginated list of schema/compiled/service_at_location.jsonexamples/service_at_location_full.jsonExampleMake this COULD because it will place a heavy load on servers
47
pageOPTIONALMUSTPage number of paginated result.
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100