Back

GET basicroles/{basicRoleid}/dialogs/{dialogid}

Read basic role dialogs by basic role ID. Add dialog ID to return a single basic role dialog that matches both IDs.

Request Information

URI Parameters

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

Guid ID of the basic role for which to read dialogs.
dialogid globally unique identifier

Optional ID: returns a single basic role dialog.

Body Parameters

None.

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>3db88318-c4a4-49ee-8f3b-30bdec4ec640</BasicRoleID>
  <DialogID>188753d3-87bf-498c-aff1-c5a5f93534f4</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>2025-04-18T21:15:19.5099005Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DialogDate>
</BasicRoleDialog>

application/json, text/json

Sample
{
  "BasicRoleID": "3db88318-c4a4-49ee-8f3b-30bdec4ec640",
  "DialogID": "188753d3-87bf-498c-aff1-c5a5f93534f4",
  "Description": "sample string 1",
  "BasicRoleName": "sample string 2",
  "BasicRoleRank": 1,
  "DialogDate": "2025-04-18T21:15:19.5099005+00:00"
}