Changes for page ERRest In Depth

Last modified by Pascal Robert on 2012/06/10 16:01

From version 20.1
edited by Pascal Robert
on 2012/04/13 14:18
Change comment: There is no comment for this version
To version 21.1
edited by Pascal Robert
on 2012/05/02 16:16
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,63 @@
1 -RestContext
2 -Properties
3 -JSON Schema
1 +* ERXRestContext
2 +** contains the editing context and an userInfo dictionnary
3 +** will be populated with er.rest.dateFormat, er.rest.timestampFormatter and er.rest.timestampFormat (read only for non-HTML responses)
4 +*** want to change the time format for a specific controller?
5 +
6 +{{code}}
7 +
8 +protected ERXRestContext createRestContext() {
9 + ERXRestContext restContext = new ERXRestContext(editingContext());
10 + restContext.setUserInfoForKey("yyyy-MM-dd", "er.rest.dateFormat");
11 + restContext.setUserInfoForKey("yyyy-MM-dd", "er.rest.timestampFormat");
12 + return restContext;
13 + }
14 +
15 +{{/code}}
16 +
17 +*
18 +** you just need to override createRestContext() in your controller if you want to add other stuff to the context (a user, etc.)
19 +* Properties
20 +** ERXRest.idKey
21 +** ERXRest.typeKey
22 +** ERXRest.nilKey
23 +** ERXRest.writeNilKey
24 +** ERXRest.pluralEntityNames
25 +** ERXRest.writeTypeKey
26 +** ERXRest.suppressTypeAttributesForSimpleTypes
27 +** ERXRest.strictMode
28 +** ERXRest.pluralEntityNames (ERXRouteRequestHandler)
29 +** ERXRest.routeCase (ERXRouteRequestHandler)
30 +** ERXRest.lowercaseEntityNames (ERXRouteRequestHandler)
31 +** ERXRest.parseUnknownExtensions (ERXRouteRequestHandler)
32 +*** (default "true") If set to "false", will return a 404 status code if the format doesn't exist
33 +** ERXRest.missingControllerName (ERXRouteRequestHandler)
34 +*** (default "ERXMissingRouteController") Allow you to specify which controller to use when a route doesn't exist
35 +** er.rest.rfcDateFormat
36 +** er.rest.dateFormat
37 +** er.rest.dateFormat.primary
38 +** er.rest.dateFormat.secondary
39 +** er.rest.dateFormatter
40 +** er.rest.timestampFormat
41 +** er.rest.timestampFormat.primary
42 +** er.rest.timestampFormat.secondary
43 +** er.rest.timestampFormatter
44 +** er.rest.rfcDateFormat
45 +** ERXRest.transactionsEnabled
46 +** ERXRest.maxEventsPerTransaction
47 +* JSON Schema
48 +** {{code}}
49 +/something?schema=true
50 +
51 +public WOActionResults indexAction() {
52 +if (isSchemaRequest()) {
53 + return schemaResponse(showFilter());
54 +}
55 +protected boolean isSchemaRequest() {
56 + return request().stringFormValueForKey("schema") != null;
57 +}
58 +{{/code}}
59 +* Same Origin policy
60 +Transactions
4 4  HTML vs other formats
5 5  Response representation
6 6  Missing route