Service Fulfillment REST API Error Codes

The following table lists the errors that are returned by CVP REST APIs.

Media File CREATE Error Code
HTTP Status	Error Code	Error Description	Error Data	Error Detail
400	invalid.inputUploadConfig	Input xml/json is empty	NA	NA
400	invalid.inputMediaFile	Input media file missing	NA	NA
400	processing.xmlSyntaxError	XML Syntax error while processing the request attachment	NA	NA
400	invalid.requestAttachment	Malformed JSON in request attachment.	NA	NA
400	invalid.attachment	Request attachment IO error.	NA	NA
400	invalidInput.invalidCharacter	Invalid characters in the input field.	Field Name which has invalid characters	InvalidValueErrorDetail
400	invalidInput.invalidFieldLength	Invalid length of input field.	Field Name which has invalid length	StringLengthErrorDetail
400	invalidInput.invalidServerRef	Invalid Server Reference URL	serverRef	InvalidValueErrorDetail
400	invalidInput.invalidMediaFileExtension	Invalid Media File Extension	fileName	InvalidValueErrorDetail
400	invalidInput.requiredInputfieldMissing	Required Input field is missing	Missing Required Input field	RequiredFieldErrorDetail
400	invalidInput.incompatibleServerVersion	Listed Media Server version is incompatible.	serverRef	InvalidValueErrorDetail
400	invalidInput.invalidDirDepth	The Directory dept in the path field is greater than the maximum allowed.	path	StringLengthErrorDetail
400	invalidInput.duplicateMediaFile	File name already exists	fileName	NA
400	invalidInput.duplicateServerRef	There is a duplicate entry in the Server list sent in the request	serverList	InvalidValueErrorDetail
400	invalid.inputMediaFile	File size out of valid range.	NA	FileSizeErrorDetail

Media File UPDATE Error Codes
HTTP Status	Error Code	Error Description	Error Data	Error Detail
400	invalid.inputUploadConfig	Input xml/json is empty	NA	NA
400	invalid.inputMediaFile	Input media file missing	NA	NA
400	invalid.requestAttachment	Malformed JSON in request attachment	NA	NA
400	invalid.attachment	Request attachment IO Error	NA	NA
400	invalidInput.invalidCharacter	Invalid characters in the input field	Field Name which has invalid characters	InvalidValueErrorDetail
400	invalidInput.invalidFieldLength	Invalid length of input field	Field Name which has invalid length	StringLengthErrorDetail
400	invalidInput.invalidServerRef	Invalid Server Reference URL	serverRef	InvalidValueErrorDetail
400	invalidInput.invalidMediaFileExtension	Invalid Media File Extension	fileName	InvalidValueErrorDetail
400	invalidInput.requiredInputfieldMissing	Required Input Field is missing	Missing Required Input field	RequiredFieldErrorDetail
400	invalidInput.incompatibleServerVersion	Listed Media Server version is incompatible	serverRef	InvalidValueErrorDetail
400	invalidInput.invalidDirDepth	The Directory dept in the path field is greater than the maximum allowed	path	StringLengthErrorDetail
400	invalidInput.duplicateServerRef	There is a duplicate entry in the Server list sent in the request	serverList	InvalidValueErrorDetail
400	invalid.inputMediaFile	File Size out of valid range	NA	FileSizeErrorDetail
400	invalid.inputMediaFile	Media file not found	NA	NA
400	invalid.updateOpertionNotAllowed	Media file cannot be updated on the set of specified servers in the request	NA	NA
400	invalid.operationInProgress	UPDATE request cannot be serviced, since an existing operation on the file is still in progress. Please try after some time	NA	NA

Media File GET LIST Error Codes
HTTP Status	Error Code	Error Description	Error Data	Error Detail
400	invalid.argument	query parameter : summary `"apiErrors": { "apiError": { "errorDetail": { "@type": "invalidValueErrorDetail", "name": "summary", "actual": "truE", "valid": "true" } } } }` `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <apiErrors> <apiError> <errorDetail xsi:type="invalidValueErrorDetail" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <name>summary</name> <actual>truE</actual> <valid>true</valid> </errorDetail> </apiError> </apiErrors>` Query parameter: startIndex if not 0 or more `{ "apiErrors": { "apiError": { "errorDetail": { "@type": "invalidValueErrorDetail", "name": "startIndex", "actual": "<actual Input>", "valid": "0 or more" } } } }` Query parameter: resultsPerPage if not 1 or more `{ "apiErrors": { "apiError": { "errorDetail": { "@type": "invalidValueErrorDetail", "name": "resultsPerPage", "actual": "<actual Input>", "valid": "0 or more" } } } }` Unknown Query parameter `{ "apiErrors": {"apiError": {"errorDetail": {"@type":"invalidQueryParamError", "name":"Query", "actualParms":"[df]", "validParmsList":"[q, summary, startindex, resultsperpage]" } } } }` Invalid Query parameter ex:q=filenae:media%20AND%20path:en-us `<apiError> <errorDetail xsi:type="invalidValueErrorDetail" xmlns:xsi="[http://www.w3.org/2001/ XMLSchema-instance">\|http://www.w3.org/2001/ XMLSchema-instance] <name>query</name> <actual>filenae:media%20AND%20path:en-us</actual> <valid>filename:media*%20AND%20path:en-us</valid> </errorDetail> </apiError>`	The invalid query parameter	InvalidValueErrorDetail

HTTP Status

Error Code

Error Description

Error Data

Error Detail

400

invalid.argument

query parameter : summary


 "apiErrors": {
 "apiError": {
      "errorDetail": {
        "@type": "invalidValueErrorDetail",
        "name": "summary",
        "actual": "truE",
        "valid": "true"
      }


    }
}
 }


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <apiErrors>
 <apiError>
 <errorDetail xsi:type="invalidValueErrorDetail" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <name>summary</name>
 <actual>truE</actual>
 <valid>true</valid>
 </errorDetail>
 </apiError>
 </apiErrors>

Query parameter: startIndex if not 0 or more


{
 "apiErrors": {
 "apiError": {
      "errorDetail": {
        "@type": "invalidValueErrorDetail",
        "name": "startIndex",
        "actual": "<actual Input>",
        "valid": "0 or more"
      }


    }
}
 }

Query parameter: resultsPerPage if not 1 or more


{
 "apiErrors": {
 "apiError": {
      "errorDetail": {
        "@type": "invalidValueErrorDetail",
        "name": "resultsPerPage",
        "actual": "<actual Input>",
        "valid": "0 or more"
      }


    }
}
 }

Unknown Query parameter

  
{ 
"apiErrors":
    {"apiError":
      {"errorDetail":
           {"@type":"invalidQueryParamError",
             "name":"Query",
             "actualParms":"[df]",
             "validParmsList":"[q, summary, startindex, resultsperpage]"
            }
       }
     }
}

Invalid Query parameter ex:q=filenae:media*%20AND%20path:en-us


<apiError>
 <errorDetail xsi:type="invalidValueErrorDetail" 
 xmlns:xsi="[http://www.w3.org/2001/
XMLSchema-instance">|http://www.w3.org/2001/
XMLSchema-instance]
  <name>query</name>
    <actual>filenae:media*%20AND%20path:en-us</actual>
    <valid>filename:media*%20AND%20path:en-us</valid>
  </errorDetail>
</apiError>

The invalid query parameter

InvalidValueErrorDetail

VXML Application DEPLOY Error Codes
HTTP Status	Error Code	Error Description	Error Data	Error Detail
400	invalid.noOfAttachments	Incorrect number of attachments received	NA	NA
400	invalid.format	URL cannot be decoded using UTF-8	NA	NA
400	invalid.inputUploadConfig	Input xml/json is empty	NA	NA
400	invalid.inputMediaFile	Input media file missing	NA	NA
400	invalid.requestAttachment	Malformed JSON in request attachment	NA	NA
400	invalid.attachment	Request attachment IO Error	NA	NA
400	invalidInput.invalidCharacter	Invalid characters in the input field	Field Name which has invalid characters	InvalidValueErrorDetail
400	invalidInput.invalidFieldLength	Invalid length of input field	Field Name which has invalid length	StringLengthErrorDetail
400	invalidInput.requiredInputfieldMissing	Required Input Field is missing	Missing Required Field name	RequiredFieldErrorDetail
400	invalidInput.incompatibleServerVersion	Listed Vxml Server version is incompatible	"serverRef"	InvalidValueErrorDetail
400	invalidInput.duplicateServerRef	There is a duplicate entry in the Server list sent in the request	"serverList"	InvalidValueErrorDetail
400	invalid.inputMediaFile	File Size out of valid range	NA	FileSizeErrorDetail
400	invalid.vxmlApplication	VXML Application archieve is invalid	NA	NA

VXML Application DELETE Error Codes
Error	Error Code	Error Type	Error message	Error Date	Error Detail
Bad Request	400	invalid.inputVxmlApp	Vxml App not found	NA	NA
Bad Request	400	invalid.invaliState	Vxml App is not in validate state to perform delete operation	NA	NA

VXML Application GET List Error Codes
HTTP Status	Error Code	Error Description	Error Data	Error Detail
400	invalid.argument	query parameter : summary `{ "apiErrors": { "apiError": { "errorDetail": { "@type": "invalidValueErrorDetail", "name": "summary", "actual": "truE", "valid": "true" } } } }` `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <apiErrors> <apiError> <errorDetail xsi:type="invalidValueErrorDetail" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <name>summary</name> <actual>truE</actual> <valid>true</valid> </errorDetail> </apiError> </apiErrors>` Query parameter: startIndex if not 0 or more `{ "apiErrors": { "apiError": { "errorDetail": { "@type": "invalidValueErrorDetail", "name": "startIndex", "actual": "<actual Input>", "valid": "0 or more" } } } }` Query parameter:resultsPerPage if not 1 or more `{ "apiErrors": { "apiError": { "errorDetail": { "@type": "invalidValueErrorDetail", "name": "resultsPerPage", "actual": "<actual Input>", "valid": "0 or more" } } } }` Unknown Query parameter `{ "apiErrors": {"apiError": {"errorDetail": {"@type":"invalidQueryParamError", "name":"Query", "actualParms":"[df]", "validParmsList":"[q, summary, startindex, resultsperpage]" } } } }`

HTTP Status

Error Code

Error Description

Error Data

Error Detail

400

invalid.argument

query parameter : summary

 {
 "apiErrors": {
 "apiError": {
      "errorDetail": {
        "@type": "invalidValueErrorDetail",
        "name": "summary",
        "actual": "truE",
        "valid": "true"
      }


    }
}
 }

 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <apiErrors>
 <apiError>
 <errorDetail xsi:type="invalidValueErrorDetail" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <name>summary</name>
 <actual>truE</actual>
 <valid>true</valid>
 </errorDetail>
 </apiError>
 </apiErrors>

Query parameter: startIndex if not 0 or more


{
 "apiErrors": {
 "apiError": {
      "errorDetail": {
        "@type": "invalidValueErrorDetail",
        "name": "startIndex",
        "actual": "<actual Input>",
        "valid": "0 or more"
      }


    }
}
 }

Query parameter:resultsPerPage if not 1 or more


{
 "apiErrors": {
 "apiError": {
      "errorDetail": {
        "@type": "invalidValueErrorDetail",
        "name": "resultsPerPage",
        "actual": "<actual Input>",
        "valid": "0 or more"
      }


    }
}
 }

Unknown Query parameter


{
   "apiErrors":
    {"apiError":
      {"errorDetail":
           {"@type":"invalidQueryParamError",
             "name":"Query",
             "actualParms":"[df]",
             "validParmsList":"[q, summary, startindex, resultsperpage]"
            }
       }
     }
}

VXML Application GET Error Codes
HTTP Status	Error Code	Error Description	Error Data	Error Detail
400	invalid.argument	Invalid 'summary' parameter `{ "apiErrors": { "apiError": { "errorDetail": { "@type": "invalidValueErrorDetail", "name": "summary", "actual": "truE", "valid": "true" } } } }` `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <apiErrors> <apiError> <errorDetail xsi:type="invalidValueErrorDetail" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <name>summary</name> <actual>truE</actual> <valid>true</valid> </errorDetail> </apiError> </apiErrors>`	The name of the invalid argument	InvalidValueErrorDetail

HTTP Status

Error Code

Error Description

Error Data

Error Detail

400

invalid.argument

Invalid 'summary' parameter


{
  "apiErrors": {
    "apiError": {
      "errorDetail": {
        "@type": "invalidValueErrorDetail",
        "name": "summary",
        "actual": "truE",
        "valid": "true"
      }
    }
  }
}


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<apiErrors>
    <apiError>
        <errorDetail xsi:type="invalidValueErrorDetail"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <name>summary</name>
            <actual>truE</actual>
            <valid>true</valid>
        </errorDetail>
    </apiError>
</apiErrors>

The name of the invalid argument

InvalidValueErrorDetail