Scribd
Upload
75 views

API Specification Doc: (Online Hotel Mangement App)

This document summarizes the API specifications for an online hotel management app. It includes 3 methods for registration, checking username availability, and checking email availability. Each method section provides the request details like URL, parameters, and data types as well as possible response statuses and response bodies. The document also includes sections on conventions and status codes used in the API.

Uploaded by

Muneeba Kaleem
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
75 views

API Specification Doc: (Online Hotel Mangement App)

This document summarizes the API specifications for an online hotel management app. It includes 3 methods for registration, checking username availability, and checking email availability. Each method section provides the request details like URL, parameters, and data types as well as possible response statuses and response bodies. The document also includes sections on conventions and status codes used in the API.

Uploaded by

Muneeba Kaleem
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 7

API Specification Doc

(Online Hotel Mangement App)


Index
1. Registration
Request
Response
2. CheckUsername
Request
Response
3.CheckuserEmail
Request
Response
Conventions
Status Codes
Methods

1. Registration

Request
Method URL

POST api/authentication/login

Type Params Values

HEAD auth_key String


POST { object
“Username”:”String”,
“Email”:”string”,
“password”:”String”,
“Confirm
password”:”string”
}

Response
Status Response

200 You are successfully loggedin.

400 {"error":"You must provide an e-mail"}


400 {"error":"You must provide a username"}

400 {"error":"You must provide a password"}

401 {"error":"Username or e-mail already exists"}

400 {"error":"Email is not Found"}

400 {"error":"Password Invalid"}

500 {"error":"Something went wrong. Please try again later."}

2. CheckUsername

Request
Method URL

GET api/authentication/login/checkusername/<username>

Type Params Values

POST { object
Username:string,
Password:String
}

Response
Status Response

400 {"error":"Username was not provided"}

401 {"error":"username is already taken"}

400 {"error":"Connection Error"}


200 {"Successfull":"username is available"}

500 {"error":"Something went wrong. Please try again later."}

3.CheckuserEmail

Request
Method URL

GET api//authentication/login/checkusername/<Email>

Type Params Values

POST { object
Username:string,
Password:String

Response
Status Response

400 {"error":"Email was not provided"}

401 {"error":"Email is already taken"}

400 {"error":"Connection Error"}

200 {"Successfull":"Email is available"}

500 {"error":"Something went wrong. Please try again later."}


Glossary
Conventions
● Client - Client application.
● Status - HTTP status code of response.
● All the possible responses are listed under ‘Responses’ for each method. Only one of them
is issued per request server.
● All response are in JSON format.
● All request parameters are mandatory unless explicitly marked as [optional]
● The type of values accepted for a request parameter are shown the the values column like
this [10|<any number>] .The | symbol means OR. If the parameter is [optional], the
default value is shown in blue bold text, as 10 is written in [10|<any number>].

Status Codes
All status codes are standard HTTP status codes. The below ones are used in this API.

2XX - Success of some kind


4XX - Error occurred in client’s part
5XX - Error occurred in server’s part

Status Code Description

200 OK

201 Created

202 Accepted (Request accepted, and queued for execution)

400 Bad request

401 Authentication failure


403 Forbidden

404 Resource not found

405 Method Not Allowed

409 Conflict

412 Precondition Failed

413 Request Entity Too Large

500 Internal Server Error

501 Not Implemented

503 Service Unavailable

You might also like