POST api/Campaign/GetCreditsUsedByTextRoute

Request Information

URI Parameters

None.

Body Parameters

GetCampaignTextRouteCreditUseDetailRequestVM

Name	Type	Additional information
ContactIds	Collection of string	None.
SubAccountId	string	Required
MergeFieldSettings	Collection of MergeFieldSettingsViewModel	None.
FromName	string	None.
Message	string	None.
IsMultiRoute	boolean	None.
SendToAllContacts	boolean	None.
IsMMS	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ContactIds": [
    "sample string 1",
    "sample string 2"
  ],
  "SubAccountId": "sample string 1",
  "MergeFieldSettings": [
    {
      "Id": "sample string 1",
      "IsCustomField": true,
      "Key": "sample string 3",
      "CustomFieldId": "sample string 4",
      "FieldName": "sample string 5",
      "AfterText": "sample string 6",
      "BeforeText": "sample string 7",
      "TextIfNotExist": "sample string 8",
      "IsEmpty": true
    },
    {
      "Id": "sample string 1",
      "IsCustomField": true,
      "Key": "sample string 3",
      "CustomFieldId": "sample string 4",
      "FieldName": "sample string 5",
      "AfterText": "sample string 6",
      "BeforeText": "sample string 7",
      "TextIfNotExist": "sample string 8",
      "IsEmpty": true
    }
  ],
  "FromName": "sample string 2",
  "Message": "sample string 3",
  "IsMultiRoute": true,
  "SendToAllContacts": true,
  "IsMMS": true
}

application/xml, text/xml

Sample:

<GetCampaignTextRouteCreditUseDetailRequestVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.RequestViewModels.CampaignRequestViewModel">
  <ContactIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ContactIds>
  <FromName>sample string 2</FromName>
  <IsMMS>true</IsMMS>
  <IsMultiRoute>true</IsMultiRoute>
  <MergeFieldSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
    <d2p1:MergeFieldSettingsViewModel>
      <d2p1:AfterText>sample string 6</d2p1:AfterText>
      <d2p1:BeforeText>sample string 7</d2p1:BeforeText>
      <d2p1:CustomFieldId>sample string 4</d2p1:CustomFieldId>
      <d2p1:FieldName>sample string 5</d2p1:FieldName>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IsCustomField>true</d2p1:IsCustomField>
      <d2p1:IsEmpty>true</d2p1:IsEmpty>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:TextIfNotExist>sample string 8</d2p1:TextIfNotExist>
    </d2p1:MergeFieldSettingsViewModel>
    <d2p1:MergeFieldSettingsViewModel>
      <d2p1:AfterText>sample string 6</d2p1:AfterText>
      <d2p1:BeforeText>sample string 7</d2p1:BeforeText>
      <d2p1:CustomFieldId>sample string 4</d2p1:CustomFieldId>
      <d2p1:FieldName>sample string 5</d2p1:FieldName>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:IsCustomField>true</d2p1:IsCustomField>
      <d2p1:IsEmpty>true</d2p1:IsEmpty>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:TextIfNotExist>sample string 8</d2p1:TextIfNotExist>
    </d2p1:MergeFieldSettingsViewModel>
  </MergeFieldSettings>
  <Message>sample string 3</Message>
  <SendToAllContacts>true</SendToAllContacts>
  <SubAccountId>sample string 1</SubAccountId>
</GetCampaignTextRouteCreditUseDetailRequestVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.