Error handling - Revision history

Adminwiki: 6 revisions imported

2021-05-07T08:07:20Z

6 revisions imported

← Older revision	Revision as of 08:07, 7 May 2021
(No difference)

w>Mpolo: Removed stack trace

2011-01-14T12:56:09Z

Removed stack trace

← Older revision		Revision as of 12:56, 14 January 2011
Line 58:		Line 58:
	** '''exceptionId''' Fixed name of the exception.		** '''exceptionId''' Fixed name of the exception.
	** '''exceptionMessage''' Human message explaining the exception		** '''exceptionMessage''' Human message explaining the exception
	** '''stackTrace''' Not used

	== Example ==		== Example ==

Line 73:		Line 71:
	'''<exceptionId>'''RuntimeException'''</exceptionId>'''		'''<exceptionId>'''RuntimeException'''</exceptionId>'''
	'''<exceptionMessage>'''This is a test exception'''</exceptionMessage>'''		'''<exceptionMessage>'''This is a test exception'''</exceptionMessage>'''
	~~'''<stackTrace></stackTrace>'''~~
	'''</exception>'''		'''</exception>'''

w>Jguillo at 08:48, 14 May 2010

2010-05-14T08:48:56Z

← Older revision		Revision as of 08:48, 14 May 2010
Line 60:		Line 60:
	** '''stackTrace''' Not used		** '''stackTrace''' Not used

	== ~~Sample~~ ==		== Example ==

	REQUEST:		REQUEST:

w>Jguillo at 08:48, 14 May 2010

2010-05-14T08:48:47Z

← Older revision		Revision as of 08:48, 14 May 2010
Line 29:		Line 29:
	* '''WorkNotFound''': The specified work code was not found		* '''WorkNotFound''': The specified work code was not found

	== ~~Sample~~ ==		== Example ==

	REQUEST:		REQUEST:

w>Jguillo at 12:46, 4 May 2010

2010-05-04T12:46:51Z

← Older revision		Revision as of 12:46, 4 May 2010
Line 60:		Line 60:
	** '''stackTrace''' Not used		** '''stackTrace''' Not used

	~~Example of an exception:~~		== Sample ==

	REQUEST:		REQUEST:

w>Jguillo at 12:46, 4 May 2010

2010-05-04T12:46:10Z

← Older revision		Revision as of 12:46, 4 May 2010
Line 24:		Line 24:
	* '''RestParameterNotExpected''': You have supplied a parameter not used by the component		* '''RestParameterNotExpected''': You have supplied a parameter not used by the component
	* '''RestParameterNotFound''': Some required parameter is missing		* '''RestParameterNotFound''': Some required parameter is missing
	* '''TimedLicenseUsageNotActive''': You are trying to register a work using a time-limited license and the authorizing user has not enabled this service.
	* '''UserKeyAuthNotFound''': The provided authkey does not exist		* '''UserKeyAuthNotFound''': The provided authkey does not exist
	* '''UserKeyNotFound''': The provided sharedkey does not exist		* '''UserKeyNotFound''': The provided sharedkey does not exist
Line 65:		Line 64:
	REQUEST:		REQUEST:

	https://api.safecreative.org/v2/?component=exception.test		<nowiki>https://api.safecreative.org/v2/?component=exception.test</nowiki>


	RESPONSE:		RESPONSE:

	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<exception>		'''<exception>'''
	<exceptionId>RuntimeException</exceptionId>		'''<exceptionId>'''RuntimeException'''</exceptionId>'''
	<exceptionMessage>This is a test exception</exceptionMessage>		'''<exceptionMessage>'''This is a test exception'''</exceptionMessage>'''
	<stackTrace></stackTrace>		'''<stackTrace></stackTrace>'''
	</exception>		'''</exception>'''

w>Jguillo: Created page with 'Invalid parameters or invalid requests return an error, server-side problems return an exception. = Errors = Errors are returned when an operation is invoked with wrong or mis…'

2010-05-04T12:44:43Z

Created page with 'Invalid parameters or invalid requests return an error, server-side problems return an exception. = Errors = Errors are returned when an operation is invoked with wrong or mis…'

New page

Invalid parameters or invalid requests return an error, server-side problems return an exception.

= Errors =

Errors are returned when an operation is invoked with wrong or missing arguments or without enough permissions.

== Syntax ==
* '''error'''
** '''errorId''' Fixed name of the error. You can test against this errorId to recover from known errors.
** '''errorMessage''' Human message explaining the error

== Error codes ==
These are some common errorId you may encounter:
* '''InsufficientLevel''': You have called an API component which requires a higher authorization level. For example, you have called work.register with a GET authkey.
* '''InvalidNonceKey''': Supplied nonce key is not correct
* '''InvalidParameter''': Some parameter has an invalid value
* '''InvalidProtocol''': You have called through HTTP a component that requires HTTPS
* '''InvalidRequest''': The request has some invalid parameter or is not correct
* '''InvalidRestComponent''': The specified component does not exist
* '''InvalidSignature''': The request [[signature parameter]] is not correct
* '''InvalidTime''': The request [[ztime parameter]] is not correct
* '''NotAuthorized''': Your application is not authorized to perform this operation. For example, you are trying to get the state of an authkey not associated to your application.
* '''ProfessionalServiceNotActive''': The operation you are requesting requires some professional service which the user has not purchased.
* '''RestParameterNotExpected''': You have supplied a parameter not used by the component
* '''RestParameterNotFound''': Some required parameter is missing
* '''TimedLicenseUsageNotActive''': You are trying to register a work using a time-limited license and the authorizing user has not enabled this service.
* '''UserKeyAuthNotFound''': The provided authkey does not exist
* '''UserKeyNotFound''': The provided sharedkey does not exist
* '''UserNotFound''': The specified user code was not found
* '''WorkNotFound''': The specified work code was not found

== Sample ==

REQUEST:

<nowiki>https://api.safecreative.org/v2/</nowiki>
?component=authkey.state
&sharedkey=zy9x4ol0ctg3btyswq7b5wi9
&ztime=1271749823276
&signature=c47b33222c850019574185051c3013ee817e5584

RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
'''<error>'''
'''<errorId>'''RestParameterNotFound'''</errorId>'''
'''<errorMessage>'''Required parameter not found: authkey'''</errorMessage>'''
'''</error>'''

= Exceptions =

Exceptions are returned if some unexpected error occurs in the API server.
Exceptions are therefore not recoverable by your application.
You should get in contact with Safe Creative if an exception persists.

== Syntax ==
* '''exception'''
** '''exceptionId''' Fixed name of the exception.
** '''exceptionMessage''' Human message explaining the exception
** '''stackTrace''' Not used

Example of an exception:

REQUEST:

https://api.safecreative.org/v2/?component=exception.test

RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<exception>
<exceptionId>RuntimeException</exceptionId>
<exceptionMessage>This is a test exception</exceptionMessage>
<stackTrace></stackTrace>
</exception>