POST MiscComment/PostMiscComment

Create a Misc Comment

Request Information

URI Parameters

Body Parameters

MiscComment object used to create a new Misc Comment

ClsMiscCommentAdd
NameDescriptionTypeAdditional Information
Type

The type of comment. Valid types are Application Comments, Blend Comments, Dispatch Comments, OrFertTagMinProdName, and Tag Warning Comments.

string

Required

Comment

User entered comment or note.

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Type": "sample string 1",
  "Comment": "sample string 2"
}

application/xml, text/xml

Sample:
<MiscCommentAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI">
  <Comment>sample string 2</Comment>
  <Type>sample string 1</Type>
</MiscCommentAdd>

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

Response Information

Resource Description

Create a Misc Comment

AgvMiscComment
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
Count

Count of how many Misc Comments.

string
MiscCommentRecords

JSON dictionary of MiscCommentRecords.

Collection of ClsMiscComment

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "MiscCommentRecords": [
    {
      "UniqueId": "sample string 1",
      "Type": "sample string 2",
      "Comment": "sample string 3"
    },
    {
      "UniqueId": "sample string 1",
      "Type": "sample string 2",
      "Comment": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<AgvMiscComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.MiscComment">
  <Message>sample string 2</Message>
  <MiscCommentRecords xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI">
    <d2p1:MiscComment>
      <d2p1:Comment>sample string 3</d2p1:Comment>
      <d2p1:Type>sample string 2</d2p1:Type>
      <d2p1:UniqueId>sample string 1</d2p1:UniqueId>
    </d2p1:MiscComment>
    <d2p1:MiscComment>
      <d2p1:Comment>sample string 3</d2p1:Comment>
      <d2p1:Type>sample string 2</d2p1:Type>
      <d2p1:UniqueId>sample string 1</d2p1:UniqueId>
    </d2p1:MiscComment>
  </MiscCommentRecords>
  <Status>sample string 1</Status>
</AgvMiscComment>