Overview
Some custom description of API.
Version information
Version: 1.0
Contact information
Contact: Power2sme
License information
License: License of API License URL: https://www.power2sme.com/privacypolicy
Terms of service: https://www.power2sme.com/termsandconditions
URI scheme
Host: localhost:8080 BasePath: /api/ws/v4
Tags
-
Static information
-
Employee Login
-
SKU’s information
-
Mobile OTP Service By Template for Customer only
-
Customer Contact
-
Bank Master
-
Location Master
-
Mobile OTP Service for Customer only
-
Mobile Application
-
General Mobile OTP Service By Template
-
General Mobile OTP Service
Paths
Mobile Application Download Link
GET /applink
Description
It will send an app link on mobile number via sms by providing the mobile number and device platform like Android, Windows, IOS
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
mobile_no |
Mobile No. |
true |
string |
8896421916 |
QueryParameter |
platform |
Device Platform |
true |
string |
Android |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Mobile Application
List of Credit Amounts
GET /approxordervallist
Description
Returns the total types of Credit Amounts which allocates to the Customer
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Static information
Information of All Banks Branches
POST /bankmaster
Description
It provides you all the information of all bank branches on the basis of IFS Code or MICR Code
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
bankMaster |
BankMaster |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Bank Master
Add new Bank IFSC
POST /bankmaster/add
Description
Add new bank IFSC details if IFSC does not already exist
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
bankMaster |
Bank IFSC details |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Invalid input |
No Content |
409 |
IFSC already exists |
No Content |
500 |
Internal Server Error |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Bank Master
Change Password
POST /changepassword
Description
Here Customer can change his password by providing old password, new password and Mobile No.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
changePassword |
ChangePassword |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Customer Contact
List of all cities of a state
GET /cities
Description
It will provide All Cities of a State on the basis of State Id.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
stateid |
stateid |
true |
integer (int32) |
8 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Location Master
Create New Password
POST /createpassword
Description
If Customer forgot his old password, then here he can create his new password.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
createPassword |
CreatePassword |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Customer Contact
Sign In
POST /customerlogin
Description
Here Customer can sign in into his account by providing Mobile No and password.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
contactLoginInfo |
ContactLogin |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Customer Contact
Generate OTP
POST /generateotp
Description
It will generate the one time password by providing the Mobile Number.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
mobileNumber |
Mobile Number |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
General Mobile OTP Service
Generate OTP By Template
POST /generateotpbytemplate
Description
It will generate the one time password by providing the Mobile Number and Message, which you wanna to sent to mobile number. You have to provide "OTP" in your message which will replace with otp.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
otpByTemplate |
Mobile Number with message |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
General Mobile OTP Service By Template
Generate OTP for Customer
POST /generateotpforcontact
Description
It will generate the one time password by providing the Mobile Number for customer.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
mobileNumber |
mobileNumber |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Mobile OTP Service for Customer only
Generate OTP for Customer By Template
POST /generateotpforcontactbytemplate
Description
It will generate the one time password by providing the Mobile Number and Message for customer, which you wanna to sent to mobile number. You have to provide "OTP" in your message which will replace with otp.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
otpByTemplate |
otpByTemplate |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Mobile OTP Service By Template for Customer only
List of All locations in Location Master
GET /getalllocation
Description
It will provide the list of all locations till present day.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Location Master
Contact Already Registered or not
POST /isregister
Description
This is a check whether user is registered with us or not by providing Mobile No. and Email.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
contactEmail |
ContactEmail |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Customer Contact
List of All city and state by pincode
GET /locationmaster
Description
It will provide the list of all cities and states and location on the basis of pincode
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pincode |
pincode |
true |
string |
122015 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Location Master
Sign Up
POST /registercontact
Description
Here Customer can register and he will registered as a contact in our system. He has to provide some basic and mandatory information like Name, Mobile No. Company Name, Email and Password
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
contact |
Contact |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Customer Contact
List of All Replacable SKU’s by Sub Category
GET /replacableskulistbysubcategory
Description
In this, you will provide the SKU Code and then it will find the sub category of that SKU and returns the list of All SKU’s related with that Sub Category.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
skuid |
SKU Code |
true |
string |
SKUN105075 |
QueryParameter |
pageIndex |
pageIndex |
false |
integer (int32) |
0 |
QueryParameter |
pageSize |
pageSize |
false |
integer (int32) |
0 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
SKU’s information
List of All Brands
GET /skubrandlist
Description
Returns the list of all brands of a single category and single subcategory in SKU System.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
category |
Category |
true |
string |
steel |
QueryParameter |
subcategory |
SubCategory |
true |
string |
angle |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
SKU’s information
List of All Categories
GET /skucategorylist
Description
Returns the list of all categories in SKU System.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
SKU’s information
List of All SKU Codes
GET /skucodelist
Description
Returns the list of all sku codes present in SKU System
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
SKU’s information
List of All Grades
GET /skugradelist
Description
Returns the list of all grades of a single category and single subcategory in SKU System.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
category |
Category |
true |
string |
steel |
QueryParameter |
subcategory |
SubCategory |
true |
string |
angle |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
SKU’s information
List of All SKU’s
GET /skulist
Description
Returns the list of all SKU’s in SKU System, and can search the result by skuid, category, subcategory, brand.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
skuid |
skuid |
false |
string |
|
QueryParameter |
category |
category |
false |
string |
|
QueryParameter |
subcategory |
subcategory |
false |
string |
|
QueryParameter |
brand |
brand |
false |
string |
|
QueryParameter |
longdesc |
longdesc |
false |
string |
|
QueryParameter |
r |
r |
false |
boolean |
|
QueryParameter |
pageIndex |
pageIndex |
false |
integer (int32) |
0 |
QueryParameter |
pageSize |
pageSize |
false |
integer (int32) |
0 |
QueryParameter |
response |
response |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
SKU’s information
List of All SubCategories
GET /skusubcategorylist
Description
Returns the list of all subcategories of a single category in SKU System.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
category |
Category |
true |
string |
steel |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
SKU’s information
List of All States
GET /states
Description
It will provide the list of all states.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Location Master
List of Taxation Preference
GET /taxationpreflist
Description
Returns the total number of Tax Preference we used
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Static information
List of All Measuring Units
GET /uomlist
Description
Returns the list of all measuring units and can search the measuring units of a single category in SKU System.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
category |
Category |
false |
string |
steel |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
SKU’s information
List of Credit Days
GET /urgencylist
Description
Returns the total types of Credit Days during which the Customer pays the amount
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Static information
Sign In for Employee
POST /userlogin
Description
Here Employee can sign in into his account by providing UserId and Password.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
contactLoginInfo |
UserLogin |
true |
||
QueryParameter |
r |
r |
false |
string |
false |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Employee Login
Validate OTP
POST /validateotp
Description
It will validate the OTP sent to your mobile number.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
otp |
otp |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
General Mobile OTP Service
Validate OTP when Generate By Template
POST /validateotpbytemplate
Description
It will validate the OTP sent to your mobile number.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
otp |
otp |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
General Mobile OTP Service By Template
Validate OTP for Customer
POST /validateotpforcontact
Description
It will validate the OTP sent to your mobile number.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
otp |
otp |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Mobile OTP Service for Customer only
Validate OTP for Customer when Generate By Template
POST /validateotpforcontactbytemplate
Description
It will validate the OTP sent to your mobile number.
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
otp |
otp |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Mobile OTP Service By Template for Customer only
Definitions
Bank Master
Model for information of Bank.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
address |
Give the Address of Bank |
false |
string |
|
bank |
Give the name of Bank |
false |
string |
|
branch |
Give the branch of Bank |
false |
string |
|
city |
Give the city in which Bank is there |
false |
string |
|
contact |
Give the Contact No. of Bank |
false |
string |
|
district |
Give the District in which Bank is there |
false |
string |
|
ifsc |
Give the IFS Code of Bank |
true |
string |
|
limit |
Give the limitation of Banks |
false |
string |
|
micrCode |
Give the MICR Code of Bank |
false |
string |
|
state |
Give the State in which Bank is there |
false |
string |
Change Password
Model for changing the password.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
newPassword |
Give the value of new password |
true |
string |
|
oldPassword |
Give the value of old password |
true |
string |
|
userName |
Give the Contact of User |
true |
string |
Contact Email
Model of Contact and Email.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
contact_number |
Give the contact of User |
true |
string |
|
Give the Email Id of User |
false |
string |
Contact Login
Model for Login into his account
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
password |
Give the password of User |
true |
string |
|
userId |
Give the User Id of User |
true |
string |
Contact Register
Model for signing up as a Contact
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
companyname |
Give the Company Name of User |
true |
string |
|
confirm_password |
Give the password of User |
true |
string |
|
contact_number |
Give the mobile no. of User |
true |
string |
|
Give the Email of User |
true |
string |
||
firstname |
Give the first name of User |
true |
string |
|
lastname |
Give the last name of User |
true |
string |
|
leadsource |
Give the Lead Source |
true |
string |
|
password |
Give the password of User |
true |
string |
Create Password
Model for creating the new password.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
newPassword |
Give the value of New Password |
true |
string |
|
tokenId |
Give the token Id of User |
true |
string |
|
userName |
Give the contact of User |
true |
string |
Mobile Number
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
mobileNumber |
Give the Mobile No. of User |
true |
string |
OTP
Model for validating the otp for mibile number
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
mobileNumber |
Give the Mobile No. of User |
true |
string |
|
otp |
Give the Otp for that Mobile No. |
true |
string |
OTP By Template
Model for the Mobile Number and Message
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
message |
Give the Message which you wanna to sent to Mobile Number |
true |
string |
|
mobileNumber |
Give the Mobile No. of User |
true |
string |
Response Model
Model for the response of API’s
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
Data |
Give the Response of API’s in the form of JSON Object |
true |
object |
|
ErrorCode |
Give the Error Code according to the Response of API’s. |
true |
integer (int32) |
|
Message |
Give the Message according to the Response of API’s. |
true |
string |
|
Status |
Give the Status according to the Response of API’s. |
true |
integer (int32) |
|
TotalRecords |
Give the Total No. of Records according to the Response of API’s. |
true |
integer (int32) |