POST api/tasks/complete

Request Information

URI Parameters

None.

Body Parameters

CompleteTaskRequest
NameDescriptionTypeAdditional information
TaskID

integer

None.

CompleteJobOnLiveDate

boolean

None.

SuppressSupplierEmail

boolean

None.

UserTypeId

integer

None.

UserID

integer

None.

ClientID

integer

None.

AllocatedUserID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "TaskID": 1,
  "CompleteJobOnLiveDate": true,
  "SuppressSupplierEmail": true,
  "UserTypeId": 4,
  "UserID": 5,
  "ClientID": 6,
  "AllocatedUserID": 7
}

application/xml, text/xml

Sample:
<CompleteTaskRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PricingWebAPI.Models">
  <AllocatedUserID>7</AllocatedUserID>
  <ClientID>6</ClientID>
  <CompleteJobOnLiveDate>true</CompleteJobOnLiveDate>
  <SuppressSupplierEmail>true</SuppressSupplierEmail>
  <TaskID>1</TaskID>
  <UserID>5</UserID>
  <UserTypeId>4</UserTypeId>
</CompleteTaskRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PricingWebAPI.Models">
  <Message>sample string 2</Message>
  <Success>true</Success>
</ApiResponse>