--- title: API's - Enterprise Service Platform slug: developer/apis-enterprise-service-platform description: This document provides a comprehensive overview of the REST communication structure between applications and the backend server. It covers the login process, accessible contracts, denied reasons, and solicitation statuses. The document also outlines vario createdAt: 2021-10-20T03:16:06.000Z --- Esta seção destina-se a descrever a estrutura de comunicação REST, estabelecida entre aplicativos e o servidor de back-end. :::hint{type="warning"} ⚠️**Atenção****!** **4biz\_URL****:** prefixo de URL inalterável, para que você possa acessar os serviços disponibilizados para os aplicativos móveis. Todo API que necessita um "**sessionID**" precisará estar em uma sessão forneceida pelo "Login" da API. ::: *** ### Login Login do usuário para usar os Serviços **4biz****:** :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/login ``` Solicitação ```json Solicitação { "userName": "mobile", "password": "123456", "token": "API132654ASFE32132121­5412", "platform": "android" } ``` ::: :::CodeblockTabs Resposta ```json Response { "sessionID": "2355A68BF75281B73607EEC1A7191645", "rangeAction": 10, "locationInterval": 10 } ``` Campos ```none Solicitação: userName: alfanumérico não vazio e nem nulo; password: alfanumérico não vazio e nem nulo; token: alfanumérico não vazio e nem nulo, refere-se ao identificador do dispositivo para enviar a notificação push; platform: refere-se ao tipo de plataforma (ios ou android) do qual o usuário efetuará login; Resposta: sessionID: não pode ser nulo nem vazio. rangeAction: é inteiro, não nulo e não pode ser zero. Representa o raio de ação de um usuário de campo em KM. locationInterval: é inteiro, não nulo e maior que zero. Representa, em minutos, o intervalo de tempo que o aplicativo deve enviar o posicionamento do atendente. ``` ::: ### ListContracts Lista dos contratos acessíveis ao atendente. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/contracts ``` Solicitação ```json { "sessionID": "2355A68BF75281B73607EEC1A7191645" } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1412101947000, "operationID": 65, "error": null, "contracts": [ { "id": 1, "description": "Test Name" } ] } ``` Campos ```none Solicitação : sessionID: alfanumérico não nulo e nem vazio; Resposta : dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; contracts: não vazio nem nulo; id: numérico não vazio nem nulo; description: alfanumérico não vazio nem nulo. ``` ::: ### ListDeniedReasons Lista de razões quando recusar uma solicitação, como no check-in: :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/deniedReasons ``` Solicitação ```json { "sessionID": "2355A68BF75281B73607EEC1A7191645" } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1412101988000, "operationID": 666, "error": null, "reasons": [ { "id": 1, "description": "First Suspension Reason" }, { "id": 2, "description": "Second Suspension Reason" } ] } ``` Campos ```none Solicitação : sessionID: alfanumérico não nulo e nem vazio; Resposta : dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; reasons: não vazio nem nulo; id: numérico não vazio nem nulo; description: alfanumérico não vazio nem nulo. ``` ::: ### ListSolicitationStatus Lista os status de uma solicitação a ser usada, por exemplo, no serviço de checkout. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/status ``` Solicitação ```json { "sessionID": "2355A68BF75281B73607EEC1A7191645" } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1412101662000, "operationID": 64, "error": null, "status": [ { "id": 1, "description": "In progress" }, { "id": 2, "description": "Suspended", "justifications": [ { "id": 1, "description": "First Suspension Reason" }, { "id": 2, "description": "Second Suspension Reason" } ] }, { "id": 3, "description": "Canceled" }, { "id": 4, "description": "Solved", "justifications": [ { "id": 1, "description": "Reconfigured database user", "parentId": null }, { "id": 2, "description": "Any other solution here", "parentId": 1 } ] } ] } ``` Campos ```none Solicitação : sessionID: alfanumérico não vazio nem nulo; Resposta : dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; status: não vazio nem nulo; id: numérico não vazio nem nulo; description: alfanumérico não vazio nem nulo; ``` ::: ### ListUnits Lista as unidades de um contrato: :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/units ``` Solicitação ```json { "sessionID": "2355A68BF75281B73607EEC1A7191645" "contractID": 1233 } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1412101988000, "operationID": 66, "error": null, "units": [ { "id": 1, "description": "Default" }, { "id": 2, "description": "Unit Test" } ] } ``` Campos ```none Solicitação: sessionID: alfanumérico não vazio nem nulo; contractID: numérico não nulo. Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; units: não vazio nem nulo; id: numérico não vazio nem nulo; description: alfanumérico não vazio nem nulo; ``` ::: ### SendCoordinates Atualiza as coordenadas geográficas de uma unidade. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/coordinates ``` Solicitação ```json { "unitID": 222, "sessionID": "2355A68BF75281B73607EEC1A7191645", "latitude": -19.369852147, "longitude": -49.369852147 } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1412102841000, "operationID": 68, "error": null, "success": true } ``` Campos ```none Solicitação: unitID: numérico não nulo; sessionID: alfanumérico não vazio nem nulo; latitude: numérico não nulo; longitude: numérico não nulo; Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; success: boolean; ``` ::: ### DeviceDisassociate Desassociar um usuário de um dispositivo para que, quando um usuário excluir uma conexão, o usuário não receba mais a notificação push da conexão excluída. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/coordinates ``` Solicitação ```json { "unitID": 222, "sessionID": "2355A68BF75281B73607EEC1A7191645", "latitude": -19.369852147, "longitude": -49.369852147 } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1412102841000, "operationID": 68, "error": null, "success": true } ``` Campos ```none Solicitação: unitID: numérico não nulo; sessionID: alfanumérico não vazio nem nulo; latitude: numérico não nulo; longitude: numérico não nulo; Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; success: boolean; ``` ::: ### GetNewest Recupera a solicitação mais recente para o usuário no grupo, a partir da última (newestNumber) no aplicativo. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/getNewest ``` Solicitação ```json { "notificationType": 0, "onlyApproval": 1, "newestNumber": 322, "sessionID": "2355A68BF75281B73607EEC1A7191645" } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1377618318000, "operationID": 336, "error": null, "notifications": [ { "number": 95933, "taskId": 22737, "type": 1, "date": "27/08/2013", "timeFlag": 12345, "timeSLA": 12, "latitude": 32.9984730, "longitude": 29.9984730, "endSLA": "null", "task": "Validar requisição", "personal": true, "inService": true, "inCkeckin": 0, "typeRequest": 0, "waiting": 1, "service": "SERVICES AND PRODUCTS REQUEST", "contract": 1, "unit": 15, "priorityorder": 1 } ] } ``` Campos ```none Solicitação: notificationType: numérico não nulo; onlyApproval: numérico não nulo; sessionID: alfanumérico não vazio nem nulo; newestNumber: numérico não nulo; Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; notifications: não nulo; number: numérico não nulo; taskId: numérico não nulo; type: numérico não vazio nem nulo; 0 - Tudo 1 - Compras 2 - Viagens 3 - RH 4 - Incidentes 5 - Outros 6 - Esperando data: string de data no formato dd/mm/aaaa; timeFlag: Número que define o período; 0 - Em tempo 1 - Menos que uma hora 2 - Atrasado timeSLA: numérico inteiro não nulo, em minutos; latitude: numérico; longitude: numérico; endSLA: data em alfanumérico no padrão dd/MM/aaaa HH:mm ou MM/dd/aaaa HH:mm, dependendo da localidade, que pode ter valor nulo. task: alfanumérico não vazio nem nulo; personal: boolean que identifica se a solicitação é destinada para o usuário ou se é do grupo; inService: Boolean não nulo que identifica se a solicitação está em atendimento; inCheckin: Flag que identifica se a solicitação está em check Pessoal (true ou false); 0 – Esperando checkin 1 – Em Checkin service: alfanumérico não vazio nem nulo; typeRequest: Flag que identifica o tipo de execução da solicitação 0 - Execução da Solicitação 1 - Aprovação da Solicitação waiting: Flag que define o status da solicitação. 0 - Acompanhando 1 - Execução disponível contract: numérico não nulo; unit: numérico não nulo; priorityorder: valor numérico que pode apresentar valor nulo, número de sequência que identifica se o gerente solicitou o atendimento; ``` ::: ### GetOldest Recupere a solicitação mais recente para o usuário no grupo, do mais antigo. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/getOldest ``` Solicitação ```json { "notificationType": 0, "onlyApproval": 1, "oldestNumber": 322, "sessionID": "2355A68BF75281B73607EEC1A7191645" } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1377618318000, "operationID": 336, "error": null, "notifications": [ { "number": 95933, "taskId": 22737, "type": 1, "date": "27/08/2013", "timeFlag": 12345, "timeSLA": 12, "latitude": 32.9984730, "longitude": 29.9984730, "endSLA": "null", "task": "Validate request", "personal": true, "inService": true, "inCheckin": 1, "typeRequest": 0, "waiting": 1 "service": "SERVICES AND PRODUCTS REQUEST", "contract": 1, "unit": 15, "priorityorder": 1 } ] } ``` Campos ```none Solicitação: notificationType: numérico não nulo; onlyApproval: numérico não nulo; sessionID: alfanumérico não vazio nem nulo; oldestNumber: numérico não nulo; Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; notifications: não nulo; number: numérico não nulo; taskId: numérico não nulo; type: numérico não vazio nem nulo; 0 - Tudo 1 - Compras 2 - Viagens 3 - RH 4 - Incidentes 5 - Outros 6 - Esperando date: data no formato dd/mm/aaaa; timeFlag: Número que define o período; 0 - Em tempo 1 - Menos de uma hora 2 - Atrasado timeSLA: numérico inteiro não nulo, em minutos; latitude: numérico; longitude: numérico; endSLA: data em alfanumérico nos padrões dd/MM/aaaa HH:mm ou MM/dd/aaaa HH:mm, dependendo do locale, que pode ter valor nulo. task: alfanumérico não vazio nem nulo; personal: boolean que identifica se a solicitação está destinada para o usuário ou para o grupo; inService: Boolean não nulo que identifica se a solicitação está em atendimento; inCheckin: Flag que identifica se a solicitação está em checkin Pessoal (true ou false); 0 – Esperando checkin 1 – Em Cleckin service: alfanumérico não vazio nem nulo; typeRequest: Flag que identifica o tipo de execução de uma solicitação 0 - Execução da Solicitação 1 - Aprovação da Solicitação waiting: Flag que define o status da solicitação 0 - Acompanhando 1 - Execução disponível contract: numérico não nulo; unit: numérico não nulo; priorityorder: valor numérico que pode apresentar valor nulo, número de sequência que identifica se o gerente solicitou o serviço; ``` ::: ### GetByCoordinates Recupera a solicitação mais recente para o usuário no grupo, a partir das coordenadas atuais do usuário. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/getByCoordinates ``` Solicitação ```json { "notificationType": 0, "onlyApproval": 1, "latitude": 32.9984730, "longitude": 29.9984730, "sessionID": "2355A68BF75281B73607EEC1A7191645", "pager": { "page": 1, "size": 10 } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1377618318000, "operationID": 336, "error": null, "notifications": [ { "number": 95933, "taskId": 22737, "type": 1, "date": "27/08/2013", "timeFlag": 12345, "timeSLA": 12, "latitude": 32.9984730, "longitude": 29.9984730, "endSLA": "null", "task": "Validate request", "typeRequest": 0, "waiting": 1 "personal": true, "inService": true, "inCheckin": 1, "service": "SERVICES AND PRODUCTS REQUEST", "contract": 1, "unit": 15, "priorityorder": 1 } ], "paging": { "page": 1, "size": 1, "totalElements": 5, "totalPages": 5 } } ``` Campos ```none Solicitação: notificationType: numérico não nulo; onlyApproval: numérico não nulo; latitude: numérico não nulo; longitude: numérico não nulo; sessionID: alfanumérico não vazio nem nulo; pager: informação de paginação: page: número de página a ser consultado, a partir de 1; size: número de elementos a retornar; Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo nem vazio; notifications: não nulo; number: numérico não nulo; taskId: numérico não nulo; type: numérico não vazio nem nulo; 0 - Tudo 1 - Compras 2 - Viagens 3 - RH 4 - Incidentes 5 - Outros 6 - Esperando date: data no formato dd/mm/aaaa; timeFlag: Número que define o período; 0 - Em tempo 1 - Menos de uma hora 2 - Atrasado timeSLA: inteiro numérico não nulo, em minutos; latitude: numérico não nulo; longitude: numérico não nulo; endSLA: date em alfanumérico nos padrões dd/MM/aaaa HH:mm ou MM/dd/aaaa HH:mm, dependendo do locale, que pode ter valor nulo. task: alfanumérico não vazio nem nulo; personal: boolean que identifica se a solicitação foi destinada ao usuário ou para o grupo; inService: Boolean não nulo que identifica se a solicitação está em atendimento; inCheckin: Flag que identifica se a solicitação está em checkin Pessoal (true ou false); 0 – Esperando checkin 1 – Em Cleckin service: alfanumérico não vazio nem nulo; typeRequest: Flag que identifica o tipo de execução de uma solicitação 0 - Execução da Solicitação 1 - Aprovação da Solicitação waiting: Flag que define o status da solicitação. 0 - Acompanhando 1 - Execução disponível contract: numérico não nulo; unit: numérico não nulo; priorityorder: valor numérico que pode apresentar valor nulo, número de sequência que identifica se o gerente solicitou o serviço; paging: informação de paginação 1. page: número da página atual 2. size: tamanho da página retornada 3. totalElements: número de elementos de acordo com a consulta totalPages: número de páginas de acordo com a consulta ``` ::: ### UpdateNotification Recupera as tarefas de um serviço. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/update ``` Solicitação ```json { number": 322, "sessionID": "2355A68BF75281B73607EEC1A7191645" } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1377618318000, "operationID": 336, "error": null, "notifications": [ { "number": 95933, "taskId": 22737, "type": 1, "date": "27/08/2013", "timeFlag": 12345, "timeSLA": 12, "latitude": 32.9984730, "longitude": 29.9984730, "endSLA": "null", "task": "Validate request", "personal": true, "inService": true, "inCheckin": 1, "typeRequest": 0, "waiting": 1 "service: "SERVICES AND PRODUCTS REQUEST", "contract": 1, "unit": 15, "priorityorder": 1 } ] } ``` Campos ```none Solicitação: notificationType: numérico não nulo; onlyApproval: numérico não nulo; sessionID: alfanumérico não vazio nem nulo; oldestNumber: numérico não nulo; Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo nem vazio; notifications: não nulo; number: numérico não nulo; taskId: numérico não nulo; type: numérico não vazio nem nulo; 0 - Tudo 1 - Compras 2 - Viagens 3 - RH 4 - Incidentes 5 - Outros 6 - Esperando date: data no formato dd/mm/aaaa; timeFlag: Número que define o período; 0 - Em tempo 1 - Menos de uma hora 2 - Atrasado timeSLA: inteiro numérico não nulo, em minutos; latitude: numérico não nulo; longitude: numérico não nulo; endSLA: date em alfanumérico nos padrões dd/MM/aaaa HH:mm ou MM/dd/aaaa HH:mm, dependendo do locale, que pode ter valor nulo. task: alfanumérico não vazio nem nulo; personal: Boolean que identifica se a solicitação foi destinada ao usuário ou para o grupo; inService: Boolean não nulo que identifica se a solicitação está em atendimento; inCheckin: Flag que identifica se a solicitação está em checkin Pessoal (true ou false); 0 – Esperando checkin 1 – Em Cleckin service: alfanumérico não vazio nem nulo; typeRequest: Flag que identifica o tipo de execução de uma solicitação 0 - Execução de Solicitação 1 - Aprovação de Solicitação waiting: Flag que define o status da solicitação. 0 - Acompanhando 1 - Execução disponível contract: numérico não nulo; unit: numérico não nulo; priorityorder: valor numérico que pode apresentar valor nulo, número de sequência que identifica se o gerente solicitou o serviço; ``` ::: ### GetById Recupera detalhes de uma solicitação, de acordo com seu identificador :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/getById ``` Solicitação ```json { "taskId": 22737, "sessionID": "2355A68BF75281B73607EEC1A7191645" } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1377618392000, "operationID": 337, "error": null, "notification": { "endSLA": "null", "task": "Validate request", "service": "SERVICES AND PRODUCTS REQUEST", "description": " test", "status": "In progress", "taskStatus": "Available", "timeSLA": 12 } } ``` Campos ```none Solicitação: taskId: numérico não nulo; sessionID: alfanumérico não vazio nem nulo; Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; notification; não vazio nem nulo; endSLA: data em alfanumérico pelos padrões dd/MM/aaaa HH:mm ou MM/dd/aaaa HH:mm, dependendo do locale. task: alfanumérico não vazio nem nulo; service: alfanumérico não vazio nem nulo; description: alfanumérico não vazio nem nulo; status: alfanumérico não vazio nem nulo; taskStatus: alfanumérico não vazio nem nulo; timeSLA: numérico inteiro não nulo, em minutos; ``` ::: ### GetReasons Recuperar os motivos a serem utilizados na aprovação de uma solicitação, de acordo com a solicitação. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/getReasons ``` Solicitação ```json { "taskId": 22737, "sessionID": "2355A68BF75281B73607EEC1A7191645" } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1377618482000, "operationID": 339, "error": null, "amount": 4, "reasons": [ { "id": 1, "desc": "Non-refundable authorization" }, { "id": 4, "desc": "Purchase necessary to the business" }, { "id": 6, "desc": "Purchase need supplied with another solution" }, { "id": 5, "desc": "Value of quotation above the budget of the contract" } ] } ``` Campos ```none Solicitação: taskId: numérico não nulo; sessionID: alfanumérico não vazio nem nulo; Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; amount: numérico não vazio nem nulo; reasons; não vazio nem nulo; id: numérico não vazio nem nulo; desc: alfanumérico não vazio nem nulo; ``` ::: ### AttendRequest Informar o início do atendimento de uma solicitação de serviço. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/attendRequest ``` Solicitação ```json { "number": 89647, "latitude": -19.369852147, "longitude": -49.369852147, "dateTime": 1377618517000, "sessionID": "2355A68BF75281B73607EEC1A7191645" } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1377618517000, "operationID": 341, "error": null, "success": true } ``` Campos ```none Solicitação: number: numérico não nulo; latitude: numérico não nulo; longitude: numérico não nulo; dateTime: timestamp não vazio nem nulo; sessionID: alfanumérico não vazio nem nulo; Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; success: Boolean que identifica a conclusão bem sucedida da operação; ``` ::: ### AttendantLocation Informa a localização automática da posição do atendente. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/location ``` Solicitação ```json { "sessionID": "2355A68BF75281B73607EEC1A7191645", "latitude": -19.369852147, "longitude": -49.369852147, "dateTime": 1412102841000 } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1412102841000, "operationID": 68, "error": null, "success": true } ``` Campos ```none N/A ``` ::: ### Feedback Registra uma aprovação ou negação de uma solicitação de serviço. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/feedback ``` Solicitação ```json { "taskId": 22736, "feedback": 0, "reasonId": 1, "comments": "Comments", "sessionID": "2355A68BF75281B73607EEC1A7191645 } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1377618517000, "operationID": 341, "error": null } ``` Campos ```none Solicitação: taskId: numérico não nulo; feedback: numérico não nulo; 0 - rejeição da solicitação; 1 - aprovação da solicitação; reasonId: numérico não nulo; comments: alfanumérico não vazio nem nulo; sessionID: alfanumérico não vazio nem nulo; Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; ``` ::: ### New Cria uma nova solicitação. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/new ``` Solicitação ```json { "description": "Teste mobile", "sessionID": "2355A68BF75281B73607EEC1A7191645", "latitude": -19.369852147, "longitude": -49.369852147 } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1377618543000, "operationID": 342, "error": null, "number": 95935 } ``` Campos ```none Solicitação: description: alfanumérico não vazio nem nulo; sessionID: alfanumérico não vazio nem nulo; latitude: numérico não nulo; longitude: numérico não nulo; Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; number: alfanumérico não vazio nem nulo; ``` ::: ### Check-In Check-in do atendente em uma solicitação. Em outras palavras, inicia o cumprimento da solicitação. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/checkin ``` Solicitação ```json { "taskId": 22778, "sessionID": "2355A68BF75281B73607EEC1A7191645", "latitude": -19.369852147, "longitude": -49.369852147, "startTime": 1377618543000 } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1377618543000, "operationID": 342, "error": null, "number": 95935 } ``` Campos ```none Solicitação: taskId:numérico não nulo; sessionID: alfanumérico não vazio nem nulo; latitude: numérico não nulo; longitude: numérico não nulo; startTime: timestamp não vazio nem nulo do tempo que o atendente solicita o "Check-in" Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; number: alfanumérico não vazio nem nulo; ``` ::: ### Check-Out Verifica um atendente em uma solicitação, atualizando seu status ("Suspenso", "Resolvido", etc.). :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/checkout ``` Solicitação ```json { "taskId": 22778, "sessionID": "2355A68BF75281B73607EEC1A7191645", "latitude": -19.369852147, "longitude": -49.369852147, "status": 5, "solution": 5, "descSolution": "Descrição da Solução" } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1377618517000, "operationID": 342, "error": null, "number": 95935 } ``` Campos ```none Solicitação: taskId: numérico não nulo; sessionID: alfanumérico não vazio nem nulo; latitude: numérico não nulo; longitude: numérico não nulo; status: numérico não nulo, de acordo com o retorno do serviço "ListNotivicationStatus" solution: numérico, informado apenas quando o status for “Solucionado (4)” or “Suspenso (2)” descSolution: alfanumérico, não vazio nem nulo, informado apenas quando o status for “Solucionado (4)” or “Suspenso (2)” Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; number: alfanumérico não vazio nem nulo; ``` ::: ### Check-InDenied Registrar a negação de uma solicitação de atendimento pelo atendente, nos casos de recusa ao check-in. :::CodeblockTabs Método ```Text POST ``` URL ```html <4biz_URL>/services/v2/denied ``` Solicitação ```json { "taskId": 22778, "sessionID": "2355A68BF75281B73607EEC1A7191645", "latitude": -19.369852147, "longitude": -49.369852147, "dateTime": 1377618543000, "reasonId": 1377618543000 } ``` ::: :::CodeblockTabs Resposta ```json { "dateTime": 1377618543000, "operationID": 342, "error": null } ``` Campos ```none Solicitação: taskId: numérico não nulo; sessionID: alfanumérico não vazio nem nulo; latitude: numérico não nulo; longitude: numérico não nulo; reasonId: numérico e não nulo. Obtido através do chamado de serviço "GetDeniedReasons"; Resposta: dateTime: timestamp não vazio nem nulo; operationID: numérico não vazio nem nulo; error: valor alfanumérico que pode ser nulo mas não pode ser vazio; number: alfanumérico não vazio nem nulo; ``` :::