POST api/jobs/{id}/notes

Adds a new note to the specified sales order. This endpoint can be used to record proof approvals, revision requests, follow-up actions, deadlines, and other audit-related information.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The sales order number to which the note will be added.	string	Required

Body Parameters

The SONotesUpdate request containing the note details, including origin number, index type, account system, note content, user, and note type.

SONotesUpdate

Name	Type	Additional information
sono	string	None.
acctsys	string	None.
originno	string	None.
indextype	string	None.
newnote	string	None.
user	string	None.
notetype	string	None.

Request Formats

application/json

Sample:

POST /api/jobs/{id}/notes HTTP/1.1
Host: webservices.visionsawards.com/proofs/
Authorization: Bearer {access_token}
Accept: application/json

application/json

Sample:

{
  "sono": "sample string 1",
  "acctsys": "sample string 2",
  "originno": "sample string 3",
  "indextype": "sample string 4",
  "newnote": "sample string 5",
  "user": "sample string 6",
  "notetype": "sample string 7"
}

application/json

Sample:

<SONotesUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Proofs.Models">
  <acctsys>sample string 2</acctsys>
  <indextype>sample string 4</indextype>
  <newnote>sample string 5</newnote>
  <notetype>sample string 7</notetype>
  <originno>sample string 3</originno>
  <sono>sample string 1</sono>
  <user>sample string 6</user>
</SONotesUpdate>

application/json

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SONotesUpdate'.

Response Information

Resource Description

Returns HTTP 201 Created when the note is successfully submitted to the database. Returns HTTP 400 if the request body is missing or fails model validation. Returns HTTP 500 if a SQL database error occurs.

IHttpActionResult

None.

Response Formats

application/json

Sample: { message = Sales Order Notes is successfully added., SONo = {id} }