POST api/receive

Request Information

URI Parameters

None.

Body Parameters

ApiData
NameDescriptionTypeAdditional information
Filename

string

None.

DataBase64

string

None.

AutomaticProcess

boolean

None.

SeriesMapping

Collection of SeriesMapping

None.

Request Formats

application/json, text/json

Sample:
{
  "Filename": "sample string 1",
  "DataBase64": "sample string 2",
  "AutomaticProcess": true,
  "SeriesMapping": [
    {
      "XmlSeries": [
        "sample string 1",
        "sample string 2"
      ],
      "OutputSeries": "sample string 1",
      "MatchesAllXmlSeries": true
    },
    {
      "XmlSeries": [
        "sample string 1",
        "sample string 2"
      ],
      "OutputSeries": "sample string 1",
      "MatchesAllXmlSeries": true
    }
  ]
}

application/xml, text/xml

Sample:
<ApiData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Onq.Models">
  <AutomaticProcess>true</AutomaticProcess>
  <DataBase64>sample string 2</DataBase64>
  <Filename>sample string 1</Filename>
  <SeriesMapping>
    <SeriesMapping>
      <MatchesAllXmlSeries>true</MatchesAllXmlSeries>
      <OutputSeries>sample string 1</OutputSeries>
      <XmlSeries xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </XmlSeries>
    </SeriesMapping>
    <SeriesMapping>
      <MatchesAllXmlSeries>true</MatchesAllXmlSeries>
      <OutputSeries>sample string 1</OutputSeries>
      <XmlSeries xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </XmlSeries>
    </SeriesMapping>
  </SeriesMapping>
</ApiData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Data

Object

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Helpers">
  <Data />
  <Message>sample string 2</Message>
  <Success>true</Success>
</GenericResponse>