PATCH api/company/{id}/agentdetails

This method updates selected details of a specified agent

Error messages
  • 409/Conflict - Company must be an agent - The ID of the company specified is not one that is associated with agent company.
  • 409/NotFound - Error retrieving Company with id - Company not found with specified ID
  • 401/Unauthorised - Access Denied - User does not have required permissions

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id The company ID integer

Required

Body Parameters

AgentDetailsModify
NameDescriptionTypeAdditional information
CommissionPayOn What the Agent is paid commission on integer

None.
CommissionRate The rate of commission decimal number

None.
CommissionPlan The ID of the commission plan assigned to this agent integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "CommissionPayOn": 1,
  "CommissionRate": 1.1,
  "CommissionPlan": 1
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.