Fast.io Developer Documentation

Fast.io simplifies the delivery of sales and marketing materials - documents, PDFs, images, videos, and websites. If you're already storing your documents in the cloud, no changes are required, and there's no need for an IT department.

Get Started    Fundamentals

Result Codes

Expected results from API requests and general descriptions of meaning.

🚧

Always Check Body

Never depend on an HTTP code response without the appropriate body. Every API response should include a response field in the body. An HTTP code with a result field may indicate the request failed, was partially processed, or was not processed at all.

HTTP Requests

Our HTTP request support is limited to a subset of RFC 2616. We do not utilize any HTTP methods in RFC 2518, RFC 3253, RFC 3648, or RFC 3744.

HTTP Request Type

Used in our API

Description

GET

Yes

Used for retrieving information, authentication, and files.

OPTIONS

No

HEAD

No

POST

Yes

Used to update information.

PUT

No

POST is used in place of PUT for API simplicity.

DELETE

Yes

Used to delete objects and disable settings.

TRACE

No

CONNECT

No

PATCH

No

SEARCH

No

HTTP Results

This API documentation does not include every possible result for each API because many of the results are common to the API as a whole. See individual API’s for specific results associated with a given API and assume there are a wide range of possible responses for boiler plate operations, including authorization failures, format issues, or platform operational issues.

Request successes are returned with HTTP status codes starting with 2xx. Below is a partial list of responses.

HTTP Result

Result

Descripton

200

Success

The request was successful.

202

Success

The input was accepted successfully.

203

Non-Authorative Success

The result may be out of date.

204

Success

The request was successful but there is no response body. Generally this is not used as we try to always return a body with an implicit result field.

205

Successful Reset

The resource was reset.

206

Partial Success

The response only includes part of the request resource.

Request errors are returned with HTTP status codes starting with 4xx and server errors are start with 5xx codes. Below is a partial list of responses.

HTTP Result

Result

Description

400

Failure

The request was invalid because the format was incorrect or the resource method was unsupported for that type.

401

Denied

The request was not processed because the authorization credentials were not valid or acceptable for this resource.

402

Failure

Payment details must be set before this action can be taken.

403

Denied

The request was not processed because the authorization credentials do not allow access to the requested resource.

404

Not Found

The resource you attempted to access is invalid.

405

Disabled

The request method is known by the server but has been disabled and cannot be used.

406

Not Acceptable

The input is not acceptable for this resource or for the field it was supplied with.

408

Timeout

The request timed out internally. Re-attempt the request.

409

Conflict

The request was rejected because of conflicting data or because it exceeded an internal limit.

414

Invalid

The request URI or headers exceeded the maximum length supported by the server.

420 429

Denied

The request may be valid but too many requests are being made. Slow down.

423

Temporarily Denied

The requested resource is locked temporarily. You should check the status of pending jobs.

500

Error

The request has failed internally and may be partially completed. These should be generated very infrequently.

500
502
503
504

Error

There is an internal outage in our stack.

🚧

Additional HTTP Result Codes

Other standard HTTP errors may be generated by our stack and not directly from our API.

❗️

Rate Limiting

Many resources have an access rate limit that, when exceeded, will result in a 429 response and error. This is a temporary error and you should retry your request again after an interval. The length of the interval is determined by the type of rate limit exceeded and is not defined on a per-API basis or in an error response.

If you run into rate limiting issues, please contact us at [email protected]

❗️

Locked Resources

When a resource is accessed and a process is in progress, the API may return 423 Locked. This is a temporary error that occurs on operations that block system access for integrity. Retry your request in a few moments.

Updated about a year ago

Result Codes


Expected results from API requests and general descriptions of meaning.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.