Consulta de Operadores - GET

Objetivo

Método que disponibiliza informações de Operadores de PDV cadastrados.

Chamada

GET api/v1/sm/tickets/cash-operator?
COMPANY_REG_NUMBER=
{COMPANY_REG_NUMBER}&OPERATOR_NAME=
{OPERATOR_NAME}&OPERATOR_REG_NUMBER=
{OPERATOR_REG_NUMBER}&LAST_UPDATE_DATE_TIME=
{LAST_UPDATE_DATE_TIME}&_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_reg_number	Company Register Number – (CNPJ) Brazilian Registry of Corporate Taxpayers Format: 00.000.000/0001-00 or 00000000000000 – Required	string	Required
operator_name	Operator Name – Optional	string	String length: inclusive between 0 and 100
operator_reg_number	Operator Register Number – (CPF) – Optional Individual Taxpayers Format: 000.000.000-00 or 00000000000 –	string	None.
last_update_date_time	Update Date – Format: dd/mm/aaaa hh:mm ou ddmmaaaa hhmm – (Optional)	string	None.
_pageNo		integer	None.
_pageSize		integer	None.

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)

CashOperatorsResponseDTO – List of Cashiers

Collection of CashOperatorsResponseDTO

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
birth_date	Operator’s Birth Date	date	None.
company_number	Company Number	integer	None.
company_reg_number	Company Register Number (CNPJ) – Brazilian Registry of Corporate Taxpayers	string	None.
function_code	Operator’s Function Code Acronym: I = Computing, G = Manager, O = Operator, S = Supervisor, V = Salesman	string	None.
function_description	Description of the Operator’s Function	string	None.
gender	Gender – Acronym: M – Male, F – Female	string	None.
date_include	Date of Inclusion	date	None.
operator_name	Operator’s Name	string	None.
reg_number_operator	Operator Register Number (CPF) – Individual Taxpayers	string	None.
operator_sequence	Operator’s Sequence	integer	None.
status	Operator’s Status	string	None.
date_update	Last Update Date	date	None.
user_code	User’s Code	string	None.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "birth_date": "2020-04-27T10:05:49.7620702-03:00",
    "company_number": 1,
    "company_reg_number": "sample string 2",
    "function_code": "sample string 3",
    "function_description": "sample string 4",
    "gender": "sample string 5",
    "date_include": "2020-04-27T10:05:49.7620702-03:00",
    "operator_name": "sample string 6",
    "reg_number_operator": "sample string 7",
    "operator_sequence": 8,
    "status": "sample string 9",
    "date_update": "2020-04-27T10:05:49.7620702-03:00",
    "user_code": "sample string 10"
  },
  {
    "birth_date": "2020-04-27T10:05:49.7620702-03:00",
    "company_number": 1,
    "company_reg_number": "sample string 2",
    "function_code": "sample string 3",
    "function_description": "sample string 4",
    "gender": "sample string 5",
    "date_include": "2020-04-27T10:05:49.7620702-03:00",
    "operator_name": "sample string 6",
    "reg_number_operator": "sample string 7",
    "operator_sequence": 8,
    "status": "sample string 9",
    "date_update": "2020-04-27T10:05:49.7620702-03:00",
    "user_code": "sample string 10"
  }
]

application/xml, text/xml

Exemplo (Sample):

<ArrayOfCashOperatorsResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Sales">
  <CashOperatorsResponseDTO>
    <BIRTH_DATE>2020-04-27T10:05:49.7620702-03:00</BIRTH_DATE>
    <COMPANY_NUMBER>1</COMPANY_NUMBER>
    <COMPANY_REG_NUMBER>sample string 2</COMPANY_REG_NUMBER>
    <FUNCTION_CODE>sample string 3</FUNCTION_CODE>
    <FUNCTION_DESCRIPTION>sample string 4</FUNCTION_DESCRIPTION>
    <GENDER>sample string 5</GENDER>
    <INCLUDE_DATE>2020-04-27T10:05:49.7620702-03:00</INCLUDE_DATE>
    <OPERATOR_NAME>sample string 6</OPERATOR_NAME>
    <OPERATOR_REG_NUMBER>sample string 7</OPERATOR_REG_NUMBER>
    <OPERATOR_SEQUENCE>8</OPERATOR_SEQUENCE>
    <STATUS>sample string 9</STATUS>
    <UPDATE_DATE>2020-04-27T10:05:49.7620702-03:00</UPDATE_DATE>
    <USER_CODE>sample string 10</USER_CODE>
  </CashOperatorsResponseDTO>
  <CashOperatorsResponseDTO>
    <BIRTH_DATE>2020-04-27T10:05:49.7620702-03:00</BIRTH_DATE>
    <COMPANY_NUMBER>1</COMPANY_NUMBER>
    <COMPANY_REG_NUMBER>sample string 2</COMPANY_REG_NUMBER>
    <FUNCTION_CODE>sample string 3</FUNCTION_CODE>
    <FUNCTION_DESCRIPTION>sample string 4</FUNCTION_DESCRIPTION>
    <GENDER>sample string 5</GENDER>
    <INCLUDE_DATE>2020-04-27T10:05:49.7620702-03:00</INCLUDE_DATE>
    <OPERATOR_NAME>sample string 6</OPERATOR_NAME>
    <OPERATOR_REG_NUMBER>sample string 7</OPERATOR_REG_NUMBER>
    <OPERATOR_SEQUENCE>8</OPERATOR_SEQUENCE>
    <STATUS>sample string 9</STATUS>
    <UPDATE_DATE>2020-04-27T10:05:49.7620702-03:00</UPDATE_DATE>
    <USER_CODE>sample string 10</USER_CODE>
  </CashOperatorsResponseDTO>
</ArrayOfCashOperatorsResponseDTO>

Árvore de páginas

Consulta de Operadores - GET

Objetivo

Chamada

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

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Descrição do Recurso (Resource Description)

Formatos de Resposta (Response Formats)

application/json, text/json

application/xml, text/xml