POST api/v1/admin/group

Request Information

URI Parameters

None.

Requires Authorization!

Roles: admin-users,admin-users-in-manager-group

Body Parameters

GroupEditDto
NameDescriptionTypeAdditional information
Id

integer

None.

IsActive

boolean

None.

Name

string

None.

Branch

integer

None.

TipoAlvo

TipoMatricula

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "IsActive": true,
  "Name": "sample string 3",
  "Branch": 1,
  "TipoAlvo": "Desconhecido"
}

application/xml, text/xml

Sample:
<GroupEditDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lar.SicopPlus.Entities.DTOs">
  <Branch>1</Branch>
  <Id>1</Id>
  <IsActive>true</IsActive>
  <Name>sample string 3</Name>
  <TipoAlvo>Desconhecido</TipoAlvo>
</GroupEditDto>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GroupEditDto'.

Response Information

Resource Description

ResultOfGroupDto
NameDescriptionTypeAdditional information
Data

GroupDto

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "Id": 1,
    "IsActive": true,
    "Name": "sample string 3",
    "Branch": 1,
    "CompanyId": "sample string 4",
    "TipoAlvo": "Desconhecido",
    "Users": [
      {
        "UserId": 1,
        "GroupId": 2,
        "UserDocument": "sample string 3",
        "GroupName": "sample string 4",
        "IsManager": true
      },
      {
        "UserId": 1,
        "GroupId": 2,
        "UserDocument": "sample string 3",
        "GroupName": "sample string 4",
        "IsManager": true
      }
    ],
    "UsersCount": 5,
    "ManagerUsersCount": 6
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ResultOfGroupDtop36I_Swao xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lar.Entities.Ep">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Lar.SicopPlus.Entities.DTOs">
    <d2p1:Branch>1</d2p1:Branch>
    <d2p1:CompanyId>sample string 4</d2p1:CompanyId>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsActive>true</d2p1:IsActive>
    <d2p1:ManagerUsersCount>6</d2p1:ManagerUsersCount>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:TipoAlvo>Desconhecido</d2p1:TipoAlvo>
    <d2p1:Users>
      <d2p1:UserAndGroupDto>
        <d2p1:GroupId>2</d2p1:GroupId>
        <d2p1:GroupName>sample string 4</d2p1:GroupName>
        <d2p1:IsManager>true</d2p1:IsManager>
        <d2p1:UserDocument>sample string 3</d2p1:UserDocument>
        <d2p1:UserId>1</d2p1:UserId>
      </d2p1:UserAndGroupDto>
      <d2p1:UserAndGroupDto>
        <d2p1:GroupId>2</d2p1:GroupId>
        <d2p1:GroupName>sample string 4</d2p1:GroupName>
        <d2p1:IsManager>true</d2p1:IsManager>
        <d2p1:UserDocument>sample string 3</d2p1:UserDocument>
        <d2p1:UserId>1</d2p1:UserId>
      </d2p1:UserAndGroupDto>
    </d2p1:Users>
    <d2p1:UsersCount>5</d2p1:UsersCount>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
</ResultOfGroupDtop36I_Swao>