Árvore de páginas

Objetivo

A finalidade deste método é inserir cenários de Perfis de Origem e de Destinação.

Chamada

POST [URLAPI]/SMIntTributAPI/api/v1/integracao-tributaria/perfil

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nenhum.

Parâmetros do Corpo (Body Parameters)

Collection of POSTPerfilRequestDTO

NomeDescriçãoTipoInformações Adicionais
TipoPerfilTipo do Perfil – Acrônimos: D = Perfil de Destino – O = Perfil de OrigemstringRequired


String length: inclusive between 0 and 1

IndicadorNúmero indicador do cenáriointegerRequired
DescricaoDescrição do cenáriostringRequired


Max length: 1000

Formatos da Requisição (Request Formats)

application/json, text/json

[
  {
    "TipoPerfil": "sample string 1",
    "Indicador": 2,
    "Descricao": "sample string 3"
  },
  {
    "TipoPerfil": "sample string 1",
    "Indicador": 2,
    "Descricao": "sample string 3"
  }
]

application/xml, text/xml

Exemplo (Sample):

<ArrayOfPOSTPerfilRequestDTO xmlns:i=”http://www.w3.org/2001/XMLSchema-instance” xmlns=”http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Perfil”>
<POSTPerfilRequestDTO>
<Descricao xmlns=”http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Common”>sample string 3</Descricao>
<Indicador xmlns=”http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Common”>2</Indicador>
<TipoPerfil>sample string 1</TipoPerfil>
</POSTPerfilRequestDTO>
<POSTPerfilRequestDTO>
<Descricao xmlns=”http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Common”>sample string 3</Descricao>
<Indicador xmlns=”http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Common”>2</Indicador>
<TipoPerfil>sample string 1</TipoPerfil>
</POSTPerfilRequestDTO>
</ArrayOfPOSTPerfilRequestDTO>

application/x-www-form-urlencoded

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Descrição dos Dados

Status Code 201 – Created

IntegracaoTributariaResponseDTO

NomeDescriçãoTipoInformações Adicionais
CallbackURLEndpoint para consulta do item manipuladostringNone.

Formatos de Resposta (Response Formats)

application/json, text/json

{
  "CallbackURL": "sample string 1"
}

application/xml, text/xml

<IntegracaoTributariaResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMIntegracaoTributaria.Common.Entities.Dto.Entities.v1.Common">
  <CallbackURL>sample string 1</CallbackURL>
</IntegracaoTributariaResponseDTO>