api response structure code example

Example 1: what are response in api

REQUEST :(request url,http methods,header,query param, param,body,cookie)

1-)Request Url where we have Endpoint (domain:Port/Endpoints)

2-)HTTP METHODS(Get, Post, Put, Patch, Delete, Header)

Get: For to retrieve resources from the server
Post: to send or add resource to the server
Put: For update the resources in the server
Patch: For partial update the resource
Delete: For deleting the resource in the server
Head: To get header from the response not the body

3-)HEADER is metadata is about the request,
basically providing more information along
with the request.

-Content Type header : to specify what kind of
 data we are sending to the server
-Accept Header : to specify what kind of data 
 format you want to get in the response like (json or xml)
-Authorization header : used to provide the
 Bearer token in many api's.

4-)Query Parameter: A key value pair usually
 for filtering result

5-)Parameter: for identifying single resource
 among the list of resources.
6-)Payload(BODY): for POST,PUT,PATCH request
(json,xml,plainText,URL encoded for data)
7-)Cookie

RESPONSE :(STATUS CODE,PAYLOAD(body),HEADER,COOKIE,
           TIME(spent to get response))

1-Status Code:
   2xx - Success
   4xx - Client Error
   5xx - Server Error

2-Payload(Body) : 
The actual resource we got from the server.
Content type can be : plain text, json, xml, html, json etc.

3- Metadata about response to provide more information

4- Cookie

5- Time for getting spended time for the response

Example 2: api response

Response 
				
				 Status code 
				 			2xx -->>  success 
				 			4xx -->>  client side error
				 			5xx -->>  server side error 
				 Header 
				 		meta data about your response 
				 		like Content-Type, Date and some other info

				 Body | Payload		
				 		The response we got from the server 
				 		and this where we do lots of validation

Example 3: api response format

{  aps: {    alert: {      "loc-key":  "REQUEST_FORMAT",      "loc-args": [@message]    },    sound:      "default",    id:         @id,    request_id:  @request_id,    push_type:  push_type,    payload:    @payload  },  pn_gcm: {    data: {      message: @message,    }  }}

Example 4: api response format

{    "success": true,    "message": "Category deleted successfully",    "data": {}}