Page tree
Skip to end of metadata
Go to start of metadata

REQUEST

URL

  • https://webdomain/api/rest/v10

  • The URL includes Domain and method name.

  • If the URL contains a reserved character, it must be encoded. Check Percent encoding for more information.

Headers

  • Authorization header

  • "Accept" header - set desired response format to "application/json" or application/xml"

  • "Content-Type" header - set to "application/json" or "application/xml" (POST method only)

Body (POST method only)

  • The content syntax must match the selected content type
  • The body syntax can be validated at jsonlint.com



RESPONSE

Code

Message

Action

HTTP 204

Success

Not necessary. Everything went well.

HTTP 401

Unauthorized

Add authorization header.

HTTP 403

Forbidden

Validate user type, username and password.

HTTP 404

Page Not found

Provide valid URL. Make sure no "\\" in URL.

HTTP 406

Not Acceptable

Validate "Accept" header.

HTTP 415

Unsupported Media Type

Validate "Content-Type" header.

HTTP 417

Account expired

Try resetting the password or Contact Support

HTTP 500

Database Access Limit Exceeded

Reduce the load to ~10 tps or Contact Support

HTTP 500

Internal Server Error

Contact Support


  • WADL

    Web Application Description Language (WADL) is a machine-readable description of all REST calls

    https://webdomain/api/rest/v7?wadl


  • No labels