POST api/clients/basicProfileInfo?count={count}

Gets basic profile information for each client passed in a list of client Ids e.g. first name, last name, dob, gender, etc. Consumers: Client Portal

Request Information

URI Parameters

Name	Description	Type	Additional information
count	an input parameter; set it to 1 to include in the response a "TotalCount" header with the total count of elements.	integer	None.

Body Parameters

the list of client ids from whom the details are to be returned.

ClientIdListHolder

Name	Description	Type	Additional information
ClientIdList		Collection of integer	Required

Request Formats

application/json, text/json

Sample:

{
  "ClientIdList": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<ClientIdListHolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO">
  <ClientIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ClientIdList>
</ClientIdListHolder>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClientIdListHolder'.

Response Information

Resource Description

An Http response message with the folliwing status codes: 200 = success (includes the list of client details found), 400 = bad request (the request is malformed or with invalid data), 404 = not found (this status is returned when there are no details found or none of the clients provided exists) 500 = something went wrong (the request was not processed).

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.