Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
basicRoleid globally unique identifier Required

Guid ID of the basic role for which to update the dialog.

dialogid globally unique identifier Required

Guid ID of the dialog to be updated.

Body Parameters (BasicRoleDialog)

This object takes all the parameters needed to update a basic role dialog.

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
BasicRoleID globally unique identifier Required

ID of the given basic role.

DialogID globally unique identifier Required

ID of the given dialog.

Description string Required

Description of the given dialog.

BasicRoleName string ReadOnly

Name of the given basic role.

BasicRoleRank integer ReadOnly

Rank of the given basic role.

DialogDate date ReadOnly

Date and time of the given dialog.

Request Formats

application/xml, text/xml

Sample
<BasicRoleDialog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <BasicRoleID>ab11fa48-e5c5-4d4e-b884-dcfbc71ef5d7</BasicRoleID>
  <DialogID>5d66f0aa-5a48-4ac9-98fe-12d8a69cbe42</DialogID>
  <Description>sample string 1</Description>
</BasicRoleDialog>

application/json, text/json

Sample
{
  "BasicRoleID": "ab11fa48-e5c5-4d4e-b884-dcfbc71ef5d7",
  "DialogID": "5d66f0aa-5a48-4ac9-98fe-12d8a69cbe42",
  "Description": "sample string 1"
}

Response Information

Resource Description (BasicRoleDialog)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
BasicRoleID globally unique identifier Required

ID of the given basic role.

DialogID globally unique identifier Required

ID of the given dialog.

Description string Required

Description of the given dialog.

BasicRoleName string ReadOnly

Name of the given basic role.

BasicRoleRank integer ReadOnly

Rank of the given basic role.

DialogDate date ReadOnly

Date and time of the given dialog.

Response Formats

application/xml, text/xml

Sample
<BasicRoleDialog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <BasicRoleID>6e6f0f9f-3f3d-40e0-a759-cb50e834ca55</BasicRoleID>
  <DialogID>e266dd61-4fc9-4822-98ad-332d2cee2be3</DialogID>
  <Description>sample string 1</Description>
  <BasicRoleName>sample string 2</BasicRoleName>
  <BasicRoleRank>1</BasicRoleRank>
  <DialogDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2021-11-03T18:45:25.2901488Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DialogDate>
</BasicRoleDialog>

application/json, text/json

Sample
{
  "BasicRoleID": "6e6f0f9f-3f3d-40e0-a759-cb50e834ca55",
  "DialogID": "e266dd61-4fc9-4822-98ad-332d2cee2be3",
  "Description": "sample string 1",
  "BasicRoleName": "sample string 2",
  "BasicRoleRank": 1,
  "DialogDate": "2021-11-03T18:45:25.2901488+00:00"
}