POST api/Email/EmailUpdate

Request Information

URI Parameters

None.

Body Parameters

EmailRequest
NameDescriptionTypeAdditional information
AutoNotifyFlag

boolean

None.

DataChangeNotifyFlag

boolean

None.

EmailAddress

string

None.

SeqNum

integer

None.

KeyNum

integer

None.

KeyType

string

None.

SessionNum

integer

None.

SessionPassword

Collection of byte

None.

ApplicationCode

string

None.

StagesURL

string

None.

Request Formats

application/json, text/json

Sample:
{
  "AutoNotifyFlag": true,
  "DataChangeNotifyFlag": true,
  "EmailAddress": "sample string 1",
  "SeqNum": 1,
  "KeyNum": 1,
  "KeyType": "sample string 2",
  "SessionNum": 3,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 4",
  "StagesURL": "sample string 5"
}

application/xml, text/xml

Sample:
<EmailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 5</StagesURL>
  <ApplicationCode>sample string 4</ApplicationCode>
  <SessionNum>3</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <KeyNum>1</KeyNum>
  <KeyType>sample string 2</KeyType>
  <AutoNotifyFlag>true</AutoNotifyFlag>
  <DataChangeNotifyFlag>true</DataChangeNotifyFlag>
  <EmailAddress>sample string 1</EmailAddress>
  <SeqNum>1</SeqNum>
</EmailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EmailUpdateQueryResult
NameDescriptionTypeAdditional information
ExcludeColumnList

Collection of string

None.

ResultSet

Collection of EmailUpdateResult

None.

Success

boolean

None.

UserErrorMessage

string

None.

ErrorTypeNum

integer

None.

SqlConnectionLost

boolean

None.

ClientVersion

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ],
  "ResultSet": [
    {
      "AutoNotifyFlag": true,
      "DataChangeNotifyFlag": true,
      "EmailAddress": "sample string 1",
      "KeyNum": 1,
      "KeyType": "sample string 2",
      "SeqNum": 1,
      "Title": "sample string 3"
    },
    {
      "AutoNotifyFlag": true,
      "DataChangeNotifyFlag": true,
      "EmailAddress": "sample string 1",
      "KeyNum": 1,
      "KeyType": "sample string 2",
      "SeqNum": 1,
      "Title": "sample string 3"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:
<EmailUpdateQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages">
  <ClientVersion>sample string 5</ClientVersion>
  <ErrorTypeNum>3</ErrorTypeNum>
  <SqlConnectionLost>true</SqlConnectionLost>
  <Success>true</Success>
  <UserErrorMessage>sample string 2</UserErrorMessage>
  <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeColumnList>
  <ResultSet>
    <EmailUpdateResult>
      <AutoNotifyFlag>true</AutoNotifyFlag>
      <DataChangeNotifyFlag>true</DataChangeNotifyFlag>
      <EmailAddress>sample string 1</EmailAddress>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 2</KeyType>
      <SeqNum>1</SeqNum>
      <Title>sample string 3</Title>
    </EmailUpdateResult>
    <EmailUpdateResult>
      <AutoNotifyFlag>true</AutoNotifyFlag>
      <DataChangeNotifyFlag>true</DataChangeNotifyFlag>
      <EmailAddress>sample string 1</EmailAddress>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 2</KeyType>
      <SeqNum>1</SeqNum>
      <Title>sample string 3</Title>
    </EmailUpdateResult>
  </ResultSet>
</EmailUpdateQueryResult>