A key contact for a service user.
A unique Id for the service user contact.
The service user contact's account code, used when exporting invoices to an accounts package.
The billing party's preference for receiving billing related commsemail, post.
A flag indiciating if billing is enabled for the service user contact.
The care enquiry the service user contact relates to.
The date/time the service user contact was created.
The service user contact's email address.
A list of email addresses to send invoices (and related documents) to.
Flag indicating if the service user contact should be contacted in an emergency for the service user.
The service user contact's first name.
A flag indicating that while billing is enabled for the service user contact they cannot appear as an option for new contracts or invoices.
A flag indicating if the service user contact has an direct debit mandate in place (in any state, pending, active or pending cancellation).
A list of fields to identify a service user with when generating a line item for the service user in an invoice for the service user contactfull_name, initials, nhs_number, patient_id, ref.
The service user contact's last name.
The location the service user contact relates to.
The service user contact's mobile number.
The date/time the service user contact was created.
Flag indicating that the service user contact is the next of kin for the service user.
Additional notes for the service user contact.
The method the billing party is expected to use for making paymentscard, cash, cheque, standing_order, direct_debit, bac.
The service user contact's phone number.
A list of power or attorney types the service user contact is assigned for the service user (if any); epa, lpa_property_affairs, lpa_health_welfare.
The service user contact's postal address.
Address line 1 (e.g. house name/number).
Address line 2 (e.g. street).
Town, city or village.
County.
Postal code.
Country.
The service user contact's relationship to the service user.
The service user the service user contact relates to.
The service user contact's title.
The service user contact's work phone number.
{
"_id": "662edc5d835c6a1ad9676c56",
"account_code": "AW0474",
"billing_comms_preference": null,
"billing_enabled": null,
"care_enquiry": null,
"created": "2024-04-28 23:31:41",
"email": "abbey.wall@gmx.co.uk",
"email_invoices_to": null,
"emergency_contact": true,
"first_name": "Abbey",
"future_billing_disabled": null,
"has_direct_debit_mandate": null,
"invoices_service_user_id_fields": null,
"last_name": "Wall",
"location": "662edc59835c6a1ad9675cce",
"mobile": "07284280384",
"modified": "2024-04-28 23:31:41",
"next_of_kin": true,
"notes": "",
"payment_method": null,
"phone": "01842625621",
"poa_types": [
"lpa_property_affairs",
"lpa_health_welfare"
],
"postal_address": {
"address_1": "The Old Rectory",
"address_2": "Rectory Rd",
"country": "",
"county": "Oxfordshire",
"postcode": "OX44 7JG",
"town": "Great Haseley"
},
"relationship": "Daughter",
"service_user": "662edc5d835c6a1ad9676b78",
"title": "Mrs",
"work_phone": ""
}
Return a list of service user contacts.
['_id']
A list of attributes to include for fetched objects.
A filter that accepts a list of care enquiry Ids and filters service user contacts by the enquiry the contacts relate to.
A filter that accepts a list of Ids and filters the items returned to those with an Id in the list.
A filter that accepts a list of location Ids and filters service user contacts by the location their service user is a client of.
A filter that accepts a date/time and filters the items returned to those modified after the date/time.
A filter that accepts a date/time and filters the items returned to those modified before the date/time.
A case insensitive keyword filter applied to the following fields; account_code, full_name.
A filter that accepts a list of service user Ids and filters service user contacts by the service user the contacts relate to.
1
The page number to fetch.
10
The number of items to return per page.
_id
A list of fields the returned items can be sorted by. Fields prefixed with minus (-) sign are sorted in descending order.
Returns a page of service user contacts.
var serviceUserContacts = apiClient.Request(
HttpMethod.Get,
"service-user-contacts",
new MultiValueDict()
.Add("attributes", "email", "first_name", "last_name")
.Add("filters-location", locationId)
);
<?php
$service_user_contacts = $api_client->request(
'GET',
'service-user-contacts',
[
'attributes'=>['email', 'first_name', 'last_name'],
'filters-location'=>[location_id]
]
);
service_user_contacts = api_client(
'GET',
'service-user-contacts',
params={
'attributes': ['email', 'first_name', 'last_name'],
'filters-location': [location_id]
}
)
service_user_contacts = api_client.request(
'GET',
'service-user-contacts',
params: {
'attributes' => ['email', 'first_name', 'last_name'],
'filters-location' => [location_id]
}
)
{
"item_count": 115,
"items": [
{
"_id": "662edc5b835c6a1ad9676630",
"email": "abigail.mills@hotmail.com",
"first_name": "Abigail",
"last_name": "Mills"
},
{
"_id": "662edc5b835c6a1ad9676634",
"email": "",
"first_name": "Brett",
"last_name": "Wilson"
},
{
"_id": "662edc5b835c6a1ad9676638",
"email": "carly.davies@yahoo.co.uk",
"first_name": "Carly",
"last_name": "Davies"
},
{
"_id": "662edc5b835c6a1ad967663a",
"email": "",
"first_name": "Danielle",
"last_name": "Lee"
},
{
"_id": "662edc5b835c6a1ad967663e",
"email": "",
"first_name": "David",
"last_name": "Watson"
},
{
"_id": "662edc5b835c6a1ad9676640",
"email": "dawn.smith@yahoo.com",
"first_name": "Dawn",
"last_name": "Smith"
},
{
"_id": "662edc5b835c6a1ad9676642",
"email": "derek.robinson@hotmail.co.uk",
"first_name": "Derek",
"last_name": "Robinson"
},
{
"_id": "662edc5b835c6a1ad9676646",
"email": "eleanor.cooper@gmail.com",
"first_name": "Eleanor",
"last_name": "Cooper"
},
{
"_id": "662edc5b835c6a1ad967664c",
"email": "gareth.kerr@gmail.com",
"first_name": "Gareth",
"last_name": "Kerr"
},
{
"_id": "662edc5b835c6a1ad967664e",
"email": "",
"first_name": "Garry",
"last_name": "Moore"
}
],
"page": 1,
"page_count": 12,
"per_page": 10
}
Retreive a service user contact object.
Returns a service user contact object.
serviceUserContact = apiClient.Request(
HttpMethod.Get,
$"service-user-contacts/{serviceUserContactId}"
);
<?php
$service_user_contact = $api_client->request(
'GET',
'service-user-contacts/' . $service_user_contact_id
);
service_user_contact = api_client(
'GET',
f'service-user-contacts/{service_user_contact_id}'
)
service_user_contact = api_client.request(
'GET',
"service-user-contacts/#{service_user_contact_id}"
)
{
"_id": "662edc5d835c6a1ad9676c56",
"account_code": "AW0474",
"billing_comms_preference": null,
"billing_enabled": null,
"care_enquiry": null,
"created": "2024-04-28 23:31:41",
"email": "abbey.wall@gmx.co.uk",
"email_invoices_to": null,
"emergency_contact": true,
"first_name": "Abbey",
"future_billing_disabled": null,
"has_direct_debit_mandate": null,
"invoices_service_user_id_fields": null,
"last_name": "Wall",
"location": "662edc59835c6a1ad9675cce",
"mobile": "07284280384",
"modified": "2024-04-28 23:31:41",
"next_of_kin": true,
"notes": "",
"payment_method": null,
"phone": "01842625621",
"poa_types": [
"lpa_property_affairs",
"lpa_health_welfare"
],
"postal_address": {
"address_1": "The Old Rectory",
"address_2": "Rectory Rd",
"country": "",
"county": "Oxfordshire",
"postcode": "OX44 7JG",
"town": "Great Haseley"
},
"relationship": "Daughter",
"service_user": "662edc5d835c6a1ad9676b78",
"title": "Mrs",
"work_phone": ""
}