PUT api/v{version}/delegategroups/{delegateGroupId}/delegates/{delegateId}

Updates an existing delegate group delegate info.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
delegateId

The delegate's ID

 integer

Required
delegateGroupId

The delegate group's ID

 integer

Required
version

The requested API version

 string

Required

Default value is 2.0

Body Parameters

The delegate group delegate to update

DelegateGroupDelegate
NameDescriptionTypeAdditional information
DelegateGroupId

The ID of the delegate group the delegate is in.

 integer

None.
DelegateId

The delegate's ID.

 integer

None.
Role

The delegate's position relative to the delegate group. For informational purposes.

 string

None.
SecuritySettings

The security permissions for the delegate for the group. If no security permissions have been defined for the delegate, this will fall back to the group security settings that the delegate inherits from.

 DelegateSecurity

None.
CanManageClients

Gets whether the delegate add/remove clients from the group.

 boolean

None.
CanManageDelegates

Gets whether the delegate can add/remove delegates from the group.

 boolean

None.
CanManageLocations

Gets whether the delegate can add/edit locations.

 boolean

None.
InheritGroupSecurity

Gets whether the delegate will have access to all settings the group does, in addition to its own security permissions.

 boolean

None.

Request Formats

application/json, text/json, application/problem+json

Sample: 
{
  "delegateGroupId": 1,
  "delegateId": 2,
  "role": "sample string 3",
  "securitySettings": {
    "canBookSubscriptions": true,
    "canBookTrips": true,
    "canEditProfile": true,
    "canViewProfile": true,
    "canCancelTrips": true,
    "canManagePassengerFeedback": true,
    "canEditCasualTrips": true,
    "canEditSubscriptionTrips": true,
    "canTopUpAccount": true,
    "canViewTransactionHistory": true,
    "canPerformMileageReimbursementTrips": true,
    "canBookMileageReimbursementTrips": true,
    "canBookSubscriptionMileageReimbursementTrips": true
  },
  "canManageClients": true,
  "canManageDelegates": true,
  "canManageLocations": true,
  "inheritGroupSecurity": true
}

application/xml, text/xml

Sample: 
<DelegateGroupDelegate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
  <CanManageClients>true</CanManageClients>
  <CanManageDelegates>true</CanManageDelegates>
  <CanManageLocations>true</CanManageLocations>
  <DelegateGroupId>1</DelegateGroupId>
  <DelegateId>2</DelegateId>
  <InheritGroupSecurity>true</InheritGroupSecurity>
  <Role>sample string 3</Role>
  <SecuritySettings>
    <CanBookMileageReimbursementTrips>true</CanBookMileageReimbursementTrips>
    <CanBookSubscriptionMileageReimbursementTrips>true</CanBookSubscriptionMileageReimbursementTrips>
    <CanBookSubscriptions>true</CanBookSubscriptions>
    <CanBookTrips>true</CanBookTrips>
    <CanCancelTrips>true</CanCancelTrips>
    <CanEditCasualTrips>true</CanEditCasualTrips>
    <CanEditProfile>true</CanEditProfile>
    <CanEditSubscriptionTrips>true</CanEditSubscriptionTrips>
    <CanManagePassengerFeedback>true</CanManagePassengerFeedback>
    <CanPerformMileageReimbursementTrips>true</CanPerformMileageReimbursementTrips>
    <CanTopUpAccount>true</CanTopUpAccount>
    <CanViewProfile>true</CanViewProfile>
    <CanViewTransactionHistory>true</CanViewTransactionHistory>
  </SecuritySettings>
</DelegateGroupDelegate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/problem+json, application/xml, text/xml

Sample:

Sample not available.