POST api/v1/docgenerator/generator/new/character

Gerar Characters

Request Information

URI Parameters

None.

Requires Authorization!

Roles:

Body Parameters

NewCharacterDto
NameDescriptionTypeAdditional information
Personagem

string

None.

Cabecalho

string

None.

Rodape

string

None.

IdCharacter

integer

None.

TipoPersonagem

integer

None.

Personagens

Collection of SicopPlusListaPersonagem

None.

Personagen

Collection of SicopPlusPersonagens

None.

Request Formats

application/json, text/json

Sample:
{
  "Personagem": "sample string 1",
  "Cabecalho": "sample string 2",
  "Rodape": "sample string 3",
  "IdCharacter": 4,
  "TipoPersonagem": 5,
  "Personagens": [
    {
      "Personagem": "sample string 1",
      "Cabecalho": "sample string 2",
      "Rodape": "sample string 3"
    },
    {
      "Personagem": "sample string 1",
      "Cabecalho": "sample string 2",
      "Rodape": "sample string 3"
    }
  ],
  "Personagen": [
    {
      "Id": 1,
      "Nomeautores": "sample string 2",
      "Nome": "sample string 3",
      "Estadocivil": "sample string 4",
      "Cpf": "sample string 5",
      "Rg": "sample string 6",
      "Rgemissao": "sample string 7",
      "Endereco": "sample string 8",
      "Municipio": "sample string 9",
      "Uf": "sample string 10",
      "Regimebens": "sample string 11",
      "Dataemissao": "2025-04-29T11:50:03.8221055-03:00",
      "Matricula": "sample string 13",
      "IdCharacter": 14,
      "TipoPersonagem": 15,
      "Email": "sample string 16"
    },
    {
      "Id": 1,
      "Nomeautores": "sample string 2",
      "Nome": "sample string 3",
      "Estadocivil": "sample string 4",
      "Cpf": "sample string 5",
      "Rg": "sample string 6",
      "Rgemissao": "sample string 7",
      "Endereco": "sample string 8",
      "Municipio": "sample string 9",
      "Uf": "sample string 10",
      "Regimebens": "sample string 11",
      "Dataemissao": "2025-04-29T11:50:03.8221055-03:00",
      "Matricula": "sample string 13",
      "IdCharacter": 14,
      "TipoPersonagem": 15,
      "Email": "sample string 16"
    }
  ]
}

application/xml, text/xml

Sample:
<NewCharacterDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lar.SicopPlus.Entities.DTOs.DocGenerator">
  <Cabecalho>sample string 2</Cabecalho>
  <IdCharacter>4</IdCharacter>
  <Personagem>sample string 1</Personagem>
  <Personagen>
    <SicopPlusPersonagens>
      <Cpf>sample string 5</Cpf>
      <Dataemissao>2025-04-29T11:50:03.8221055-03:00</Dataemissao>
      <Email>sample string 16</Email>
      <Endereco>sample string 8</Endereco>
      <Estadocivil>sample string 4</Estadocivil>
      <Id>1</Id>
      <IdCharacter>14</IdCharacter>
      <Matricula>sample string 13</Matricula>
      <Municipio>sample string 9</Municipio>
      <Nome>sample string 3</Nome>
      <Nomeautores>sample string 2</Nomeautores>
      <Regimebens>sample string 11</Regimebens>
      <Rg>sample string 6</Rg>
      <Rgemissao>sample string 7</Rgemissao>
      <TipoPersonagem>15</TipoPersonagem>
      <Uf>sample string 10</Uf>
    </SicopPlusPersonagens>
    <SicopPlusPersonagens>
      <Cpf>sample string 5</Cpf>
      <Dataemissao>2025-04-29T11:50:03.8221055-03:00</Dataemissao>
      <Email>sample string 16</Email>
      <Endereco>sample string 8</Endereco>
      <Estadocivil>sample string 4</Estadocivil>
      <Id>1</Id>
      <IdCharacter>14</IdCharacter>
      <Matricula>sample string 13</Matricula>
      <Municipio>sample string 9</Municipio>
      <Nome>sample string 3</Nome>
      <Nomeautores>sample string 2</Nomeautores>
      <Regimebens>sample string 11</Regimebens>
      <Rg>sample string 6</Rg>
      <Rgemissao>sample string 7</Rgemissao>
      <TipoPersonagem>15</TipoPersonagem>
      <Uf>sample string 10</Uf>
    </SicopPlusPersonagens>
  </Personagen>
  <Personagens>
    <SicopPlusListaPersonagem>
      <Cabecalho>sample string 2</Cabecalho>
      <Personagem>sample string 1</Personagem>
      <Rodape>sample string 3</Rodape>
    </SicopPlusListaPersonagem>
    <SicopPlusListaPersonagem>
      <Cabecalho>sample string 2</Cabecalho>
      <Personagem>sample string 1</Personagem>
      <Rodape>sample string 3</Rodape>
    </SicopPlusListaPersonagem>
  </Personagens>
  <Rodape>sample string 3</Rodape>
  <TipoPersonagem>5</TipoPersonagem>
</NewCharacterDto>

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 'NewCharacterDto'.

Response Information

Resource Description

ResultOfNewCharacterDto
NameDescriptionTypeAdditional information
Data

NewCharacterDto

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "Personagem": "sample string 1",
    "Cabecalho": "sample string 2",
    "Rodape": "sample string 3",
    "IdCharacter": 4,
    "TipoPersonagem": 5,
    "Personagens": [
      {
        "Personagem": "sample string 1",
        "Cabecalho": "sample string 2",
        "Rodape": "sample string 3"
      },
      {
        "Personagem": "sample string 1",
        "Cabecalho": "sample string 2",
        "Rodape": "sample string 3"
      }
    ],
    "Personagen": [
      {
        "Id": 1,
        "Nomeautores": "sample string 2",
        "Nome": "sample string 3",
        "Estadocivil": "sample string 4",
        "Cpf": "sample string 5",
        "Rg": "sample string 6",
        "Rgemissao": "sample string 7",
        "Endereco": "sample string 8",
        "Municipio": "sample string 9",
        "Uf": "sample string 10",
        "Regimebens": "sample string 11",
        "Dataemissao": "2025-04-29T11:50:03.8221055-03:00",
        "Matricula": "sample string 13",
        "IdCharacter": 14,
        "TipoPersonagem": 15,
        "Email": "sample string 16"
      },
      {
        "Id": 1,
        "Nomeautores": "sample string 2",
        "Nome": "sample string 3",
        "Estadocivil": "sample string 4",
        "Cpf": "sample string 5",
        "Rg": "sample string 6",
        "Rgemissao": "sample string 7",
        "Endereco": "sample string 8",
        "Municipio": "sample string 9",
        "Uf": "sample string 10",
        "Regimebens": "sample string 11",
        "Dataemissao": "2025-04-29T11:50:03.8221055-03:00",
        "Matricula": "sample string 13",
        "IdCharacter": 14,
        "TipoPersonagem": 15,
        "Email": "sample string 16"
      }
    ]
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ResultOfNewCharacterDtoLDG1iB_Pd 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.DocGenerator">
    <d2p1:Cabecalho>sample string 2</d2p1:Cabecalho>
    <d2p1:IdCharacter>4</d2p1:IdCharacter>
    <d2p1:Personagem>sample string 1</d2p1:Personagem>
    <d2p1:Personagen>
      <d2p1:SicopPlusPersonagens>
        <d2p1:Cpf>sample string 5</d2p1:Cpf>
        <d2p1:Dataemissao>2025-04-29T11:50:03.8221055-03:00</d2p1:Dataemissao>
        <d2p1:Email>sample string 16</d2p1:Email>
        <d2p1:Endereco>sample string 8</d2p1:Endereco>
        <d2p1:Estadocivil>sample string 4</d2p1:Estadocivil>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:IdCharacter>14</d2p1:IdCharacter>
        <d2p1:Matricula>sample string 13</d2p1:Matricula>
        <d2p1:Municipio>sample string 9</d2p1:Municipio>
        <d2p1:Nome>sample string 3</d2p1:Nome>
        <d2p1:Nomeautores>sample string 2</d2p1:Nomeautores>
        <d2p1:Regimebens>sample string 11</d2p1:Regimebens>
        <d2p1:Rg>sample string 6</d2p1:Rg>
        <d2p1:Rgemissao>sample string 7</d2p1:Rgemissao>
        <d2p1:TipoPersonagem>15</d2p1:TipoPersonagem>
        <d2p1:Uf>sample string 10</d2p1:Uf>
      </d2p1:SicopPlusPersonagens>
      <d2p1:SicopPlusPersonagens>
        <d2p1:Cpf>sample string 5</d2p1:Cpf>
        <d2p1:Dataemissao>2025-04-29T11:50:03.8221055-03:00</d2p1:Dataemissao>
        <d2p1:Email>sample string 16</d2p1:Email>
        <d2p1:Endereco>sample string 8</d2p1:Endereco>
        <d2p1:Estadocivil>sample string 4</d2p1:Estadocivil>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:IdCharacter>14</d2p1:IdCharacter>
        <d2p1:Matricula>sample string 13</d2p1:Matricula>
        <d2p1:Municipio>sample string 9</d2p1:Municipio>
        <d2p1:Nome>sample string 3</d2p1:Nome>
        <d2p1:Nomeautores>sample string 2</d2p1:Nomeautores>
        <d2p1:Regimebens>sample string 11</d2p1:Regimebens>
        <d2p1:Rg>sample string 6</d2p1:Rg>
        <d2p1:Rgemissao>sample string 7</d2p1:Rgemissao>
        <d2p1:TipoPersonagem>15</d2p1:TipoPersonagem>
        <d2p1:Uf>sample string 10</d2p1:Uf>
      </d2p1:SicopPlusPersonagens>
    </d2p1:Personagen>
    <d2p1:Personagens>
      <d2p1:SicopPlusListaPersonagem>
        <d2p1:Cabecalho>sample string 2</d2p1:Cabecalho>
        <d2p1:Personagem>sample string 1</d2p1:Personagem>
        <d2p1:Rodape>sample string 3</d2p1:Rodape>
      </d2p1:SicopPlusListaPersonagem>
      <d2p1:SicopPlusListaPersonagem>
        <d2p1:Cabecalho>sample string 2</d2p1:Cabecalho>
        <d2p1:Personagem>sample string 1</d2p1:Personagem>
        <d2p1:Rodape>sample string 3</d2p1:Rodape>
      </d2p1:SicopPlusListaPersonagem>
    </d2p1:Personagens>
    <d2p1:Rodape>sample string 3</d2p1:Rodape>
    <d2p1:TipoPersonagem>5</d2p1:TipoPersonagem>
  </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>
</ResultOfNewCharacterDtoLDG1iB_Pd>