view OrthancCppClient/HttpEnumerations.h @ 419:ab070786f478

fix
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 07 May 2013 13:45:02 +0200
parents 1188cb0ddaa5
children
line wrap: on
line source

/**
 * Orthanc - A Lightweight, RESTful DICOM Store
 * Copyright (C) 2012-2013 Medical Physics Department, CHU of Liege,
 * Belgium
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy,
 * modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 **/


#pragma once


/**
 * This file contains the enumerations for the access to the Orthanc
 * REST API in C and C++. Namespaces are not used, in order to enable
 * the access in C.
 **/

// Most common, non-joke and non-experimental HTTP status codes
// http://en.wikipedia.org/wiki/List_of_HTTP_status_codes
enum Orthanc_HttpStatus
{
  Orthanc_HttpStatus_None = -1,

  // 1xx Informational
  Orthanc_HttpStatus_100_Continue = 100,
  Orthanc_HttpStatus_101_SwitchingProtocols = 101,
  Orthanc_HttpStatus_102_Processing = 102,

  // 2xx Success
  Orthanc_HttpStatus_200_Ok = 200,
  Orthanc_HttpStatus_201_Created = 201,
  Orthanc_HttpStatus_202_Accepted = 202,
  Orthanc_HttpStatus_203_NonAuthoritativeInformation = 203,
  Orthanc_HttpStatus_204_NoContent = 204,
  Orthanc_HttpStatus_205_ResetContent = 205,
  Orthanc_HttpStatus_206_PartialContent = 206,
  Orthanc_HttpStatus_207_MultiStatus = 207,
  Orthanc_HttpStatus_208_AlreadyReported = 208,
  Orthanc_HttpStatus_226_IMUsed = 226,

  // 3xx Redirection
  Orthanc_HttpStatus_300_MultipleChoices = 300,
  Orthanc_HttpStatus_301_MovedPermanently = 301,
  Orthanc_HttpStatus_302_Found = 302,
  Orthanc_HttpStatus_303_SeeOther = 303,
  Orthanc_HttpStatus_304_NotModified = 304,
  Orthanc_HttpStatus_305_UseProxy = 305,
  Orthanc_HttpStatus_307_TemporaryRedirect = 307,

  // 4xx Client Error
  Orthanc_HttpStatus_400_BadRequest = 400,
  Orthanc_HttpStatus_401_Unauthorized = 401,
  Orthanc_HttpStatus_402_PaymentRequired = 402,
  Orthanc_HttpStatus_403_Forbidden = 403,
  Orthanc_HttpStatus_404_NotFound = 404,
  Orthanc_HttpStatus_405_MethodNotAllowed = 405,
  Orthanc_HttpStatus_406_NotAcceptable = 406,
  Orthanc_HttpStatus_407_ProxyAuthenticationRequired = 407,
  Orthanc_HttpStatus_408_RequestTimeout = 408,
  Orthanc_HttpStatus_409_Conflict = 409,
  Orthanc_HttpStatus_410_Gone = 410,
  Orthanc_HttpStatus_411_LengthRequired = 411,
  Orthanc_HttpStatus_412_PreconditionFailed = 412,
  Orthanc_HttpStatus_413_RequestEntityTooLarge = 413,
  Orthanc_HttpStatus_414_RequestUriTooLong = 414,
  Orthanc_HttpStatus_415_UnsupportedMediaType = 415,
  Orthanc_HttpStatus_416_RequestedRangeNotSatisfiable = 416,
  Orthanc_HttpStatus_417_ExpectationFailed = 417,
  Orthanc_HttpStatus_422_UnprocessableEntity = 422,
  Orthanc_HttpStatus_423_Locked = 423,
  Orthanc_HttpStatus_424_FailedDependency = 424,
  Orthanc_HttpStatus_426_UpgradeRequired = 426,

  // 5xx Server Error
  Orthanc_HttpStatus_500_InternalServerError = 500,
  Orthanc_HttpStatus_501_NotImplemented = 501,
  Orthanc_HttpStatus_502_BadGateway = 502,
  Orthanc_HttpStatus_503_ServiceUnavailable = 503,
  Orthanc_HttpStatus_504_GatewayTimeout = 504,
  Orthanc_HttpStatus_505_HttpVersionNotSupported = 505,
  Orthanc_HttpStatus_506_VariantAlsoNegotiates = 506,
  Orthanc_HttpStatus_507_InsufficientStorage = 507,
  Orthanc_HttpStatus_509_BandwidthLimitExceeded = 509,
  Orthanc_HttpStatus_510_NotExtended = 510
};


enum Orthanc_HttpMethod
{
  Orthanc_HttpMethod_Get = 0,
  Orthanc_HttpMethod_Post = 1,
  Orthanc_HttpMethod_Delete = 2,
  Orthanc_HttpMethod_Put = 3
};


const char* Orthanc_HttpMethod_ToString(Orthanc_HttpMethod method);