POST api/ArticleInfo

Request Information

URI Parameters

None.

Body Parameters

InputRequest
NameDescriptionTypeAdditional information
CompanyId

globally unique identifier

None.

Input1

string

None.

Input2

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CompanyId": "19e1b363-2064-49dd-aa94-56d64b530e22",
  "Input1": "sample string 2",
  "Input2": "sample string 3"
}

application/xml, text/xml

Sample:
<InputRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmeletteSoft.Models">
  <CompanyId>19e1b363-2064-49dd-aa94-56d64b530e22</CompanyId>
  <Input1>sample string 2</Input1>
  <Input2>sample string 3</Input2>
</InputRequest>

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

Response Information

Resource Description

ArticleInfoOutput
NameDescriptionTypeAdditional information
ArticleInfo

ArticleInfo

None.

Error

ErrorInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "ArticleInfo": {
    "url": "sample string 1",
    "id": 2,
    "title": "sample string 3",
    "abstract": "sample string 4",
    "authorString": "sample string 5",
    "authors": [
      {
        "firstName": "sample string 1",
        "middleName": "sample string 2",
        "lastName": "sample string 3",
        "affiliation": {
          "en_US": "sample string 1"
        },
        "country": "sample string 4",
        "countryLocalized": "sample string 5",
        "email": "sample string 6",
        "url": "sample string 7",
        "competingInterests": {
          "en_US": "sample string 1"
        },
        "biography": {
          "en_US": "sample string 1"
        },
        "primaryContact": true
      },
      {
        "firstName": "sample string 1",
        "middleName": "sample string 2",
        "lastName": "sample string 3",
        "affiliation": {
          "en_US": "sample string 1"
        },
        "country": "sample string 4",
        "countryLocalized": "sample string 5",
        "email": "sample string 6",
        "url": "sample string 7",
        "competingInterests": {
          "en_US": "sample string 1"
        },
        "biography": {
          "en_US": "sample string 1"
        },
        "primaryContact": true
      }
    ],
    "sectionId": "sample string 6",
    "sectionTitle": "sample string 7",
    "galleys": [
      {
        "id": "sample string 1",
        "label": "sample string 2",
        "url": "sample string 3"
      },
      {
        "id": "sample string 1",
        "label": "sample string 2",
        "url": "sample string 3"
      }
    ],
    "citations": "sample string 8"
  },
  "Error": {
    "ErrorId": 1,
    "ErrorDescription": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<ArticleInfoOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmeletteSoft.Models">
  <ArticleInfo>
    <abstract>sample string 4</abstract>
    <authorString>sample string 5</authorString>
    <authors>
      <Author>
        <affiliation>
          <en_US>sample string 1</en_US>
        </affiliation>
        <biography>
          <en_US>sample string 1</en_US>
        </biography>
        <competingInterests>
          <en_US>sample string 1</en_US>
        </competingInterests>
        <country>sample string 4</country>
        <countryLocalized>sample string 5</countryLocalized>
        <email>sample string 6</email>
        <firstName>sample string 1</firstName>
        <lastName>sample string 3</lastName>
        <middleName>sample string 2</middleName>
        <primaryContact>true</primaryContact>
        <url>sample string 7</url>
      </Author>
      <Author>
        <affiliation>
          <en_US>sample string 1</en_US>
        </affiliation>
        <biography>
          <en_US>sample string 1</en_US>
        </biography>
        <competingInterests>
          <en_US>sample string 1</en_US>
        </competingInterests>
        <country>sample string 4</country>
        <countryLocalized>sample string 5</countryLocalized>
        <email>sample string 6</email>
        <firstName>sample string 1</firstName>
        <lastName>sample string 3</lastName>
        <middleName>sample string 2</middleName>
        <primaryContact>true</primaryContact>
        <url>sample string 7</url>
      </Author>
    </authors>
    <citations>sample string 8</citations>
    <galleys>
      <Galley>
        <id>sample string 1</id>
        <label>sample string 2</label>
        <url>sample string 3</url>
      </Galley>
      <Galley>
        <id>sample string 1</id>
        <label>sample string 2</label>
        <url>sample string 3</url>
      </Galley>
    </galleys>
    <id>2</id>
    <sectionId>sample string 6</sectionId>
    <sectionTitle>sample string 7</sectionTitle>
    <title>sample string 3</title>
    <url>sample string 1</url>
  </ArticleInfo>
  <Error>
    <ErrorDescription>sample string 2</ErrorDescription>
    <ErrorId>1</ErrorId>
  </Error>
</ArticleInfoOutput>