POST api/CreateCampaignConfiguration

Request Information

URI Parameters

None.

Body Parameters

CampaignConfigurationVm
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

OtherChannels

Collection of CampaignConfigChannelVm

None.

Project_Id

integer

None.

Users

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 1",
  "OtherChannels": [
    {
      "SourceId": 1,
      "SubSource": "sample string 2",
      "CompanyIvrId": 3
    },
    {
      "SourceId": 1,
      "SubSource": "sample string 2",
      "CompanyIvrId": 3
    }
  ],
  "Project_Id": 1,
  "Users": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<CampaignConfigurationVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Services.Campaign">
  <Id>1</Id>
  <Name>sample string 1</Name>
  <OtherChannels>
    <CampaignConfigChannelVm>
      <CompanyIvrId>3</CompanyIvrId>
      <SourceId>1</SourceId>
      <SubSource>sample string 2</SubSource>
    </CampaignConfigChannelVm>
    <CampaignConfigChannelVm>
      <CompanyIvrId>3</CompanyIvrId>
      <SourceId>1</SourceId>
      <SubSource>sample string 2</SubSource>
    </CampaignConfigChannelVm>
  </OtherChannels>
  <Project_Id>1</Project_Id>
  <Users xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </Users>
</CampaignConfigurationVm>

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 'CampaignConfigurationVm'.

Response Information

Resource Description

Response
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Description

string

None.

Data

Object

None.

Count

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Data": {},
  "Count": 5
}

application/xml, text/xml

Sample:
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
  <Count>5</Count>
  <Data />
  <Description>sample string 3</Description>
  <Message>sample string 2</Message>
  <Success>true</Success>
</Response>