TheSpiritProject REST API

Fetch Client List

With the use of this API, you can fetch the client in Admin Panel.

Method: POST

URI: /clients

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
offset* Integer Enter the offset value.
limit* String Enter the limit of records you want to fetch in page.
SITE_DOMAIN* String Enter the domain id from where you want to fetch.

Fetch Clients

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

RESPONSE

{"status":"1","clientCount":77,"clientList":[{"id":1,"type_id":1,"name":"Turning Point","description":"Turning Point Experience","primary_email":"test@test.com","primary_phone":"(000) 000-0000","primary_mobile":"","primary_fax":"","address":"123 Apple St","secondary_address":" ","locality":"sdads","region_id":33,"postal":"50034","created_at":"2011-03-29 00:00:00","updated_at":"2017-07-12 15:26:08","created_by_id":6,"updated_by_id":19,"datastate":1,"domain":1,"created_by":{"id":6,"client_id":1,"person_id":1,"email":"abc@gs.com","username":"admin","password":"xxxxxxxx","first_name":"Kapil","last_name":"test","logins":0,"unique_id":"0","manual_organisation":"0","created_user":"0","patternId":"0","stActive":"0","last_login":1427481947,"license_agreed_date":"0000-00-00 00:00:00","recover_token":null,"recover_date":null,"created_at":"-0001-11-30 00:00:00","updated_at":"2015-03-27 11:46:31","removed_flag":0,"removed_by":0,"profilephoto":"","user_type":"","time_zone":"America\/Los_Angeles","org_roles":0,"failed":0,"failedlasttime":"","notificationsfor":"1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19","notificationsforproviders":"","isAdmin":0,"contact_number":"0","domain":1,"relationship_status":1,"time_timezone":"America\/Los_Angeles"},"updated_by":{"id":19,"client_id":28,"person_id":4,"email":"abc@thespiritproject.com","username":"eric","password":"XXXXXXXX","first_name":"Eric","last_name":"Niddifer","logins":2612,"unique_id":"0","manual_organisation":"0","created_user":"0","patternId":"0","stActive":"1","last_login":1496746369,"license_agreed_date":"2012-02-14 10:29:03","recover_token":null,"recover_date":null,"created_at":"-0001-11-30 00:00:00","updated_at":"2017-07-07 09:24:53","removed_flag":0,"removed_by":0,"profilephoto":"","user_type":"","time_zone":"America\/Denver","org_roles":0,"failed":0,"failedlasttime":"1495015226","notificationsfor":"18,2,8,9,4,6,7,10,5,11,12,14,15,16,17,19,20,21,22,23","notificationsforproviders":"","isAdmin":1,"contact_number":"0","domain":1,"relationship_status":1,"time_timezone":"America\/Los_Angeles"}}]}


Add/Update Client List

With the use of this API, you can add/update the client in Admin Panel.

Method: POST

URI: /clientsSave

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
name* String Enter the name of client.
user_id* String Enter the user id who creates/update the client.
primary_email* String Enter the unique email address of client.
address* String Enter the address of the client.
region_id* Integer Enter the regions id of client from where it belongs.
datastate* Integer Enter the datastate id from where it belongs.
domain* Integer Enter the domain id from where you want to save the client.
primary_phone String Enter the primary phone number of the client.
primary_mobile String Enter the primary mobile number of the client.
primary_fax String Enter the fax number of the client.
secondary_address String Enter the secondary address the client.
locality String Enter the locality of the client.
postal String Enter the postal of the client.
description String Enter the description of the client.
client_id Integer Enter the client id if you want to update the existing client.

Save Client

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

RESPONSE

{
  "status": "1",
  "message": "Succesfully Done"
  "client_id": "1"
}


Fetch Client Notes

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

Method: POST

URI: /fetchNotes

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 notes 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.

Fetch Client Notes

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

RESPONSE

{"status":"1","data":"{\"page\":\"1\",\"rows\":[{\"id\":6,\"cell\":{\"id\":6,\"title\":\"\",\"content\":\"test note 2011-11-19 FGJ<\\\/a>\",\"private\":\"Yes\",\"created_by\":\"Georges Moncrief\",\"created_at\":\"11\\\/29\\\/2011 04:12:00\",\"updated_at\":\"07\\\/12\\\/2017 09:26:55\",\"tools\":\""}}],\"total\":16}"}


Save/Update Client Notes

With the use of this API, you can save or update the client Notes.

Method: POST

URI: /saveClientNotes

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 under which notes are going to save.
user_id* Integer Enter the user id who create the note.
content* String Enter the Content of note.
private Integer Enter the type of note whether it is private(1) or public(0).
note_id String Enter the Note id if you want to update the exiting created note.

Save Client Notes

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

RESPONSE

{
  "status": "1",
  "message": "Succesfully Done",
  "client_id": "21",
 }


Fetch Single Client Notes

With the use of this API, you can save or update the client Notes.

Method: POST

URI: /fetchSingleClientNote

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

Single Client Notes

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

RESPONSE

{"status":"1","data":{"id":6,"client_id":1,"private":1,"content":"test note 2011-11-19 FGJ","created_at":"2011-11-29 11:12:00","created_by_id":17,"updated_at":"2017-07-12 15:26:55","updated_by_id":19,"time_timezone":"UTC"}}


Fetch Client Organizations

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

Method: POST

URI: /clientOrg

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* String Enter the Cleint id that organization should be fetched.

Fetch Client Organization

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

RESPONSE

{"status":"1","organization":[{"id":115,"client_id":1,"type_id":1,"name":"Raster Media","abbreviation":"RMS","description":"Web & Mobile app developers","primary_email":"abc@test.com.test","primary_phone":"1234567890","primary_mobile":"","primary_fax":"1234567890","address":"2560 East Sunset","secondary_address":"Suite 1101","locality":"Las Vegas","region_id":33,"postal":"89120","website":"http:\/\/www.abc.com","hours":"","notes":"","referral_addendum":"","approved_sp_only_flag":0,"created_at":"2012-02-14 10:50:10","updated_at":"2017-07-17 12:37:32","created_by_id":6,"updated_by_id":3762,"active":1,"datastate":1,"extension":96,"org_type":"1,2","ag_code":"RBS","s_type":"2","_related":"1","mkallowed":0,"permissions_provider":"managefieldset,addclient","specialpermission":"on","permission_templates":"0","create_type":"","internal_sign":"","org_roles":0,"canaddsuborg":1,"parentorg":0,"referralemail":1,"respondemail":1,"orgtype_id":0,"custom_report_date_field":"0","istrialorg":0,"api_key":"","api_secret":"","api_enable":0,"password_expiry":"90","corecasedisabled":null,"domain":1,"allowbeingsub":0,"licensenumber":"","fcp_valid":0,"on_vacation":0,"from_vacation":"0000-00-00 00:00:00","to_vacation":"0000-00-00 00:00:00","vacation_reason":"","to_be_investigated":0,"wouldyouacceptsiblinggroup":0,"onlysibling":0,"send_for_investigation":0,"max_beds_allowed":0,"min_age_allowed":0,"max_age_allowed":18,"placement_instructions":"","profilephoto":"","datehomestudy":"","assignedworker":0,"describe_pets":"","petshypoallergenic":0,"number_of_childs":0,"wheelchairs":0,"specialneeds":"","active_is_youth":0,"petsin":"","license_type":0,"pendingacceptance":0,"org_latitude":36.072502,"org_longitude":-115.115351,"allowedGender":"","services_offered":"","facilityid":0,"parentGender":"","parentRace":"","parentMaritalStatus":0,"namedmd5":"","reason_for_deactive":"","assigned_agency":0,"allowfunds":0,"case_pattern":"","time_timezone":"America\/Los_Angeles","client":{"id":1,"type_id":1,"name":"Turning Point1","description":"Turning Point Experience","primary_email":"test@test.com","primary_phone":"(000) 000-0000","primary_mobile":"","primary_fax":"","address":"123 Apple St","secondary_address":" ","locality":"sdads","region_id":33,"postal":"50034","created_at":"2011-03-29 00:00:00","updated_at":"2017-07-12 15:26:08","created_by_id":6,"updated_by_id":19,"datastate":1,"domain":1},"created_by":{"id":6,"client_id":1,"person_id":1,"email":"kapl_test@gs.com","username":"admin","password":"xxxxxxxxxx","first_name":"Kapil","last_name":"test","logins":0,"unique_id":"0","manual_organisation":"0","created_user":"0","patternId":"0","stActive":"0","last_login":1427481947,"license_agreed_date":"0000-00-00 00:00:00","recover_token":null,"recover_date":null,"created_at":"-0001-11-30 00:00:00","updated_at":"2015-03-27 11:46:31","removed_flag":0,"removed_by":0,"profilephoto":"","user_type":"","time_zone":"America\/Los_Angeles","org_roles":0,"failed":0,"failedlasttime":"","notificationsfor":"1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19","notificationsforproviders":"","isAdmin":0,"contact_number":"0","domain":1,"relationship_status":1,"time_timezone":"America\/Los_Angeles"},"updated_by":{"id":3762,"client_id":63,"person_id":42900,"email":"abc@gmail.com","username":"kapilsachdeva","password":"xxxxxx","first_name":"Kapil","last_name":"Sachdeva","logins":39,"unique_id":"0","manual_organisation":"0","created_user":"0","patternId":"0","stActive":"0","last_login":1494581415,"license_agreed_date":"0000-00-00 00:00:00","recover_token":"recover.58c13a911b6229.94377934","recover_date":"2017-03-09 00:00:00","created_at":"2017-03-08 01:13:07","updated_at":"2017-05-12 02:30:15","removed_flag":0,"removed_by":0,"profilephoto":"http:\/\/com-compass-thespiritproject.com-beta.s3.amazonaws.com\/docs\/1489493335.jpg","user_type":"","time_zone":"America\/Los_Angeles","org_roles":0,"failed":0,"failedlasttime":"","notificationsfor":"71,72,74,75,76","notificationsforproviders":"","isAdmin":0,"contact_number":"8146488733","domain":3,"relationship_status":1,"time_timezone":"America\/Los_Angeles"},"type":{"id":1,"name":"Drug & Rehab Center","description":" Test","domain":1},"region":{"id":33,"name":"Nevada","abbreviation":"NV","country_id":1}}]}