Unified CVP API Error Codes

Generic Error Response Structure

The following is the generic structure of an error response :

<apierrors>
    <apiError>
           <errorType>errorType</errorType>
           <errorData>errorData</errorData>
           <errorMessage>errorMessage</errorMessage>
           <errorDetail xsi:type="errordetailname" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
              <!-- see below for more information on various errordetail structures -->
           </errorDetail>
    </apiError>
    <apierror>
   ...
   </apierror>
</apierrors>

 {
  "apierrors": {
    "apiError": {
      "errorType": "errorType",
      "errorData": "errorData",
      "errorMessage": "errorMessage",
      "errorDetail": {
        "-xsi:type": "errordetailname",
        "-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance"
      }
    },
    "apierror": "
   ...
   "
  }
}

Sample Error Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<apiErrors>
    <apiError>
        <errorType>invalidInput.invalidDirDepth</errorType>
        <errorData>path</errorData>
        <errorMessage>The Directory depth in the path field is greater than the maximum allowed</errorMessage>
        <errorDetail xsi:type="stringLengthErrorDetail" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <name>invalidInput.invalidDirDepth</name>
            <max>6</max>
            <min>1</min>
        </errorDetail>
    </apiError>
</apiErrors>

{
  "apiErrors": {
    "apiError": {
      "errorType": "invalidInput.invalidDirDepth",
      "errorData": "path",
      "errorMessage": "The Directory depth in the path field is greater than the maximum allowed",
      "errorDetail": {
        "-xsi:type": "stringLengthErrorDetail",
        "-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
        "name": "invalidInput.invalidDirDepth",
        "max": "6",
        "min": "1"
      }
    }
  }
}

<ApiErrors>
     <ApiError>
             <ErrorType>Authorization Failure</ErrorType>
             <ErrorMessage>UNAUTHORIZED</ErrorMessage>
             <ErrorData>jsmith</ErrorData>
        </ApiError>
    </ApiErrors>

The following table lists the various categories of Unified CVP API errors:

Various Categories of Unified CVP API Errors
Operation	Categories
GET Server List	Authentication. Generic. Query Parameters. Server Type. Input Output Formatting. Server Type.
CREATE Media File	Authentication. Create Media File Validation. Input Output Formatting. Generic. Server Type.
GET Media/GET Content	Authentication. Generic. Input Output Formatting. GET Media File.
DELETE Media File	Authentication. Generic. Input Output Formatting. Delete Media File.

The following table lists the HTTP error codes:

HTTP Error Codes
Category	HTTP Status	Error Code	Error Description
Authentication	401	authorization.unathorized	Unauthorized request.
		authentication.notAuthorized	User is not authorized to access the requested resource.
		authentication.noAccess	User is not allowed to access the resource. Check the user roles.
Input Output Formatting	400	processing.jsonSyntaxError	JSON syntax error while processing the request attachment.
Input Output Formatting	400	processing.xmlSyntaxError	XML Syntax error while processing the request attachment.
Create Media File Validation	400	invalid.noOfAttachments	Incorrect number of attachments received.
	400	invalid.format	URL cannot be decoded using UTF-8.
	400	invalid.inputUploadConfig	Input XML/JSON is empty.
	400	invalid.inputMediaFile	Input media file missing.
	400	invalid.requestAttachment	Malformed JSON in request attachment.
	400	invalid.attachment	Request attachment IO error.
	400	invalidInput.invalidCharacter	Invalid characters in the input field.
	400	invalidInput.invalidFieldLength	Invalid length of input field.
	400	invalidInput.invalidMediaServerRef	Invalid Media Server Ref URL.
	400	invalidInput.duplicateMediaFile	File object already exists.
	400	invalidInput.invalidMediaFileExtension	Invalid Media File extension.
	400	invalidInput.requiredInputfieldMissing	Required Input field is missing.
	400	invalidInput.incompatibleServerVersion	Listed Media Server version is incompatible.
	400	invalidInput.invalidDirDepth	The Directory dept in the path field is greater than the maximum allowed.
	400	invalidInput.duplicateServerRef	There is a duplicate entry in the Server list sent in the request.
	400	invalid.inputMediaFile	File size out of valid range.
Generic	400	invalid.acceptHeader	Invalid accept header, it should contain either XML or JSON.
	400	invalid.argument	Invalid Argument.
	400	invalid.header	Missing accept header.
	404	invalid.url	Requested URL not found.
	500	processing.fileProcessingFailed	File processing failed.
	500	processing.urlGenerationFailed	Failed to generate URL.
	500	processing.internal	Internal server error.
	500	processing.databaseProcessingFailed	Database processing failed.
	500	internal.serverError	An internal error has occurred.
	500	processing.failed	Internal error.
	501	invalid.operation	Invalid RestOperator (not implemented).
Server Type	400	invalid.serverType	Invalid server type.
Query Parameters	400	invalid.serverQuery	Invalid query param. Value should start with (type:).
Query Parameters	400	invalid.queryParam	Query param can either be 'q' or 'Q'.
DELETE Media File	400	invalid.jobId	Job ID given in the request is not valid for the operation.
DELETE Media File	500	operation.deleteMediaFailed	Media File Delete operation failed.
GET Media File	400	invalid.inputMediaFile	Media file not available for download.