GET api/TipoDeDocumento/ObterPeloNome?nome={nome}

Request Information

URI Parameters

Name	Description	Type	Additional information
nome		string	Required

Body Parameters

None.

Response Information

Resource Description

TipoDeEscaneamentoViewModel

Name	Type	Additional information
Nome	string	Required Max length: 200
FrenteEhVerso	boolean	None.
AutoDesvio	boolean	None.
RemoverBordasEscuras	boolean	None.
PretoEhBranco	boolean	None.
RemoverPontosIsolados	boolean	None.
AutoBrilho	boolean	None.
Area	DocumentoAreaViewModel	None.
Brilho	integer	Required Range: inclusive between -1000 and 1000
Contraste	integer	Required Range: inclusive between -1000 and 1000
Resolucao	integer	Required Range: inclusive between 75 and 600
Saturacao	integer	Required Range: inclusive between -100 and 100
Gama	integer	Required Range: inclusive between 0 and 100
TipoDeArquivo	TipoDeArquivo	None.
AnotacaoID	globally unique identifier	None.
Rotacionar	RotateFlipType	Required
GerarOCR	boolean	None.
LerCodigoDeBarras	boolean	None.
AssinaturaDigital	boolean	None.
ConfigurarDerivada	boolean	None.
TamanhoDoPapel	string	None.
ExcluirPaginaEmBranco	boolean	None.
Privado	boolean	None.
NatoDigital	boolean	None.
Modelo	Collection of byte	None.
ModeloAnotacao	Collection of byte	None.
GruposDeAcesso	string	None.
ConfiguracaoDeArmazenamento	DocumentoConfiguracaoDeArmazenamentoViewModel	None.
ConfiguracaoDaDerivada	DocumentoDerivadaViewModel	None.
Indices	Collection of TipoDeEscaneamentoIndiceViewModel	None.
ModelosDePesquisa	Collection of TipoDeEscaneamentoModeloDePesquisaViewModel	None.
ID	globally unique identifier	None.
ValidationResult	ValidationResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Nome": "sample string 1",
  "FrenteEhVerso": true,
  "AutoDesvio": true,
  "RemoverBordasEscuras": true,
  "PretoEhBranco": true,
  "RemoverPontosIsolados": true,
  "AutoBrilho": true,
  "Area": {
    "Esquerda": 1,
    "Topo": 2,
    "Tamanho": 3,
    "Largura": 4
  },
  "Brilho": 8,
  "Contraste": 9,
  "Resolucao": 10,
  "Saturacao": 11,
  "Gama": 12,
  "TipoDeArquivo": 0,
  "AnotacaoID": "ee271612-383c-42da-9d87-80eda96a6ecc",
  "Rotacionar": 0,
  "GerarOCR": true,
  "LerCodigoDeBarras": true,
  "AssinaturaDigital": true,
  "ConfigurarDerivada": true,
  "TamanhoDoPapel": "sample string 18",
  "ExcluirPaginaEmBranco": true,
  "Privado": true,
  "NatoDigital": true,
  "Modelo": "QEA=",
  "ModeloAnotacao": "QEA=",
  "GruposDeAcesso": "sample string 22",
  "ConfiguracaoDeArmazenamento": {
    "TipoDeArmazenamento": 0,
    "CaminhoLocal": "sample string 1",
    "UrlFTP": "sample string 2",
    "UsuarioFTP": "sample string 3",
    "SenhaFTP": "sample string 4",
    "Conexao": "sample string 5"
  },
  "ConfiguracaoDaDerivada": {
    "PretoEhBranco": true,
    "Resolucao": 2,
    "TipoDeArquivo": 0,
    "AssinaturaDigital": true
  },
  "Indices": [
    {
      "ID": "dd01704f-8615-4e39-886a-4fc722769cd4",
      "Nome": "sample string 2",
      "TipoDeControle": 0,
      "Mascara": "sample string 3",
      "Obrigatorio": true,
      "TipoDeValidacao": 0,
      "TamanhoDaColuna": "sample string 5",
      "ColecaoID": "sample string 6",
      "Unico": true,
      "PesquisaContem": true
    },
    {
      "ID": "dd01704f-8615-4e39-886a-4fc722769cd4",
      "Nome": "sample string 2",
      "TipoDeControle": 0,
      "Mascara": "sample string 3",
      "Obrigatorio": true,
      "TipoDeValidacao": 0,
      "TamanhoDaColuna": "sample string 5",
      "ColecaoID": "sample string 6",
      "Unico": true,
      "PesquisaContem": true
    }
  ],
  "ModelosDePesquisa": [
    {
      "DadosModeloDePesquisa": [
        {
          "IndiceID": "6eb91244-ce59-430d-ba5c-7a445052790c",
          "Ordem": 2
        },
        {
          "IndiceID": "6eb91244-ce59-430d-ba5c-7a445052790c",
          "Ordem": 2
        }
      ]
    },
    {
      "DadosModeloDePesquisa": [
        {
          "IndiceID": "6eb91244-ce59-430d-ba5c-7a445052790c",
          "Ordem": 2
        },
        {
          "IndiceID": "6eb91244-ce59-430d-ba5c-7a445052790c",
          "Ordem": 2
        }
      ]
    }
  ],
  "ID": "c8245ea0-f562-4922-bb96-8da71e980782",
  "ValidationResult": {
    "IsOK": true,
    "Erros": [
      "sample string 1",
      "sample string 2"
    ],
    "MessageSuccess": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<TipoDeEscaneamentoViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/rift.doctus.model.ViewModels">
  <ID>c8245ea0-f562-4922-bb96-8da71e980782</ID>
  <ValidationResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/rift.doctus.model">
    <d2p1:Erros xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Erros>
    <d2p1:IsOK>true</d2p1:IsOK>
    <d2p1:MessageSuccess>sample string 2</d2p1:MessageSuccess>
  </ValidationResult>
  <AnotacaoID>ee271612-383c-42da-9d87-80eda96a6ecc</AnotacaoID>
  <Area>
    <Esquerda>1</Esquerda>
    <Largura>4</Largura>
    <Tamanho>3</Tamanho>
    <Topo>2</Topo>
  </Area>
  <AssinaturaDigital>true</AssinaturaDigital>
  <AutoBrilho>true</AutoBrilho>
  <AutoDesvio>true</AutoDesvio>
  <Brilho>8</Brilho>
  <ConfiguracaoDaDerivada>
    <AssinaturaDigital>true</AssinaturaDigital>
    <PretoEhBranco>true</PretoEhBranco>
    <Resolucao>2</Resolucao>
    <TipoDeArquivo>JPEG</TipoDeArquivo>
  </ConfiguracaoDaDerivada>
  <ConfiguracaoDeArmazenamento>
    <CaminhoLocal>sample string 1</CaminhoLocal>
    <Conexao>sample string 5</Conexao>
    <SenhaFTP>sample string 4</SenhaFTP>
    <TipoDeArmazenamento>Local</TipoDeArmazenamento>
    <UrlFTP>sample string 2</UrlFTP>
    <UsuarioFTP>sample string 3</UsuarioFTP>
  </ConfiguracaoDeArmazenamento>
  <ConfigurarDerivada>true</ConfigurarDerivada>
  <Contraste>9</Contraste>
  <ExcluirPaginaEmBranco>true</ExcluirPaginaEmBranco>
  <FrenteEhVerso>true</FrenteEhVerso>
  <Gama>12</Gama>
  <GerarOCR>true</GerarOCR>
  <GruposDeAcesso>sample string 22</GruposDeAcesso>
  <Indices>
    <TipoDeEscaneamentoIndiceViewModel>
      <ColecaoID>sample string 6</ColecaoID>
      <ID>dd01704f-8615-4e39-886a-4fc722769cd4</ID>
      <Mascara>sample string 3</Mascara>
      <Nome>sample string 2</Nome>
      <Obrigatorio>true</Obrigatorio>
      <PesquisaContem>true</PesquisaContem>
      <TamanhoDaColuna>sample string 5</TamanhoDaColuna>
      <TipoDeControle>TEXTO</TipoDeControle>
      <TipoDeValidacao>Nenhum</TipoDeValidacao>
      <Unico>true</Unico>
    </TipoDeEscaneamentoIndiceViewModel>
    <TipoDeEscaneamentoIndiceViewModel>
      <ColecaoID>sample string 6</ColecaoID>
      <ID>dd01704f-8615-4e39-886a-4fc722769cd4</ID>
      <Mascara>sample string 3</Mascara>
      <Nome>sample string 2</Nome>
      <Obrigatorio>true</Obrigatorio>
      <PesquisaContem>true</PesquisaContem>
      <TamanhoDaColuna>sample string 5</TamanhoDaColuna>
      <TipoDeControle>TEXTO</TipoDeControle>
      <TipoDeValidacao>Nenhum</TipoDeValidacao>
      <Unico>true</Unico>
    </TipoDeEscaneamentoIndiceViewModel>
  </Indices>
  <LerCodigoDeBarras>true</LerCodigoDeBarras>
  <Modelo>QEA=</Modelo>
  <ModeloAnotacao>QEA=</ModeloAnotacao>
  <ModelosDePesquisa>
    <TipoDeEscaneamentoModeloDePesquisaViewModel>
      <DadosModeloDePesquisa>
        <DadosModeloDePesquisaViewModel>
          <IndiceID>6eb91244-ce59-430d-ba5c-7a445052790c</IndiceID>
          <Ordem>2</Ordem>
        </DadosModeloDePesquisaViewModel>
        <DadosModeloDePesquisaViewModel>
          <IndiceID>6eb91244-ce59-430d-ba5c-7a445052790c</IndiceID>
          <Ordem>2</Ordem>
        </DadosModeloDePesquisaViewModel>
      </DadosModeloDePesquisa>
    </TipoDeEscaneamentoModeloDePesquisaViewModel>
    <TipoDeEscaneamentoModeloDePesquisaViewModel>
      <DadosModeloDePesquisa>
        <DadosModeloDePesquisaViewModel>
          <IndiceID>6eb91244-ce59-430d-ba5c-7a445052790c</IndiceID>
          <Ordem>2</Ordem>
        </DadosModeloDePesquisaViewModel>
        <DadosModeloDePesquisaViewModel>
          <IndiceID>6eb91244-ce59-430d-ba5c-7a445052790c</IndiceID>
          <Ordem>2</Ordem>
        </DadosModeloDePesquisaViewModel>
      </DadosModeloDePesquisa>
    </TipoDeEscaneamentoModeloDePesquisaViewModel>
  </ModelosDePesquisa>
  <NatoDigital>true</NatoDigital>
  <Nome>sample string 1</Nome>
  <PretoEhBranco>true</PretoEhBranco>
  <Privado>true</Privado>
  <RemoverBordasEscuras>true</RemoverBordasEscuras>
  <RemoverPontosIsolados>true</RemoverPontosIsolados>
  <Resolucao>10</Resolucao>
  <Rotacionar>RotateNoneFlipNone</Rotacionar>
  <Saturacao>11</Saturacao>
  <TamanhoDoPapel>sample string 18</TamanhoDoPapel>
  <TipoDeArquivo>JPEG</TipoDeArquivo>
</TipoDeEscaneamentoViewModel>