POST Study/AddPeerToCart

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
studyId	integer	None.
studyPeersIds	string	None.
userId	integer	None.
isProprietaryInclude	boolean	None.
studyKPIParms	StudyKPIParms	None.

Request Formats

application/json, text/json

Sample:

{
  "studyId": 1,
  "studyPeersIds": "sample string 2",
  "userId": 3,
  "isProprietaryInclude": true,
  "studyKPIParms": {
    "StudyMetricRangeId": 1,
    "studyId": 1,
    "templateId": 2,
    "userId": 3,
    "paramSelectedKPIs": "sample string 4",
    "paramSelectedMetricGroups": "sample string 5",
    "paramSELECTEDTopGroups": [
      {
        "MetricId": 1,
        "ParentMetricGroupID": 2,
        "IsMetricGroup": true
      },
      {
        "MetricId": 1,
        "ParentMetricGroupID": 2,
        "IsMetricGroup": true
      }
    ]
  }
}

application/xml, text/xml

Sample:

<AddToCartParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DUA.REST.Models">
  <isProprietaryInclude>true</isProprietaryInclude>
  <studyId>1</studyId>
  <studyKPIParms>
    <StudyMetricRangeId>1</StudyMetricRangeId>
    <paramSELECTEDTopGroups xmlns:d3p1="http://schemas.datacontract.org/2004/07/DUA.Data.Models">
      <d3p1:StudyKPIFilterType>
        <d3p1:IsMetricGroup>true</d3p1:IsMetricGroup>
        <d3p1:MetricId>1</d3p1:MetricId>
        <d3p1:ParentMetricGroupID>2</d3p1:ParentMetricGroupID>
      </d3p1:StudyKPIFilterType>
      <d3p1:StudyKPIFilterType>
        <d3p1:IsMetricGroup>true</d3p1:IsMetricGroup>
        <d3p1:MetricId>1</d3p1:MetricId>
        <d3p1:ParentMetricGroupID>2</d3p1:ParentMetricGroupID>
      </d3p1:StudyKPIFilterType>
    </paramSELECTEDTopGroups>
    <paramSelectedKPIs>sample string 4</paramSelectedKPIs>
    <paramSelectedMetricGroups>sample string 5</paramSelectedMetricGroups>
    <studyId>1</studyId>
    <templateId>2</templateId>
    <userId>3</userId>
  </studyKPIParms>
  <studyPeersIds>sample string 2</studyPeersIds>
  <userId>3</userId>
</AddToCartParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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.