Skip to main content

Error Codes

caution

The contents of this page are applicable to all V3 calls, excluding the Content Reporting API.

When using the Showpad API, you might run into a situation where an API request doesn't return the response you expected. To help you understand what went wrong and how you can resolve it, the Showpad API has an extensive list of errors and error types.

Parameter Errors

Parameter errors occur when an incorrect query parameter has been entered. For example, a NegativeParameterError is returned when the limit URL parameter is negative.

CodeName
2001InvalidParameterError
2002NegativeParameterError
2003NotNumericParameterError
2004NotIntegerParameterError

Persistence Errors

Persistence errors occur when an operation cannot be completed because it is not possible on a data level. For example, if an unknown ID is submitted, a ResourceNotFoundError will be returned

CodeName
3000PersistenceError
3001RelationshipDoesNotExistError
3002RelationshipExistsError
3003RelationshipNotFound
3004ResourceNotFoundError
3005SubcollectionNotFoundError
3006UnableToDeleteError
3007RelationshipUnsupportedError
3008ResourceNotModifiableError

Validation Errors

Validation errors occur when an operation cannot be completed because the entity or entities being submitted are not conform to the requirements put by Showpad. For example, if a username is already registered, a NotUniqueValidationError will be returned

CodeName
4000ValidationError
4001ChoiceValidationError
4002DateTooEarlyValidationError
4003DateTooLateValidationError
4004FileTooBigValidationError
4005FileValidationError
4006FormatValidationError
4007I18nValidationError
4008IsRequiredValidationError
4009NotUniqueValidationError
4010TooFewCharsValidationError
4011TooManyCharsValidationError
4012UnavailableValidationError
4013WrongFileTypeValidationError
4014NoLicensesLeftValidationError
4015OwnerAlreadyExistsValidationError
4016UrlUnavailableValidationError
4017BelowMinimumValidationError
4018AboveMaximumValidationError
4019OwnerDoesNotExistValidationError
4020OwnerLockoutValidationError
4021ProfileLimitReachedValidationError
4022NoLowerCaseCharacterValidationError
4023NoUpperCaseCharacterValidationError
4024NoNumericCharacterValidationError
4025NoSymbolicCharacterValidationError
4026NotUniqueOverLatestChangesValidationError
4027NotUniqueOverTimeValidationError
4028FileTooSmallValidationError
4029RevokedCatalogValidationError

Body Errors

Body errors are returned when the format entered in the request's body is invalid.

CodeName
5000InvalidBodyError
5001InvalidJsonBodyError
5002TooManyResourcesInBodyError