POST api/v1/groups
Endpoint to insert a new group.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Select | Collection of string |
None. |
|
| OrderBy | Collection of TupleOfStringAndOrderDirection |
None. |
|
| Top | integer |
None. |
|
| Skip | integer |
None. |
|
| PageSize | integer |
None. |
|
| Page | integer |
None. |
|
| SearchText | string |
None. |
|
| Expand | Dictionary of string [key] and MooQueryOptions [value] |
None. |
|
| SearchParameters | Dictionary of string [key] and string [value] |
None. |
Body Parameters
The information about the new group to insert
Group| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
Required |
|
| FunctionName | string |
None. |
|
| Status | GroupStatus |
None. |
|
| SchoolYear | integer |
None. |
|
| Type | GroupType |
Required |
|
| OrganisationKey | globally unique identifier |
Required |
|
| Users | Collection of User |
None. |
|
| AccountPngPicture | string |
None. |
|
| AccountPngPictureUrl | string |
None. |
|
| ActiveDirectoryId | string |
None. |
|
| ResourceLockStatus |
Indicates whether the resource is locked for editing (e.g. by Basispoort). |
ResourceLockStatus |
None. |
| ResourceLockOwnerName |
Holds the name of the owner of the resource lock in case the ResourceLockStatus is Locked. |
string |
None. |
| IsLocked |
This property is only added for backwards compatibility, but will be removed before release. |
boolean |
None. |
| SystemRoleType | GroupSystemRoleIdentificationMarkType |
None. |
|
| InsertDate | date |
None. |
|
| ModifiedDate | date |
None. |
|
| AdImportSid | string |
None. |
|
| GroupLoginAdImportSid | string |
None. |
|
| GroupTemplateKey | globally unique identifier |
None. |
|
| ActionLinks | Collection of Link |
None. |
|
| Key | globally unique identifier |
None. |
Response Information
Resource Description
Created Group.
Group| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
Required |
|
| FunctionName | string |
None. |
|
| Status | GroupStatus |
None. |
|
| SchoolYear | integer |
None. |
|
| Type | GroupType |
Required |
|
| OrganisationKey | globally unique identifier |
Required |
|
| Users | Collection of User |
None. |
|
| AccountPngPicture | string |
None. |
|
| AccountPngPictureUrl | string |
None. |
|
| ActiveDirectoryId | string |
None. |
|
| ResourceLockStatus |
Indicates whether the resource is locked for editing (e.g. by Basispoort). |
ResourceLockStatus |
None. |
| ResourceLockOwnerName |
Holds the name of the owner of the resource lock in case the ResourceLockStatus is Locked. |
string |
None. |
| IsLocked |
This property is only added for backwards compatibility, but will be removed before release. |
boolean |
None. |
| SystemRoleType | GroupSystemRoleIdentificationMarkType |
None. |
|
| InsertDate | date |
None. |
|
| ModifiedDate | date |
None. |
|
| AdImportSid | string |
None. |
|
| GroupLoginAdImportSid | string |
None. |
|
| GroupTemplateKey | globally unique identifier |
None. |
|
| ActionLinks | Collection of Link |
None. |
|
| Key | globally unique identifier |
None. |