Consulta de Agentes Comerciais e Clientes Associados – GET

Filtros


Atalhos para busca

Objetivo

A finalidade deste método é, possibilitar a consulta de agentes comerciais e seus clientes associados.

Chamada

GET api/v1/sm/commercial-agent-customer?LAST_UPDATE_DATE=
{LAST_UPDATE_DATE}&COMMERCIAL_AGENT_SEQUENCE=
{COMMERCIAL_AGENT_SEQUENCE}&CUSTOMER_SEQUENCE=
{CUSTOMER_SEQUENCE}&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)
ast_update_date Date Time of Last Update – Formats: ddmmaaaahhmm or dd/mm/yyyy hh:mm – Optional string Não há.
commercial_agent_sequence Number of Commercial Agent – Optional integer Não há.
customer_sequence Number of Associated Customer of Commercial Agent – Optional integer Não há.
status Status of relationship between commercial agent and his associated customer – Acronyms: A (Active), I (Inactive), E (Deleted) – 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)

CommercialAgentCustomerResponseDTO – List of Commercial Agent and his Asociated Customers

Collection of CommercialAgentCustomerResponseDTO

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
last_update_date Last Update Date date Não há.
commercial_agent_sequence Number of Commercial Agent integer Não há.
customer_sequence Number of Associated Customer of Commercial Agent integer Não há.
status Status of relationship between commercial agent and his associated customer – Acronyms: A (Active), I (Inactive), E (Deleted) string Não há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "last_update_date": "2019-11-07T15:31:25.1653256-03:00",
    "commercial_agent_sequence": 1,
    "customer_sequence": 2,
    "status": "sample string 3"
  },
  {
    "last_update_date": "2019-11-07T15:31:25.1653256-03:00",
    "commercial_agent_sequence": 1,
    "customer_sequence": 2,
    "status": "sample string 3"
  }
]
application/xml, text/xml 

Exemplo (Sample):

<ArrayOfCommercialAgentCustomerResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Common">
  <CommercialAgentCustomerResponseDTO>
    <COMMERCIAL_AGENT_SEQUENCE>1</COMMERCIAL_AGENT_SEQUENCE>
    <CUSTOMER_SEQUENCE>2</CUSTOMER_SEQUENCE>
    <LAST_UPDATE_DATE>2019-11-07T15:31:25.1653256-03:00</LAST_UPDATE_DATE>
    <STATUS>sample string 3</STATUS>
  </CommercialAgentCustomerResponseDTO>
  <CommercialAgentCustomerResponseDTO>
    <COMMERCIAL_AGENT_SEQUENCE>1</COMMERCIAL_AGENT_SEQUENCE>
    <CUSTOMER_SEQUENCE>2</CUSTOMER_SEQUENCE>
    <LAST_UPDATE_DATE>2019-11-07T15:31:25.1653256-03:00</LAST_UPDATE_DATE>
    <STATUS>sample string 3</STATUS>
  </CommercialAgentCustomerResponseDTO>
</ArrayOfCommercialAgentCustomerResponseDTO>

 

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