TheSpiritProject REST API

Add Emails Data

With the use of this API, you can add Email data to WORKER TIER instance.

Method: POST

URI: /addEmail

Authentication: Require a valid access token to use this API

*Required HEADER
Parameters Type Description
token String This token required to use this API. You can get the token using authenticate API.
*Required POST fields(All post Data is json format)
Parameters Type Description
user_id Integer This is unique id of user who sends an email.
to String This is an email id where the mail has to send.
toname String This is a name of user who receives the email.
from String This is an email who sends an email.
fromname String This is a name of user who sends an email.
subject String This is the subject of the email.
body String Body contain the Html content of message.
bcc String This is string which contain bcc email. It may multiple. Multiple emails are separated by comma.
type_domain Integer This is an integer number. you can get this from api owner. It is diffrent from all domains.

Add Email

               
curl "http://beta.core.thespiritproject.com/api/addEmail" \
token: Your token is here

RESPONSE

{
  "status": "1",
  "message": "Succesfully added"
}


Add SMS Data

With the use of this API, you can add SMS data to WORKER TIER instance.

Method: POST

URI: /addSms

Authentication: Require a valid access token to use this API

*Required HEADER
Parameters Type Description
token String This token required to use this API. You can get the token using authenticate API.
*Required POST fields(All post data is in json format entered in raw payload.)
Parameters Type Description
user_id Integer This is unique id of user who sends an email.
number Integer This is phone number where the message has to send.
message String This is text message you want to send.
type_domain Integer This is an integer number. you can get this from api owner. It is diffrent from all domains.

Add Sms

               
curl "http://beta.core.thespiritproject.com/api/addSms" \
token: Your token is here

RESPONSE

{
  "status": "1",
  "message": "Succesfully added"
}


For Account Save

With the use of this API, you can update the account of ADMIN as well as DASHBOARD.

Method: POST

URI: /accoutSave

Authentication: Require a valid access token to use this API

*Required HEADER
Parameters Type Description
token* String This token required to use this API. You can get the token using authenticate API.
*Required POST fields(All post data is in json format entered in raw payload.)
Parameters Type Description
user_id* Integer Enter the user id you want to update.
email* String Enter the email you want to update. If not, enter the existing one.
time_zone* String Enter the timezone of the login user.
alternative_email_add String Enter that param if you want to add an alternative email.
alternative_email_edit String Enter that param if you want to update an alternative email.
alternate_email_remove String Enter that param if you want to remove an alternative email.
password String Enter the Password if you want to update.
password_confirm String Enter that field if you enter the password field.That is for password confirmation
contact_number String Enter the conatct number of user.
profilephoto File Select the file in multipart form.
pattern_clients String Enter the Pattern client of user. It may be more than one by comma separated.

Save account

               
curl "http://beta.core.thespiritproject.com/api/accoutSave" \
token: Your token is here

RESPONSE

{
  "status": "1",
  "message": "Your account was updated successfully"
}


Fetch Admin Users

With the use of this API, you can serach agency.

Method: POST

URI: /adminUsers

Authentication: Require a valid access token to use this API

*Required HEADER
Parameters Type Description
token* String This token required to use this API. You can get the token using authenticate API.
*Required POST fields(All post data is in json format entered in raw payload.)
Parameters Type Description
role* Integer Enter the role id of admin users.
SITE_DOMAIN* Integer Enter the domain id from where you want to fetch.

Fetch Admin Users

               
curl "http://beta.core.thespiritproject.com/api/adminUsers" \
token: Your token is here

RESPONSE

{"status":"1","data":[{"id":111,"client_id":22,"person_id":00,"email":"Test@mailinator.com","username":"","password":"XXXXXXXX","first_name":"check","last_name":"admin","logins":0,"unique_id":"0","manual_organisation":"0","created_user":"0","patternId":"0","stActive":"0","last_login":null,"license_agreed_date":"0000-00-00 00:00:00","recover_token":null,"recover_date":null,"created_at":"2017-06-14 14:08:00","updated_at":"2017-06-14 14:08:00","removed_flag":0,"removed_by":0,"profilephoto":"","user_type":"","time_zone":"America\/Los_Angeles","org_roles":0,"failed":0,"failedlasttime":null,"notificationsfor":"1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19","notificationsforproviders":null,"isAdmin":0,"contact_number":"123313","domain":1,"relationship_status":1,"time_timezone":"America\/Los_Angeles","roles":[{"name":"Org User"}]}]}


Fetch Admin Users with roles

With the use of this API, you can fetch admin users with roles.

Method: POST

URI: /getUserWithRoles

Authentication: Require a valid access token to use this API

*Required HEADER
Parameters Type Description
token* String This token required to use this API. You can get the token using authenticate API.
*Required POST fields(All post data is in json format entered in raw payload.)
Parameters Type Description
role* String Enter the roles you want to fetch as a array.
domain* Integer Enter the domain id from where you want to fetch.

Fetch Admin Users

               
curl "http://beta.core.thespiritproject.com/api/getUserWithRoles" \
token: Your token is here

RESPONSE

{"status":"1","data":{"1":0}}


Save/Edit Users

With the use of this API, you can save or edit the user.

Method: POST

URI: /saveUser

Authentication: Require a valid access token to use this API

*Required HEADER
Parameters Type Description
token* String This token required to use this API. You can get the token using authenticate API.
*Required POST fields(All post data is in json format entered in raw payload.)
Parameters Type Description
first_name* Integer Enter the first name of the user.
last_name* Integer Enter the last name of the user.
email* Integer Enter the email the of the user.
password* Integer Enter the password for user.
confirm_password* Integer Enter the confirm password for the user.
user_id Integer Enter the user id if you want to update.

Save/Edit User

               
curl "http://beta.core.thespiritproject.com/api/saveUser" \
token: Your token is here

RESPONSE

{"status":"1","staff_id":"1"}