Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


Índice

...

Objetivos 

Determinar os serviços que serão consumidos aplicativo TOTVS Supervisor Minha Gestão de Postos.


GET /rest/supervisorgs/checkin

Retorna a lista dos apontamentos disponíveis.

Parâmetros aceitos

Os parâmetros serão passados por queryParams e poderão ser utilizados em conjunto. Caso haja mais de um parâmetro enviado, a lógica utilizada dever ser "E".

ParâmetroTipoDescriçãoValor Default
cCodestringFiltra pelo código do atendenteda Agenda-
cInOutstringTipo Marcação 1=Entrada/2=Saída-

e


Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

...

Bloco de código
languagejs
themeRDark
titleresponse.json
collapsetrue
{
   "checkin": [
       {
			"lat": "-23.5083524",
			"long": "-46.6497187",
			"hr": "11:11",
			"obs": ""
			"selfie": “Aqui vem o base64 da imagem”
			"additionalphotos": []
        }
    ],
    "count": 1
}

GET /rest/supervisorgs/appointments

Retorna a lista dos apontaentos na url.

Parâmetros aceitos

Os parâmetros serão passados por queryParams e poderão ser utilizados em conjunto. Caso haja mais de um parâmetro enviado, a lógica utilizada dever ser "E".

ParametroTipoDescriçãoValor Default
cStationstringcódigo da estaçãoCódigo do Local-
cStartstringdata inicioHorário Inicial-
cEndstringdata fimHorário Final-
cMinutesStringDiferença de Minutos entre a agenda e o horário


Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

PropriedadeTipoDescriçãoAdicional
appointments
ArrayArray com os apontamentos.-
appointments[x].code
StringCódigo do atendente.-
appointments[x].attendant

String

Nome do atendente.-
appointments[x].schedule
StringHora do schedule.-
appointments[x].realschedule
StringHora do real schedule-
appointments[x].inout
String
-
appointments[x].desc
String
-
appointments[x].late
String
-
appointments[x].executed
String
-
countNumericTotal de apontamentos.-

...

Bloco de código
languagejs
themeRDark
titleresponse.json
collapsetrue
{
    "appointments": [
        {
			"code": "000000000283",
			"attendant": "MATHEUS LANDO RAIMUNDO",
			"schedule": "08:00",
			"realschedule": "",
			"inout": "1",
			"desc": "Entrada",
			"late": "1",
			"executed": " "
		},
		{
			"code": "000000000283",
			"attendant": "MATHEUS LANDO RAIMUNDO",
			"schedule": "12:00",
			"realschedule": "",
			"desc": "Saída",
			"late": "2",
			"inout": "2",
			"executed": " "
		}
    ],
    "count": 2
}

...


GET /

...

rest/

...

supervisorgs/

...

stations

Retorna a lista das estações disponiveis na urlEnvia requisição para tranferência / baixa e ampliação do ativo.

Parâmetros aceitos

Não são aceitos parâmetros de URL para esta requisição.

Payload

Os parâmetros serão passados por queryParams e poderão ser utilizados em conjunto. Caso haja mais de um parâmetro enviado, a lógica utilizada dever ser "E".

ParametroTipoDescriçãoValor Default
nSituationnumericSituação da estação (1 - Sem Pendencias, 2 - Pendentes, 3 - Todos)3
cStartstringHorario Inicial-
cEndstringHorario Final-
cMinutesstringMinutos-
cClientsstringCliente da estaçao-
cPlacesstringCódigo do Local-
cRegionsstringRegiao da estação-
cSupervisorstringSupervisores      -


Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.O payload que será enviado na requisição conterá as seguintes propriedades:

PropriedadeTipoDescriçãoAdicional
operation
stations
numberIndica qual solicitação está sendo requisitada.

0: Baixa

1: Transferência

2: Ampliação

assetstringCódigo do ativoitemstringItem do ativorequests[].statusstringStatus da solicitação

0: Pendente

1: Finalizada

2: Cancelada

requests[].datedataData da solicitaçãoFormato data Protheus "YYYYMMDD"requests[].reasonstringMotivo (descrição)

Se operation=0 -> Motivo

Se operation=1 -> Detalhes

Se operation=2 -> Observação

requests[].valuenumberValorSó existe se operation for 1requests[].quantitynumberQuantidade que for baixadaSó existe se operation for 0requests[].balancestringSaldo que foi baixadoSó existe se operation for 0requests[].typestringTipo de transferência

0: Física

1: Contábil

Exemplo de retorno da requisição:

- item: Código do item (mostrar sempre junto)  

- status: Status da solicitação (0-Pendente, 1-Finalizada, 2-cancelada)

- date: Data da solicitação, formato data Protheus YYYYMMDD

- reason: Motivo

    Se operation=0 -> Motivo

    Se operation=1 -> Detalhes

    Se operation=2 -> Observação

- value:  (só não existe se operation=1)

- quantity: (só existe se operation=0)

- balances: Tipos de saldo disponíveis no bem (ver GET /assets) (só existe se operation=0)

- type: Tipo de transferência (0-física, 1-contábil) (só existe se for operation=1)

ArrayArray com as estações.-
stations[x].code
StringCódigo da estação.-
stations[x].desc

String

Descrição da estação.-
stations[x].type
StringTipo da estação.-
stations[x].lat
StringLatitude da estação.-
stations[x].long
StringLongitude da estação.-
count
NumericQantidade de estações.


GET rest/SUPERVISORGS/stations?nSituation=3&cStart=&cEnd=&cMinutes=&cClients=&cPlaces=&cRegions


Bloco de código
languagejs
themeRDark
titleresponse.json
collapsetrue
{
    "stations": [
        {
			"code": "00000001",
			"desc": "TOTVS SITE SP",
			"type": "2",
			"lat": "-23.5085024",
			"long": "-46.6527313"
		 }
	],
	"count": 1
}


GET /rest/supervisorgs/clients

Retorna a lista dos clientes disponiveis na url.

Parâmetros aceitos

ParâmetroTipoDescriçãoValor Default
nPageNumericPágina da Consulta-
nPageSizeNumericTamanho da Página (resultset)-
cSearchItemstringString de Busca que pode ser código ou descrição-


Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

PropriedadeTipoDescriçãoAdicional
clients
ArrayArray com os clientes.-
clients[x].code
StringCódigo do cliente.-
clients[x].desc

String

Descrição do cliente-
clients[x].store
StringLoja do cliente.-
clients[x].check
String
-
hasNext
booleanondica se há uma próxima página a ser retornada ou se atingiu a última página disponível

true = Há uma próxima página

false = É a última página disponível

count
NumericQantidade de clientes.


GET rest/SUPERVISORGS/clients


Bloco de código
languagejs
themeRDark
titleresponse.json
collapsetrue
{
    "clients": [
        {
			"code": "001",
			"store": "01",
			"check": "false",
			"desc": "CLIENTE 001"
		},
		{
			"code": "000001",
			"store": "01",
			"check": "false",
			"desc": "CLIENTE PADRAO P/ ORCAMENTO"
		},
		{
			"code": "EX0001",
			"store": "01",
			"check": "false",
			"desc": "CLIENTE EXTERIOR 001"
		}
    ],

    "hasNext": "false",
    "count": 3
}



GET /rest/supervisorgs/regions

Retorna a lista das regioes disponiveis na url.

Parâmetros aceitos

Não são aceitos parâmetros de URL para esta requisição.


Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

PropriedadeTipoDescriçãoAdicional
regions
ArrayArray com as regiões.-
regions[x].code
stringCódigo da região.-
regions[x].desc
stringDescrição da região.-
count
NumericQantidade de clientes.-


GET rest/SUPERVISORGS/clients

Bloco de código
languagejs
themeRDark
titleresponse.json
collapsetrue
{
    "regions": [
        {
			"code": "001",
			"desc": "Norte"
		},
		{
			"code": "002",
			"desc": "Sul"
		},
		{
			"code": "003",
			"desc": "Leste"
		},
		{
			"code": "004",
			"desc": "Oeste"
		},
		{
			"code": "005",
			"desc": "Centro"
		},
		{
			"code": "006",
			"desc": "Centro oeste"
		}
	],
	"count": 5
}



GET /rest/supervisorgs/places

Retorna a lista dos locais disponiveis na url.

Parâmetros aceitos

Não são aceitos parâmetros de URL para esta requisição.

ParâmetroTipoDescriçãoValor Default
nPageNumericPágina da Consulta-
nPageSizeNumericTamanho da Página (resultset)-
cSearchTermstringString de Busca que pode ser código ou descrição-

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

PropriedadeTipoDescriçãoAdicional
regions
ArrayArray com os locais-
regions[x].code
stringCódigo do local.-
regions[x].desc
stringDescrição do local.-
count
NumericQuantidade de locais.-


GET rest/SUPERVISORGS/placesPost /wsatf001/assets/request

Bloco de código
languagejs
themeRDark
titleresponse.json
collapsetrue
{
    "places": [
        {
			"operationcode": 1"00000001",
			"assetdesc": "000001"TOTVS SITE SP"
		},
	"item	{
			"code": "000100000002",
			"typedesc": "0",
    "status" : 0,    
	"reason" : "teste",
	"value" : 100,
	"quantity" : 1,
    "balance": {
		"type": "10",
		"balance_type": "3"}
}

TOTVS MATRIZ - 1000"
		},
		{
			"code": "00000003",
			"desc": "CASA DO GUILHERME"
		},
		{
			"code": "00000004",
			"desc": "IBIRAPUERA"
       }
    ],
    "count": 4
}


POST /rest/supervisorgs/operationalDecision


Envia requisição

Parâmetros aceitos

Não são aceitos parâmetros de URL para esta requisição.


Payload

O payload que será enviado na requisição conterá as seguintes propriedades:

PropriedadeTipoDescriçãoAdicional
cCode
stringcódigo do operador-
cInOutStringTipo da operação 1=Entrada/2=Saída
cobsstringcampo de observação-


Post /rest/SUPERVISORGS/operationalDecision

Bloco de código
languagejs
themeRDark
titleresponse.json
collapsetrue
{
cCode: "000000000283", 
cObs: "teste"


}


GET /rest/supervisorgs/supervisor

Retorna a lista dos supervisores disponiveis na url.

Parâmetros aceitos

Não são aceitos parâmetros de URL para esta requisição.

ParâmetroTipoDescriçãoValor Default
nPageNumericPágina da Consulta-
nPageSizeNumericTamanho da Página (resultset)-
cSearchTermstringString de Busca que pode ser código ou descrição-

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

PropriedadeTipoDescriçãoAdicional
supervisor
ArrayArray com os locais-
supervisor[x].code
stringCódigo do local.-
supervisor[x].desc
stringDescrição do local.-
count
NumericQuantidade de locais.-


GET rest/SUPERVISORGS/supervisor

Bloco de código
languagejs
themeRDark
titleresponse.json
collapsetrue
{
    "supervisor": [
        {
            "code": "D MG  01000023",
            "desc": "FUNCIONARIO A"
        },
        {
            "code": "D MG  01000025",
            "desc": "FUNCIONARIO C"
        },
        {
            "code": "D MG  01000029",
            "desc": "FUNCIONARIO AA"
        },
        {
            "code": "D MG  01000030",
            "desc": "FUNCIONARIO BB"
        }
    ],
    "hasNext": "false"
}