POST api/branch/createscheduledmailmerge

Request Information

URI Parameters

None.

Body Parameters

MailMergeScheduledCommandDataContract
NameDescriptionTypeAdditional information
Name

string

None.

Description

string

None.

IncludeOfferAccepted

boolean

None.

MatchLimit

integer

None.

Grades

Collection of EnumDataContract

None.

IncludePriceChange

boolean

None.

ExcludeAlreadySent

boolean

None.

ExcludeAlreadySentInLastDays

integer

None.

Sales

boolean

None.

Lettings

boolean

None.

StartDate

date

None.

DailySchedule

RecurringScheduleDataContract

None.

WeeklySchedule

RecurringScheduleDataContract

None.

MonthlySchedule

RecurringScheduleDataContract

None.

QuarterlySchedule

RecurringScheduleDataContract

None.

YearlySchedule

RecurringScheduleDataContract

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "IncludeOfferAccepted": true,
  "MatchLimit": 4,
  "Grades": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "IncludePriceChange": true,
  "ExcludeAlreadySent": true,
  "ExcludeAlreadySentInLastDays": 7,
  "Sales": true,
  "Lettings": true,
  "StartDate": "2018-11-16T22:08:43.3432752Z",
  "DailySchedule": {
    "Frequency": 1,
    "StartDate": "2018-11-16T22:08:43.3432752Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "AnniversaryDay": 3,
    "AnniversaryMonth": 4
  },
  "WeeklySchedule": {
    "Frequency": 1,
    "StartDate": "2018-11-16T22:08:43.3432752Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "AnniversaryDay": 3,
    "AnniversaryMonth": 4
  },
  "MonthlySchedule": {
    "Frequency": 1,
    "StartDate": "2018-11-16T22:08:43.3432752Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "AnniversaryDay": 3,
    "AnniversaryMonth": 4
  },
  "QuarterlySchedule": {
    "Frequency": 1,
    "StartDate": "2018-11-16T22:08:43.3432752Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "AnniversaryDay": 3,
    "AnniversaryMonth": 4
  },
  "YearlySchedule": {
    "Frequency": 1,
    "StartDate": "2018-11-16T22:08:43.3432752Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "AnniversaryDay": 3,
    "AnniversaryMonth": 4
  }
}

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

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.