Lista Empresa e Segmentos Associados – GET

Filtros


Atalhos para busca

Objetivo

A finalidade deste método é possibilitar listar as empresas e os segmentos associados as mesmas.

Chamada

GET api/v1/sm/company-segment?COMPANY_NUMBER=
{COMPANY_NUMBER}&LAST_UPDATE_DATE=
{LAST_UPDATE_DATE}&PRICING_SEGMENT=
{PRICING_SEGMENT}&SEGMENT_NUMBER=
{SEGMENT_NUMBER}&STATUS=
{STATUS}&_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)
company_number Company Number – Optional integer Não há.
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 relationship between commercial agent and his associated customer – Acronyms: A (Active), I (Inactive) – Optional string Não há.
_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)

CompanySegmentResponseDTO – List of Company and his Associated Segments

Collection of CompanySegmentResponseDTO

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
company_number Number Company integer Não há.
division_number Number Division integer Não há.
last_update_date Date Time of last register update date Não há.
main_segment Indicates Main Segment string Não há.
segment_description Short description of Segment string Não há.
segment_number Number Segment integer Não há.
status Status of relationship between company and his associated segment – Acronyms: A (Active), I (Inactive) string Não há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "company_number": 1,
    "division_number": 1,
    "last_update_date": "2019-11-07T17:23:23.9875918-03:00",
    "main_segment": "sample string 1",
    "segment_description": "sample string 2",
    "segment_number": 1,
    "status": "sample string 3"
  },
  {
    "company_number": 1,
    "division_number": 1,
    "last_update_date": "2019-11-07T17:23:23.9875918-03:00",
    "main_segment": "sample string 1",
    "segment_description": "sample string 2",
    "segment_number": 1,
    "status": "sample string 3"
  }
]
application/xml, text/xml 

Exemplo (Sample):

<ArrayOfCompanySegmentResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Common">
  <CompanySegmentResponseDTO>
    <COMPANY_NUMBER>1</COMPANY_NUMBER>
    <DIVISION_NUMBER>1</DIVISION_NUMBER>
    <LAST_UPDATE_DATE>2019-11-07T17:23:23.9875918-03:00</LAST_UPDATE_DATE>
    <MAIN_SEGMENT>sample string 1</MAIN_SEGMENT>
    <SEGMENT_DESCRIPTION>sample string 2</SEGMENT_DESCRIPTION>
    <SEGMENT_NUMBER>1</SEGMENT_NUMBER>
    <STATUS>sample string 3</STATUS>
  </CompanySegmentResponseDTO>
  <CompanySegmentResponseDTO>
    <COMPANY_NUMBER>1</COMPANY_NUMBER>
    <DIVISION_NUMBER>1</DIVISION_NUMBER>
    <LAST_UPDATE_DATE>2019-11-07T17:23:23.9875918-03:00</LAST_UPDATE_DATE>
    <MAIN_SEGMENT>sample string 1</MAIN_SEGMENT>
    <SEGMENT_DESCRIPTION>sample string 2</SEGMENT_DESCRIPTION>
    <SEGMENT_NUMBER>1</SEGMENT_NUMBER>
    <STATUS>sample string 3</STATUS>
  </CompanySegmentResponseDTO>
</ArrayOfCompanySegmentResponseDTO>

 

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