GET api/group/{id}
Get a group by its Id
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 | string |
None. |
|
| Description | string |
None. |
|
| GroupType | EnumDataContract |
None. |
|
| GroupIcon | EnumDataContract |
None. |
|
| SystemStatus | EnumDataContract |
None. |
|
| GroupBackgroundImageUrl | string |
None. |
|
| Notes | string |
None. |
|
| Members | Collection of GroupMemberDataContract |
None. |
|
| PreferredCompanies | Collection of PreferredCompanyDataContract |
None. |
|
| AdditionalQuestions | AdditionalQuestionsDataContract |
None. |
|
| Separated | boolean |
None. |
|
| CustomFields | Collection of CustomFieldGroupWithValuesDataContract |
None. |
|
| CreatedDate | date |
None. |
|
| CreatedBy | CreatedByDataContract |
None. |
|
| Id | integer |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.