GET api/client/{aAbrev}

Get All Clients From Careplanner

Request Information

URI Parameters

Name	Description	Type	Additional information
aAbrev	Abreviated Organisation Name	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ClientDetailModel

Name	Type	Additional information
ClientId	integer	None.
ClientCode	string	None.
PersonForename	string	None.
PersonSurname	string	None.
FullName	string	None.
PreferredName	string	None.
Password	string	None.
TitleDescription	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
AddressLine3	string	None.
AddressLine4	string	None.
AddressPostcode	string	None.
AddressPostcodeFirstPart	string	None.
AddressPostcodeSecondPart	string	None.
AddressOneLine	string	None.
TelephoneNumber	string	None.
MobileNumber	string	None.
EmailAddress	string	Required Data type: EmailAddress
DateOfBirth	date	None.
ClientImage	Collection of byte	None.
loc_id	integer	None.
ID	integer	None.
LocationServiceID	integer	None.
UserCreated	string	None.
DateCreated	date	None.
UserUpdated	string	None.
DateUpdated	date	None.
UserArchived	string	None.
DateArchived	date	None.

Response Formats

application/json

Sample:

[
  {
    "ClientId": 1,
    "ClientCode": "sample string 2",
    "PersonForename": "sample string 3",
    "PersonSurname": "sample string 4",
    "FullName": "sample string 5",
    "PreferredName": "sample string 6",
    "Password": "sample string 7",
    "TitleDescription": "sample string 8",
    "AddressLine1": "sample string 9",
    "AddressLine2": "sample string 10",
    "AddressLine3": "sample string 11",
    "AddressLine4": "sample string 12",
    "AddressPostcode": "sample string 13 sample string 14",
    "AddressPostcodeFirstPart": "sample string 13",
    "AddressPostcodeSecondPart": "sample string 14",
    "AddressOneLine": "Sample String 9,Sample String 10,Sample String 11,Sample String 12,sample string 13 sample string 14",
    "TelephoneNumber": "sample string 15",
    "MobileNumber": "sample string 16",
    "EmailAddress": "sample string 17",
    "DateOfBirth": "2026-01-15T12:45:30.3090951+00:00",
    "ClientImage": "QEA=",
    "loc_id": 19,
    "ID": 20,
    "LocationServiceID": 21,
    "UserCreated": "sample string 22",
    "DateCreated": "2026-01-15T12:45:30.3090951+00:00",
    "UserUpdated": "sample string 24",
    "DateUpdated": "2026-01-15T12:45:30.3090951+00:00",
    "UserArchived": "sample string 26",
    "DateArchived": "2026-01-15T12:45:30.3090951+00:00"
  },
  {
    "ClientId": 1,
    "ClientCode": "sample string 2",
    "PersonForename": "sample string 3",
    "PersonSurname": "sample string 4",
    "FullName": "sample string 5",
    "PreferredName": "sample string 6",
    "Password": "sample string 7",
    "TitleDescription": "sample string 8",
    "AddressLine1": "Sample String 9",
    "AddressLine2": "Sample String 10",
    "AddressLine3": "Sample String 11",
    "AddressLine4": "Sample String 12",
    "AddressPostcode": "sample string 13 sample string 14",
    "AddressPostcodeFirstPart": "sample string 13",
    "AddressPostcodeSecondPart": "sample string 14",
    "AddressOneLine": "Sample String 9,Sample String 10,Sample String 11,Sample String 12,sample string 13 sample string 14",
    "TelephoneNumber": "sample string 15",
    "MobileNumber": "sample string 16",
    "EmailAddress": "sample string 17",
    "DateOfBirth": "2026-01-15T12:45:30.3090951+00:00",
    "ClientImage": "QEA=",
    "loc_id": 19,
    "ID": 20,
    "LocationServiceID": 21,
    "UserCreated": "sample string 22",
    "DateCreated": "2026-01-15T12:45:30.3090951+00:00",
    "UserUpdated": "sample string 24",
    "DateUpdated": "2026-01-15T12:45:30.3090951+00:00",
    "UserArchived": "sample string 26",
    "DateArchived": "2026-01-15T12:45:30.3090951+00:00"
  }
]

text/json

Sample:

[
  {
    "ClientId": 1,
    "ClientCode": "sample string 2",
    "PersonForename": "sample string 3",
    "PersonSurname": "sample string 4",
    "FullName": "sample string 5",
    "PreferredName": "sample string 6",
    "Password": "sample string 7",
    "TitleDescription": "sample string 8",
    "AddressLine1": "Sample String 9",
    "AddressLine2": "Sample String 10",
    "AddressLine3": "Sample String 11",
    "AddressLine4": "Sample String 12",
    "AddressPostcode": "sample string 13 sample string 14",
    "AddressPostcodeFirstPart": "sample string 13",
    "AddressPostcodeSecondPart": "sample string 14",
    "AddressOneLine": "Sample String 9,Sample String 10,Sample String 11,Sample String 12,sample string 13 sample string 14",
    "TelephoneNumber": "sample string 15",
    "MobileNumber": "sample string 16",
    "EmailAddress": "sample string 17",
    "DateOfBirth": "2026-01-15T12:45:30.3090951+00:00",
    "ClientImage": "QEA=",
    "loc_id": 19,
    "ID": 20,
    "LocationServiceID": 21,
    "UserCreated": "sample string 22",
    "DateCreated": "2026-01-15T12:45:30.3090951+00:00",
    "UserUpdated": "sample string 24",
    "DateUpdated": "2026-01-15T12:45:30.3090951+00:00",
    "UserArchived": "sample string 26",
    "DateArchived": "2026-01-15T12:45:30.3090951+00:00"
  },
  {
    "ClientId": 1,
    "ClientCode": "sample string 2",
    "PersonForename": "sample string 3",
    "PersonSurname": "sample string 4",
    "FullName": "sample string 5",
    "PreferredName": "sample string 6",
    "Password": "sample string 7",
    "TitleDescription": "sample string 8",
    "AddressLine1": "Sample String 9",
    "AddressLine2": "Sample String 10",
    "AddressLine3": "Sample String 11",
    "AddressLine4": "Sample String 12",
    "AddressPostcode": "sample string 13 sample string 14",
    "AddressPostcodeFirstPart": "sample string 13",
    "AddressPostcodeSecondPart": "sample string 14",
    "AddressOneLine": "Sample String 9,Sample String 10,Sample String 11,Sample String 12,sample string 13 sample string 14",
    "TelephoneNumber": "sample string 15",
    "MobileNumber": "sample string 16",
    "EmailAddress": "sample string 17",
    "DateOfBirth": "2026-01-15T12:45:30.3090951+00:00",
    "ClientImage": "QEA=",
    "loc_id": 19,
    "ID": 20,
    "LocationServiceID": 21,
    "UserCreated": "sample string 22",
    "DateCreated": "2026-01-15T12:45:30.3090951+00:00",
    "UserUpdated": "sample string 24",
    "DateUpdated": "2026-01-15T12:45:30.3090951+00:00",
    "UserArchived": "sample string 26",
    "DateArchived": "2026-01-15T12:45:30.3090951+00:00"
  }
]

text/html

Sample:

[{"ClientId":1,"ClientCode":"sample string 2","PersonForename":"sample string 3","PersonSurname":"sample string 4","FullName":"sample string 5","PreferredName":"sample string 6","Password":"sample string 7","TitleDescription":"sample string 8","AddressLine1":"Sample String 9","AddressLine2":"Sample String 10","AddressLine3":"Sample String 11","AddressLine4":"Sample String 12","AddressPostcode":"sample string 13 sample string 14","AddressPostcodeFirstPart":"sample string 13","AddressPostcodeSecondPart":"sample string 14","AddressOneLine":"Sample String 9,Sample String 10,Sample String 11,Sample String 12,sample string 13 sample string 14","TelephoneNumber":"sample string 15","MobileNumber":"sample string 16","EmailAddress":"sample string 17","DateOfBirth":"2026-01-15T12:45:30.3090951+00:00","ClientImage":"QEA=","loc_id":19,"ID":20,"LocationServiceID":21,"UserCreated":"sample string 22","DateCreated":"2026-01-15T12:45:30.3090951+00:00","UserUpdated":"sample string 24","DateUpdated":"2026-01-15T12:45:30.3090951+00:00","UserArchived":"sample string 26","DateArchived":"2026-01-15T12:45:30.3090951+00:00"},{"ClientId":1,"ClientCode":"sample string 2","PersonForename":"sample string 3","PersonSurname":"sample string 4","FullName":"sample string 5","PreferredName":"sample string 6","Password":"sample string 7","TitleDescription":"sample string 8","AddressLine1":"Sample String 9","AddressLine2":"Sample String 10","AddressLine3":"Sample String 11","AddressLine4":"Sample String 12","AddressPostcode":"sample string 13 sample string 14","AddressPostcodeFirstPart":"sample string 13","AddressPostcodeSecondPart":"sample string 14","AddressOneLine":"Sample String 9,Sample String 10,Sample String 11,Sample String 12,sample string 13 sample string 14","TelephoneNumber":"sample string 15","MobileNumber":"sample string 16","EmailAddress":"sample string 17","DateOfBirth":"2026-01-15T12:45:30.3090951+00:00","ClientImage":"QEA=","loc_id":19,"ID":20,"LocationServiceID":21,"UserCreated":"sample string 22","DateCreated":"2026-01-15T12:45:30.3090951+00:00","UserUpdated":"sample string 24","DateUpdated":"2026-01-15T12:45:30.3090951+00:00","UserArchived":"sample string 26","DateArchived":"2026-01-15T12:45:30.3090951+00:00"}]

application/xml, text/xml

Sample:

<ArrayOfClientDetailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels">
  <ClientDetailModel>
    <DateArchived xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">2026-01-15T12:45:30.3090951+00:00</DateArchived>
    <DateCreated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">2026-01-15T12:45:30.3090951+00:00</DateCreated>
    <DateUpdated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">2026-01-15T12:45:30.3090951+00:00</DateUpdated>
    <UserArchived xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">sample string 26</UserArchived>
    <UserCreated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">sample string 22</UserCreated>
    <UserUpdated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">sample string 24</UserUpdated>
    <AddressLine1>Sample String 9</AddressLine1>
    <AddressLine2>Sample String 10</AddressLine2>
    <AddressLine3>Sample String 11</AddressLine3>
    <AddressLine4>Sample String 12</AddressLine4>
    <AddressPostcodeFirstPart>sample string 13</AddressPostcodeFirstPart>
    <AddressPostcodeSecondPart>sample string 14</AddressPostcodeSecondPart>
    <ClientCode>sample string 2</ClientCode>
    <ClientId>1</ClientId>
    <ClientImage>QEA=</ClientImage>
    <DateOfBirth>2026-01-15T12:45:30.3090951+00:00</DateOfBirth>
    <EmailAddress>sample string 17</EmailAddress>
    <FullName>sample string 5</FullName>
    <ID>20</ID>
    <LocationServiceID>21</LocationServiceID>
    <MobileNumber>sample string 16</MobileNumber>
    <Password>sample string 7</Password>
    <PersonForename>sample string 3</PersonForename>
    <PersonSurname>sample string 4</PersonSurname>
    <PreferredName>sample string 6</PreferredName>
    <TelephoneNumber>sample string 15</TelephoneNumber>
    <TitleDescription>sample string 8</TitleDescription>
    <loc_id>19</loc_id>
  </ClientDetailModel>
  <ClientDetailModel>
    <DateArchived xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">2026-01-15T12:45:30.3090951+00:00</DateArchived>
    <DateCreated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">2026-01-15T12:45:30.3090951+00:00</DateCreated>
    <DateUpdated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">2026-01-15T12:45:30.3090951+00:00</DateUpdated>
    <UserArchived xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">sample string 26</UserArchived>
    <UserCreated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">sample string 22</UserCreated>
    <UserUpdated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">sample string 24</UserUpdated>
    <AddressLine1>Sample String 9</AddressLine1>
    <AddressLine2>Sample String 10</AddressLine2>
    <AddressLine3>Sample String 11</AddressLine3>
    <AddressLine4>Sample String 12</AddressLine4>
    <AddressPostcodeFirstPart>sample string 13</AddressPostcodeFirstPart>
    <AddressPostcodeSecondPart>sample string 14</AddressPostcodeSecondPart>
    <ClientCode>sample string 2</ClientCode>
    <ClientId>1</ClientId>
    <ClientImage>QEA=</ClientImage>
    <DateOfBirth>2026-01-15T12:45:30.3090951+00:00</DateOfBirth>
    <EmailAddress>sample string 17</EmailAddress>
    <FullName>sample string 5</FullName>
    <ID>20</ID>
    <LocationServiceID>21</LocationServiceID>
    <MobileNumber>sample string 16</MobileNumber>
    <Password>sample string 7</Password>
    <PersonForename>sample string 3</PersonForename>
    <PersonSurname>sample string 4</PersonSurname>
    <PreferredName>sample string 6</PreferredName>
    <TelephoneNumber>sample string 15</TelephoneNumber>
    <TitleDescription>sample string 8</TitleDescription>
    <loc_id>19</loc_id>
  </ClientDetailModel>
</ArrayOfClientDetailModel>