Exibir origem

Objetivo

Método para realizar consulta dos segmentos de um lote das verbas sell out.

Chamada

POST [URLAPI]/VerbaSelloutAPI/api/v1/verbas/lotes/{seqLote}/segmentos

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Comercial Web > Módulo de aplicações web para Verbas > API de Verba Sell-out

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

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

Parâmetros Route (Route Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
SeqLote	Identificador do lote	integer($int64)	Obrigatório

Parâmetros URI (URI Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
NroSegmento	Número do segmento	integer($int32)	Não há.
DescSegmento	Descrição do segmento	string	Não há.
Filter	Campo para filtro vindo do	string	Não há.
Fields	Campos	string	Não há.
Order	Ordenação dos campos	string	Não há.
Page	Número da página	integer($int32)	Não há.
PageSize	Tamanho da página	integer($int32)	Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (200)
BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - OK

{
  "hasNext": true,
  "items": [
    {
      "nroSegmento": 0,
      "descSegmento": "string"
    }
  ]
}

application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}