PATCH api/jobs/{id}/status

Updates the status of a sales order using its sales order number.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The sales order number whose status will be updated.

string

Required

Body Parameters

The JobInfo2 request containing the username performing the update and the requested new job status.

JobInfo2
NameDescriptionTypeAdditional information
SONo

string

None.

SecondKey

string

None.

UserName

string

None.

nStatus

string

None.

Request Formats

application/json

Sample:
Host: webservices.visionsawards.com/proofs/
Authorization: Bearer {access_token}
Accept: application/json

application/json

Sample:
{
  "SONo": "sample string 1",
  "SecondKey": "sample string 2",
  "UserName": "sample string 3",
  "nStatus": "sample string 4"
}

application/json

Sample:
<JobInfo2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Proofs.Models">
  <SONo>sample string 1</SONo>
  <SecondKey>sample string 2</SecondKey>
  <UserName>sample string 3</UserName>
  <nStatus>sample string 4</nStatus>
</JobInfo2>

application/json

Sample:

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

Response Information

Resource Description

Returns the job identifier and a message indicating that the sales order status update was processed. Returns HTTP 500 if an exception occurs during the update.

IHttpActionResult

None.

Response Formats

application/json

Sample: { JobId = MR10020, Notes = Sales Order Status is now updated. }