Skip to content

Latest commit

 

History

History
33 lines (17 loc) · 1.54 KB

APIError.md

File metadata and controls

33 lines (17 loc) · 1.54 KB

DyspatchClient.APIError

Properties

Name Type Description Notes
code String Error code: * server_error - Internal server error. * invalid_parameter - Validation error, parameter will contain invalid field and message will contain the reason. * invalid_body - Body could not be parsed, message will contain the reason. * invalid_request - Validation error, the protocol used to make the request was not https. * unauthorized - Credentials were found but permissions were not sufficient. * unauthenticated - Credentials were not found or were not valid. * not_found - The requested resource was not found. * rate_limited - The request was refused because a rate limit was exceeded. There is an account wide rate limit of 3600 requests per-minute, although that is subject to change. The current remaining rate limit can be viewed by checking the X-Ratelimit-Remaining header. [optional]
message String Human readable error message [optional]
parameter String The invalid parameter, if 'code' is invalid_parameter [optional]

Enum: CodeEnum

  • server_error (value: "server_error")

  • invalid_parameter (value: "invalid_parameter")

  • invalid_body (value: "invalid_body")

  • invalid_request (value: "invalid_request")

  • unauthorized (value: "unauthorized")

  • unauthenticated (value: "unauthenticated")

  • not_found (value: "not_found")

  • rate_limited (value: "rate_limited")