Actions Atendimento

Open-att-categories

Função que retorna a lista de CATEGORIAS do módulo de Atendimento da plataforma mobileX.

Parâmetro	Descrição
parameters -> querystring:	Vazio: Retorna todas as categorias “raiz” cadastradas para o espaço virtual: CategoryId: Id da categoria

Exemplo para todas as categorias:

{
    "order": 0,
    "name": "open-att-categories",
    "permissionLevel": 2,
    "publishLevel": 1,
    "title": "",
    "icon": "",
    "parameters": null
}

Exemplo para listagem a partir de uma categoria superior:

{
    "order": 0,
    "name": "open-att-categories",
    "permissionLevel": 2,
    "publishLevel": 1,
    "title": "",
    "icon": "",
    "parameters": [
            {"title":"querystring","value":"?parentId=xxx"}
    ]
}

A lista resultante já virá com ação de clique padrão, podendo ser:

• Se a categoria possuir filhas, a ação padrão será abrir a lista de categorias filhas .

• Senão, abre a lista de serviços

Open-att-services

Função que retorna a lista de SERVIÇOS de uma categoria do módulo de Atendimento da plataforma mobileX.

Parâmetros	Descrição
parameters -> querystring	CategoryId: Id da categoria Add: Indica se, ao clicar no serviço, qual o tipo de ação a ser executada Se add=true: a ação padrão será adicionar uma nova solicitação de atendimento para o serviço. Se add=false: abre a lista de solicitações realizadas para o serviço pelo usuário logado.

Exemplo para todas as categorias:

{
    "order": 0,
    "name": "open-att-services",
    "permissionLevel": 2,
    "publishLevel": 1,
    "title": "",
    "icon": "",
    "parameters": [
            {"title":"querystring","value":"?categoryId=dcc9736e...&add=false"}
    ]
}

A lista resultante virá com ação de clique de acordo com a variável “add” informada na querystring:

• Se add=true, a ação padrão será adicionar uma nova solicitação de atendimento para o serviço.

• Se add=false, abre a lista de solicitações realizadas para o serviço pelo usuário logado

Open-att-send-message

Função que permite o usuário, a partir de um atendimento, enviar uma mensagem para o atendente do atendimento em questão

Essa action geralmente não é configurada manualmente, pois as mensagens enviadas e recebidas estão associadas a um atendimento. Sendo assim, é normal que a mensagem seja enviada a partir do detalhe de um atendimento, que é um template fixo retornado pelo backend.

Parâmetros	Descrição
parameters	attendanceId: Id do atendimento ao qual a mensagem deve ser associada.

Exemplo para enviar uma mensagem:

{
    "order": 0,
    "name": "open-att-send-message",
    "permissionLevel": 2,
    "publishLevel": 1,
    "title": "Enviar Mensagem",
    "icon": "E974",
    "parameters": [
            {"title":"attendanceId","value":"33b924a5-ff10-4d0e-93ee-2fc7afe6c6c8"}
    ]
}

Open-att-attendances

Função que retorna a lista de SOLICITAÇÕES realizadas pelo usuário logado, a partir de uma categoria ou serviço do módulo de Atendimento da plataforma mobileX.

Parâmetros	Descrição
parameters -> querystring	CategoryId: Se informado, retorna as solicitações do usuário para todos os serviços cadastrados para a categoria indicada. ServiceId: Se informado, retorna as solicitações do usuário para todos o serviço indicado. Add: Indica se a opção de adicionar atendimento estará disponível na tela. Se add=true, a opção de adicionar solicitação é exibida. Se add=false, a opção permanece oculta.

Exemplo:

{
    "order": 0,
    "name": "open-att-attendances",
    "permissionLevel": 2,
    "publishLevel": 1,
    "title": "",
    "icon": "",
    "parameters": [
            {"title":"querystring","value":"?categoryId=xxx&add=false/true"}   OU
            {"title":"querystring","value":"?serviceId=xxxx&add=false/true"}
    ]
}

Open-att-attendance-view

Função que retorna o Detalhamento de uma Solicitação registrada no módulo de Atendimento da plataforma mobileX.

O detalhamento é composto pelas informações da solicitação e histórico de Alterações de Situação.

Parâmetros	Descrição
parameters -> querystring	Deve informar: attId: Guid da solicitação.

Exemplo:

{
    "order": 0,
    "name": "open-att-attendance-view",
    "permissionLevel": 2,
    "publishLevel": 1,
    "title": "",
    "icon": "",
    "parameters": [
            {"title":"querystring","value":"?attId=xxx"}
    ]
}

Open-att-attendance-add

Função que disponibiliza o processo de abertura de solicitação.

Parâmetros	Descrição
parameters -> querystring	formada pelo serviceId e FormId do serviço.
parameters -> formParameters	Necessário apenas se desejar o preenchimento do form com dados prévios

Importante: Para exibir a sempre a última versão do formulário é necessário informar o “rootParentId” do form como formID.

Exemplo:

{
    "order": 0,
    "name": "open-att-attendance-add",
    "permissionLevel": 2,
    "publishLevel": 1,
    "title": "",
    "parameters": [          
            {"title":"querystring", "value":"?serviceId=xxx&formId=xx"},
            {"title":"formParameters","value":"filterby=1&nome=ana"}, 
    ]
}

Open-att-attendance-edit

Função que disponibiliza o processo de edição de uma solicitação.

Parâmetros	Descrição
parameters -> Querystring	serviceId: Guid ou identificador único do serviço FormId: Guid ou Identificador único do formulário
parameters -> formParameters	Dados para preenchimento do form com dados prévios. As variáveis informadas devem corresponder a identificadores únicos de campos dentro do formulário. Parâmetro Opcional.

Importante: Para exibir a sempre a última versão do formulário é necessário informar o “rootParentId” do form como formID.

Exemplo:

{
    "order": 0,
    "name": "open-att-attendance-edit",
    "permissionLevel": 2,
    "publishLevel": 1,
    "title": "",
    "parameters": [          
            {"title":"querystring", "value":"?serviceId=xxx&formId=xx"},
            {"title":"formParameters","value":"filterby=1&nome=ana"}
    ]
}

Open-att-attendance-del

Função que disponibiliza a alteração do status “ativo” ou “inativo” do atendimento

Parâmetros	Descrição
parameters -> Querystring	formada pelo id da solicitação

Exemplo:

{
	"order": 0,
	"name": "open-att-attendance-change_status",
	"permissionLevel": 2,
	"publishLevel": 1,
	"title": "",
	"parameters": [
		{"title":"querystring", "value": "?id=xxx"}
	]
}

Open-att-attendance-change_situacion

Função que disponibiliza o processo de alteração de situação de uma solicitação.

Entretanto, as situações possíveis são aquelas cujo o acesso é permitido via app. Esta configuração é feita no Manager.

Parâmetros	Descrição
parameters -> Querystring	formada pelo id da solicitação e RowVersion do atendimento.

Exemplo:

{
    "order": 0,
    "name": "open-att-attendance-change_situation",
    "permissionLevel": 2,
    "publishLevel": 1,
    "title": "",
    "parameters": [
    {
        "title": "querystring",
         "value": "id=xxx&RowVersion=xxx"
    }	
    ]
}