POST api/clients/profiles/datadictionary-fields/program-map/get

A list of mappings between DataDictionary fields (profile fields configured in the DataDictionary) and the programs where each apply.

Request Information

URI Parameters

None.

Body Parameters

A list of client ids used to identify the universe of programs.

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 following status codes: 200 = success (a list of objects is returned; each object has a mapping between a DataDictionary field and a program; 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 DataDictionaryProgramMap

Name	Description	Type	Additional information
DataDictionaryFieldId		integer	None.
ProgramId		integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DataDictionaryFieldId": 1,
    "ProgramId": 2
  },
  {
    "DataDictionaryFieldId": 1,
    "ProgramId": 2
  }
]

application/xml, text/xml

Sample:

<ArrayOfDataDictionaryProgramMap xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO">
  <DataDictionaryProgramMap>
    <DataDictionaryFieldId>1</DataDictionaryFieldId>
    <ProgramId>2</ProgramId>
  </DataDictionaryProgramMap>
  <DataDictionaryProgramMap>
    <DataDictionaryFieldId>1</DataDictionaryFieldId>
    <ProgramId>2</ProgramId>
  </DataDictionaryProgramMap>
</ArrayOfDataDictionaryProgramMap>