Consulta Lista de Segmentos – GET

Filtros


Atalhos para busca

Objetivo

A finalidade deste método é listar os segmentos cadastrados na empresa.

Chamada

GET api/v1/sm/segment?LAST_UPDATE_DATE={LAST_UPDATE_DATE}&PRICING_SEGMENT={PRICING_SEGMENT}&SEGMENT_NUMBER={SEGMENT_NUMBER}&STATUS={STATUS}&USES_SFA={USES_SFA}&_pageNo={_pageNo}&_pageSize={_pageSize}

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

Parâmetros URI (URI Parameters)

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
last_update_date Date Time of Last Update – Formats: dd/mm/yyyy hh:mm or ddmmyyyyhhmm – Optional string Não há.
is_pricing_segment List only Pricing Segments (‘S’ – Yes, ‘N’ – No) (Default = ‘N’ – NO) string Tamanho da String: inclusive between 0 and 1
segment_number Segment Number – Optional integer Não há.
status Status of segment – Acronyms: A (Active), I (Inactive) – Optional string Não há.
uses_SFA Uses Sales Force Automation (‘S’ – Yes, ‘N’ – No) string String length: inclusive between 0 and 1
_pageNo integer Não há.
_pageSize integer 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)
  • NotFound (404)
  • BadRequest (400)
  • Unauthorized (401)
  • InternalServerError (500)

Descrição do Recurso (Resource Description)

SegmentResponseDTO – List of segment

Collection of SegmentResponseDTO

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
last_update_date Date Time of last update date date Não há.
segment_number Segment Number integer Não há.
segment_description Short description of Segment string Não há.
status Segment Status string Não há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "last_update_date": "2019-11-12T13:50:20.4302889-03:00",
    "segment_number": 1,
    "segment_description": "sample string 1",
    "status": "sample string 2"
  },
  {
    "last_update_date": "2019-11-12T13:50:20.4302889-03:00",
    "segment_number": 1,
    "segment_description": "sample string 1",
    "status": "sample string 2"
  }
]
application/xml, text/xml 

Exemplo (Sample):

<ArrayOfSegmentResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Common">
  <SegmentResponseDTO>
    <LAST_UPDATE_DATE>2019-11-12T13:50:20.4302889-03:00</LAST_UPDATE_DATE>
    <SEGMENT_DESCRIPTION>sample string 1</SEGMENT_DESCRIPTION>
    <SEGMENT_NUMBER>1</SEGMENT_NUMBER>
    <STATUS>sample string 2</STATUS>
  </SegmentResponseDTO>
  <SegmentResponseDTO>
    <LAST_UPDATE_DATE>2019-11-12T13:50:20.4302889-03:00</LAST_UPDATE_DATE>
    <SEGMENT_DESCRIPTION>sample string 1</SEGMENT_DESCRIPTION>
    <SEGMENT_NUMBER>1</SEGMENT_NUMBER>
    <STATUS>sample string 2</STATUS>
  </SegmentResponseDTO>
</ArrayOfSegmentResponseDTO>

 

Este artigo foi útil para você?
Sim
Não
Confirmar que o artigo não foi útil