POST api/clients/profiles/datadictionary-fields/values/get

Gets the list of Values for each profile fields configured in the DataDictionary.

Request Information

URI Parameters

None.

Body Parameters

A list of client ids, for each of whom the values are retrieved.

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 following status codes: 200 = success (a list of objects is returned; each object has the value of a data dictionary field for a client; it can be an empty list) 400 = bad request (the request is malformed or with invalid data), 500 = something went wrong (the request was not processed).

Collection of ClientFieldsValues

Name	Description	Type	Additional information
ClientId		integer	None.
FieldsValues		Collection of FieldSourceNameValue	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientId": 1,
    "FieldsValues": [
      {
        "SourceName": "sample string 1",
        "FieldName": "sample string 2",
        "FieldValue": "sample string 3"
      },
      {
        "SourceName": "sample string 1",
        "FieldName": "sample string 2",
        "FieldValue": "sample string 3"
      }
    ]
  },
  {
    "ClientId": 1,
    "FieldsValues": [
      {
        "SourceName": "sample string 1",
        "FieldName": "sample string 2",
        "FieldValue": "sample string 3"
      },
      {
        "SourceName": "sample string 1",
        "FieldName": "sample string 2",
        "FieldValue": "sample string 3"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientFieldsValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO">
  <ClientFieldsValues>
    <ClientId>1</ClientId>
    <FieldsValues>
      <FieldSourceNameValue>
        <FieldName>sample string 2</FieldName>
        <FieldValue>sample string 3</FieldValue>
        <SourceName>sample string 1</SourceName>
      </FieldSourceNameValue>
      <FieldSourceNameValue>
        <FieldName>sample string 2</FieldName>
        <FieldValue>sample string 3</FieldValue>
        <SourceName>sample string 1</SourceName>
      </FieldSourceNameValue>
    </FieldsValues>
  </ClientFieldsValues>
  <ClientFieldsValues>
    <ClientId>1</ClientId>
    <FieldsValues>
      <FieldSourceNameValue>
        <FieldName>sample string 2</FieldName>
        <FieldValue>sample string 3</FieldValue>
        <SourceName>sample string 1</SourceName>
      </FieldSourceNameValue>
      <FieldSourceNameValue>
        <FieldName>sample string 2</FieldName>
        <FieldValue>sample string 3</FieldValue>
        <SourceName>sample string 1</SourceName>
      </FieldSourceNameValue>
    </FieldsValues>
  </ClientFieldsValues>
</ArrayOfClientFieldsValues>