POST api/job/SendSystemEmail

Sends a basic email to any specified party.

Request Information

URI Parameters

None.

Body Parameters

The send system email.

Dezrez.Core.DataContracts.External.Api.Job.Command.SendSystemEmail.SendSystemEmailCommandDataContract
NameDescriptionTypeAdditional information
To

Collection of string

None.

From

string

None.

Subject

string

None.

Body

string

None.

SystemDocumentBody

string

None.

JsonModel

string

None.

SystemDocumentAttachments

Collection of string

None.

Request Formats

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

application/json, text/json

Sample:
{
  "To": [
    "sample string 1",
    "sample string 2"
  ],
  "From": "sample string 1",
  "Subject": "sample string 2",
  "Body": "sample string 3",
  "SystemDocumentBody": "sample string 4",
  "JsonModel": "sample string 5",
  "SystemDocumentAttachments": [
    "sample string 1",
    "sample string 2"
  ]
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Job.Query.Get.JobInvocationDetailsDataContract
NameDescriptionTypeAdditional information
SupportsCancellation

boolean

None.

ReportsProgress

boolean

None.

InitialStatusText

string

None.

JobReference

globally unique identifier

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "9581efef-5a92-469c-bcf1-a78685088c58",
  "Success": true
}