Consulta de Agentes Comerciais – GET

Filtros


Atalhos para busca

Objetivo

A finalidade deste método é, possibilitar a consulta de agentes comerciais.

Chamada

GET api/v1/sm/commercial-agent?COMMERCIAL_AGENT_NUMBER=
{COMMERCIAL_AGENT_NUMBER}&LAST_UPDATE_DATE=
{LAST_UPDATE_DATE}&ONLY_REGISTRED_EMAILS=
{ONLY_REGISTRED_EMAILS}&STATUS=
{STATUS}&TYPE_COMMERCIAL_AGENT=
{TYPE_COMMERCIAL_AGENT}&_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)
commercial_agent_number Representative number of Commercial Agent – 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á.
only_registred_emails Indicates whether to filter only registred emails Acronyms: S (Yes), N (No) – Default ‘N’ – Optional string Tamanho da String: inclusive between 0 and 1
status Status of commercial agent – Acronyms: A (Active), I (Inactive) – Optional string Não há.
type_commercial_agent Type of Commercial Agent – Can be a list, separated by commas. Eg.: A,S – A = Self Employed – E = Company – F = Employee – G = Manager – R = Commercial Representative – S = Supervisor – T = Telesales – X = Auxiliary – 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)

CommercialAgentResponseDTO – List of Commercial Agent

Collection of CommercialAgentResponseDTO

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
commercial_agent_status Commercial Agent Status – A = Active/Not Blocked – I = Inactive/Blocked string Não há.
current_balance Current Balance of your Checking Account decimal number Não há.
current_credit_limit Current Value of Credit Limit decimal number Não há.
email E-mail string Tamanho da String: inclusive between 0 and 50
indicates_use_current_account Indicates if Commercial Agent Uses the Concept of Current Account string Não há.
last_update_date Last Update Date date Não há.
maximum_percentage_increase Maximum Percentage of Increase decimal number Não há.
minimum_value_sale_order Minimum Value of Sale per Order decimal number Não há.
name Name of Commercial Agent string Tamanho da String: inclusive between 0 and 40
nickname Nickname of Commercial Agent string Tamanho da String: inclusive between 0 and 15
number_commercial_agent Representative Number of Commercial Agent integer Não há.
number_segment Distribution Code integer Não há.
number_supervisor Supervisor Code integer Não há.
supervisor_name Name Supervisor string Não há.
percentage_commission_sales Percentage of Commission on Sales decimal number Não há.
phone_number_main Main Phone Number string Não há.
phone_number_secondary Secondary Phone Number string Não há.
reg_number Registration Number CPF if type_person = ‘F’ CNPJ if type_person = ‘J’ string Tamanho da String: inclusive between 0 and 14
seq_sale_region Sequence of Sales Region decimal number Não há.
type_commercial_agent Type of Commercial Agent – A = Self Employed – E = Company – F = Employee – G = Manager – R = Commercial Representative – S = Supervisor – T = Telesales – X = Auxiliary string Não há.
type_person Type of Person from Commercial- J (Legal Entity) or F (Physical Person) string Tamanho da String: inclusive between 0 and 1

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "commercial_agent_status": "sample string 8",
    "current_balance": 1.1,
    "current_credit_limit": 1.1,
    "email": "sample string 9",
    "indicates_use_current_account": "sample string 10",
    "last_update_date": "2019-11-07T15:06:07.7734379-03:00",
    "maximum_percentage_increase": 1.1,
    "minimum_value_sale_order": 1.1,
    "name": "sample string 11",
    "nickname": "sample string 12",
    "number_commercial_agent": 13,
    "number_segment": 14,
    "number_supervisor": 15,
    "supervisor_name": "sample string 16",
    "percentage_commission_sales": 1.1,
    "phone_number_main": "sample string 17",
    "phone_number_secondary": "sample string 18",
    "reg_number": "sample string 19",
    "seq_sale_region": 1.0,
    "type_commercial_agent": "sample string 20",
    "type_person": "sample string 21"
  },
  {
    "commercial_agent_status": "sample string 8",
    "current_balance": 1.1,
    "current_credit_limit": 1.1,
    "email": "sample string 9",
    "indicates_use_current_account": "sample string 10",
    "last_update_date": "2019-11-07T15:06:07.7734379-03:00",
    "maximum_percentage_increase": 1.1,
    "minimum_value_sale_order": 1.1,
    "name": "sample string 11",
    "nickname": "sample string 12",
    "number_commercial_agent": 13,
    "number_segment": 14,
    "number_supervisor": 15,
    "supervisor_name": "sample string 16",
    "percentage_commission_sales": 1.1,
    "phone_number_main": "sample string 17",
    "phone_number_secondary": "sample string 18",
    "reg_number": "sample string 19",
    "seq_sale_region": 1.0,
    "type_commercial_agent": "sample string 20",
    "type_person": "sample string 21"
  }
]

application/xml, text/xml

Exemplo (Sample):

<ArrayOfCommercialAgentResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
 xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Common">
  <CommercialAgentResponseDTO>
    <COMMERCIAL_AGENT_STATUS>sample string 8</COMMERCIAL_AGENT_STATUS>
    <COUNT>1</COUNT>
    <CURRENT_BALANCE>1.1</CURRENT_BALANCE>
    <CURRENT_CREDIT_LIMIT>1.1</CURRENT_CREDIT_LIMIT>
    <EMAIL>sample string 9</EMAIL>
    <INDICATES_USE_CURRENT_ACCOUNT>sample string 10</INDICATES_USE_CURRENT_ACCOUNT>
    <LAST_UPDATE_DATE>2019-11-07T15:06:07.7734379-03:00</LAST_UPDATE_DATE>
    <MAXIMUM_PERCENTAGE_INCREASE>1.1</MAXIMUM_PERCENTAGE_INCREASE>
    <MINIMUM_VALUE_SALE_ORDER>1.1</MINIMUM_VALUE_SALE_ORDER>
    <NAME>sample string 11</NAME>
    <NAME_SUPERVISOR>sample string 16</NAME_SUPERVISOR>
    <NICKNAME>sample string 12</NICKNAME>
    <NUMBER_COMMERCIAL_AGENT>13</NUMBER_COMMERCIAL_AGENT>
    <NUMBER_SEGMENT>14</NUMBER_SEGMENT>
    <NUMBER_SUPERVISOR>15</NUMBER_SUPERVISOR>
    <PERCENTAGE_COMMISSION_SALES>1.1</PERCENTAGE_COMMISSION_SALES>
    <PHONE_AREA_CODE_1>sample string 2</PHONE_AREA_CODE_1>
    <PHONE_AREA_CODE_2>sample string 3</PHONE_AREA_CODE_2>
    <PHONE_COMPLEMENT_1>sample string 4</PHONE_COMPLEMENT_1>
    <PHONE_COMPLEMENT_2>sample string 5</PHONE_COMPLEMENT_2>
    <PHONE_MAIN>sample string 17</PHONE_MAIN>
    <PHONE_NUMBER_1>sample string 6</PHONE_NUMBER_1>
    <PHONE_NUMBER_2>sample string 7</PHONE_NUMBER_2>
    <PHONE_SECONDARY>sample string 18</PHONE_SECONDARY>
    <REG_NUMBER>1</REG_NUMBER>
    <REG_NUMBER_COMPLETE>sample string 19</REG_NUMBER_COMPLETE>
    <REG_NUMBER_DIGIT>1</REG_NUMBER_DIGIT>
    <SEQ_SALE_REGION>1</SEQ_SALE_REGION>
    <TYPE_COMMERCIAL_AGENT>sample string 20</TYPE_COMMERCIAL_AGENT>
    <TYPE_COMMERCIAL_AGENT_PERSON>sample string 21</TYPE_COMMERCIAL_AGENT_PERSON>
  </CommercialAgentResponseDTO>
  <CommercialAgentResponseDTO>
    <COMMERCIAL_AGENT_STATUS>sample string 8</COMMERCIAL_AGENT_STATUS>
    <COUNT>1</COUNT>
    <CURRENT_BALANCE>1.1</CURRENT_BALANCE>
    <CURRENT_CREDIT_LIMIT>1.1</CURRENT_CREDIT_LIMIT>
    <EMAIL>sample string 9</EMAIL>
    <INDICATES_USE_CURRENT_ACCOUNT>sample string 10</INDICATES_USE_CURRENT_ACCOUNT>
    <LAST_UPDATE_DATE>2019-11-07T15:06:07.7734379-03:00</LAST_UPDATE_DATE>
    <MAXIMUM_PERCENTAGE_INCREASE>1.1</MAXIMUM_PERCENTAGE_INCREASE>
    <MINIMUM_VALUE_SALE_ORDER>1.1</MINIMUM_VALUE_SALE_ORDER>
    <NAME>sample string 11</NAME>
    <NAME_SUPERVISOR>sample string 16</NAME_SUPERVISOR>
    <NICKNAME>sample string 12</NICKNAME>
    <NUMBER_COMMERCIAL_AGENT>13</NUMBER_COMMERCIAL_AGENT>
    <NUMBER_SEGMENT>14</NUMBER_SEGMENT>
    <NUMBER_SUPERVISOR>15</NUMBER_SUPERVISOR>
    <PERCENTAGE_COMMISSION_SALES>1.1</PERCENTAGE_COMMISSION_SALES>
    <PHONE_AREA_CODE_1>sample string 2</PHONE_AREA_CODE_1>
    <PHONE_AREA_CODE_2>sample string 3</PHONE_AREA_CODE_2>
    <PHONE_COMPLEMENT_1>sample string 4</PHONE_COMPLEMENT_1>
    <PHONE_COMPLEMENT_2>sample string 5</PHONE_COMPLEMENT_2>
    <PHONE_MAIN>sample string 17</PHONE_MAIN>
    <PHONE_NUMBER_1>sample string 6</PHONE_NUMBER_1>
    <PHONE_NUMBER_2>sample string 7</PHONE_NUMBER_2>
    <PHONE_SECONDARY>sample string 18</PHONE_SECONDARY>
    <REG_NUMBER>1</REG_NUMBER>
    <REG_NUMBER_COMPLETE>sample string 19</REG_NUMBER_COMPLETE>
    <REG_NUMBER_DIGIT>1</REG_NUMBER_DIGIT>
    <SEQ_SALE_REGION>1</SEQ_SALE_REGION>
    <TYPE_COMMERCIAL_AGENT>sample string 20</TYPE_COMMERCIAL_AGENT>
    <TYPE_COMMERCIAL_AGENT_PERSON>sample string 21</TYPE_COMMERCIAL_AGENT_PERSON>
  </CommercialAgentResponseDTO>
</ArrayOfCommercialAgentResponseDTO>

 

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