Server Notes

API Server Notes

Data structures for Server responses for CRUD methods

In order for this application to properly function there are a few expectation it has about the format/structure of the data that it receives in responses form the server They are as follows:

Create Request

On Success

(WIP) Documentation coming soon

On Failure

(WIP) Documentation coming soon

Update Request

On Success

(WIP) Documentation coming soon

On Failure

(WIP) Documentation coming soon

Delete Request

On Success

(WIP) Documentation coming soon

On Failure

(WIP) Documentation coming soon

Index Request

On Success

(WIP) Documentation coming soon

On Failure

(WIP) Documentation coming soon

Show Request

A HTTP request to get data for a specific resource entry ex. A book

Expected Path [HOST_PATH]/[resource name plural]/[resource id] ex. http://localhost:3000/users/1

On Success

{
  data: {
    id: ...,
    ... // other attributes of the resource
  },
  ... // additional data if desired.
}

On Failure

{
   header: ...,
   body: {
     message: 'A USEFUL ERROR MESSAGE',
     statusCode: 'The HTTP status code ex. 401',
    ...
   }
}

Expected Stripe Responses

(WIP) Documentation coming soon

Validation Error messages from Server

(WIP) Documentation coming soon