-
Notifications
You must be signed in to change notification settings - Fork 0
/
jsoncstyleguide.xml
1048 lines (988 loc) · 38.2 KB
/
jsoncstyleguide.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="styleguide.xsl"?>
<GUIDE title="Preggy Health JSON Style Guide">
<p align="right">
Revision 1.0
</p>
<address>
</address>
<OVERVIEW>
<CATEGORY title="Important Note">
<STYLEPOINT title="Display Hidden Details in this Guide">
<SUMMARY>
This style guide contains many details that are initially hidden from view. They are marked by the triangle icon, which you see here on your left. Click it now. You should see "Hooray" appear below.
</SUMMARY>
<BODY>
<p>Hooray! Now you know you can expand points to get more details. Alternatively, there's an "expand all" at the top of this document.</p>
</BODY>
</STYLEPOINT>
</CATEGORY>
<CATEGORY title="Introduction">
<p>This style guide documents guidelines and recommendations for building JSON APIs at Preggy Health. In general, JSON APIs should follow the spec found at <a href="http://www.json.org">JSON.org</a>. This style guide clarifies and standardizes specific cases so that JSON APIs from Preggy Health have a standard look and feel. These guidelines are applicable to JSON requests and responses in both RPC-based and REST-based APIs.</p>
</CATEGORY>
<CATEGORY title="Definitions">
<p>For the purposes of this style guide, we define the following terms:</p><ul><li><b>property</b> - a name/value pair inside a JSON object.</li><li><b>property name</b> - the name (or key) portion of the property.</li><li><b>property value</b> - the value portion of the property.</li></ul>
<CODE_SNIPPET>
{
// The name/value pair together is a "property".
"propertyName": "propertyValue"
}
</CODE_SNIPPET>
<p>Javascript's <code>number</code> type encompasses all floating-point numbers, which is a broad designation. In this guide, <code>number</code> will refer to JavaScript's <code>number</code> type, while <code>integer</code> will refer to integers.</p>
</CATEGORY>
</OVERVIEW>
<CATEGORY title="General Guidelines">
<STYLEPOINT title="Comments">
<SUMMARY>
No comments in JSON objects.
</SUMMARY>
<BODY>
<p>Comments should not be included in JSON objects. Some of the examples in this style guide include comments. However this is only to clarify the examples.</p>
<BAD_CODE_SNIPPET>
{
// You may see comments in the examples below,
// But don't include comments in your JSON.
"propertyName": "propertyValue"
}
</BAD_CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="Double Quotes">
<SUMMARY>
Use double quotes.
</SUMMARY>
<BODY>
<p>If a property requires quotes, double quotes must be used. All property names must be surrounded by double quotes. Property values of type string must be surrounded by double quotes. Other value types (like boolean or number) should not be surrounded by double quotes.</p>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="Flattened data vs Structured Hierarchy">
<SUMMARY>
Data should not be arbitrarily grouped for convenience.
</SUMMARY>
<BODY>
<p>Data elements should be "flattened" in the JSON representation. Data should not be arbitrarily grouped for convenience.</p><p>In some cases, such as a collection of properties that represents a single structure, it may make sense to keep the structured hierarchy. These cases should be carefully considered, and only used if it makes semantic sense. For example, an address could be represented two ways, but the structured way probably makes more sense for developers:</p>
<p>Flattened Address:</p>
<CODE_SNIPPET>
{
"company": "Preggy Health",
"website": "https://www.preggy.health/",
"addressLine1": "111 8th Ave",
"addressLine2": "4th Floor",
"region": "GA",
"city": "Accra"
}
</CODE_SNIPPET>
<p>Structured Address:</p>
<CODE_SNIPPET>
{
"company": "Preggy Health",
"website": "https://www.preggy.health/",
"address": {
"line1": "111 8th Ave",
"line2": "4th Floor",
"region": "GA",
"city": "Accra"
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
</CATEGORY>
<CATEGORY title="Property Name Guidelines">
<STYLEPOINT title="Property Name Format">
<SUMMARY>
Choose meaningful property names.
</SUMMARY>
<BODY>
<p>Property names must conform to the following guidelines:</p><ul><li>Property names should be meaningful names with defined semantics.</li><li>Property names must be camel-cased, ascii strings.</li><li>The first character must be a letter, an underscore (_) or a dollar sign ($).</li><li>Subsequent characters can be a letter, a digit, an underscore, or a dollar sign.</li><li>Reserved JavaScript keywords should be avoided (A list of reserved JavaScript keywords can be found below).</li></ul><p>These guidelines mirror the guidelines for naming JavaScript identifiers. This allows JavaScript clients to access properties using dot notation. (for example, <code>result.thisIsAnInstanceVariable</code>). Here's an example of an object with one property:</p>
<CODE_SNIPPET>
{
"thisPropertyIsAnIdentifier": "identifier value"
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="Key Names in JSON Maps">
<SUMMARY>
JSON maps can use any Unicode character in key names.
</SUMMARY>
<BODY>
<p>The property name naming rules do not apply when a JSON object is used as a map. A map (also referred to as an associative array) is a data type with arbitrary key/value pairs that use the keys to access the corresponding values. JSON objects and JSON maps look the same at runtime; this distinction is relevant to the design of the API. The API documentation should indicate when JSON objects are used as maps.</p><p>The keys of a map do not have to obey the naming guidelines for property names. Map keys may contain any Unicode characters. Clients can access these properties using the square bracket notation familiar for maps (for example, <code>result.thumbnails["72"]</code>).</p>
<CODE_SNIPPET>
{
// The "address" property is a sub-object
// holding the parts of an address.
"address": {
"addressLine1": "123 Anystreet",
"city": "Anytown",
"state": "XX",
"zip": "00000"
},
// The "thumbnails" property is a map that maps
// a pixel size to the thumbnail url of that size.
"thumbnails": {
"72": "http://url.to.72px.thumbnail",
"144": "http://url.to.144px.thumbnail"
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="Reserved Property Names">
<SUMMARY>
Certain property names are reserved for consistent use across services.
</SUMMARY>
<BODY>
<p>Details about reserved property names, along with the full list, can be found later on in this guide. Services should avoid using these property names for anything other than their defined semantics.</p>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="Singular vs Plural Property Names">
<SUMMARY>
Array types should have plural property names. All other property names should be singular.
</SUMMARY>
<BODY>
<p>Arrays usually contain multiple items, and a plural property name reflects this. An example of this can be seen in the reserved names below. The <code>items</code> property name is plural because it represents an array of item objects. Most of the other fields are singular.</p><p>There may be exceptions to this, especially when referring to numeric property values. For example, in the reserved names, <code>totalItems</code> makes more sense than <code>totalItem</code>. However, technically, this is not violating the style guide, since <code>totalItems</code> can be viewed as <code>totalOfItems</code>, where <code>total</code> is singular (as per the style guide), and <code>OfItems</code> serves to qualify the total. The field name could also be changed to <code>itemCount</code> to look singular.</p>
<CODE_SNIPPET>
{
// Singular
"author": "lisa",
// An array of siblings, plural
"siblings": [ "bart", "maggie"],
// "totalItem" doesn't sound right
"totalItems": 10,
// But maybe "itemCount" is better
"itemCount": 10,
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="Naming Conflicts">
<SUMMARY>
Avoid naming conflicts by choosing a new property name or versioning the API.
</SUMMARY>
<BODY>
<p>New properties may be added to the reserved list in the future. There is no concept of JSON namespacing. If there is a naming conflict, these can usually be resolved by choosing a new property name or by versioning. For example, suppose we start with the following JSON object:</p>
<CODE_SNIPPET>
{
"apiVersion": "1.0",
"data": {
"issueName": "allergy",
"issueEntries": ["milk", "sugar", "sausage"]
}
}
</CODE_SNIPPET>
<p>If in the future we wish to make <code>issueEntries</code> a reserved word, we can do one of two things:</p><p>1) Choose a different name:</p>
<CODE_SNIPPET>
{
"apiVersion": "1.0",
"data": {
"issueName": "pizza",
"issueData": "Some new property",
"issueEntries": ["milk", "sugar", "sausage"]
}
}
</CODE_SNIPPET>
<p>2) Rename the property on a major version boundary:</p>
<CODE_SNIPPET>
{
"apiVersion": "2.0",
"data": {
"issueName": "pizza",
"issueEntries": "Some new property",
"issueData": ["milk", "sugar", "sausage"]
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
</CATEGORY>
<CATEGORY title="Property Value Guidelines">
<STYLEPOINT title="Property Value Format">
<SUMMARY>
Property values must be Unicode booleans, numbers, strings, objects, arrays, or <code>null</code>.
</SUMMARY>
<BODY>
<p>The spec at <a href="http://www.json.org">JSON.org</a> specifies exactly what type of data is allowed in a property value. This includes Unicode booleans, numbers, strings, objects, arrays, and <code>null</code>. JavaScript expressions are not allowed. APIs should support that spec for all values, and should choose the data type most appropriate for a particular property (numbers to represent numbers, etc.).</p><p>Good:</p>
<CODE_SNIPPET>
{
"canPigsFly": null, // null
"areWeThereYet": false, // boolean
"answerToLife": 42, // number
"name": "Penny", // string
"moreData": {}, // object
"things": [] // array
}
</CODE_SNIPPET>
<p>Bad:</p>
<BAD_CODE_SNIPPET>
{
"aVariableName": aVariableName, // Bad - JavaScript identifier
"functionFoo": function() { return 1; } // Bad - JavaScript function
}
</BAD_CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="Empty/Null Property Values">
<SUMMARY>
Consider removing empty or <code>null</code> values.
</SUMMARY>
<BODY>
<p>If a property is optional or has an empty or <code>null</code> value, consider dropping the property from the JSON, unless there's a strong semantic reason for its existence.</p>
<CODE_SNIPPET>
{
"volume": 10,
// Even though the "balance" property's value is zero, it should be left in,
// since "0" signifies "even balance" (the value could be "-1" for left
// balance and "+1" for right balance.
"balance": 0,
// The "currentlyPlaying" property can be left out since it is null.
// "currentlyPlaying": null
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="Enum Values">
<SUMMARY>
Enum values should be represented as strings.
</SUMMARY>
<BODY>
<p>As APIs grow, enum values may be added, removed or changed. Using strings as enum values ensures that downstream clients can gracefully handle changes to enum values.</p><p>Java code:</p>
<CODE_SNIPPET>
public enum Color {
WHITE,
BLACK,
RED,
YELLOW,
BLUE
}
</CODE_SNIPPET>
<p>JSON object:</p>
<CODE_SNIPPET>
{
"color": "WHITE"
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
</CATEGORY>
<CATEGORY title="Property Value Data Types">
<p>As mentioned above, property value types must be booleans, numbers, strings, objects, arrays, or <code>null</code>. However, it is useful define a set of standard data types when dealing with certain values. These data types will always be strings, but they will be formatted in a specific manner so that they can be easily parsed.</p>
<STYLEPOINT title="Date Property Values">
<SUMMARY>
Dates should be formatted as recommended by RFC 3339.
</SUMMARY>
<BODY>
<p>Dates should be strings formatted as recommended by <a href="https://www.ietf.org/rfc/rfc3339.txt">RFC 3339</a></p>
<CODE_SNIPPET>
{
"lastUpdate": "2007-11-06T16:34:41.000Z"
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="Time Duration Property Values">
<SUMMARY>
Time durations should be formatted as recommended by ISO 8601.
</SUMMARY>
<BODY>
<p>Time duration values should be strings formatted as recommended by <a href="https://en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601</a>.</p>
<CODE_SNIPPET>
{
// three years, six months, four days, twelve hours,
// thirty minutes, and five seconds
"duration": "P3Y6M4DT12H30M5S"
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="Latitude/Longitude Property Values">
<SUMMARY>
Latitudes/Longitudes should be formatted as recommended by ISO 6709.
</SUMMARY>
<BODY>
<p>Latitude/Longitude should be strings formatted as recommended by <a href="https://en.wikipedia.org/wiki/ISO_6709">ISO 6709</a>. Furthermore, they should favor the ±DD.DDDD±DDD.DDDD degrees format.</p>
<CODE_SNIPPET>
{
// The latitude/longitude location of the statue of liberty.
"statueOfLiberty": "+40.6894-074.0447"
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
</CATEGORY>
<CATEGORY title="JSON Structure & Reserved Property Names">
<p>In order to maintain a consistent interface across APIs, JSON objects should follow the structure outlined below. This structure applies to both requests and responses made with JSON. Within this structure, there are certain property names that are reserved for specific uses. These properties are NOT required; in other words, each reserved property may appear zero or one times. But if a service needs these properties, this naming convention is recommend. Here is a schema of the JSON structure, represented in <a href="https://orderly-json.org/">Orderly</a> format (which in turn can be compiled into a <a href="https://json-schema.org/">JSONSchema</a>). You can few examples of the JSON structure at the end of this guide.</p>
<CODE_SNIPPET>
object {
string apiVersion?;
string requestId?;
string context?;
string kind?;
object {
string fields?;
string etag?;
string id?;
string lang?;
string updated?; # date formatted RFC 3339
boolean deleted?;
integer currentItemCount?;
integer itemsPerPage?;
integer startIndex?;
integer totalItems?;
integer pageIndex?;
integer totalPages?;
string pageLinkTemplate /^https?:/ ?;
object {}* next?;
string nextLink?;
object {}* previous?;
string previousLink?;
object {}* self?;
string selfLink?;
object {}* edit?;
string editLink?;
array [
object {}*;
] items?;
}* data?;
object {
integer code?;
string message?;
array [
object {
string domain?;
string reason?;
string message?;
string location?;
string locationType?;
string extendedHelp?;
string sendReport?;
}*;
] errors?;
}* error?;
}*;
</CODE_SNIPPET>
<p>The JSON object has a few top-level properties, followed by either a <code>data</code> object or an <code>error</code> object, but not both. An explanation of each of these properties can be found below.</p>
</CATEGORY>
<CATEGORY title="Top-Level Reserved Property Names">
<p>The top-level of the JSON object may contain the following properties.</p>
<STYLEPOINT title="apiVersion">
<SUMMARY>
Property Value Type: string<br />Parent: -
</SUMMARY>
<BODY>
<p>Represents the desired version of the service API in a request, and the version of the service API that's served in the response. <code>apiVersion</code> should always be present. This is not related to the version of the data. Versioning of data should be handled through some other mechanism such as etags.</p><p>Example:</p>
<CODE_SNIPPET>
{ "apiVersion": "2.1" }
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="context">
<SUMMARY>
Property Value Type: string<br />Parent: -
</SUMMARY>
<BODY>
<p>Client sets this value and server processes response data with it. This is mainly the service identifier name, where the user can use the <code>context</code> to correlate responses with requests. This property is a top-level property because the <code>context</code> should present regardless of whether the response was successful or an error. </p><p>Example:</p><p>Request #1:</p>
<CODE_SNIPPET>
https://preggy.health/myapi?context=payment
</CODE_SNIPPET>
<p>Request #2:</p>
<CODE_SNIPPET>
https://preggy.health/myapi?context=patient
</CODE_SNIPPET>
<p>Response #1:</p>
<CODE_SNIPPET>
{
"context": "payment",
"data": {
"items": []
}
}
</CODE_SNIPPET>
<p>Response #2:</p>
<CODE_SNIPPET>
{
"context": "patient",
"data": {
"items": []
}
}
</CODE_SNIPPET>
<p>Common JavaScript handler code to process both responses:</p>
<CODE_SNIPPET>
function handleResponse(response) {
if (response.result.context == "payment") {
// Update the "Payment" section of the page.
} else if (response.result.context == "patient") {
// Update the "Patient" section of the page.
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="requestId">
<SUMMARY>
Property Value Type: string<br />Parent: -
</SUMMARY>
<BODY>
<p>A server supplied identifier for the response (regardless of whether the response is a success or an error). This is useful for correlating server logs with individual responses received at a client.</p><p>Example:</p>
<CODE_SNIPPET>
{ "requestId": "1" }
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="kind">
<SUMMARY>
Property Value Type: string<br />Parent: -
</SUMMARY>
<BODY>
<p>The <code>kind</code> property serves as a guide to what type of information this particular endpoint processes. It is the endpoint associated with the context property </p><p>Example:</p>
<CODE_SNIPPET>
{
"context": "payments",
"kind": "pay"
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data">
<SUMMARY>
Property Value Type: object<br />Parent: -
</SUMMARY>
<BODY>
<p>Container for all the data from a response. This property itself has many reserved property names, which are described below. Services are free to add their own data to this object. A JSON response should contain either a <code>data</code> object or an <code>error</code> object, but not both. If both <code>data</code> and <code>error</code> are present, the <code>error</code> object takes precedence.</p>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="error">
<SUMMARY>
Property Value Type: object<br />Parent: -
</SUMMARY>
<BODY>
<p>Indicates that an error has occurred, with details about the error. The error format supports either one or more errors returned from the service. A JSON response should contain either a <code>data</code> object or an <code>error</code> object, but not both. If both <code>data</code> and <code>error</code> are present, the <code>error</code> object takes precedence.</p><p>Example:</p>
<CODE_SNIPPET>
{
"apiVersion": "2.0",
"error": {
"code": 404,
"message": "File Not Found",
"errors": [{
"domain": "Payment",
"reason": "ResourceNotFoundException",
"message": "File Not Found
}]
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
</CATEGORY>
<CATEGORY title="Reserved Property Names in the data object">
<p>The <code>data</code> property of the JSON object may contain the following properties.</p>
<STYLEPOINT title="data.fields">
<SUMMARY>
Property Value Type: string<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>Represents the fields present in the response when doing a partial GET, or the fields present in a request when doing a partial PATCH. This property should only exist during a partial GET/PATCH, and should not be empty.</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
"fields": "name,id",
"id": "penny",
"name": "Penny"
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.etag">
<SUMMARY>
Property Value Type: string<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>Represents the etag for the response. </p><p>Example:</p>
<CODE_SNIPPET>
{"data": {"etag": "W/"C0QBRXcycSp7ImA9WxRVFUk.""}}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.id">
<SUMMARY>
Property Value Type: string<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>A globally unique string used to reference the object. The specific details of the <code>id</code> property are left up to the service.</p><p>Example:</p>
<CODE_SNIPPET>
{"data": {"id": "12345"}}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.lang">
<SUMMARY>
Property Value Type: string (formatted as specified in BCP 47)<br />Parent: <code>data (or any child element)</code>
</SUMMARY>
<BODY>
<p>Indicates the language of the rest of the properties in this object. This property mimics HTML's <code>lang</code> property and XML's <code>xml:lang</code> properties. The value should be a language value as defined in <a href="https://www.rfc-editor.org/rfc/bcp/bcp47.txt">BCP 47</a>. If a single JSON object contains data in multiple languages, the service is responsible for developing and documenting an appropriate location for the <code>lang</code> property.</p><p>Example:</p>
<CODE_SNIPPET>
{"data": {
"items": [
{ "lang": "en",
"title": "Hello world!" },
{ "lang": "fr",
"title": "Bonjour monde!" }
]}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.updated">
<SUMMARY>
Property Value Type: string (formatted as specified in RFC 3339)<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>Indicates the last date/time (<a href="https://www.ietf.org/rfc/rfc3339.txt">RFC 3339</a>) the item was updated, as defined by the service.</p><p>Example:</p>
<CODE_SNIPPET>
{"data": {"updated": "2007-11-06T16:34:41.000Z"}}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.deleted">
<SUMMARY>
Property Value Type: boolean<br />Parent: <code>data (or any child element)</code>
</SUMMARY>
<BODY>
<p>A marker element, that, when present, indicates the containing entry is deleted. If deleted is present, its value must be <code>true</code>; a value of <code>false</code> can cause confusion and should be avoided.</p><p>Example:</p>
<CODE_SNIPPET>
{"data": {
"items": [
{ "title": "A deleted entry",
"deleted": true
}
]}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.items">
<SUMMARY>
Property Value Type: array<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>The property name <code>items</code> is reserved to represent an array of items (for example, tracking data in Diet Tracking, appointments in Patient Appointments). This construct is intended to provide a standard location for collections related to the current result. For example, the JSON output could be plugged into a generic pagination system that knows to page on the <code>items</code> array. If <code>items</code> exists, it should be the last property in the <code>data</code> object (See the "Property Ordering" section below for more details).</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
"items": [
{ /* Object #1 */ },
{ /* Object #2 */ },
...
]
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
</CATEGORY>
<CATEGORY title="Reserved Property Names for Paging">
<p>The following properties are located in the <code>data</code> object, and help page through a list of items. Some of the language and concepts are borrowed from the <a href="http://www.opensearch.org/Home">OpenSearch specification</a>.</p><p>The paging properties below allow for various styles of paging, including:</p><ul><li>Previous/Next paging - Allows user's to move forward and backward through a list, one page at a time. The <code>nextLink</code> and <code>previousLink</code> properties (described in the "Reserved Property Names for Links" section below) are used for this style of paging.</li><li>Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string <code>?startIndex=200</code>.</li><li>Page-based paging - Allows user's to jump directly to a specific page within the items. This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string <code>?page=1</code> or <code>?page=20</code>. The <code>pageIndex</code> and <code>totalPages</code> properties are used for this style of paging.</li></ul><p>An example of how to use these properties to implement paging can be found at the end of this guide.</p>
<STYLEPOINT title="data.currentItemCount">
<SUMMARY>
Property Value Type: integer<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>The number of items in this result set. Should be equivalent to items.length, and is provided as a convenience property. For example, suppose a developer requests a set of search items, and asks for 10 items per page. The total set of that search has 14 total items. The first page of items will have 10 items in it, so both <code>itemsPerPage</code> and <code>currentItemCount</code> will equal "10". The next page of items will have the remaining 4 items; <code>itemsPerPage</code> will still be "10", but <code>currentItemCount</code> will be "4".</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
// "itemsPerPage" does not necessarily match "currentItemCount"
"itemsPerPage": 10,
"currentItemCount": 4
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.itemsPerPage">
<SUMMARY>
Property Value Type: integer<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>The number of items in the result. This is not necessarily the size of the data.items array; if we are viewing the last page of items, the size of data.items may be less than <code>itemsPerPage</code>. However the size of data.items should not exceed <code>itemsPerPage</code>.</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
"itemsPerPage": 10
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.startIndex">
<SUMMARY>
Property Value Type: integer<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>The index of the first item in data.items. For consistency, <code>startIndex</code> should be 1-based. For example, the first item in the first set of items should have a <code>startIndex</code> of 1. If the user requests the next set of data, the <code>startIndex</code> may be 10.</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
"startIndex": 1
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.totalItems">
<SUMMARY>
Property Value Type: integer<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>The total number of items available in this set. For example, if a user has 100 appointment records, the response may only contain 10 items, but the <code>totalItems</code> would be 100.</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
"totalItems": 100
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.pagingLinkTemplate">
<SUMMARY>
Property Value Type: string<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>A URI template indicating how users can calculate subsequent paging links. The URI template also has some reserved variable names: <code>{index}</code> representing the item number to load, and <code>{pageIndex}</code>, representing the page number to load.</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
"pagingLinkTemplate": "https://preggy.health/records/pl=en&pId=PH0012384&start={index}"
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.pageIndex">
<SUMMARY>
Property Value Type: integer<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>The index of the current page of items. For consistency, <code>pageIndex</code> should be 1-based. For example, the first page of items has a <code>pageIndex</code> of 1. <code>pageIndex</code> can also be calculated from the item-based paging properties: <code>pageIndex = floor(startIndex / itemsPerPage) + 1</code>.</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
"pageIndex": 1
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.totalPages">
<SUMMARY>
Property Value Type: integer<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>The total number of pages in the result set. <code>totalPages</code> can also be calculated from the item-based paging properties above: <code>totalPages = ceiling(totalItems / itemsPerPage)</code>.</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
"totalPages": 50
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
</CATEGORY>
<CATEGORY title="Reserved Property Names for Links">
<p>The following properties are located in the <code>data</code> object, and represent references to other resources. There are two forms of link properties: 1) objects, which can contain any sort of reference (such as a JSON-RPC object), and 2) URI strings, which represent URIs to resources (and will always be suffixed with "Link").</p>
<STYLEPOINT title="data.self / data.selfLink">
<SUMMARY>
Property Value Type: object / string<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>The self link can be used to retrieve the item's data. For example, in a list of a user's Pregnancy appointments, each appointment object in the <code>items</code> array could contain a <code>selfLink</code> that can be used to retrieve data related to that particular appointment.</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
"self": { },
"selfLink": "https://preggy.health/patient/appointements/1234"
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.edit / data.editLink">
<SUMMARY>
Property Value Type: object / string<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>The edit link indicates where a user can send update or delete requests. This is useful for REST-based APIs. This link need only be present if the user can update/delete this item.</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
"edit": { },
"editLink": "https://preggy.health/patient/appointements/1234/edit"
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.next / data.nextLink">
<SUMMARY>
Property Value Type: object / string<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>The next link indicates how more data can be retrieved. It points to the location to load the next set of data. It can be used in conjunction with the <code>itemsPerPage</code>, <code>startIndex</code> and <code>totalItems</code> properties in order to page through data.</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
"next": { },
"nextLink": ""https://preggy.health/patient/appointements/1234/next"
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="data.previous / data.previousLink">
<SUMMARY>
Property Value Type: object / string<br />Parent: <code>data</code>
</SUMMARY>
<BODY>
<p>The previous link indicates how more data can be retrieved. It points to the location to load the previous set of data. It can be used in conjunction with the <code>itemsPerPage</code>, <code>startIndex</code> and <code>totalItems</code> properties in order to page through data.</p><p>Example:</p>
<CODE_SNIPPET>
{
"data": {
"previous": { },
"previousLink": ""https://preggy.health/patient/appointements/1234/previous"
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
</CATEGORY>
<CATEGORY title="Reserved Property Names in the error object">
<p>The <code>error</code> property of the JSON object may contain the following properties.</p>
<STYLEPOINT title="error.code">
<SUMMARY>
Property Value Type: integer<br />Parent: <code>error</code>
</SUMMARY>
<BODY>
<p>Represents the code for this error. This property value will usually represent the HTTP response code. If there are multiple errors, <code>code</code> will be the error code for the first error.</p><p>Example:</p>
<CODE_SNIPPET>
{
"error":{
"code": 404
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="error.message">
<SUMMARY>
Property Value Type: string<br />Parent: <code>error</code>
</SUMMARY>
<BODY>
<p>A human readable message providing more details about the error. If there are multiple errors, <code>message</code> will be the message for the first error.</p><p>Example:</p>
<CODE_SNIPPET>
{
"error":{
"message": "File Not Found"
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="error.errors">
<SUMMARY>
Property Value Type: array<br />Parent: <code>error</code>
</SUMMARY>
<BODY>
<p>Container for any additional information regarding the error. If the service returns multiple errors, each element in the <code>errors</code> array represents a different error.</p><p>Example:</p>
<CODE_SNIPPET>
{ "error": { "errors": [] } }
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="error.errors[].domain">
<SUMMARY>
Property Value Type: string<br />Parent: <code>error.errors</code>
</SUMMARY>
<BODY>
<p>Unique identifier for the service raising this error. This helps distinguish service-specific errors (i.e. error inserting an event in a tracking) from general protocol errors (i.e. file not found).</p><p>Example:</p>
<CODE_SNIPPET>
{
"error":{
"errors": [{"domain": "Tracking"}]
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="error.errors[].reason">
<SUMMARY>
Property Value Type: string<br />Parent: <code>error.errors</code>
</SUMMARY>
<BODY>
<p>Unique identifier for this error. Different from the <code>error.code</code> property in that this is not an http response code.</p><p>Example:</p>
<CODE_SNIPPET>
{
"error":{
"errors": [{"reason": "ResourceNotFoundException"}]
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="error.errors[].message">
<SUMMARY>
Property Value Type: string<br />Parent: <code>error.errors</code>
</SUMMARY>
<BODY>
<p>A human readable message providing more details about the error. If there is only one error, this field will match <code>error.message</code>.</p><p>Example:</p>
<CODE_SNIPPET>
{
"error":{
"code": 404
"message": "File Not Found",
"errors": [{"message": "File Not Found"}]
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="error.errors[].extendedHelp">
<SUMMARY>
Property Value Type: string<br />Parent: <code>error.errors</code>
</SUMMARY>
<BODY>
<p>A URI for a help text that might shed some more light on the error.</p><p>Example:</p>
<CODE_SNIPPET>
{
"error":{
"errors": [{"extendedHelper": "http://url.to.more.details.example.com/"}]
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="error.errors[].sendReport">
<SUMMARY>
Property Value Type: string<br />Parent: <code>error.errors</code>
</SUMMARY>
<BODY>
<p>A URI for a report form used by the service to collect data about the error condition. This URI should be preloaded with parameters describing the request.</p><p>Example:</p>
<CODE_SNIPPET>
{
"error":{
"errors": [{"sendReport": "https://report.example.com/"}]
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
</CATEGORY>
<CATEGORY title="Property Ordering">
<p>Properties can be in any order within the JSON object. However, in some cases the ordering of properties can help parsers quickly interpret data and lead to better performance. One example is a pull parser in a mobile environment, where performance and memory are critical, and unnecessary parsing should be avoided.</p>
<STYLEPOINT title="Items Property">
<SUMMARY>
<code>items</code> should be the last property in the <code>data</code> object
</SUMMARY>
<BODY>
<p>This allows all the collection's properties to be read before reading each individual item. In cases where there are a lot of items, this avoids unnecessarily parsing those items when the developer only needs fields from the data.</p>
</BODY>
</STYLEPOINT>
<STYLEPOINT title="Property Ordering Example">
<BODY>
<CODE_SNIPPET>
// The "items" property is the last property in the "data" object.
{
"data": {
"title": "Preg One Appointments",
"description": "First pregnancy appointment in user's account",
"items": [
{
"kind": "appointment",
"date": "01/01/2023"
}
]
}
}
</CODE_SNIPPET>
</BODY>
</STYLEPOINT>
</CATEGORY>
<CATEGORY title="Examples">
<STYLEPOINT title="Paging Example">
<SUMMARY>
This example demonstrates how the Preggy Health search records could be represented as a JSON object, with special attention to the paging variables.
</SUMMARY>
<BODY>
<p>This sample is for illustrative purposes only. The API below does not actually exist.</p><p>Here's a sample Preggy Health search results page:<br /></p><p>Here's a sample JSON representation of this page:</p>
<CODE_SNIPPET>
{
"apiVersion": "1.0",
"requestId": "1",
"context": "records",
"kind": "appointments",
"data": {
"id": "22",
"patientId": "PH12334",
"patientName": "Maame Yaa",
"currentItemCount": 10,
"itemsPerPage": 10,
"startIndex": 11,
"totalItems": 2700000,
"nextLink": "https://preggy.health/records?pl=en&pId=PH12334&start=20&apiVersion=1.0&context=records&kind=appointments"
"previousLink": "https://preggy.health/records?pl=en&pId=PH12334&start=0&apiVersion=1.0&context=records&kind=appointments",
"pagingLinkTemplate": "https://preggy.health/record/pl=en&pId=PH12334&start={index}&apiVersion=1.0&context=records&kind=appointments",
"items": [
{
"title": "Appointment A"
// More fields for the search results
}
// More search results
]
}