TheSpiritProject REST API

With the use of this API, you can get the organization users.

Method: POST

URI: /getOrgUsers

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
agency_id* Integer Enter the Organization/Agency id you want to fetch that user.
user_role String Enter the user roles by comma separated. It may be empty.


With the use of this API, you can fetch the client Organizations.

Method: POST

URI: /fetchOrganizations

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
client_id* Integer Enter the client id of which organization are going to fetch.
page* Integer Enter the number of page you want to fetch.
rp* Integer Enter the number of records fetch you want to fetch.
sortname* String Enter the column name by which you want to sort.
sortorder* String Enter the order you want to sort.
ActiveUserTimeZone* String Enter the user timezone who fetch the organizations.
base_url* String Enter the base url.
BUCKET* String Enter the Bucket url of domain from where you fetch.
isadmin* Integer Enter the value that user is admin(1) or not(0).


With the use of this API, you can Create the Staff in admin as well as in Dashboard.

Method: POST

URI: /staffCreate

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
email* String This is the unique email address you enters for staff creation.
password* String This is password you enters for staff creation.
confirm_password* String This is Confirm password you enters for staff creation.Remember Password and Confirm Password field should be same.
domain* Integer Enter the Domain id from where you create the staff.
user_id* Integer Enter the user id who create the staff.
organization_id* Integer Enter the Organization id under which staff is going to create.
first_name String Enter the first name of the staff.
last_name String Enter the last name of the staff.
phone Integer Enter the phone number the staff.
org_roles String Enter the Organisation Roles in form of number of the staff.('0'=>'Super Admin','1'=>'Admin','2'=>'Staff')
client_id Integer Enter the Client id under which staff is going to create.


With the use of this API, you can Fetch the Staff in admin as well as in Dashboard.

Method: POST

URI: /fetchStaff

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
page* Integer This is the number of page you want to see.
rp* Integer This is the number of results on page.
sortname* String This is the column name by which you want to sort.
sortorder* String Define the sort order by which you want to sort.
organization_id* Integer Enter the Organization id of staff you want to fetch.
ActiveUserTimeZone* String Enter the login user time zone.
bucket* String Enter the Bucket Url.
base_url* String Enter the base url.
isAdmin* String Enter the value the user is admin or not (1->admin/0->no admin).
parentorg* String Enter array of parent organisation ids.It may be empty
ActiveUserOrgRoles Integer Enter the login user Organization Role.
agency_id Integer Enter the Agency Id Under which staff belongs.


With the use of this API, you can Fetch the Staff in admin as well as in Dashboard.

Method: POST

URI: /checkEmailExist

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
email* String Enter the email you want to check.
domain* Integer Enter the domain id from where you want to search.


With the use of this API, you can Check the email existance.

Method: POST

URI: /fetchUser

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
id* Integer Enter the user id you want to fetch.


With the use of this API, you can delete the staff.

Method: POST

URI: /deleteStaff

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
staff_id* Integer Enter the staff id you want to delete.
organization_id* Integer Enter the organization id under which that staff belongs.
user_id* Integer Enter the user id who deletes the staff.


With the use of this API, you can update the user notifications.

Method: POST

URI: /notificationsUpdate

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.
notificationsfor* String Enter the Notificarion ids by comma separated that what you want to update.


With the use of this API, you can update the staff.

Method: POST

URI: /updateStaff

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
email* String Enter the email you want to email. If you don't, please keep it same.
password* String Enter the password you want to update.
staff_id* Integer Enter the staff id you want to update.
first_name String Enter the first name of staff.
last_name String Enter the last name of staff.
contact_number Integer Enter the conatct number of staff.
user_type String Enter the user type of the staff.


With the use of this API, you can Unable/Disable Organizations.

Method: POST

URI: /orgEnableDisable

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
agency_id* Integer Enter the organization/agency id which you want to enable or disable.
status* Integer Enter the status that you want to enable(1) or disable(0) the organization.


With the use of this API, you can fetch the organization.

Method: POST

URI: /fetchOrg

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
id* String Enter the Organization id you want to fetch.


With the use of this API, you can search the parents.

Method: POST

URI: /searchparent

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
search_str* String Enter the string you want to search.
client_id* Integer Enter the Client id from where you search for its parent.
base_url* String Enter the base url of the domain from where you search.


With the use of this API, you can create the organization.

Method: POST

URI: /createOrg

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* Inetger Enter the user id who creates the organization.
client_id* Integer Enter the Client id under which organization is created.
type_id* Integer Enter the organization type id under which you are going to create
org_type* String Enter the organization types wheather it is Agency(1) , Provider(2) or both.
primary_email* String Enter the primary email of the organization.
password_expiry* Integer Enter the number of number of days after password should be changed. It should be 30,60,90,180,365 days
domain* Integer Enter the doamain id under which organization is created.
name String Enter the name of the organization.
abbreviation String Enter the abbreviation of the organization.
website String Enter the website of the organization.
canaddsuborg Integer Enter the 1 for add sub-organization permission and 0 for not.
ag_code String Enter the code of the organization.
description String Enter the description of the organization.
approved_sp_only_flag Integer Enter 1 if allow this Organization to make referrals from organizations.
permissions_provider Integer Enter 1 if allow special permission to this provider?.
primary_phone String Enter the primary phone of the organization.
primary_fax String Enter the primary fax of the organization.
address String Enter the address of the organization.
secondary_address String Enter the secondary address of the organization.
locality String Enter the locality of the organization.
region_id Integer Enter the region id of the organization.
postal String Enter the postal address of the organization.
specialpermission Integer Enter 1 if you organization will have special permissions.


With the use of this API, you can update the organization.

Method: POST

URI: /updateOrg

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
id* Inetger Enter the organization id who update the organization.
user_id Inetger Enter the user id who updated the organization.
client_id Integer Enter the Client id under which organization is created.
type_id Integer Enter the organization type id under which you are going to create
org_type String Enter the organization types wheather it is Agency(1) , Provider(2) or both.
primary_email String Enter the primary email of the organization.
password_expiry Integer Enter the number of number of days after password should be changed. It should be 30,60,90,180,365 days
domain Integer Enter the doamain id under which organization is created.
name String Enter the name of the organization.
abbreviation String Enter the abbreviation of the organization.
website String Enter the website of the organization.
canaddsuborg Integer Enter the 1 for add sub-organization permission and 0 for not.
ag_code String Enter the code of the organization.
description String Enter the description of the organization.
approved_sp_only_flag Integer Enter 1 if allow this Organization to make referrals from organizations.
permissions_provider Integer Enter 1 if allow special permission to this provider?.
primary_phone String Enter the primary phone of the organization.
primary_fax String Enter the primary fax of the organization.
address String Enter the address of the organization.
secondary_address String Enter the secondary address of the organization.
locality String Enter the locality of the organization.
region_id Integer Enter the region id of the organization.
postal String Enter the postal address of the organization.
specialpermission Integer Enter 1 if you organization will have special permissions.


With the use of this API, you can fetch the organization agencies.

Method: POST

URI: /OrgAgencies

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
client_id* Integer Enter the client id of which organization belongs.
page* Integer Enter the number of page you want to fetch.
rp* Integer Enter the number of records fetch you want to fetch.
sortname* String Enter the column name by which you want to sort.
sortorder* String Enter the order you want to sort.
organization_id* String Enter the user organization/agency id whose organizations are going to be fetched.
base_url* String Enter the base url.
SITE_DOMAIN* String Enter the domain id from where you fetch.
isadmin* String Enter 1 of you are as a admin.
isprovider* String Enter 1 if you are as a provider.


With the use of this API, you can fetch the add or remove organization agencies.

Method: POST

URI: /IncExcOrgAgencies

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
agency_id* Integer Enter the agnecy id of which organization belongs.
organization_id* String Enter the user organization id which you want to include and exclude.


With the use of this API, you can fetch approve providers.

Method: POST

URI: /approveProviders

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
agency_id* Integer Enter the agency id of whose providers you want to fetch.
page* Integer Enter the number of page you want to fetch.
rp* Integer Enter the number of records fetch you want to fetch.
sortname* String Enter the column name by which you want to sort.
sortorder* String Enter the order you want to sort.
base_url* String Enter the base url.


With the use of this API, you can fetch the add or remove providers.

Method: POST

URI: /appDisappProviders

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
agency_id* Integer Enter the agnecy id of which organization belongs.
organization_id* String Enter the user organization id which you want to approve or diapprove.
approval* String Enter 1 for approve and 0 for disapprove.


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

Method: POST

URI: /searchorg

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
base_url* Integer Enter the base url of the domain.
SITE_DOMAIN* String Enter the domain id from you want to search.
orgname String Enter the organization name you want to search.
fname String Enter first name you want to search.
lname String Enter last name you want to search.
email String Enter email you want to search.


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.


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.


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.