POST api/Mail/AddOrEditNotificationRecipient

AddOrEditNotificationRecipient

Request Information

URI Parameters

None.

Body Parameters

rule

EmailNotificationRecipient
NameDescriptionTypeAdditional information
ProjectID

integer

None.

NotificationRuleID

integer

None.

RecipientTypeID

integer

None.

RecipientID

integer

None.

RecipientScope

integer

None.

CCEmailAddress

string

None.

SendOption

integer

None.

ScopeItems

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ProjectID": 1,
  "NotificationRuleID": 2,
  "RecipientTypeID": 3,
  "RecipientID": 4,
  "RecipientScope": 5,
  "CCEmailAddress": "sample string 6",
  "SendOption": 7,
  "ScopeItems": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<EmailNotificationRecipient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <CCEmailAddress>sample string 6</CCEmailAddress>
  <NotificationRuleID>2</NotificationRuleID>
  <ProjectID>1</ProjectID>
  <RecipientID>4</RecipientID>
  <RecipientScope>5</RecipientScope>
  <RecipientTypeID>3</RecipientTypeID>
  <ScopeItems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ScopeItems>
  <SendOption>7</SendOption>
</EmailNotificationRecipient>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddOrEditNotificationRecipient

API_Data_Int32
NameDescriptionTypeAdditional information
Success

boolean

None.

Error

ErrorInfo

None.

Data

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": 2
}

application/xml, text/xml

Sample:
<API_Data_int xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
  <Data>2</Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_int>