POST api/ESB/DocumentAddEmail

Request Information

URI Parameters

None.

Body Parameters

DocumentActionEmail
NameDescriptionTypeAdditional information
TransactionId

string

None.

DocumentIdentifier_6

string

Max length: 200

Reason

string

Max length: 200

SendNotification

boolean

None.

DocumentDescription

string

None.

Emails

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "TransactionId": "sample string 1",
  "DocumentIdentifier_6": "sample string 2",
  "Reason": "sample string 3",
  "SendNotification": true,
  "DocumentDescription": "sample string 5",
  "Emails": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<DocumentActionEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
  <DocumentDescription>sample string 5</DocumentDescription>
  <DocumentIdentifier_6>sample string 2</DocumentIdentifier_6>
  <Emails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Emails>
  <Reason>sample string 3</Reason>
  <SendNotification>true</SendNotification>
  <TransactionId>sample string 1</TransactionId>
</DocumentActionEmail>

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

Response Information

Resource Description

ServiceResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

TransactionId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "TransactionId": "sample string 3"
}

application/xml, text/xml

Sample:
<ServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels">
  <Message>sample string 2</Message>
  <Success>true</Success>
  <TransactionId>sample string 3</TransactionId>
</ServiceResponse>