POST api/Campaign/PurgeOutdialCalls

Request Information

URI Parameters

None.

Body Parameters

OutDialCallsPurgeRequest
NameDescriptionTypeAdditional information
CampaignId

string

Required

MemberId

string

Required

PhoneNumber

string

Required

Request Formats

text/json, application/json

Sample:
Request sample for request 

--------------------------------------------------------------------------------------------------------------------------------

{
  "CampaignId": "sample string 1",
  "MemberId": "sample string 2",
  "PhoneNumber": "sample string 3"
}

--------------------------------------------------------------------------------------------------------------------------------


text/xml, application/xml

Sample:
Request sample for request 

--------------------------------------------------------------------------------------------------------------------------------

<OutDialCallsPurgeRequest xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CampaignId>sample string 1</CampaignId>
  <MemberId>sample string 2</MemberId>
  <PhoneNumber>sample string 3</PhoneNumber>
</OutDialCallsPurgeRequest>

--------------------------------------------------------------------------------------------------------------------------------


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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

text/json, application/json

Sample:

--------------------------------------------------------------------------------------------------------------------------------

{
  "OutdialPurgeResult": true,
  "ProcessingStatusList": [
    {
      "StatusCode": "sample string 1",
      "StatusDescription": "sample string 2"
    },
    {
      "StatusCode": "sample string 1",
      "StatusDescription": "sample string 2"
    }
  ]
}

--------------------------------------------------------------------------------------------------------------------------------


text/xml, application/xml

Sample:

--------------------------------------------------------------------------------------------------------------------------------

<OutDialCallsPurgeResponse xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OutdialPurgeResult>true</OutdialPurgeResult>
  <ProcessingStatusList xmlns:a="http://schemas.datacontract.org/2004/07/AHC.Core">
    <a:ProcessingStatus>
      <a:StatusCode>sample string 1</a:StatusCode>
      <a:StatusDescription>sample string 2</a:StatusDescription>
    </a:ProcessingStatus>
    <a:ProcessingStatus>
      <a:StatusCode>sample string 1</a:StatusCode>
      <a:StatusDescription>sample string 2</a:StatusDescription>
    </a:ProcessingStatus>
  </ProcessingStatusList>
</OutDialCallsPurgeResponse>

--------------------------------------------------------------------------------------------------------------------------------