GET PlanCare2Api/DynamicData/ClientDetailsList?clientlist={clientlist}

Gets clients by a list of unique identifiers

Request Information

URI Parameters

Name	Description	Type	Additional information
clientlist	The list of clients seperated by comma to obtain the clientdetails for	string	Required

Body Parameters

None.

Response Information

Resource Description

Detailed client information

Collection of ClientDetailsListResult

Name	Type	Additional information
Relationid	integer	Nullable
Clientid	integer	Nullable
PCD_Clientid	integer	Nullable
BSN	string	-
Mobile	string	-
Telephone	string	-
Email	string	-
Gender	string	-
Maritalstatus	byte	Nullable
Language	string	-
Religion	string	-
Livingunit	string	-
Dateofbirth	string	-
Dateofdeath	string	-
Nationality	string	-
Prefix	string	-
Firstname	string	-
Initials	string	-
Birthname	string	-
Birthnameprefix	string	-
Partnername	string	-
Partnernameprefix	string	-
Lookupname	string	-
Fullname	string	-
Fullnamecomposition	byte	Nullable
Suffix	string	-
Nickname	string	-
City	string	-
Street	string	-
Housenumber	string	-
Housenumberaddon	string	-
Postalcode	string	-
Country	string	-
Legalstatus	byte	Nullable
Countryofbirth	string	-
Cityofbirth	string	-
Addressrn	integer	Nullable
Photo	string	-
Registrationnumber	string	-
Secretplacement	boolean	Nullable

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Relationid": 1,
    "Clientid": 1,
    "PCD_Clientid": 1,
    "BSN": "sample string 1",
    "Mobile": "sample string 2",
    "Telephone": "sample string 3",
    "Email": "sample string 4",
    "Gender": "sample string 5",
    "Maritalstatus": 64,
    "Language": "sample string 6",
    "Religion": "sample string 7",
    "Livingunit": "sample string 8",
    "Dateofbirth": "sample string 9",
    "Dateofdeath": "sample string 10",
    "Nationality": "sample string 11",
    "Prefix": "sample string 12",
    "Firstname": "sample string 13",
    "Initials": "sample string 14",
    "Birthname": "sample string 15",
    "Birthnameprefix": "sample string 16",
    "Partnername": "sample string 17",
    "Partnernameprefix": "sample string 18",
    "Lookupname": "sample string 19",
    "Fullname": "sample string 20",
    "Fullnamecomposition": 64,
    "Suffix": "sample string 21",
    "Nickname": "sample string 22",
    "City": "sample string 23",
    "Street": "sample string 24",
    "Housenumber": "sample string 25",
    "Housenumberaddon": "sample string 26",
    "Postalcode": "sample string 27",
    "Country": "sample string 28",
    "Legalstatus": 64,
    "Countryofbirth": "sample string 29",
    "Cityofbirth": "sample string 30",
    "Addressrn": 1,
    "Photo": "sample string 31",
    "Registrationnumber": "sample string 32",
    "Secretplacement": true
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDynamicDataController.ClientDetailsListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Controllers">
  <DynamicDataController.ClientDetailsListResult>
    <Addressrn>1</Addressrn>
    <BSN>sample string 1</BSN>
    <Birthname>sample string 15</Birthname>
    <Birthnameprefix>sample string 16</Birthnameprefix>
    <City>sample string 23</City>
    <Cityofbirth>sample string 30</Cityofbirth>
    <Clientid>1</Clientid>
    <Country>sample string 28</Country>
    <Countryofbirth>sample string 29</Countryofbirth>
    <Dateofbirth>sample string 9</Dateofbirth>
    <Dateofdeath>sample string 10</Dateofdeath>
    <Email>sample string 4</Email>
    <Firstname>sample string 13</Firstname>
    <Fullname>sample string 20</Fullname>
    <Fullnamecomposition>64</Fullnamecomposition>
    <Gender>sample string 5</Gender>
    <Housenumber>sample string 25</Housenumber>
    <Housenumberaddon>sample string 26</Housenumberaddon>
    <Initials>sample string 14</Initials>
    <Language>sample string 6</Language>
    <Legalstatus>64</Legalstatus>
    <Livingunit>sample string 8</Livingunit>
    <Lookupname>sample string 19</Lookupname>
    <Maritalstatus>64</Maritalstatus>
    <Mobile>sample string 2</Mobile>
    <Nationality>sample string 11</Nationality>
    <Nickname>sample string 22</Nickname>
    <PCD_Clientid>1</PCD_Clientid>
    <Partnername>sample string 17</Partnername>
    <Partnernameprefix>sample string 18</Partnernameprefix>
    <Photo>sample string 31</Photo>
    <Postalcode>sample string 27</Postalcode>
    <Prefix>sample string 12</Prefix>
    <Registrationnumber>sample string 32</Registrationnumber>
    <Relationid>1</Relationid>
    <Religion>sample string 7</Religion>
    <Secretplacement>true</Secretplacement>
    <Street>sample string 24</Street>
    <Suffix>sample string 21</Suffix>
    <Telephone>sample string 3</Telephone>
  </DynamicDataController.ClientDetailsListResult>
  <DynamicDataController.ClientDetailsListResult>
    <Addressrn>1</Addressrn>
    <BSN>sample string 1</BSN>
    <Birthname>sample string 15</Birthname>
    <Birthnameprefix>sample string 16</Birthnameprefix>
    <City>sample string 23</City>
    <Cityofbirth>sample string 30</Cityofbirth>
    <Clientid>1</Clientid>
    <Country>sample string 28</Country>
    <Countryofbirth>sample string 29</Countryofbirth>
    <Dateofbirth>sample string 9</Dateofbirth>
    <Dateofdeath>sample string 10</Dateofdeath>
    <Email>sample string 4</Email>
    <Firstname>sample string 13</Firstname>
    <Fullname>sample string 20</Fullname>
    <Fullnamecomposition>64</Fullnamecomposition>
    <Gender>sample string 5</Gender>
    <Housenumber>sample string 25</Housenumber>
    <Housenumberaddon>sample string 26</Housenumberaddon>
    <Initials>sample string 14</Initials>
    <Language>sample string 6</Language>
    <Legalstatus>64</Legalstatus>
    <Livingunit>sample string 8</Livingunit>
    <Lookupname>sample string 19</Lookupname>
    <Maritalstatus>64</Maritalstatus>
    <Mobile>sample string 2</Mobile>
    <Nationality>sample string 11</Nationality>
    <Nickname>sample string 22</Nickname>
    <PCD_Clientid>1</PCD_Clientid>
    <Partnername>sample string 17</Partnername>
    <Partnernameprefix>sample string 18</Partnernameprefix>
    <Photo>sample string 31</Photo>
    <Postalcode>sample string 27</Postalcode>
    <Prefix>sample string 12</Prefix>
    <Registrationnumber>sample string 32</Registrationnumber>
    <Relationid>1</Relationid>
    <Religion>sample string 7</Religion>
    <Secretplacement>true</Secretplacement>
    <Street>sample string 24</Street>
    <Suffix>sample string 21</Suffix>
    <Telephone>sample string 3</Telephone>
  </DynamicDataController.ClientDetailsListResult>
</ArrayOfDynamicDataController.ClientDetailsListResult>