All the APIs that are available today
APIs
Details
-
auth
Request
{
"version" : 1.0,
"appid" : "XXXXXXXX",
"password" : "XXXXXXXXXXX"
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "XXXXXXXX",
"token" : "JWT_TOKEN"*
}
-
forgotpassword
Request
{
"version" : "1.0",
"emailaddress" : ""
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "",
"errors" : [],
}
-
getcountries
Request
{
"version" : 1.0
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "success",
"data" : {
"countrieslist" : [
[
{
"id" : "XXXXXXXX",
"name" : "11"
}
{
"id" : "XXXXXXXX",
"name" : "12"
}
]
]
}
-
getmembershiptype
Request
*use valid token in the "Authorization" HTTP header
{
"version" : 1.0,
"id" : 1
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "Success",
"data" : {
""membershiptypedetails" : {
"id" : "XXXXXXXX",
"title" : "XXXXXXXXXXX",
"description" : "XXXXXXXXXXX",
"price" : n.nn,
"durationindays" : n,
"isactive" : 1 or 0
}
}
}
-
getstates
Request
{
"version" : 1.0
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "success",
"data" : {
"statelist" : [
[
{
"id" : "XXXXXXXX",
"statecode" : "11",
"statedesc" : "XXXXXXXXXXX"
}
{
"id" : "XXXXXXXX",
"statecode" : "12",
"statedesc" : "XXXXXXXXXXX"
}
]
]
}
-
getvalidenrollmentdetailsbyuserid
Request
*use valid token in the "Authorization" HTTP header
{
"version" : 1.0,
"userid" : 1
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "Success",
"data" : {
""enrollmentdetails" : {
"id" : "XXXXXXXX",
"title" : "XXXXXXXXXXX",
"description" : "XXXXXXXXXXX",
"price" : n.nn,
"durationindays" : n,
"isactive" : 1 or 0
}
}
}
-
isvalidemailaddress
Request
{
"version" : "1.0",
"emailaddress" : "",
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "",
"errors" : [],
}
-
isvalidtoken
Request
{
"version" : 1.0
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "Token is valid",
}
-
isvalidusername
Request
{
"version" : "1.0",
"username" : "",
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "",
"errors" : [],
}
-
mshipenrollprocesspaymentresponse
Request
*use valid token in the "Authorization" HTTP header
{
"version" : 1.0,
"membershiptypeid" : 1,
"userid" : 1,
"txnid" : *paypal transaction id*,
"paymentgross" : *paypal gross amount*,
"payeremail" : *paypal returned email address*,
"paymentstatus" : *paypal status*,
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "enrollment completed successfully"
}
-
registerwithwaiver
Request
*use valid token in the "Authorization" HTTP header
{
"version" : 1.0,
"username" : "", // valid username, should be unique value
"password" : "", // valid password, minimum 8 characters, max 100
"firstname" : "",
"lastname" : "",
"emailaddress" : "", // valid email address, should be unique value
"gender" :, // M or F
"city" : "",
"stateid" : "",
"countryid" : "",
"postalcode" : "",
"birthmonth" : "",
"birthyear" : "",
"phonenumber" : "" // xxx-xxx-xxxx,
"volunteerinterest" : "", // Y or N
"signature" : "", // base64 object
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "Registration successful"
}
-
signwaiver
Request
*use valid token in the "Authorization" HTTP header
{
"version" : 1.0,
"userid" : 1,
"signature" : "" // base64 object
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "waiver signed successfully"
}
-
userlogin
Request
*use valid token in the "Authorization" HTTP header
{
"version" : 1.0,
"username" : "XXXXXXXX",
"password" : "XXXXXXXXXXX"
}
Response
{
"status" : HTTP_STATUS_CODES,
"message" : "XXXXXXXX",
"data" : {
"user" : {
"username" : "XXXXXXXX",
"firstname" : "XXXXXXXXXXX"
"lastname" : "XXXXXXXXXXX"
"emailaddress" : "XXXXXXXXXXX"
}
}
}