POST api/OpsLog/UpdateRole/{auth}/{roleid}

Used to update a role for the specified tab

Request Information

URI Parameters

NameDescriptionTypeAdditional information
auth

The authorization GUID for this user session

string

Required

roleid

The role identifier return from the GetRoles or AddRole method(s)

integer

Required

Body Parameters

Parameters for updating role

UpdateRoleParm
NameDescriptionTypeAdditional information
OfficeID

The office identifier associated with the role

integer

None.

IsOpsCoord

Role is operations coordinator

boolean

None.

IsDispatcher

Role is dispatcher

boolean

None.

IsCSR

Role is CSR

boolean

None.

IsCallback

Role is POD callback

boolean

None.

IsNoShow

Role is no show

boolean

None.

IsBilling

Role is billing

boolean

None.

IsShipCoord

Role is shipment coordinator

boolean

None.

IsQualityControl

Role is quality control

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "OfficeID": 1,
  "IsOpsCoord": true,
  "IsDispatcher": true,
  "IsCSR": true,
  "IsCallback": true,
  "IsNoShow": true,
  "IsBilling": true,
  "IsShipCoord": true,
  "IsQualityControl": true
}

application/xml, text/xml

Sample:
<UpdateRoleParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <IsBilling>true</IsBilling>
  <IsCSR>true</IsCSR>
  <IsCallback>true</IsCallback>
  <IsDispatcher>true</IsDispatcher>
  <IsNoShow>true</IsNoShow>
  <IsOpsCoord>true</IsOpsCoord>
  <IsQualityControl>true</IsQualityControl>
  <IsShipCoord>true</IsShipCoord>
  <OfficeID>1</OfficeID>
</UpdateRoleParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

(void)

ResponseBase
NameDescriptionTypeAdditional information
IsSuccessful

Set to true if method was successful

boolean

None.

ErrorMessage

The error message if method call was not successful

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>