POST api/userGroup/add
Request Information
URI Parameters
None.
Body Parameters
CreateUserGroupRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Type | UserGroupType |
None. |
|
| Name | string |
None. |
|
| ParentGroupId | globally unique identifier |
None. |
|
| Level | string |
None. |
|
| ClassSymbol | string |
None. |
|
| GroupId | string |
None. |
|
| InstitutionNumber | string |
None. |
|
| ZipCode | string |
None. |
|
| City | string |
None. |
|
| Address | string |
None. |
|
| string |
None. |
||
| TypeId | string |
None. |
|
| TypeName | string |
None. |
|
| PhysicalCommuneNumber | string |
None. |
|
| PhysicalCommuneName | string |
None. |
|
| AdministrativeCommuneNumber | string |
None. |
|
| AdministrativeCommuneName | string |
None. |
|
| HasWs17Agreement | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Type": 0,
"Name": "sample string 1",
"ParentGroupId": "0bd39056-2426-42ca-a66d-03dc65249291",
"Level": "sample string 2",
"ClassSymbol": "sample string 3",
"GroupId": "sample string 4",
"InstitutionNumber": "sample string 5",
"ZipCode": "sample string 6",
"City": "sample string 7",
"Address": "sample string 8",
"Email": "sample string 9",
"TypeId": "sample string 10",
"TypeName": "sample string 11",
"PhysicalCommuneNumber": "sample string 12",
"PhysicalCommuneName": "sample string 13",
"AdministrativeCommuneNumber": "sample string 14",
"AdministrativeCommuneName": "sample string 15",
"HasWs17Agreement": true
}
application/xml, text/xml
Sample:
<CreateUserGroupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests.UserGroups"> <Address>sample string 8</Address> <AdministrativeCommuneName>sample string 15</AdministrativeCommuneName> <AdministrativeCommuneNumber>sample string 14</AdministrativeCommuneNumber> <City>sample string 7</City> <ClassSymbol>sample string 3</ClassSymbol> <Email>sample string 9</Email> <GroupId>sample string 4</GroupId> <HasWs17Agreement>true</HasWs17Agreement> <InstitutionNumber>sample string 5</InstitutionNumber> <Level>sample string 2</Level> <Name>sample string 1</Name> <ParentGroupId>0bd39056-2426-42ca-a66d-03dc65249291</ParentGroupId> <PhysicalCommuneName>sample string 13</PhysicalCommuneName> <PhysicalCommuneNumber>sample string 12</PhysicalCommuneNumber> <Type>Default</Type> <TypeId>sample string 10</TypeId> <TypeName>sample string 11</TypeName> <ZipCode>sample string 6</ZipCode> </CreateUserGroupRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ValidationResult| Name | Description | Type | Additional information |
|---|---|---|---|
| IsValid | boolean |
None. |
|
| Errors | Collection of ValidationFailure |
None. |
Response Formats
application/json, text/json
Sample:
{
"errors": []
}
application/xml, text/xml
Sample:
<ValidationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FluentValidation.Results"> <errors /> </ValidationResult>