annotate OrthancCppClient/HttpEnumerations.h @ 121:a7e98bbeaf48 Orthanc-0.2.2

close
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 29 Apr 2013 12:54:48 +0200
parents 77aec9be0a51
children e3a40c7846b8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
60
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012 Medical Physics Department, CHU of Liege,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Belgium
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * Permission is hereby granted, free of charge, to any person
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * obtaining a copy of this software and associated documentation
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * files (the "Software"), to deal in the Software without
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * restriction, including without limitation the rights to use, copy,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * modify, merge, publish, distribute, sublicense, and/or sell copies
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * of the Software, and to permit persons to whom the Software is
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * furnished to do so, subject to the following conditions:
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * The above copyright notice and this permission notice shall be
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * included in all copies or substantial portions of the Software.
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * SOFTWARE.
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 **/
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 #pragma once
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29
43
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
30
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
31 /**
60
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
32 * This file contains the enumerations for the access to the Orthanc
43
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
33 * REST API in C and C++. Namespaces are not used, in order to enable
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
34 * the access in C.
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
35 **/
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
36
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
37 // Most common, non-joke and non-experimental HTTP status codes
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
38 // http://en.wikipedia.org/wiki/List_of_HTTP_status_codes
60
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
39 enum Orthanc_HttpStatus
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 {
60
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
41 Orthanc_HttpStatus_None = -1,
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
43
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
43 // 1xx Informational
60
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
44 Orthanc_HttpStatus_100_Continue = 100,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
45 Orthanc_HttpStatus_101_SwitchingProtocols = 101,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
46 Orthanc_HttpStatus_102_Processing = 102,
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47
43
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
48 // 2xx Success
60
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
49 Orthanc_HttpStatus_200_Ok = 200,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
50 Orthanc_HttpStatus_201_Created = 201,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
51 Orthanc_HttpStatus_202_Accepted = 202,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
52 Orthanc_HttpStatus_203_NonAuthoritativeInformation = 203,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
53 Orthanc_HttpStatus_204_NoContent = 204,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
54 Orthanc_HttpStatus_205_ResetContent = 205,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
55 Orthanc_HttpStatus_206_PartialContent = 206,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
56 Orthanc_HttpStatus_207_MultiStatus = 207,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
57 Orthanc_HttpStatus_208_AlreadyReported = 208,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
58 Orthanc_HttpStatus_226_IMUsed = 226,
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
43
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
60 // 3xx Redirection
60
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
61 Orthanc_HttpStatus_300_MultipleChoices = 300,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
62 Orthanc_HttpStatus_301_MovedPermanently = 301,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
63 Orthanc_HttpStatus_302_Found = 302,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
64 Orthanc_HttpStatus_303_SeeOther = 303,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
65 Orthanc_HttpStatus_304_NotModified = 304,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
66 Orthanc_HttpStatus_305_UseProxy = 305,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
67 Orthanc_HttpStatus_307_TemporaryRedirect = 307,
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68
43
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
69 // 4xx Client Error
60
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
70 Orthanc_HttpStatus_400_BadRequest = 400,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
71 Orthanc_HttpStatus_401_Unauthorized = 401,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
72 Orthanc_HttpStatus_402_PaymentRequired = 402,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
73 Orthanc_HttpStatus_403_Forbidden = 403,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
74 Orthanc_HttpStatus_404_NotFound = 404,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
75 Orthanc_HttpStatus_405_MethodNotAllowed = 405,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
76 Orthanc_HttpStatus_406_NotAcceptable = 406,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
77 Orthanc_HttpStatus_407_ProxyAuthenticationRequired = 407,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
78 Orthanc_HttpStatus_408_RequestTimeout = 408,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
79 Orthanc_HttpStatus_409_Conflict = 409,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
80 Orthanc_HttpStatus_410_Gone = 410,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
81 Orthanc_HttpStatus_411_LengthRequired = 411,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
82 Orthanc_HttpStatus_412_PreconditionFailed = 412,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
83 Orthanc_HttpStatus_413_RequestEntityTooLarge = 413,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
84 Orthanc_HttpStatus_414_RequestUriTooLong = 414,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
85 Orthanc_HttpStatus_415_UnsupportedMediaType = 415,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
86 Orthanc_HttpStatus_416_RequestedRangeNotSatisfiable = 416,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
87 Orthanc_HttpStatus_417_ExpectationFailed = 417,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
88 Orthanc_HttpStatus_422_UnprocessableEntity = 422,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
89 Orthanc_HttpStatus_423_Locked = 423,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
90 Orthanc_HttpStatus_424_FailedDependency = 424,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
91 Orthanc_HttpStatus_426_UpgradeRequired = 426,
43
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
92
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
93 // 5xx Server Error
60
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
94 Orthanc_HttpStatus_500_InternalServerError = 500,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
95 Orthanc_HttpStatus_501_NotImplemented = 501,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
96 Orthanc_HttpStatus_502_BadGateway = 502,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
97 Orthanc_HttpStatus_503_ServiceUnavailable = 503,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
98 Orthanc_HttpStatus_504_GatewayTimeout = 504,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
99 Orthanc_HttpStatus_505_HttpVersionNotSupported = 505,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
100 Orthanc_HttpStatus_506_VariantAlsoNegotiates = 506,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
101 Orthanc_HttpStatus_507_InsufficientStorage = 507,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
102 Orthanc_HttpStatus_509_BandwidthLimitExceeded = 509,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
103 Orthanc_HttpStatus_510_NotExtended = 510
43
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
104 };
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106
60
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
107 enum Orthanc_HttpMethod
43
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
108 {
60
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
109 Orthanc_HttpMethod_Get = 0,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
110 Orthanc_HttpMethod_Post = 1,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
111 Orthanc_HttpMethod_Delete = 2,
77aec9be0a51 renaming of cppclient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 57
diff changeset
112 Orthanc_HttpMethod_Put = 3
43
9be852ad33d2 rename for c
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
113 };