GET api/group/{id}
Get a group by its Id Processes this group API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The id of the group to get. Pass 0 to be returned a GroupSave empty data contract. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The group or null if it does not exist
GroupDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
The name value. |
string |
None. |
| Description |
The description value. |
string |
None. |
| GroupType |
The group type value. |
EnumDataContract |
None. |
| GroupIcon |
The group icon value. |
EnumDataContract |
None. |
| SystemStatus |
The system status value. |
EnumDataContract |
None. |
| GroupBackgroundImageUrl |
The group background image url value. |
string |
None. |
| Notes |
The notes value. |
string |
None. |
| Members |
The collection of members. |
Collection of GroupMemberDataContract |
None. |
| PreferredCompanies |
The collection of preferred companies. |
Collection of PreferredCompanyDataContract |
None. |
| AdditionalQuestions |
The additional questions value. |
AdditionalQuestionsDataContract |
None. |
| Separated |
Indicates whether separated is true. |
boolean |
None. |
| CustomFields |
The collection of custom fields. |
Collection of CustomFieldGroupWithValuesDataContract |
None. |
| CreatedDate |
The created date, expressed as a date and time. |
date |
None. |
| CreatedBy |
The created by value. |
CreatedByDataContract |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.