POST api/Announcements

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": "28924556-b44f-4328-be80-3bc27a351aa8",
  "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>28924556-b44f-4328-be80-3bc27a351aa8</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

AnnouncementOutput
NameDescriptionTypeAdditional information
Announcements

Collection of Announcement

None.

Error

ErrorInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "Announcements": [
    {
      "url": "sample string 1",
      "id": "sample string 2",
      "title": "sample string 3",
      "description": "sample string 4",
      "datePosted": "sample string 5"
    },
    {
      "url": "sample string 1",
      "id": "sample string 2",
      "title": "sample string 3",
      "description": "sample string 4",
      "datePosted": "sample string 5"
    }
  ],
  "Error": {
    "ErrorId": 1,
    "ErrorDescription": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<AnnouncementOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmeletteSoft.Models">
  <Announcements>
    <Announcement>
      <datePosted>sample string 5</datePosted>
      <description>sample string 4</description>
      <id>sample string 2</id>
      <title>sample string 3</title>
      <url>sample string 1</url>
    </Announcement>
    <Announcement>
      <datePosted>sample string 5</datePosted>
      <description>sample string 4</description>
      <id>sample string 2</id>
      <title>sample string 3</title>
      <url>sample string 1</url>
    </Announcement>
  </Announcements>
  <Error>
    <ErrorDescription>sample string 2</ErrorDescription>
    <ErrorId>1</ErrorId>
  </Error>
</AnnouncementOutput>