POST api/as2/sender

send EDI or other messages over HTTP/S, using the AS2 protocol.

Request Information

URI Parameters

None.

Body Parameters

Edi sender request

SuiteBridge.Models.Edi.EdiSenderRequest

Name	Description	Type	Additional information
AS2Identifier	The AS2 Identifier of the sending system.	string	None.
Partner	Trading Partner	SuiteBridge.Models.Edi.TradingPartner	None.
Payload	EDI data	SuiteBridge.Models.Edi.EdiPayload	None.

Request Formats

application/json, text/json

Sample:

{
  "AS2Identifier": "sample string 1",
  "Partner": {
    "AS2Identifier": "sample string 1",
    "MDNTo": "sample string 2",
    "TargetUrl": "sample string 3",
    "CompressMessage": true,
    "SignMessage": true,
    "SignatureAlgorithm": "sample string 6",
    "EncryptMessage": true,
    "EncryptionAlgorithm": "sample string 8"
  },
  "Payload": {
    "Name": "sample string 1",
    "Content": "sample string 2",
    "EDIType": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<EdiSenderRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AS2Identifier>sample string 1</AS2Identifier>
  <Partner>
    <AS2Identifier>sample string 1</AS2Identifier>
    <MDNTo>sample string 2</MDNTo>
    <TargetUrl>sample string 3</TargetUrl>
    <CompressMessage>true</CompressMessage>
    <SignMessage>true</SignMessage>
    <SignatureAlgorithm>sample string 6</SignatureAlgorithm>
    <EncryptMessage>true</EncryptMessage>
    <EncryptionAlgorithm>sample string 8</EncryptionAlgorithm>
  </Partner>
  <Payload>
    <Name>sample string 1</Name>
    <Content>sample string 2</Content>
    <EDIType>sample string 3</EDIType>
  </Payload>
</EdiSenderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MDN Receipt

SuiteBridge.Models.Edi.EdiMdnReceiptResponse

Name	Description	Type	Additional information
Content	This contains the entire content of the MDN Receipt.	string	None.
Headers	Headers contains all of the headers of the AS2 MDN Receipt as a single string. This will include headers such as AS2-From, AS2-To, Date, Content-Type, transport headers of the MDN Receipt. etc.	string	None.
Message	The human-readable portion of the MDN receipt.	string	None.
MDN	MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. It will report either success or failure depending on the processing status of the receiver. In either case, it will be RFC-compliant.	string	None.
Id	The Id of the message.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Content": "sample string 1",
  "Headers": "sample string 2",
  "Message": "sample string 3",
  "MDN": "sample string 4",
  "Id": "sample string 5"
}

application/xml, text/xml

Sample:

<EdiMdnReceiptResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Content>sample string 1</Content>
  <Headers>sample string 2</Headers>
  <Message>sample string 3</Message>
  <MDN>sample string 4</MDN>
  <Id>sample string 5</Id>
</EdiMdnReceiptResponse>