GET api/userGroups/userGroup/getAllGroupAditionalDetailsFields
Return user group additional details tags.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of AdditionalDetailField| Name | Description | Type | Additional information |
|---|---|---|---|
| FieldId |
Field ID |
integer |
None. |
| FieldDataType |
Field data type |
AdditionalDetailFieldDataType |
None. |
| FieldName |
Field Name |
string |
None. |
| FieldType |
Tag Type. |
string |
None. |
| CanUserEdit |
Can user edit their own data in this field (For example, a learner should not able to edit/change their enrolment number) |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"FieldId": 1,
"FieldDataType": 1,
"FieldName": "sample string 2",
"FieldType": "sample string 3",
"CanUserEdit": true
},
{
"FieldId": 1,
"FieldDataType": 1,
"FieldName": "sample string 2",
"FieldType": "sample string 3",
"CanUserEdit": true
}
]
application/xml, text/xml
Sample:
<ArrayOfAdditionalDetailField xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AdditionalDetailField>
<FieldId>1</FieldId>
<FieldDataType>Text</FieldDataType>
<FieldName>sample string 2</FieldName>
<FieldType>sample string 3</FieldType>
<CanUserEdit>true</CanUserEdit>
</AdditionalDetailField>
<AdditionalDetailField>
<FieldId>1</FieldId>
<FieldDataType>Text</FieldDataType>
<FieldName>sample string 2</FieldName>
<FieldType>sample string 3</FieldType>
<CanUserEdit>true</CanUserEdit>
</AdditionalDetailField>
</ArrayOfAdditionalDetailField>
