GET api/group/{id}

Get a group by its Id

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

Dezrez.Core.DataContracts.External.Api.Group.Query.Get.GroupDataContract
NameDescriptionTypeAdditional information
Name

string

None.

Description

string

None.

GroupType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

GroupIcon

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

SystemStatus

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

GroupBackgroundImageUrl

string

None.

Notes

string

None.

Members

Collection of Dezrez.Core.DataContracts.External.Api.Group.Query.Get.GroupMemberDataContract

None.

PreferredCompanies

Collection of Dezrez.Core.DataContracts.External.Api.Group.Query.Get.PreferredCompanyDataContract

None.

AdditionalQuestions

Dezrez.Core.DataContracts.External.Api.Group.Command.AddGroup.AdditionalQuestionsDataContract

None.

Separated

boolean

None.

CustomFields

Collection of Dezrez.Core.DataContracts.External.Api.Custom.Command.SaveCustomField.CustomFieldGroupWithValuesDataContract

None.

CreatedDate

date

None.

CreatedBy

Dezrez.Core.DataContracts.External.Api.People.Query.Get.CreatedByDataContract

None.

Id

integer

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.