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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
|
<pre>Internet Engineering Task Force (IETF) K. Murchison
Request for Comments: 8144 CMU
Updates: <a href="./rfc7240">7240</a> April 2017
Category: Standards Track
ISSN: 2070-1721
<span class="h1">Use of the Prefer Header Field in</span>
<span class="h1">Web Distributed Authoring and Versioning (WebDAV)</span>
Abstract
This document defines how the Prefer header field (<a href="./rfc7240">RFC 7240</a>) can be
used by a Web Distributed Authoring and Versioning (WebDAV) client to
request that certain behaviors be employed by a server while
constructing a response to a request. Furthermore, it defines the
new "depth-noroot" preference.
This document updates <a href="./rfc7240">RFC 7240</a>.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc7841#section-2">Section 2 of RFC 7841</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc8144">http://www.rfc-editor.org/info/rfc8144</a>.
Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
<span class="grey">Murchison Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
Table of Contents
<a href="#section-1">1</a>. Introduction ....................................................<a href="#page-3">3</a>
<a href="#section-1.1">1.1</a>. Notational Conventions .....................................<a href="#page-3">3</a>
<a href="#section-2">2</a>. Reducing WebDAV Response Verbosity with "return=minimal" ........<a href="#page-3">3</a>
<a href="#section-2.1">2.1</a>. Minimal PROPFIND and REPORT Responses ......................<a href="#page-4">4</a>
<a href="#section-2.2">2.2</a>. Minimal PROPPATCH Response .................................<a href="#page-5">5</a>
<a href="#section-2.3">2.3</a>. Minimal MKCALENDAR and MKCOL Responses .....................<a href="#page-5">5</a>
<a href="#section-3">3</a>. Reducing WebDAV Roundtrips with "return=representation" .........<a href="#page-6">6</a>
<a href="#section-3.1">3.1</a>. Successful State-Changing Requests .........................<a href="#page-6">6</a>
<a href="#section-3.2">3.2</a>. Unsuccessful Conditional State-Changing Requests ...........<a href="#page-6">6</a>
<a href="#section-4">4</a>. The "depth-noroot" Processing Preference ........................<a href="#page-7">7</a>
<a href="#section-5">5</a>. Security Considerations .........................................<a href="#page-7">7</a>
<a href="#section-6">6</a>. IANA Considerations .............................................<a href="#page-8">8</a>
<a href="#section-6.1">6.1</a>. Preference Registration ....................................<a href="#page-8">8</a>
<a href="#section-6.2">6.2</a>. Method References ..........................................<a href="#page-8">8</a>
<a href="#section-6.3">6.3</a>. Status Code References .....................................<a href="#page-9">9</a>
<a href="#section-7">7</a>. References ......................................................<a href="#page-9">9</a>
<a href="#section-7.1">7.1</a>. Normative References .......................................<a href="#page-9">9</a>
<a href="#section-7.2">7.2</a>. Informative References ....................................<a href="#page-10">10</a>
<a href="#appendix-A">Appendix A</a>. The Brief and Extended Depth Header Fields ...........<a href="#page-12">12</a>
<a href="#appendix-B">Appendix B</a>. Examples .............................................<a href="#page-12">12</a>
<a href="#appendix-B.1">B.1</a>. PROPFIND ..................................................<a href="#page-12">12</a>
<a href="#appendix-B.2">B.2</a>. REPORT ....................................................<a href="#page-16">16</a>
<a href="#appendix-B.3">B.3</a>. PROPPATCH .................................................<a href="#page-21">21</a>
<a href="#appendix-B.4">B.4</a>. MKCOL .....................................................<a href="#page-22">22</a>
<a href="#appendix-B.5">B.5</a>. POST ......................................................<a href="#page-23">23</a>
<a href="#appendix-B.6">B.6</a>. PUT .......................................................<a href="#page-27">27</a>
Acknowledgements ..................................................<a href="#page-28">28</a>
Author's Address ..................................................<a href="#page-28">28</a>
<span class="grey">Murchison Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
[<a id="ref-RFC7240">RFC7240</a>] defines the Prefer header field and the "return=minimal"
preference, which indicate that a client wishes for the server to
return a minimal response to a successful request but states that
what constitutes an appropriate minimal response is left solely to
the discretion of the server. <a href="#section-2">Section 2</a> of this specification
defines precisely what is expected of a server when constructing
minimal responses to successful WebDAV [<a href="./rfc4918" title=""HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)"">RFC4918</a>] requests.
[<a id="ref-RFC7240">RFC7240</a>] also defines the "return=representation" preference, which
indicates that a client wishes for the server to include an entity
representing the current state of the resource in the response to a
successful request. <a href="#section-3">Section 3</a> of this specification makes
recommendations on when this preference should be used by clients and
extends its applicability to 412 (Precondition Failed) [<a href="./rfc7232" title=""Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests"">RFC7232</a>]
responses.
Finally, <a href="#section-4">Section 4</a> of this specification defines the "depth-noroot"
preference that can be used with HTTP methods that support the Depth
header field.
<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Notational Conventions</span>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>].
This document references XML element types in the "DAV:" [<a href="./rfc4918" title=""HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)"">RFC4918</a>],
"urn:ietf:params:xml:ns:caldav" [<a href="./rfc4791" title=""Calendaring Extensions to WebDAV (CalDAV)"">RFC4791</a>], and
"urn:ietf:params:xml:ns:carddav" [<a href="./rfc6352" title=""CardDAV: vCard Extensions to Web Distributed Authoring and Versioning (WebDAV)"">RFC6352</a>] namespaces outside of the
context of an XML fragment. When doing so, the strings "DAV:",
"CALDAV:", and "CARDDAV:" will be prepended to the XML element types,
respectively.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Reducing WebDAV Response Verbosity with "return=minimal"</span>
Some payload bodies in responses to WebDAV requests, such as 207
(Multi-Status) [<a href="./rfc4918" title=""HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)"">RFC4918</a>] responses, can be quite verbose or even
unnecessary at times. This specification defines how the Prefer
header field, in conjunction with its "return=minimal" preference,
can be used by clients to reduce the verbosity of such responses by
requesting that the server omit those portions of the response that
can be inferred by their absence.
<span class="grey">Murchison Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Minimal PROPFIND and REPORT Responses</span>
When a PROPFIND [<a href="./rfc4918" title=""HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)"">RFC4918</a>] request, or a REPORT [<a href="./rfc3253" title=""Versioning Extensions to WebDAV (Web Distributed Authoring and Versioning)"">RFC3253</a>] request
whose report type results in a 207 (Multi-Status) response, contains
a Prefer header field with a preference of "return=minimal", the
server SHOULD omit all DAV:propstat XML elements containing a
DAV:status XML element of value 404 (Not Found) [<a href="./rfc7231" title=""Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"">RFC7231</a>] from the
207 (Multi-Status) response. If the omission of such a DAV:propstat
element would result in a DAV:response XML element containing zero
DAV:propstat elements, the server MUST substitute one of the
following in its place:
o a DAV:propstat element consisting of an empty DAV:prop element and
a DAV:status element of value 200 (OK) [<a href="./rfc7231" title=""Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"">RFC7231</a>]
o a DAV:status element of value 200 (OK)
The following report types are candidates that could benefit from use
of the "return=minimal" preference. NOTE: This list is not intended
to be normative or exhaustive.
o DAV:expand-property [<a href="./rfc3253" title=""Versioning Extensions to WebDAV (Web Distributed Authoring and Versioning)"">RFC3253</a>]
o DAV:acl-principal-prop-set [<a href="./rfc3744" title=""Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol"">RFC3744</a>]
o DAV:principal-property-search [<a href="./rfc3744" title=""Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol"">RFC3744</a>]
o DAV:sync-collection [<a href="./rfc6578" title=""Collection Synchronization for Web Distributed Authoring and Versioning (WebDAV)"">RFC6578</a>]
o CALDAV:calendar-query [<a href="./rfc4791" title=""Calendaring Extensions to WebDAV (CalDAV)"">RFC4791</a>]
o CALDAV:calendar-multiget [<a href="./rfc4791" title=""Calendaring Extensions to WebDAV (CalDAV)"">RFC4791</a>]
o CARDDAV:addressbook-query [<a href="./rfc6352" title=""CardDAV: vCard Extensions to Web Distributed Authoring and Versioning (WebDAV)"">RFC6352</a>]
o CARDDAV:addressbook-multiget [<a href="./rfc6352" title=""CardDAV: vCard Extensions to Web Distributed Authoring and Versioning (WebDAV)"">RFC6352</a>]
See Appendices B.1 and B.2 for examples.
<span class="grey">Murchison Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
<span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. Minimal PROPPATCH Response</span>
When a PROPPATCH [<a href="./rfc4918" title=""HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)"">RFC4918</a>] request contains a Prefer header field
with a preference of "return=minimal", and all instructions are
processed successfully, the server SHOULD return one of the following
responses rather than a 207 (Multi-Status) response:
o 204 (No Content) [<a href="./rfc7231" title=""Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"">RFC7231</a>]
o 200 (OK) [<a href="./rfc7231" title=""Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"">RFC7231</a>] (preferably with a zero-length message body)
See <a href="#appendix-B.3">Appendix B.3</a> for examples.
<span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>. Minimal MKCALENDAR and MKCOL Responses</span>
Both the MKCALENDAR [<a href="./rfc4791" title=""Calendaring Extensions to WebDAV (CalDAV)"">RFC4791</a>] and Extended MKCOL [<a href="./rfc5689" title=""Extended MKCOL for Web Distributed Authoring and Versioning (WebDAV)"">RFC5689</a>]
specifications indicate that a server MAY return a message body in
response to a successful request. This specification explicitly
defines the intended behavior in the presence of the Prefer header
field.
When a MKCALENDAR or an extended MKCOL request contains a Prefer
header field with a preference of "return=minimal", and the
collection is created with all requested properties being set
successfully, the server SHOULD return a 201 (Created) [<a href="./rfc7231" title=""Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"">RFC7231</a>]
response with an empty (zero-length) message body.
Note that the rationale for requiring that a minimal success response
have an empty body is twofold:
o <a href="./rfc4791#section-5.3.1">[RFC4791], Section 5.3.1</a> states: "If a response body for a
successful request is included, it MUST be a CALDAV:mkcalendar-
response XML element."
o <a href="./rfc5689#section-3">[RFC5689], Section 3</a> states: "When an empty response body is
returned with a success request status code, the client can assume
that all properties were set."
See <a href="#appendix-B.4">Appendix B.4</a> for examples.
<span class="grey">Murchison Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Reducing WebDAV Roundtrips with "return=representation"</span>
[<a id="ref-RFC7240">RFC7240</a>] describes the "return=representation" preference as being
intended to provide a means of optimizing communication between the
client and server by eliminating the need for a subsequent GET
request to retrieve the current representation of the resource
following a modification. This preference is equally applicable to
situations where the server itself modifies a resource, and where a
resource has been modified by another client.
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Successful State-Changing Requests</span>
The state-changing methods PUT [<a href="./rfc7231" title=""Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"">RFC7231</a>], COPY/MOVE [<a href="./rfc4918" title=""HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)"">RFC4918</a>], PATCH
[<a href="./rfc5789" title=""PATCH Method for HTTP"">RFC5789</a>], and POST [<a href="./rfc5995" title=""Using POST to Add Members to Web Distributed Authoring and Versioning (WebDAV) Collections"">RFC5995</a>] can be used to create or update a
resource. In some instances, such as with Calendaring Extensions to
WebDAV (CalDAV) Scheduling [<a href="./rfc6638" title=""Scheduling Extensions to CalDAV"">RFC6638</a>], the created or updated resource
representation may differ from the representation sent in the body of
the request or from that referenced by the effective request URI. In
cases where the client, upon receiving a 2xx (Successful) [<a href="./rfc7231" title=""Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"">RFC7231</a>]
response to its state-changing request, would normally issue a
subsequent GET request to retrieve the current representation of the
resource, the client can instead include a Prefer header field with
the "return=representation" preference in the state-changing request.
When a state-changing request contains a Prefer header field with a
preference of "return=representation", and the resource is created or
updated successfully, the server SHOULD include an entity
representing the current state of the resource in the resulting 201
(Created) or 200 (OK) [<a href="./rfc7231" title=""Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"">RFC7231</a>] response. In addition to coalescing
the create/update and retrieve operations into a single roundtrip, by
returning the current representation of the resource in the response,
the client will know that any changes to the resource were produced
by the server rather than a concurrent client, thus providing a level
of atomicity to the operation.
See <a href="#appendix-B.5">Appendix B.5</a> for examples.
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Unsuccessful Conditional State-Changing Requests</span>
Frequently, clients using a state-changing method such as those
listed above will make them conditional by including either an
If-Match or an If-None-Match [<a href="./rfc7232" title=""Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests"">RFC7232</a>] header field in the request.
This is done to prevent the client from accidentally overwriting a
resource whose current state has been modified by another client
acting in parallel. In cases where the client, upon receiving a 412
(Precondition Failed) [<a href="./rfc7232" title=""Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests"">RFC7232</a>] response to its conditional state-
changing request, would normally issue a subsequent GET request to
retrieve the current representation of the resource, the client can
<span class="grey">Murchison Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
instead include a Prefer header field with the
"return=representation" preference in the conditional state-changing
request.
When a conditional state-changing request contains a Prefer header
field with a preference of "return=representation", and the specified
condition evaluates to false, the server SHOULD include an entity
representing the current state of the resource in the resulting 412
(Precondition Failed) [<a href="./rfc7232" title=""Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests"">RFC7232</a>] response.
See <a href="#appendix-B.6">Appendix B.6</a> for examples.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. The "depth-noroot" Processing Preference</span>
The "depth-noroot" preference indicates that the client wishes for
the server to exclude the target (root) resource from processing by
the HTTP method and only apply the HTTP method to the target
resource's subordinate resources.
This preference is only intended to be used with HTTP methods whose
definitions explicitly provide support for the Depth [<a href="./rfc4918" title=""HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)"">RFC4918</a>] header
field. Furthermore, this preference only applies when the Depth
header field has a value of "1" or "infinity" (either implicitly or
explicitly).
The "depth-noroot" preference MAY be used in conjunction with the
"return=minimal" preference in a single request.
See <a href="#appendix-B.1">Appendix B.1</a> for examples.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Security Considerations</span>
No new security considerations are introduced by use of the Prefer
header field with WebDAV requests, beyond those discussed in
[<a href="./rfc7240" title=""Prefer Header for HTTP"">RFC7240</a>] and those already inherent in those requests.
<span class="grey">Murchison Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. IANA Considerations</span>
<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. Preference Registration</span>
The following preference has been added to the HTTP Preferences
Registry defined in <a href="./rfc7240#section-5.1">Section 5.1 of [RFC7240]</a>.
Preference: depth-noroot
Description: The "depth-noroot" preference indicates that the client
wishes for the server to exclude the target (root) resource from
processing by the HTTP method and only apply the HTTP method to
the target resource's subordinate resources.
Reference: <a href="./rfc8144#section-4">RFC 8144, Section 4</a>
Notes: This preference is only intended to be used with HTTP methods
whose definitions explicitly provide support for the Depth
[<a href="./rfc4918" title=""HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)"">RFC4918</a>] header field. Furthermore, this preference only applies
when the Depth header field has a value of "1" or "infinity"
(either implicitly or explicitly).
<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. Method References</span>
The following methods have had their references updated in the "HTTP
Method Registry" (<a href="http://www.iana.org/assignments/http-methods">http://www.iana.org/assignments/http-methods</a>).
+------------+------+------------+----------------------------------+
| Method | Safe | Idempotent | References |
| Name | | | |
+------------+------+------------+----------------------------------+
| MKCALENDAR | no | yes | <a href="./rfc4791#section-5.3.1">RFC 4791, Section 5.3.1</a>; RFC |
| | | | 8144, <a href="#section-2.3">Section 2.3</a> |
| MKCOL | no | yes | <a href="./rfc4918#section-9.3">RFC 4918, Section 9.3</a>; <a href="./rfc5689">RFC 5689</a>, |
| | | | <a href="#section-3">Section 3</a>; <a href="./rfc8144#section-2.3">RFC 8144, Section 2.3</a> |
| PROPFIND | yes | yes | <a href="./rfc4918#section-9.1">RFC 4918, Section 9.1</a>; <a href="./rfc8144">RFC 8144</a>, |
| | | | <a href="#section-2.1">Section 2.1</a> |
| PROPPATCH | no | yes | <a href="./rfc4918#section-9.2">RFC 4918, Section 9.2</a>; <a href="./rfc8144">RFC 8144</a>, |
| | | | <a href="#section-2.2">Section 2.2</a> |
| REPORT | yes | yes | <a href="./rfc3253#section-3.6">RFC 3253, Section 3.6</a>; <a href="./rfc8144">RFC 8144</a>, |
| | | | <a href="#section-2.1">Section 2.1</a> |
+------------+------+------------+----------------------------------+
<span class="grey">Murchison Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
<span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>. Status Code References</span>
The following status code has had its references updated in the "HTTP
Status Codes" registry (<a href="http://www.iana.org/assignments/http-status-codes">http://www.iana.org/assignments/http-status-</a>
<a href="http://www.iana.org/assignments/http-status-codes">codes</a>).
+-------+-------------------+---------------------------------------+
| Value | Description | References |
+-------+-------------------+---------------------------------------+
| 412 | Precondition | <a href="./rfc7232#section-4.2">RFC 7232, Section 4.2</a>; <a href="./rfc8144">RFC 8144</a>, |
| | Failed | <a href="#section-3.2">Section 3.2</a> |
+-------+-------------------+---------------------------------------+
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. References</span>
<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Normative References</span>
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>,
DOI 10.17487/RFC2119, March 1997,
<<a href="http://www.rfc-editor.org/info/rfc2119">http://www.rfc-editor.org/info/rfc2119</a>>.
[<a id="ref-RFC3253">RFC3253</a>] Clemm, G., Amsden, J., Ellison, T., Kaler, C., and J.
Whitehead, "Versioning Extensions to WebDAV (Web
Distributed Authoring and Versioning)", <a href="./rfc3253">RFC 3253</a>,
DOI 10.17487/RFC3253, March 2002,
<<a href="http://www.rfc-editor.org/info/rfc3253">http://www.rfc-editor.org/info/rfc3253</a>>.
[<a id="ref-RFC4791">RFC4791</a>] Daboo, C., Desruisseaux, B., and L. Dusseault,
"Calendaring Extensions to WebDAV (CalDAV)", <a href="./rfc4791">RFC 4791</a>,
DOI 10.17487/RFC4791, March 2007,
<<a href="http://www.rfc-editor.org/info/rfc4791">http://www.rfc-editor.org/info/rfc4791</a>>.
[<a id="ref-RFC4918">RFC4918</a>] Dusseault, L., Ed., "HTTP Extensions for Web Distributed
Authoring and Versioning (WebDAV)", <a href="./rfc4918">RFC 4918</a>,
DOI 10.17487/RFC4918, June 2007,
<<a href="http://www.rfc-editor.org/info/rfc4918">http://www.rfc-editor.org/info/rfc4918</a>>.
[<a id="ref-RFC5689">RFC5689</a>] Daboo, C., "Extended MKCOL for Web Distributed Authoring
and Versioning (WebDAV)", <a href="./rfc5689">RFC 5689</a>, DOI 10.17487/RFC5689,
September 2009, <<a href="http://www.rfc-editor.org/info/rfc5689">http://www.rfc-editor.org/info/rfc5689</a>>.
[<a id="ref-RFC5789">RFC5789</a>] Dusseault, L. and J. Snell, "PATCH Method for HTTP",
<a href="./rfc5789">RFC 5789</a>, DOI 10.17487/RFC5789, March 2010,
<<a href="http://www.rfc-editor.org/info/rfc5789">http://www.rfc-editor.org/info/rfc5789</a>>.
<span class="grey">Murchison Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
[<a id="ref-RFC5995">RFC5995</a>] Reschke, J., "Using POST to Add Members to Web Distributed
Authoring and Versioning (WebDAV) Collections", <a href="./rfc5995">RFC 5995</a>,
DOI 10.17487/RFC5995, September 2010,
<<a href="http://www.rfc-editor.org/info/rfc5995">http://www.rfc-editor.org/info/rfc5995</a>>.
[<a id="ref-RFC7231">RFC7231</a>] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
Protocol (HTTP/1.1): Semantics and Content", <a href="./rfc7231">RFC 7231</a>,
DOI 10.17487/RFC7231, June 2014,
<<a href="http://www.rfc-editor.org/info/rfc7231">http://www.rfc-editor.org/info/rfc7231</a>>.
[<a id="ref-RFC7232">RFC7232</a>] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
Protocol (HTTP/1.1): Conditional Requests", <a href="./rfc7232">RFC 7232</a>,
DOI 10.17487/RFC7232, June 2014,
<<a href="http://www.rfc-editor.org/info/rfc7232">http://www.rfc-editor.org/info/rfc7232</a>>.
[<a id="ref-RFC7240">RFC7240</a>] Snell, J., "Prefer Header for HTTP", <a href="./rfc7240">RFC 7240</a>,
DOI 10.17487/RFC7240, June 2014,
<<a href="http://www.rfc-editor.org/info/rfc7240">http://www.rfc-editor.org/info/rfc7240</a>>.
<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Informative References</span>
[<a id="ref-MSDN.aa493854">MSDN.aa493854</a>]
Microsoft Developer Network, "PROPPATCH Method", June
2006,
<<a href="http://msdn.microsoft.com/en-us/library/aa493854.aspx">http://msdn.microsoft.com/en-us/library/aa493854.aspx</a>>.
[<a id="ref-MSDN.aa563501">MSDN.aa563501</a>]
Microsoft Developer Network, "Brief Header", June 2006,
<<a href="http://msdn.microsoft.com/en-us/library/aa563501.aspx">http://msdn.microsoft.com/en-us/library/aa563501.aspx</a>>.
[<a id="ref-MSDN.aa563950">MSDN.aa563950</a>]
Microsoft Developer Network, "Depth Header", June 2006,
<<a href="http://msdn.microsoft.com/en-us/library/aa563950.aspx">http://msdn.microsoft.com/en-us/library/aa563950.aspx</a>>.
[<a id="ref-MSDN.aa580336">MSDN.aa580336</a>]
Microsoft Developer Network, "PROPFIND Method", June 2006,
<<a href="http://msdn.microsoft.com/en-us/library/aa580336.aspx">http://msdn.microsoft.com/en-us/library/aa580336.aspx</a>>.
[<a id="ref-RFC3744">RFC3744</a>] Clemm, G., Reschke, J., Sedlar, E., and J. Whitehead, "Web
Distributed Authoring and Versioning (WebDAV) Access
Control Protocol", <a href="./rfc3744">RFC 3744</a>, DOI 10.17487/RFC3744, May
2004, <<a href="http://www.rfc-editor.org/info/rfc3744">http://www.rfc-editor.org/info/rfc3744</a>>.
[<a id="ref-RFC6352">RFC6352</a>] Daboo, C., "CardDAV: vCard Extensions to Web Distributed
Authoring and Versioning (WebDAV)", <a href="./rfc6352">RFC 6352</a>,
DOI 10.17487/RFC6352, August 2011,
<<a href="http://www.rfc-editor.org/info/rfc6352">http://www.rfc-editor.org/info/rfc6352</a>>.
<span class="grey">Murchison Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
[<a id="ref-RFC6578">RFC6578</a>] Daboo, C. and A. Quillaud, "Collection Synchronization for
Web Distributed Authoring and Versioning (WebDAV)",
<a href="./rfc6578">RFC 6578</a>, DOI 10.17487/RFC6578, March 2012,
<<a href="http://www.rfc-editor.org/info/rfc6578">http://www.rfc-editor.org/info/rfc6578</a>>.
[<a id="ref-RFC6638">RFC6638</a>] Daboo, C. and B. Desruisseaux, "Scheduling Extensions to
CalDAV", <a href="./rfc6638">RFC 6638</a>, DOI 10.17487/RFC6638, June 2012,
<<a href="http://www.rfc-editor.org/info/rfc6638">http://www.rfc-editor.org/info/rfc6638</a>>.
<span class="grey">Murchison Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. The Brief and Extended Depth Header Fields</span>
This document is based heavily on the Brief [<a href="#ref-MSDN.aa563501">MSDN.aa563501</a>] and
extended Depth [<a href="#ref-MSDN.aa563950">MSDN.aa563950</a>] header fields. The behaviors
described in Sections <a href="#section-2.1">2.1</a> and <a href="#section-2.2">2.2</a> are identical to those provided by
the Brief header field when used with the PROPFIND [<a href="#ref-MSDN.aa580336">MSDN.aa580336</a>]
and PROPPATCH [<a href="#ref-MSDN.aa493854">MSDN.aa493854</a>] methods, respectively. The behavior
described in <a href="#section-4">Section 4</a> is identical to that provided by the
"1,noroot" [<a href="#ref-MSDN.aa563950">MSDN.aa563950</a>] and "infinity,noroot" [<a href="#ref-MSDN.aa563950">MSDN.aa563950</a>]
Depth header field values.
Client and server implementations that already support the Brief
header field can add support for the "return=minimal" preference with
nominal effort.
If a server supporting the Prefer header field receives both the
Brief and Prefer header fields in a request, clients can expect the
server to ignore the Brief header field and only use the Prefer
header field preferences.
<span class="h2"><a class="selflink" id="appendix-B" href="#appendix-B">Appendix B</a>. Examples</span>
<span class="h3"><a class="selflink" id="appendix-B.1" href="#appendix-B.1">B.1</a>. PROPFIND</span>
<span class="h4"><a class="selflink" id="appendix-B.1.1" href="#appendix-B.1.1">B.1.1</a>. Typical PROPFIND Request/Response with Depth:1</span>
This example tries to fetch one known and one unknown property from
child resources.
>> Request <<
PROPFIND /container/ HTTP/1.1
Host: webdav.example.com
Content-Type: application/xml; charset=utf-8
Content-Length: 189
Depth: 1
<?xml version="1.0" encoding="UTF-8"?>
<D:propfind xmlns:D="DAV:" xmlns:X="http://ns.example.com/foobar/">
<D:prop>
<D:resourcetype/>
<X:foobar/>
</D:prop>
</D:propfind>
>> Response <<
HTTP/1.1 207 Multi-Status
<span class="grey">Murchison Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
Content-Type: application/xml; charset=utf-8
Content-Length: 1722
<?xml version="1.0" encoding="utf-8"?>
<D:multistatus xmlns:D="DAV:"
xmlns:X="http://ns.example.com/foobar/">
<D:response>
<D:href>/container/</D:href>
<D:propstat>
<D:prop>
<D:resourcetype>
<D:collection/>
</D:resourcetype>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
<D:propstat>
<D:prop>
<X:foobar/>
</D:prop>
<D:status>HTTP/1.1 404 Not Found</D:status>
</D:propstat>
</D:response>
<D:response>
<D:href>/container/work/</D:href>
<D:propstat>
<D:prop>
<D:resourcetype>
<D:collection/>
</D:resourcetype>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
<D:propstat>
<D:prop>
<X:foobar/>
</D:prop>
<D:status>HTTP/1.1 404 Not Found</D:status>
</D:propstat>
</D:response>
<D:response>
<D:href>/container/home/</D:href>
<D:propstat>
<D:prop>
<D:resourcetype>
<D:collection/>
</D:resourcetype>
</D:prop>
<span class="grey">Murchison Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
<D:propstat>
<D:prop>
<X:foobar/>
</D:prop>
<D:status>HTTP/1.1 404 Not Found</D:status>
</D:propstat>
</D:response>
<D:response>
<D:href>/container/foo.txt</D:href>
<D:propstat>
<D:prop>
<D:resourcetype/>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
<D:propstat>
<D:prop>
<X:foobar/>
</D:prop>
<D:status>HTTP/1.1 404 Not Found</D:status>
</D:propstat>
</D:response>
</D:multistatus>
<span class="h4"><a class="selflink" id="appendix-B.1.2" href="#appendix-B.1.2">B.1.2</a>. Minimal PROPFIND Request/Response with Depth:1</span>
This example tries to fetch one known and one unknown property from
child resources only.
>> Request <<
PROPFIND /container/ HTTP/1.1
Host: webdav.example.com
Content-Type: application/xml; charset=utf-8
Content-Length: 189
Depth: 1
Prefer: return=minimal, depth-noroot
<?xml version="1.0" encoding="UTF-8"?>
<D:propfind xmlns:D="DAV:" xmlns:X="http://ns.example.com/foobar/">
<D:prop>
<D:resourcetype/>
<X:foobar/>
</D:prop>
</D:propfind>
<span class="grey">Murchison Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
>> Response <<
HTTP/1.1 207 Multi-Status
Content-Type: application/xml; charset=utf-8
Content-Length: 837
Preference-Applied: return=minimal, depth-noroot
<?xml version="1.0" encoding="utf-8"?>
<D:multistatus xmlns:D="DAV:">
<D:response>
<D:href>/container/work/</D:href>
<D:propstat>
<D:prop>
<D:resourcetype>
<D:collection/>
</D:resourcetype>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
</D:response>
<D:response>
<D:href>/container/home/</D:href>
<D:propstat>
<D:prop>
<D:resourcetype>
<D:collection/>
</D:resourcetype>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
</D:response>
<D:response>
<D:href>/container/foo.txt</D:href>
<D:propstat>
<D:prop>
<D:resourcetype/>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
</D:response>
</D:multistatus>
<span class="grey">Murchison Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
<span class="h4"><a class="selflink" id="appendix-B.1.3" href="#appendix-B.1.3">B.1.3</a>. Minimal PROPFIND Request/Response with an Empty DAV:propstat</span>
Element
This example tries to fetch an unknown property from a collection.
>> Request <<
PROPFIND /container/ HTTP/1.1
Host: webdav.example.com
Content-Type: application/xml; charset=utf-8
Content-Length: 166
Prefer: return=minimal
<?xml version="1.0" encoding="UTF-8"?>
<D:propfind xmlns:D="DAV:" xmlns:X="http://ns.example.com/foobar/">
<D:prop>
<X:foobar/>
</D:prop>
</D:propfind>
>> Response <<
HTTP/1.1 207 Multi-Status
Content-Type: application/xml; charset=utf-8
Content-Length: 255
Preference-Applied: return=minimal
<?xml version="1.0" encoding="utf-8"?>
<D:multistatus xmlns:D="DAV:">
<D:response>
<D:href>/container/</D:href>
<D:propstat>
<D:prop/>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
</D:response>
</D:multistatus>
<span class="h3"><a class="selflink" id="appendix-B.2" href="#appendix-B.2">B.2</a>. REPORT</span>
<span class="h4"><a class="selflink" id="appendix-B.2.1" href="#appendix-B.2.1">B.2.1</a>. Typical REPORT Request/Response</span>
This example tries to fetch an unknown property from several
resources via the DAV:expand-property [<a href="./rfc3253" title=""Versioning Extensions to WebDAV (Web Distributed Authoring and Versioning)"">RFC3253</a>] REPORT type.
>> Request <<
REPORT /dav/principals/ HTTP/1.1
<span class="grey">Murchison Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
Host: webdav.example.com
Content-type: text/xml; charset=utf-8
Content-length: 847
<?xml version="1.0" encoding="utf-8"?>
<D:expand-property xmlns:D="DAV:">
<D:property name="current-user-principal">
<D:property name="resourcetype"/>
<D:property name="displayname"/>
<D:property name="foobar"
namespace="http://ns.example.com/foobar"/>
<D:property name="calendar-home-set"
namespace="urn:ietf:params:xml:ns:caldav">
<D:property name="resourcetype"/>
<D:property name="foobar"
namespace="http://ns.example.com/foobar"/>
</D:property>
<D:property name="addressbook-home-set"
namespace="urn:ietf:params:xml:ns:carddav">
<D:property name="resourcetype"/>
<D:property name="foobar"
namespace="http://ns.example.com/foobar"/>
</D:property>
</D:property>
</D:expand-property>
>> Response <<
HTTP/1.1 207 Multi-Status
Content-Type: application/xml; charset=utf-8
Content-Length: 2664
<?xml version="1.0" encoding="utf-8"?>
<D:multistatus xmlns:D="DAV:"
xmlns:C="urn:ietf:params:xml:ns:caldav"
xmlns:R="urn:ietf:params:xml:ns:carddav"
xmlns:X="http://ns.example.com/foobar">
<D:response>
<D:href>/dav/principals/</D:href>
<D:propstat>
<D:prop>
<D:current-user-principal>
<D:response>
<D:href>/dav/principals/user/ken/</D:href>
<D:propstat>
<D:prop>
<D:resourcetype>
<D:principal/>
<span class="grey">Murchison Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
</D:resourcetype>
<D:displayname>ken</D:displayname>
<C:calendar-home-set>
<D:response>
<D:href>/dav/calendars/user/ken/</D:href>
<D:propstat>
<D:prop>
<D:resourcetype>
<D:collection/>
</D:resourcetype>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
<D:propstat>
<D:prop>
<X:foobar/>
</D:prop>
<D:status>HTTP/1.1 404 Not Found</D:status>
</D:propstat>
</D:response>
</C:calendar-home-set>
<R:addressbook-home-set>
<D:response>
<D:href>/dav/addressbooks/user/ken/</D:href>
<D:propstat>
<D:prop>
<D:resourcetype>
<D:collection/>
</D:resourcetype>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
<D:propstat>
<D:prop>
<X:foobar/>
</D:prop>
<D:status>HTTP/1.1 404 Not Found</D:status>
</D:propstat>
</D:response>
</R:addressbook-home-set>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
<D:propstat>
<D:prop>
<X:foobar/>
</D:prop>
<D:status>HTTP/1.1 404 Not Found</D:status>
<span class="grey">Murchison Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
</D:propstat>
</D:response>
</D:current-user-principal>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
</D:response>
</D:multistatus>
<span class="h4"><a class="selflink" id="appendix-B.2.2" href="#appendix-B.2.2">B.2.2</a>. Minimal REPORT Request/Response</span>
This example tries to fetch an unknown property from several
resources via the DAV:expand-property [<a href="./rfc3253" title=""Versioning Extensions to WebDAV (Web Distributed Authoring and Versioning)"">RFC3253</a>] REPORT type.
>> Request <<
REPORT /dav/principals/ HTTP/1.1
Host: webdav.example.com
Content-Type: application/xml; charset=utf-8
Content-Length: 847
Prefer: return=minimal
<?xml version="1.0" encoding="utf-8"?>
<D:expand-property xmlns:D="DAV:">
<D:property name="current-user-principal">
<D:property name="resourcetype"/>
<D:property name="displayname"/>
<D:property name="foobar"
namespace="http://ns.example.com/foobar"/>
<D:property name="calendar-home-set"
namespace="urn:ietf:params:xml:ns:caldav">
<D:property name="resourcetype"/>
<D:property name="foobar"
namespace="http://ns.example.com/foobar"/>
</D:property>
<D:property name="addressbook-home-set"
namespace="urn:ietf:params:xml:ns:carddav">
<D:property name="resourcetype"/>
<D:property name="foobar"
namespace="http://ns.example.com/foobar"/>
</D:property>
</D:property>
</D:expand-property>
>> Response <<
HTTP/1.1 207 Multi-Status
Content-Type: application/xml; charset=utf-8
<span class="grey">Murchison Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
Content-Length: 1998
Preference-Applied: return=minimal
<?xml version="1.0" encoding="utf-8"?>
<D:multistatus xmlns:D="DAV:"
xmlns:C="urn:ietf:params:xml:ns:caldav"
xmlns:R="urn:ietf:params:xml:ns:carddav"
xmlns:X="http://ns.example.com/foobar">
<D:response>
<D:href>/dav/principals/</D:href>
<D:propstat>
<D:prop>
<D:current-user-principal>
<D:response>
<D:href>/dav/principals/user/ken/</D:href>
<D:propstat>
<D:prop>
<D:resourcetype>
<D:principal/>
</D:resourcetype>
<D:displayname>ken</D:displayname>
<C:calendar-home-set>
<D:response>
<D:href>/dav/calendars/user/ken/</D:href>
<D:propstat>
<D:prop>
<D:resourcetype>
<D:collection/>
</D:resourcetype>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
</D:response>
</C:calendar-home-set>
<R:addressbook-home-set>
<D:response>
<D:href>/dav/addressbooks/user/ken/</D:href>
<D:propstat>
<D:prop>
<D:resourcetype>
<D:collection/>
</D:resourcetype>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
</D:response>
</R:addressbook-home-set>
</D:prop>
<span class="grey">Murchison Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
</D:response>
</D:current-user-principal>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
</D:response>
</D:multistatus>
<span class="h3"><a class="selflink" id="appendix-B.3" href="#appendix-B.3">B.3</a>. PROPPATCH</span>
<span class="h4"><a class="selflink" id="appendix-B.3.1" href="#appendix-B.3.1">B.3.1</a>. Typical PROPPATCH Request/Response</span>
>> Request <<
PROPPATCH /container/ HTTP/1.1
Host: webdav.example.com
Content-Type: application/xml; charset=utf-8
Content-Length: 199
<?xml version="1.0" encoding="utf-8"?>
<D:propertyupdate xmlns:D="DAV:">
<D:set>
<D:prop>
<D:displayname>My Container</D:displayname>
</D:prop>
</D:set>
</D:propertyupdate>
>> Response <<
HTTP/1.1 207 Multi-Status
Content-Type: application/xml; charset=utf-8
Content-Length: 297
<?xml version="1.0" encoding="utf-8"?>
<D:multistatus xmlns:D="DAV:">
<D:response>
<D:href>/container/</D:href>
<D:propstat>
<D:prop>
<D:displayname/>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
</D:response>
</D:multistatus>
<span class="grey">Murchison Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
<span class="h4"><a class="selflink" id="appendix-B.3.2" href="#appendix-B.3.2">B.3.2</a>. Minimal PROPPATCH Request/Response</span>
>> Request <<
PROPPATCH /container/ HTTP/1.1
Host: webdav.example.com
Content-Type: application/xml; charset=utf-8
Content-Length: 199
Prefer: return=minimal
<?xml version="1.0" encoding="utf-8"?>
<D:propertyupdate xmlns:D="DAV:">
<D:set>
<D:prop>
<D:displayname>My Container</D:displayname>
</D:prop>
</D:set>
</D:propertyupdate>
>> Response <<
HTTP/1.1 200 OK
Content-Length: 0
Preference-Applied: return=minimal
<span class="h3"><a class="selflink" id="appendix-B.4" href="#appendix-B.4">B.4</a>. MKCOL</span>
<span class="h4"><a class="selflink" id="appendix-B.4.1" href="#appendix-B.4.1">B.4.1</a>. Verbose MKCOL Request/Response</span>
>> Request <<
MKCOL /container/ HTTP/1.1
Host: webdav.example.com
Content-Type: application/xml; charset=utf-8
Content-Length: 181
<?xml version="1.0" encoding="utf-8"?>
<D:mkcol xmlns:D="DAV:">
<D:set>
<D:prop>
<D:displayname>My Container</D:displayname>
</D:prop>
</D:set>
</D:mkcol>
>> Response <<
HTTP/1.1 201 Created
<span class="grey">Murchison Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
Cache-Control: no-cache
Content-Type: application/xml; charset=utf-8
Content-Length: 224
<?xml version="1.0" encoding="utf-8"?>
<D:mkcol-response xmlns:D="DAV:">
<D:propstat>
<D:prop>
<D:displayname/>
</D:prop>
<D:status>HTTP/1.1 200 OK</D:status>
</D:propstat>
</D:mkcol-response>
<span class="h4"><a class="selflink" id="appendix-B.4.2" href="#appendix-B.4.2">B.4.2</a>. Minimal MKCOL Request/Response</span>
>> Request <<
MKCOL /container/ HTTP/1.1
Host: webdav.example.com
Content-Type: application/xml; charset=utf-8
Content-Length: 181
Prefer: return=minimal
<?xml version="1.0" encoding="utf-8"?>
<D:mkcol xmlns:D="DAV:">
<D:set>
<D:prop>
<D:displayname>My Container</D:displayname>
</D:prop>
</D:set>
</D:mkcol>
>> Response <<
HTTP/1.1 201 Created
Cache-Control: no-cache
Content-Length: 0
Preference-Applied: return=minimal
<span class="h3"><a class="selflink" id="appendix-B.5" href="#appendix-B.5">B.5</a>. POST</span>
<span class="h4"><a class="selflink" id="appendix-B.5.1" href="#appendix-B.5.1">B.5.1</a>. Typical Resource Creation and Retrieval via POST + GET</span>
Note that this request is not conditional because by using the POST
[<a href="./rfc5995" title=""Using POST to Add Members to Web Distributed Authoring and Versioning (WebDAV) Collections"">RFC5995</a>] method, the client lets the server choose the resource URI,
thereby guaranteeing that it will not modify an existing resource.
<span class="grey">Murchison Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
>> Request <<
POST /container/work;add-member/ HTTP/1.1
Host: caldav.example.com
Content-Type: text/calendar; charset=utf-8
Content-Length: 521
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example Corp.//CalDAV Client//EN
BEGIN:VEVENT
UID:CD87465FA
SEQUENCE:0
DTSTAMP:20120602T185254Z
DTSTART:20120602T160000Z
DTEND:20120602T170000Z
TRANSP:OPAQUE
SUMMARY:Lunch
ORGANIZER;CN="Ken Murchison":mailto:murch@example.com
ATTENDEE;CN="Ken Murchison";CUTYPE=INDIVIDUAL;PARTSTAT=ACCEPTED:
mailto:murch@example.com
ATTENDEE;CN="John Doe";CUTYPE=INDIVIDUAL;PARTSTAT
=NEEDS-ACTION;ROLE=REQ-PARTICIPANT;RSVP=TRUE:mailto:jdoe@
example.com
END:VEVENT
END:VCALENDAR
>> Response <<
HTTP/1.1 201 Created
Location: /container/work/abc.ics
Content-Length: 0
Note that the server did not include any validator header fields
(e.g., ETag) in the response, signaling that the created
representation differs from the representation sent in the body of
the request. The client has to send a separate GET request to
retrieve the current representation:
>> Request <<
GET /container/work/abc.ics HTTP/1.1
Host: caldav.example.com
>> Response <<
HTTP/1.1 200 OK
<span class="grey">Murchison Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
Content-Type: text/calendar; charset=utf-8
Content-Length: 541
ETag: "nahduyejc"
Schedule-Tag: "jfd84hgbcn"
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example Corp.//CalDAV Server//EN
BEGIN:VEVENT
UID:CD87465FA
SEQUENCE:0
DTSTAMP:20120602T185300Z
DTSTART:20120602T160000Z
DTEND:20120602T170000Z
TRANSP:OPAQUE
SUMMARY:Lunch
ORGANIZER;CN="Ken Murchison":mailto:murch@example.com
ATTENDEE;CN="Ken Murchison";CUTYPE=INDIVIDUAL;PARTSTAT=ACCEPTED:
mailto:murch@example.com
ATTENDEE;CN="John Doe";CUTYPE=INDIVIDUAL;PARTSTAT
=NEEDS-ACTION;ROLE=REQ-PARTICIPANT;RSVP=TRUE;SCHEDULE-STATUS=
1.2:mailto:jdoe@example.com
END:VEVENT
END:VCALENDAR
<span class="h4"><a class="selflink" id="appendix-B.5.2" href="#appendix-B.5.2">B.5.2</a>. Streamlined Resource Creation and Retrieval via POST</span>
Note that this request is not conditional because by using the POST
[<a href="./rfc5995" title=""Using POST to Add Members to Web Distributed Authoring and Versioning (WebDAV) Collections"">RFC5995</a>] method, the client lets the server choose the resource URI,
thereby guaranteeing that it will not modify an existing resource.
>> Request <<
POST /container/work;add-member/ HTTP/1.1
Host: caldav.example.com
Content-Type: text/calendar; charset=utf-8
Content-Length: 521
Prefer: return=representation
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example Corp.//CalDAV Client//EN
BEGIN:VEVENT
UID:CD87465FA
SEQUENCE:0
DTSTAMP:20120602T185254Z
DTSTART:20120602T160000Z
DTEND:20120602T170000Z
<span class="grey">Murchison Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
TRANSP:OPAQUE
SUMMARY:Lunch
ORGANIZER;CN="Ken Murchison":mailto:murch@example.com
ATTENDEE;CN="Ken Murchison";CUTYPE=INDIVIDUAL;PARTSTAT=ACCEPTED:
mailto:murch@example.com
ATTENDEE;CN="John Doe";CUTYPE=INDIVIDUAL;PARTSTAT
=NEEDS-ACTION;ROLE=REQ-PARTICIPANT;RSVP=TRUE:mailto:jdoe@
example.com
END:VEVENT
END:VCALENDAR
>> Response <<
HTTP/1.1 201 Created
Location: /container/work/abc.ics
Content-Type: text/calendar; charset=utf-8
Content-Length: 541
Content-Location: /container/work/abc.ics
ETag: "nahduyejc"
Schedule-Tag: "jfd84hgbcn"
Preference-Applied: return=representation
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example Corp.//CalDAV Server//EN
BEGIN:VEVENT
UID:CD87465FA
SEQUENCE:0
DTSTAMP:20120602T185300Z
DTSTART:20120602T160000Z
DTEND:20120602T170000Z
TRANSP:OPAQUE
SUMMARY:Lunch
ORGANIZER;CN="Ken Murchison":mailto:murch@example.com
ATTENDEE;CN="Ken Murchison";CUTYPE=INDIVIDUAL;PARTSTAT=ACCEPTED:
mailto:murch@example.com
ATTENDEE;CN="John Doe";CUTYPE=INDIVIDUAL;PARTSTAT
=NEEDS-ACTION;ROLE=REQ-PARTICIPANT;RSVP=TRUE;SCHEDULE-STATUS=
1.2:mailto:jdoe@example.com
END:VEVENT
END:VCALENDAR
<span class="grey">Murchison Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
<span class="h3"><a class="selflink" id="appendix-B.6" href="#appendix-B.6">B.6</a>. PUT</span>
<span class="h4"><a class="selflink" id="appendix-B.6.1" href="#appendix-B.6.1">B.6.1</a>. Typical Conditional Resource Update Failure and Retrieval via</span>
PUT + GET
>> Request <<
PUT /container/motd.txt HTTP/1.1
Host: dav.example.com
Content-Type: text/plain
Content-Length: 69
If-Match: "asd973"
Either write something worth reading or do something worth writing.
>> Response <<
HTTP/1.1 412 Precondition Failed
Content-Length: 0
The resource has been modified by another user agent (ETag mismatch);
therefore, the client has to send a separate GET request to retrieve
the current representation:
>> Request <<
GET /container/motd.txt HTTP/1.1
Host: dav.example.com
>> Response <<
HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 52
ETag: "789sdas"
An investment in knowledge pays the best interest.
<span class="h4"><a class="selflink" id="appendix-B.6.2" href="#appendix-B.6.2">B.6.2</a>. Streamlined Conditional Resource Update Failure and Retrieval</span>
via PUT
>> Request <<
PUT /container/motd.txt HTTP/1.1
Host: dav.example.com
Content-Type: text/plain
<span class="grey">Murchison Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc8144">RFC 8144</a> Prefer Header Field in WebDAV April 2017</span>
Content-Length: 69
If-Match: "asd973"
Prefer: return=representation
Either write something worth reading or do something worth writing.
>> Response <<
HTTP/1.1 412 Precondition Failed
Content-Type: text/plain
Content-Length: 52
Content-Location: /container/motd.txt
ETag: "789sdas"
Preference-Applied: return=representation
An investment in knowledge pays the best interest.
Acknowledgements
The author would like to thank the following individuals for
contributing their ideas and support for writing this specification:
Cyrus Daboo, Helge Hess, Andrew McMillan, Arnaud Quillaud, and Julian
Reschke.
The author would also like to thank the Calendaring and Scheduling
Consortium for advice with this specification and for organizing
interoperability testing events to help refine it.
Author's Address
Kenneth Murchison
Carnegie Mellon University
5000 Forbes Avenue
Pittsburgh, PA 15213
United States of America
Phone: +1-412-268-1982
Email: murch@andrew.cmu.edu
Murchison Standards Track [Page 28]
</pre>
|
