Client Details

The endpoints are https://yourhubsolv.hubsolv.com/api/client/format/json/ or https://yourhubsolv.hubsolv.com/api/client/format/xml/

The API requires you send a username and password using HTTP Basic Authentication when posting or making requests as an additional layer of security. You can find your username and password by navigating to Settings > API Settings in your Advize. This is transmitted in the header envelope of your request in the format Authorization: Basic yourusername:yourpassword where the username and password separated by a colon are base64 encoded.

An incorrect username and password will return a status of false along with an error message:

JSON:

{"status":false,"error":"Not authorized"}

XML:

<xml><status>0</status><error>Not authorized</error></xml>

The Advize API accepts input as Key Value pairs.

You are required to post your Advize API key as a means of authentication.

This can be found by navigating to Settings > API Settings in your Advize.

HUBSOLV-API-KEY=1718debe6fcde8124494c1116bb26fbe45755d1

An incorrect API key will return a status of false along with an error message:

JSON:

{"status":false,"error":"Invalid API Key."}

XML:

<xml><status>0</status><error>Invalid API Key.</error></xml>

Successful post to the API will return a status of "success_post" along with the id of the client record that has been created:

JSON:

{"status":"success_post","id":26}

XML:

<xml><status>success_post</status><id>26</id></xml>

We do not accept JSON in the body of the request, all requests must be normal form posts, key value pairs.

These are fields which you can post into via the API in to the Client Details module

If obtaining partner information, fields should be updated to add partner_ to the beginning. If the field includes client_ this should be replaced with partner_

Field	Field Name	Field Restriction	Notes
Title	title	mr, mrs, miss, ms, master, sir, madam, dr, professor, rev, sgt, unknown, mx, mics, ind	enum
First, names(s)	firstname		string
Middle name	middlename		string
Last name	lastname		string
Other/Previous Names	othername		string
Security Question	security_question		string
Answer	security_answer		string
Place Of Birth	pob		string
Date Of Birth	dob	UNIX TIMESTAMP	string
Marital status	marital_status	not_disclosed, single, single_parent, co_habiting, married, civil_partnership, divorced, widowed, separated	enum
Marital Status Since	marital_status_since	UNIX TIMESTAMP	string
Gender	gender	male, female, neut	enum
Home phone no	phone_home		string
Home phone no: Out of Service	home_phone_out_service	0, 1	integer
Mobile no	phone_mobile		string
Mobile no: Out of Service	mobile_phone_out_service	0, 1	integer
Work phone number	phone_work		string
Work phone number: Out of Service	work_phone_out_service	0, 1	integer
Best time to call	time_to_contact	early_morning, late_morning, early_afternoon, late_afternoon, early_evening, late_evening	enum
Preferred contact method	contact_method	landline, mobile, email, post	enum
Email	email		string
Service - Permission to contact by; Home Phone	contact_home	0, 1	integer
Service - Permission to contact by: Mobile Phone (Call)	contact_mobile	0, 1	integer
Service - Permission to contact by: Work Phone	contact_work	0, 1	integer
Service - Permission to contact by: Email	contact_email	0, 1	integer
Service - Permission to contact by: SMS	contact_sms	0, 1	integer
Service - Permission to contact by: Mail	contact_post	0, 1	integer
Marketing - Permission to contact by; Home Phone	contact_home_marketing	0, 1	integer
Marketing - Permission to contact by: Mobile Phone (Call)	contact_mobile_marketing	0, 1	integer
Marketing - Permission to contact by: Work Phone	contact_work_marketing	0, 1	integer
Marketing - Permission to contact by: Email	contact_email_marketing	0, 1	integer
Marketing - Permission to contact by: SMS	contact_sms_marketing	0, 1	integer
Marketing - Permission to contact by: Mail	contact_post_marketing	0, 1	integer
Employment status	employment_status	not_diclosed, tbc, full_time_student, unemployed_attachable_benefits, unemployed, employed_full_time, employed_part_time, employed_zero_hour, self_employed, retired, cis, director	enum
Occupation	occupation		string
Address line 1	address_1		string
Address line 2	address_2		string
Address line 3	address_3		string
Town	town		string
County	county		string
Post Code	postcode		string
Country	country		string
Time at address? Years	client_time_at_address_year	Whole Number 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11	integer
Time at address? Months	client_time_at_address_month	Whole Number 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11	integer
No longer at this address	no_longer_at_address	0, 1	integer
Consent Given to Discuss with a 3rd Party (Relative / Health Worker / Doctor)	third_party_consent	0, 1	integer
3rd Party: Title	third_party_title	mr, mrs, miss, ms, master, sir, madam, dr, professor, rev, sgt, unknown, mx, mics, ind	enum
3rd Party: First name(s)	third_party_firstname		string
3rd Party: Last name	third_party_lastname		string
3rd Party: Relationship	third_party_relationship		string
3rd Party: Phone No	third_party_phone		string
3rd Party Phone No: Out of Service	third_party_phone_out_service	0, 1	integer
3rd Party: Best time to call	third_party_time_to_contact	early_morning, late_morning, early_afternoon, late_afternoon, early_evening, late_evening	enum
3rd Party: Email Address	third_party_email		string
3rd Party: Address line 1	third_party_address_1		string
3rd Party: Address line 2	third_party_address_2		string
3rd Party: Address line 3	third_party_address_3		string
3rd Party: Town	third_party_town		string
3rd Party: County	third_party_county		string
3rd Party: Post Code	third_party_postcode		string
3rd Party: Country	third_party_country		string
3rd Party: Notes	third_party_notes		string
Vulnerability Level	vulnerability_rating	v1, v2, v3	enum
Type(s) of Vulnerability	vulnerability_type	age, illness, terminal_condition, physical_disability, learning_disability, mental_health, abuse, addiction, language_barrier, change_in_circumstance, homelessness, carer, suspected	comma separate for multiple
Vulnerability Details	vulnerability_notes		string
Print Letters in Large Font?	large_font	0, 1	integer
Authority to Share Info with 3rd Parties	authority_share	0, 1	integer
Authority to Store Information	authority_store	0, 1	integer
Review Required	vulnerability_review_required	0, 1	integer
Review Date	vulnerability_review_due_date	UNIX TIMESTAMP	string
Client Deceased	client_deceased	0, 1	integer
Date Informed	client_deceased_date_informed	UNIX TIMESTAMP	string
Informed by	client_deceased_informed_by	phone, email, letter	enum
3rd Party: Title	client_deceased_third_party_title	mr, mrs, miss, ms, master, sir, madam, dr, professor, rev, sgt, unknown, mx, mics, ind	enum
3rd Party: First name(s)	client_deceased_third_party_firstname		string
3rd Party: Last name	client_deceased_third_party_lastname		string
3rd Party: Relationship	client_deceased_third_party_relationship	son, daughter, husband, wife, boyfriend, girlfriend, mother, father, sister, brother, firned, niece, nephew, other	enum
3rd Party: Phone No	client_deceased_third_party_phone		string
3rd Party: Best time to call	client_deceased_third_party_time_to_call	early_morning, late_morning, early_afternoon, late_afternoon, early_evening, late_evening	enum
3rd Party: Email Address	client_deceased_third_party_email		string
3rd Party: Address line 1	client_deceased_third_party_address_1		string
3rd Party: Address line 2	client_deceased_third_party_address_2		string
3rd Party: Address line 3	client_deceased_third_party_address_3		string
3rd Party: Town	client_deceased_third_party_town		string
3rd Party: County	client_deceased_third_party_county		string
3rd Party: Post Code	client_deceased_third_party_postcode		string
3rd Party: Country	client_deceased_third_party_country		string
3rd Party: Notes	client_deceased_third_party_notes		string
Evidence received	client_deceased_evidence_received	0, 1	integer
Take Partner's details?	partner	0, 1	integer
Same address?	living_with_partner	0, 1	integer