API Field Control

Esse documento descreve os recursos que compõe a API de Integração oficial do Field Control.

Introdução

A API do Field Control tem como base conceitos de arquitetura REST.

Os endpoints da API são organizados em torno de recursos, como ordens de serviço, comentários ou formulários. Os recursos são representados em JSON, ações pelos métodos do HTTP e os erros por HTTP status code.

Autenticação

Todas as requisições para a API são autenticadas fornecendo sua chave de API.

A chave da API deve ser fornecida como um cabeçalho HTTP chamado X-Api-Key.

Header

curl -H "X-Api-Key: SUA_KEY" https://carchost.fieldcontrol.com.br/

Como obtenho minha chave?

Usuários com perfil de administrador podem gerenciar as chaves de acesso ou API keys no Painel de gestão pelo link: https://app.fieldcontrol.com.br/#/configuracoes/configuracao-para-desenvolvedores

Ao acessar o painel, na seção "Chave de integração", clique no link demonstrado na imagem abaixo.

Em seguida, dê um nome para sua chave e clique em "Criar".

Pronto! Sua chave foi criada.

Métodos HTTP

A API usa métodos padrões do HTTP para indicar a ação a ser executada em um recurso.

Schema

O corpo das requisições e das respostas da API são representadas no formato JSON. Todos os timestamps são retornados no formato ISO 8601: YYYY-MM-DDTHH:MM:SSZ sempre em UTC.

Recursos individuais

Os recursos individuais são representados de forma singular. Ao lado, segue uma representação de um serviço.

Exemplo de resultado individual de serviço:

{
  "name": "Manutenção corretiva",
  "duration": 60,
  "archived": false
}

Lista de recursos

As listas de recursos são representadas por um membro de nível mais alto chamado items e no nível mais abaixo, encontram-se os recursos.

O membro totalCount representa o número total de registros do recurso solicitado.

Exemplo de resultado de uma listagem de serviços:

GET https://carchost.fieldcontrol.com.br/services

{
  "items": [
    {
      "name": "Instalação",
      "duration": 60,
      "archived": false
    },
    {
      "name": "Reparo",
      "duration": 30,
      "archived": false
    },
    {
      "name": "Reforma",
      "duration": 120,
      "archived": false
    }
  ],
  "totalCount": 3
}

Paginação, Filtros e Ordenação de resultados

Paginação

Os endpoints que retornam listas de recursos devem limitar o número de registros retornados em uma resposta. O parâmetro limit da query deve ser usado para alterar o número de registros retornados.

Um endpoint irá retornar 10 registros por padrão e permite, no máximo, retornar 100 registros.

O parâmetro offset da query deve ser usado para deslocar um conjunto de resultados. Esses parâmetros podem ser combinados para recuperar todos os recursos de uma lista por meio de uma série de requisições que incrementam o offset pelo valor do limit em cada uma delas.

Para utilizar os dois parâmetros na mesma requisição, basta separá-los com &, como por exemplo:

https://carchost.fieldcontrol.com.br/services?limit=20&offset=40.

Por exemplo, se existem 345 registros e o parâmetro limit é igual ao valor padrão (10), use offset=10 para recuperar a próxima página de resultados.

O número total de registros em uma lista pode ser encontrado na propriedade totalCount da resposta.

Filtros

Os filtros permitem refinar a consulta de um determinada lista. Para aplicar um filtro, deve ser inserido ?q=chave:"valor" logo após o endpoint na URL. Cada recurso é compatível com um tipo de parâmetro.

Por exemplo, serviços podem ser filtrados por nome.

Serviços filtrados por nome

GET https://carchost.fieldcontrol.com.br/services?q=name:"Instalação"

{
  "items": [
    {
      "id": "NTox",
      "name": "Instalação",
      "duration": 60,
      "archived": false
    }
  ],
  "totalCount": 1
}

É possível aplicar mais de um filtro na mesma requisição, basta separar os parâmetros por espaço na query. Por exemplo:

Consulta com mais de um filtro

GET https://carchost.fieldcontrol.com.br/customer?q=name:"Luiz Freneda" document_number:"59784800870"

{
  "items": [
    {
      "id": "NTox",
      "name": "Luiz Freneda",
      "documentNumber": "59784800870",
      "contact": {
        "email": "luiz@fieldcontrol.com.br",
        "phone": "17996584235"
      },
      "address": {
        "zipCode": "15085480",
        "street": "Rua Padre Clemente Marton Segura",
        "number": "51",
        "neighborhood": "Higienópolis",
        "complement": "Sobrado amarelo",
        "city": "São José do Rio Preto",
        "state": "São Paulo",
        "coords": {
          "latitude": -20.836378,
          "longitude": -49.38591
        }
      },
      "statistics": {
        "updatedAt": null,
        "service": {
          "firstAt": null,
          "lastAt": null,
          "total": 0
        },
        "rating": {
          "averageStars": 0,
          "lastComment": null,
          "lastStar": 0
        }
      },
      "archived": false
    }
  ],
  "totalCount": 1
}

Alguns filtros podem utilizar de operadores condicionais, como o parâmetro created_at. Para aplicar o filtro com o operador condicional compatível, basta colocá-lo no final do nome do parâmetro.

Por exemplo, para filtrar os resultados de um recurso por data de criação maior ou igual a 2020-06-12 o filtro ficaria &q=created_at>=:2020-06-12. Para resultados exatos, utiliza-se o parâmetro sem operador condicional, como: &q=created_at:2020-06-12T15:20:00Z

Ordenação de resultados

Os endpoints que retornam listas de recursos podem ter seus resultados ordenados. Para aplicar uma ordenação, deve ser inserido &sort=valor após o endpoint na URL. Os dados podem ser organizados em ordem ascendente ou em ordem descendente, para isso, é necessário incluir - junto do valor de sort para que os resultados sejam mostrados em ordem descendente e somente valor para que os resultados sejam mostrados em ordem ascendente.

Por exemplo, as ordens de serviços podem ser ordenadas pela data de criação, então seria &sort=created_at para a ordenação ascendente dos resultados e &sort=-created_at para a ordenação descendente dos resultados.

Exemplo de requisição para recuperar lista de clientes em ordem descendente da data de criação (mais recente primeiro):

curl -X GET https://carchost.fieldcontrol.com.br/customers&limit=2&sort=-created_at \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "MTox",
      "name": "Eduardo Luiz Santos",
      "code": "e1eb7458ff84",
      "contact": {
        "email": "edu@fieldcontrol.com.br",
        "phone": "17996543210"
      },
      "address": {
        "zipCode": "05422010",
        "street": "Rua dos Pinheiros",
        "number": "383",
        "neighborhood": null,
        "complement": null,
        "city": "São Paulo",
        "state": "São Paulo",
        "coords": {
          "latitude": -23.565217,
          "longitude": -46.681819
        }
      },
      "statistics": {
        "updatedAt": null,
        "service": {
          "firstAt": null,
          "lastAt": null,
          "total": 0
        },
        "rating": {
          "averageStars": 0,
          "lastComment": null,
          "lastStar": 0
        }
      },
      "createdAt": "2020-06-12T15:35:06Z"
    },
    {
      "id": "MTI0NTY2OjMyNjM1",
      "name": "Maria Luiza dos Reis",
      "code": "5adf68asf87h",
      "contact": {
        "email": "mluiza@gmail.com",
        "phone": "11996874231"
      },
      "address": {
        "zipCode": "06874139",
        "street": "Rua dos Trabalhadores",
        "number": "500",
        "neighborhood": null,
        "complement": null,
        "city": "São Paulo",
        "state": "São Paulo",
        "coords": {
          "latitude": -23.567891,
          "longitude": -46.64712
        }
      },
      "statistics": {
        "updatedAt": null,
        "service": {
          "firstAt": null,
          "lastAt": null,
          "total": 0
        },
        "rating": {
          "averageStars": 0,
          "lastComment": null,
          "lastStar": 0
        }
      },
      "createdAt": "2020-06-10T1:00:06Z"
    }
  ],
  "totalCount": 200
}

Erros

A API utiliza o status code do HTTP para indicar que ocorreu um erro enquanto processava a requisição.

No caso do erro 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Segue o exemplo abaixo:

{
  "code": "resourceValidationErr",
  "errors": [
    {
      "code": null,
      "reason": "optional",
      "message": "is missing and not optional",
      "property": "@.address"
    }
  ]
}

Rate Limits

A API permite que a aplicação cliente possa fazer uma requisição por segundo. Contas com alta demanda podem entrar em contato conosco para obter uma solução de limite personalizada.

Headers obrigatórios

Para garantir a segurança e o correto funcionamento ao consumir nossa API de integração, é essencial incluir os seguintes headers em suas requisições:

• Host: Especifica o domínio ou subdomínio para o qual a solicitação está sendo enviada. Esse header é essencial para direcionar a solicitação corretamente.
• Content-Type: Necessário para requisições com corpo, como POST, PUT, etc. Define o tipo de dado enviado no corpo da requisição (por exemplo, application/json).
• User-Agent: Identifica o cliente que faz a solicitação. A ausência deste header pode disparar regras que bloqueiam bots ou tráfego não autenticado.

Certifique-se de que todos os headers obrigatórios estão presentes em suas requisições para evitar problemas de autenticação e roteamento.

Bibliotecas oficiais

As bibliotecas oficiais da API Field Control permitem simplificar e reduzir o montante de código que você precisa escrever para utilizar os recursos disponíveis.

As bibliotecas oficiais são de código aberto e ao clicar nos logos abaixo você será redirecionado para a página do repositório no GitHub. Lá, você encontrará todas as instruções de como instalar e utilizar a biblioteca.

Confira as bibliotecas oficias disponíveis:

Clientes

Clientes são os consumidores finais dos serviços prestados (tipos de OSs), seja ele uma pessoa física ou jurídica.

Parâmetros

Atenção: As propriedades com * são obrigatórias

Usuários podem gerenciar os clientes no Painel de gestão pelo link: https://app.fieldcontrol.com.br/#/clientes

Caso seu sistema não possua dados de geolocalização para seus clientes, veja essa seção.

Criar um cliente

Cria um novo cliente

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para criação de um cliente:

curl -X POST https://carchost.fieldcontrol.com.br/customers \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Nicola Zagari",
    "code": "22f30236efad",
    "notes": null,
    "external": {
      "id": null
    },
    "address": {
      "zipCode": "05432070",
      "street": "R. Fidalga",
      "number": "66",
      "neighborhood": "Vila Madalena",
      "complement": "Prédio branco",
      "city": "São Paulo",
      "state": "SP",
      "coords": {
        "latitude": -23.558418,
        "longitude": -46.688081
      }
    }
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NTc4NTQ1OjIyOTE1",
  "name": "Nicola Zagari",
  "code": "22f30236efad",
  "notes": null,
  "external": {
    "id": null
  },
  "documentNumber": null,
  "contact": {
    "email": null,
    "phone": null
  },
  "primaryLocation": {
    "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE="
  },
  "address": {
    "zipCode": "05432070",
    "street": "R. Fidalga",
    "number": "66",
    "neighborhood": "Vila Madalena",
    "complement": "Prédio branco",
    "city": "São Paulo",
    "state": "SP",
    "coords": {
      "latitude": -23.558418,
      "longitude": -46.688081
    }
  },
  "statistics": {
    "updatedAt": null,
    "service": {
      "firstAt": null,
      "lastAt": null,
      "total": 0
    },
    "rating": {
      "averageStars": 0,
      "lastComment": null,
      "lastStar": 0
    }
  }
}

Recuperar um cliente

Recupera um cliente existente por id.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar um cliente:

curl -X GET https://carchost.fieldcontrol.com.br/customers/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "MTox",
  "name": "Eduardo Luiz Santos",
  "code": "ef2bf873154c",
  "external": {
    "id": "194a98af-bcea-4561-bc21-cc706d925827"
  },
  "notes": null,
  "contact": {
    "email": "edu@fieldcontrol.com.br",
    "phone": "17996543210"
  },
  "primaryLocation": {
    "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE=",
  },
  "address": {
    "zipCode": "05422010",
    "street": "Rua dos Pinheiros",
    "number": "383",
    "neighborhood": null,
    "complement": null,
    "city": "São Paulo",
    "state": "São Paulo",
    "coords": {
      "latitude": -23.565217,
      "longitude": -46.681819
    }
  },
  {
    "statistics": {
    "updatedAt": null,
    "service": {
      "firstAt": null,
      "lastAt": null,
      "total": 0
    },
    "rating": {
      "averageStars": 0,
      "lastComment": null,
      "lastStar": 0
    }
  }
}

Atualizar um cliente

Atualiza um cliente existente

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualização de um cliente:

curl -X PUT https://carchost.fieldcontrol.com.br/customers/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Luiz Freneda",
    "code": "05e67c054594",
    "notes": null,
    "documentNumber": "27032236881",
    "external": {
      "id": "aa282c35-ec38-4c07-b017-f7ea4fccdcca"
    },
    "address": {
      "zipCode": "15085480",
      "street": "Rua Padre Clemente Marton Segura",
      "number": "51",
      "neighborhood": "Higienópolis",
      "complement": "Sobrado amarelo",
      "city": "São José do Rio Preto",
      "state": "São Paulo",
      "coords": {
        "latitude": -20.836378,
        "longitude": -49.38591
      }
    }
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NTAxMDc0OjIyOTE1",
  "name": "Luiz Freneda",
  "code": "05e67c054594",
  "notes": null,
  "documentNumber": "27032236881",
  "external": {
    "id": "aa282c35-ec38-4c07-b017-f7ea4fccdcca"
  },
  "contact": {
    "email": "luiz@fieldcontrol.com.br",
    "phone": "17996584235"
  },
  "primaryLocation": {
    "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE="
  },
  "address": {
    "zipCode": "15085480",
    "street": "Rua Padre Clemente Marton Segura",
    "number": "51",
    "neighborhood": "Higienópolis",
    "complement": "Sobrado amarelo",
    "city": "São José do Rio Preto",
    "state": "São Paulo",
    "coords": {
      "latitude": -20.836378,
      "longitude": -49.38591
    }
  },
  "statistics": {
    "updatedAt": null,
    "service": {
      "firstAt": null,
      "lastAt": null,
      "total": 0
    },
    "rating": {
      "averageStars": 0,
      "lastComment": null,
      "lastStar": 0
    }
  }
}

Listar clientes

Lista clientes existentes

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de clientes:

Valores disponíveis para ordenação de resultados:

Exemplo de requisição para recuperar lista de clientes:

curl -X GET https://carchost.fieldcontrol.com.br/customers \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "MTox",
      "name": "Eduardo Luiz Santos",
      "code": "e1eb7458ff84",
      "notes": null,
      "external": {
        "id": "194a98af-bcea-4561-bc21-cc706d925827"
      },
      "contact": {
        "email": "edu@fieldcontrol.com.br",
        "phone": "17996543210"
      },
      "primaryLocation": {
        "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE=",
      },
      "address": {
        "zipCode": "05422010",
        "street": "Rua dos Pinheiros",
        "number": "383",
        "neighborhood": null,
        "complement": null,
        "city": "São Paulo",
        "state": "São Paulo",
        "coords": {
          "latitude": -23.565217,
          "longitude": -46.681819
        }
      },
      {
        "statistics": {
        "updatedAt": null,
        "service": {
          "firstAt": null,
          "lastAt": null,
          "total": 0
        },
        "rating": {
          "averageStars": 0,
          "lastComment": null,
          "lastStar": 0
        }
      },
      "createdAt": "2020-06-12T15:35:06Z"
    }
  ],
  "totalCount": 1
}

Informações de contato

As informações de contato de um cliente são compostas por telefone e e-mail.

Telefones

São todos os telefones associados a um cliente.

Parâmetros

Atenção: As propriedades com * são obrigatórias

Usuários podem gerenciar os clientes no Painel de gestão pelo link: https://app.fieldcontrol.com.br/#/clientes

Parâmetro type e seus valores

Criar um telefone

Cria um telefone.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para criação de um telefone de um cliente:

curl -X POST https://carchost.fieldcontrol.com.br/customers/:id/phones \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "number": "17996085421",
    "type": "mobile",
    "primary": true
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE=",
  "number": "17996085421",
  "type": "mobile",
  "primary": true
}

Atualizar um telefone

Atualiza um telefone existente.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualizar um telefone:

curl -X GET https://carchost.fieldcontrol.com.br/customers/:id/phones/:phone_id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'
  --data-binary \
  '{
    "number": "17996089867",
    "type": "mobile"
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE=",
  "number": "17996089867",
  "type": "mobile",
  "primary": true
}

Listar telefones

Lista todos os telefones do cliente.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para listar os telefones de um cliente:

curl -X GET https://carchost.fieldcontrol.com.br/customers/:id/phones \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "Y2U4M2YyOTgtZTg1Ni00YjRlLTk0OTMtOWEwODEyN2E4ZWQwOjE=",
      "number": "17996854723",
      "type": "work",
      "primary": false
    },
    {
      "id": "MGUwYzdmYzQtZGZhZS00OWFiLThlNzYtNjJjYWYyNDk4NWFhOjE=",
      "number": "17996325412",
      "type": "mobile",
      "primary": true
    }
  ],
  "totalCount": 2
}

Remover um telefone

Remove um telefone existente.

Exemplo de requisição para remover um telefone de um cliente:

curl -X GET https://carchost.fieldcontrol.com.br/customers/:id/phones/:phone_id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

E-mails

São todos os e-mails associados a um cliente.

Parâmetros

Atenção: As propriedades com * são obrigatórias

Usuários podem gerenciar os clientes no Painel de gestão pelo link: https://app.fieldcontrol.com.br/#/clientes

Parâmetro type e seus valores

Criar um e-mail

Cria um e-mail.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para criação de um e-mail de um cliente:

curl -X POST https://carchost.fieldcontrol.com.br/customers/:id/emails \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "address": "andre@gmail.com",
    "type": "personal",
    "primary": true
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE=",
  "address": "andre@gmail.com",
  "type": "personal",
  "primary": true
}

Atualizar um e-mail

Atualiza um e-mail existente.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualizar um e-mail:

curl -X GET https://carchost.fieldcontrol.com.br/customers/:id/emails/:email_id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'
  --data-binary \
  '{
    "address": "andre@empresa.com.br",
    "type": "work"
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE=",
  "address": "andre@empresa.com.br",
  "type": "work",
  "primary": true
}

Listar e-mails

Lista todos os e-mails do cliente.

Exemplo de requisição para listar os e-mails de um cliente:

curl -X GET https://carchost.fieldcontrol.com.br/customers/:id/emails \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "Y2U4M2YyOTgtZTg1Ni00YjRlLTk0OTMtOWEwODEyN2E4ZWQwOjE=",
      "address": "andre@empresa.com.br",
      "type": "work",
      "primary": false
    },
    {
      "id": "MGUwYzdmYzQtZGZhZS00OWFiLThlNzYtNjJjYWYyNDk4NWFhOjE=",
      "address": "andre@gmail.com",
      "type": "personal",
      "primary": true
    }
  ],
  "totalCount": 2
}

Remover um e-mail

Remove um e-mail existente.

Exemplo de requisição para remover um e-mail de um cliente:

curl -X GET https://carchost.fieldcontrol.com.br/customers/:id/emails/:email_id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Etiquetas do cliente

São as etiquetas vinculadas a um cliente.

Parâmetros

Type O type sempre será 1, pois é referente às etiquetas de clientes.

Listar as etiquetas do cliente

Recupera todas as etiquetas de um cliente por id do cliente.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "Mjk3NzI2ZDAtMzAxZC00ZGU2LWI5YTQtZTQzOWI4MWY0NGJhOjE=",
      "name": "Contrato",
      "color": "yellow",
      "type": 1
    },
    {
      "id": "MWRiNmUwN2YtOTFlMi00MmZiLWI2NWMtOWEzNjRiNmJhZDRjOjE=",
      "name": "Particular",
      "color": "purple",
      "type": 1
    }
  ],
  "totalCount": 2
}

Inserir etiquetas em um cliente

Vincular uma etiqueta a um cliente.

Parâmetros

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para inserção de uma etiqueta a um cliente:

curl -X POST https://carchost.fieldcontrol.com.br/customers/:id/labels \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "label": {
      "id": "OGFjYmZjNDctMDkxMy00YTU2LWI1OTQtYWEzMWI5OGU0Y2IwOjE="
    }
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "OGFjYmZjNDctMDkxMy00YTU2LWI1OTQtYWEzMWI5OGU0Y2IwOjE=",
  "name": "Zona Oeste de São Paulo",
  "color": "red",
  "type": 1
}

Remover uma etiqueta de um cliente

Desvincular etiqueta de um cliente.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para remover uma etiqueta de um cliente:

curl -X DELETE https://carchost.fieldcontrol.com.br/customers/:id/labels/:label_id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Resposta de sucesso não possui informações no corpo da mensagem

Localizações

São as localizações com endereços vinculados a um cliente.

Parâmetros

Atenção: As propriedades com * são obrigatórias

Usuários podem gerenciar os as localizações de um cliente no Painel de gestão pelo link: https://app.fieldcontrol.com.br/#/localizacoes

Caso seu sistema não possua dados de geolocalização para seus clientes, veja essa seção.

Criar uma localização

Cria uma localização.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para criação de uma localização de um cliente:

curl -X POST https://carchost.fieldcontrol.com.br/customers/:id/locations \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Localização de Nicola Zagari",
    "address": {
      "postalCode": "15035180",
      "street": "Rua Santina Figliacci",
      "number": "461",
      "neighborhood": "Vila Itália",
      "city": "São José do Rio Preto",
      "state": "São Paulo",
      "complement": "Apt 24 Bloco F",
      "coords": {
        "latitude": -20.799553,
        "longitude": -49.4161149
      }
    }
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE=",
  "customer": {
    "id": "NTc4NTQ1OjIyOTE1"
  },
  "name": "Luiz Freneda Localização Teste",
  "address": {
    "postalCode": "15035180",
    "street": "Rua Santina Figliacci",
    "number": "461",
    "neighborhood": "Vila Itália",
    "city": "São José do Rio Preto",
    "state": "São Paulo",
    "complement": "Apt 24 Bloco F",
    "coords": {
      "latitude": -20.799553,
      "longitude": -49.4161149
    }
  },
  "archived": false,
  "notes": null
}

Recuperar uma localização

Recupera uma localização existente por id.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar um cliente:

curl -X GET https://carchost.fieldcontrol.com.br/customers/:id/locations/:locationId \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE=",
  "customer": {
    "id": "NTc4NTQ1OjIyOTE1"
  },
  "name": "Localização de Nicola Zagari",
  "address": {
    "postalCode": "15035181",
    "street": "Rua Santina Figliacci",
    "number": "465",
    "neighborhood": "Vila França",
    "city": "Sao José Do Rio Preto",
    "state": "Sao Paulo",
    "complement": "Apt 25 Bloco A",
    "coords": {
      "latitude": -21.799553,
      "longitude": -50.4161149
    }
  },
  "archived": true,
  "notes": "Tive que arquivar"
}

Atualizar uma localização

Atualiza uma localização existente.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualizar uma localização:

curl -X GET https://carchost.fieldcontrol.com.br/:id/locations/:locationId \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'
  --data-binary \
  '{
    "name": "Localização de Nicola Zagari",
    "address": {
      "postalCode": "15035181",
      "street": "Rua Santina Figliacci",
      "number": "465",
      "neighborhood": "Vila França",
      "city": "Sao José Do Rio Preto",
      "state": "Sao Paulo",
      "complement": "Apt 25 Bloco A",
      "coords": {
        "latitude": -21.799553,
        "longitude": -50.4161149
      }
    },
    "archived": true,
    "notes": "Tive que arquivar"
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE=",
  "customer": {
    "id": "NTc4NTQ1OjIyOTE1"
  },
  "name": "Luiz Freneda Localização Teste Modificado",
  "address": {
    "postalCode": "15035181",
    "street": "Rua Santina Figliacci",
    "number": "465",
    "neighborhood": "Vila França",
    "city": "Sao José Do Rio Preto",
    "state": "Sao Paulo",
    "complement": "Apt 25 Bloco A",
    "coords": {
      "latitude": -21.799553,
      "longitude": -50.4161149
    }
  },
  "archived": true,
  "notes": "Tive que arquivar"
}

Atualizar a localização primária de um cliente

Atualiza o vinculo da localização primária de um cliente

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualizar a localização primária de um cliente:

curl -X GET https://carchost.fieldcontrol.com.br/customers/:id/primary-location/:locationId \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "NTc4NTQ1OjIyOTE1",
  "name": "Nicola Zagari",
  "code": "22f30236efad",
  "documentNumber": null,
  "contact": {
    "email": null,
    "phone": null
  },
  "primaryLocation": {
    "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE=",
  },
  "address": {
    "zipCode": "05432070",
    "street": "R. Fidalga",
    "number": "66",
    "neighborhood": "Vila Madalena",
    "complement": "Prédio branco",
    "city": "São Paulo",
    "state": "SP",
    "coords": {
      "latitude": -23.558418,
      "longitude": -46.688081
    }
  },
  "statistics": {
    "updatedAt": null,
    "service": {
      "firstAt": null,
      "lastAt": null,
      "total": 0
    },
    "rating": {
      "averageStars": 0,
      "lastComment": null,
      "lastStar": 0
    }
  }
}

Listar localizações

Lista todos os telefones do cliente.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de localizações:

Valores disponíveis para ordenação de resultados:

Exemplo de requisição para listar os telefones de um cliente:

curl -X GET https://carchost.fieldcontrol.com.br/customers/:id/locations \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "NmJlZTk4ZWQtNGRjZC00MTYyLTgwYWYtODFjNzk3OGNhN2FhOjE=",
      "customer": {
        "id": "NTc4NTQ1OjIyOTE1"
      },
      "name": "Luiz Freneda Localização Teste Modificado",
      "address": {
        "postalCode": "15035181",
        "street": "Rua Santina Figliacci",
        "number": "465",
        "neighborhood": "Vila França",
        "city": "Sao José Do Rio Preto",
        "state": "Sao Paulo",
        "complement": "Apt 25 Bloco A",
        "coords": {
          "latitude": -21.799553,
          "longitude": -50.4161149
        }
      },
      "archived": true,
      "notes": "Tive que arquivar"
    }
  ],
  "totalCount": 1
}

Colaboradores

Colaboradores são os profissionais que trabalham externamente usando o app Field Control.

Parâmetros

Usuários com perfil de administrador podem gerenciar os colaboradores no Painel de gestão pelo link: https://app.fieldcontrol.com.br/#/colaboradores

Criar um colaborador

Cria um colaborador.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para criação de um colaborador:

curl -X POST https://carchost.fieldcontrol.com.br/employees \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "João Vitor",
    "email": "jvitor@gmail.com",
    "avatarUrl": null,
    "isActive": true
  }' \
  --compressed

Recuperar um colaborador

Recupera um colaborador existente pelo identificador.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar um colaborador:

curl -X GET https://carchost.fieldcontrol.com.br/employees/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "MTY0MTU6MjI5MTU=",
  "name": "Mauro Garcia",
  "email": "m.garcia@gmail.com",
  "avatarUrl": null
}

Atualizar um colaborador

Atualiza um colaborador.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualização de um colaborador:

curl -X PUT https://carchost.fieldcontrol.com.br/employees/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Mauro Garcia",
  }' \
  --compressed

Listar colaboradores

Lista os colaboradores existentes.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de colaboradores:

Exemplo de requisição para recuperar lista de colaboradores:

curl -X GET https://carchost.fieldcontrol.com.br/employees \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "MTY0MTU6MjI5MTU=",
      "name": "Mauro Garcia",
      "notes": "Principal colaborador",
      "email": "m.garcia@gmail.com",
      "avatarUrl": null
    },
    {
      "id": "MTY1NDk6MjI5MTU=",
      "name": "Renan Valentin",
      "notes": null,
      "email": "renanvalentin@gmail.com",
      "avatarUrl": null
    },
    {
      "id": "MTY1NTU6MjI5MTU=",
      "name": "Felipe Zini",
      "email": "zini@gmail.com",
      "avatarUrl": null
    }
  ],
  "totalCount": 3
}

Atualizar um colaborador

Atualiza um colaborador.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualização de um colaborador:

curl -X PUT https://carchost.fieldcontrol.com.br/employees/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Mauro Garcia",
  }' \
  --compressed

Listar localização dos colaboradores

Lista a geolocalizações dos colaboradores.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar lista de geolocalização dos colaboradores:

curl -X GET https://carchost.fieldcontrol.com.br/employees/tracking \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

  [
    {
      "accuracy": 16.2,
      "speed": -1,
      "heading": -1,
      "employee": {
        "id": "NTgyNjox"
      },
      "coords": {
        "latitude": -22.3368284,
        "longitude": -49.0473741
      },
      "timestamp": "2019-08-05T17:04:17.355Z",
      "receivedAt": "2019-08-05T17:04:18.270Z",
    },
    {
      "accuracy": 7.5,
      "speed": 0,
      "heading": 0,
      "employee": {
        "id": "NjE5MTox"
      },
      "coords": {
        "latitude": -22.3364431,
        "longitude": -49.0474458
      },
      "timestamp": "2019-08-05T17:01:29.000Z",
      "receivedAt": "2019-08-05T17:01:29.763Z",
    }
  ]

Materiais

Materiais são os produtos ou peças utilizados na execução de uma ordem de serviço. Caso ocorra a migração de materiais para produtos, serão considerados os produtos nas operações.

Parâmetros

Criar um material

Cria um novo material

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para criação de um material:

curl -X POST https://carchost.fieldcontrol.com.br/materials \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Tomada Padrão americano RJ11",
    "measure": "unity"
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "MzUxMzE6MjI5MTU=",
  "name": "Tomada Padrão americano RJ11",
  "measure": "unity"
  "archived": false
}

Recuperar um material

Recupera um material existente por id

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar um material:

curl -X GET https://carchost.fieldcontrol.com.br/materials/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "MzUxMzE6MjI5MTU=",
  "name": "Tomada Padrão americano RJ11",
  "measure": "unity",
  "archived": false
}

Atualizar um material

Atualiza um material existente

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualização de um material:

curl -X PUT https://carchost.fieldcontrol.com.br/materials/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Tomada Padrão americano RJ11",
    "measure": "unity"
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "MzUxMzE6MjI5MTU=",
  "name": "Tomada Padrão americano RJ11",
  "measure": "unity",
  "archived": false
}

Listar materiais

Lista materiais existentes

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de materiais:

Exemplo de requisição para recuperar lista de materiais:

curl -X GET https://carchost.fieldcontrol.com.br/materials \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "MzUxMzE6MjI5MTU=",
      "name": "Tomada Padrão americano RJ11",
      "measure": "unity",
      "archived": false
    }
  ],
  "totalCount": 1
}

Listar materiais de uma ordem de serviço

Materiais são os produtos ou peças utilizados na execução de uma ordem de serviço.

Parâmetros

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar lista de anexos de uma ordem de serviço:

curl -X GET https://carchost.fieldcontrol.com.br/orders/:order_id/materials \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "YWY0MmZmZDktODY1NS00MTdjLTlkM2QtNDRkMDZlZmQ5Y2MzOjE=",
      "quantity": 25,
      "material": {
        "id": "NzNjZTBiNDEtZjYwMC00YmU0LWFhMzEtNTE1MTQ1NTNmMjY5OjE=",
        "name": "Fibra ótica",
        "measure": "centimeter"
      }
    }
  ],
  "totalCount": 1
}

Produtos e serviços

Produtos/Serviços são os produtos ou serviços incluídos na execução de uma ordem de serviço.

Parâmetros

Criar um produto/serviço

Cria um novo produto/serviço

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para criação de um produto/serviço:

curl -X POST https://carchost.fieldcontrol.com.br/products-services \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Cabo de rede",
    "measure": "meter",
    "description": "Modelo rj45",
    "value": 9.99,
    "type": "product",
    "archived": false,
    "imageUrl": null
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NDdjYTQyZT",
  "name": "Cabo de rede",
  "description": "Modelo rj45",
  "measure": "meter",
  "archived": false,
  "type": "product",
  "value": 9.99,
  "imageUrl": null
}

Listar produtos/serviços

Listar todos produtos/serviços existentes.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de produtos/serviços:

Exemplo de requisição para recuperar produtos/serviços:

curl -X GET https://carchost.fieldcontrol.com.br/products-services \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "YjY0NzZkNGItMDJiNi00YWE2LWJmZTUtNjM0ODY1YzMzMzFkOjE=",
      "name": "Cabo de aço",
      "description": null,
      "measure": "meter",
      "imageUrl": null,
      "type": "product",
      "value": 499.99,
      "archived": false
    },
    {
      "id": "PsA0NzMpOLItMDJiNi22YWE2LWJmMNBtNjM0ODY1YzMzMzFkOjE=",
      "name": "Prego",
      "description": null,
      "measure": "unity",
      "imageUrl": null,
      "type": "product",
      "value": 0.15,
      "archived": false
    },
  ],
  "totalCount": 2
}

Recuperar um produto/serviço

Recupera um produto/serviço existente por id.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar um produto/serviço:

curl -X GET https://carchost.fieldcontrol.com.br/products-services/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "YjY0NzZkNGItMDJiNi00YWE2LWJmZTUtNjM0ODY1YzMzMzFkOjE=",
  "name": "Cabo de aço",
  "description": null,
  "measure": "meter",
  "imageUrl": null,
  "type": "product",
  "value": 499.99,
  "archived": false
}

Atualizar um produto/serviço

Atualiza um produto/serviço

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualização de um produto/serviço:

curl -X PUT https://carchost.fieldcontrol.com.br/products-services/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Cabo de rede rj45",
    "description": "Novo modelo rj45",
    "measure": "unity",
    "archived": false,
    "type": "product",
    "value": 3.99,
    "imageUrl": "https://www.domain.name/cabo"
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NDdjYTQyZT",
  "name": "Cabo de rede rj45",
  "description": "Novo modelo rj45",
  "measure": "unity",
  "archived": false,
  "type": "product",
  "value": 3.99,
  "imageUrl": "https://www.domain.name/cabo"
}

Equipamentos

Equipamentos são os aparelhos da ordem de serviço que recebem manutenções.

Parâmetros

OBS: Ao inserir ou atualizar um equipamento, é possível informar o nome do tipo do equipamento e/ou o nome do cliente ao invés de seus identificadores. É importante notar que um dos dois parâmetros deve ser informado. Caso os dois parâmetros sejam informados, somente o identificador será considerado.

Criar um equipamento

Cria um equipamento.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

OBS: O parâmetro customFields é opcional, não sendo necessário seu uso. A requisição será realizada com ou sem ele, ou até como um array vazio.

Exemplo de requisição para criação de um equipamento:

curl -X POST https://carchost.fieldcontrol.com.br/equipments \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "type": {
      "id": "MTox"
    },
    "customer": {
      "id": "MTox"
    },
    "location": {
      "id": "MTox"
    },
    "name": "LG DUAL Inverter 12.000 Btus",
    "number": "XG900",
    "qrCode": "04e3a914-6d6b-4cd6-b5ec-fca2937ce8b0",
    "notes": null,
    "avatarUrl": null
  }' \
  --compressed

Exemplo de requisição para criação de um equipamento com o nome do tipo de equipamento e o nome do cliente

curl -X POST https://carchost.fieldcontrol.com.br/equipments \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "type": {
      "name": "Instalação"
    },
    "customer": {
      "name": "Luana Oliveira"
    },
    "location": {
      "id": "MTox"
    },
    "name": "LG DUAL Inverter 12.000 Btus",
    "number": "XG900",
    "qrCode": "04e3a914-6d6b-4cd6-b5ec-fca2937ce8b0",
    "notes": null,
    "avatarUrl": null
  }' \
  --compressed

Exemplo de requisição para criação de um equipamento com o parâmetro customFields

curl -X POST https://carchost.fieldcontrol.com.br/equipments \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "type": {
      "id": "MTox"
    },
    "customer": {
      "id": "MTox"
    },
    "location": {
      "id": "MTox"
    },
    "name": "LG DUAL Inverter 12.000 Btus",
    "number": "XG900",
    "qrCode": "04e3a914-6d6b-4cd6-b5ec-fca2937ce8b0",
    "notes": null,
    "avatarUrl": null,
    "customFields": [
      {
        "name": "Qual é a marca do equipamento ?",
            "value": "LG",
            "position": "0",
            "type": "question"
      },
      {
        "name": "Quantos Btus possui ?",
            "value": "12000",
            "position": "1",
            "type": "number"
      }
    ]
  }' \
  --compressed

Recuperar um equipamento

Recupera um equipamento existente pelo identificador.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar um material:

curl -X GET https://carchost.fieldcontrol.com.br/equipments/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "YzkyMTA0MzgtNWVmNy00YjU4LTkxOWYtMjBmY2Y4ZDI1OTdiOjE=",
  "name": "Venax FI109",
  "number": "4as57n9c7",
  "notes": "Localizado no centro da cozinha",
  "archived": false,
  "qrCode": "5f40c7a6-3889-4b5c-afc2-8484af60bae6",
  "avatarUrl": null,
  "customer": {
    "id": "MTox"
  },
  "location": {
    "id": "MTox"
  },
  "type": {
    "id": "NDFkNzk3MDctZDI3Yy00ZTM1LWJmZGQtYTNhMTUwNzEwNmNkOjE="
  },
  "customFields": [
    {
      "id": "ZDRhODlmNDYtOWE1MS00Njg1LThmMGUtNmU3MTIyZTJjY2MwOjIyOTE1",
      "name": "Qual a data de fabricação do forno?",
      "value": "2020-02-19T16:40:43.671Z",
      "position": 1,
      "type": "date",
      "equipment": {
        "id": "YzkyMTA0MzgtNWVmNy00YjU4LTkxOWYtMjBmY2Y4ZDI1OTdiOjE="
      }
    },
    {
      "id": "ZWQ0NjE5MjgtNzhkMy00Y2YyLWI4NDAtMmZjZTI2ZGE4MjVjOjIyOTE1",
      "name": "Qual a potência do forno?",
      "value": "4.5",
      "position": 2,
      "type": "number",
      "equipment": {
        "id": "YzkyMTA0MzgtNWVmNy00YjU4LTkxOWYtMjBmY2Y4ZDI1OTdiOjE="
    },
    {
      "id": "ZjM4MDAwMDMtZjc2Zi00ODdlLWJlYjMtYzQyODczZTBiYWQ3OjIyOTE1",
      "name": "Selecione a marca:",
      "value": "Venax",
      "position": 3,
      "type": "multiple-choice",
      "equipment": {
        "id": "YzkyMTA0MzgtNWVmNy00YjU4LTkxOWYtMjBmY2Y4ZDI1OTdiOjE="
    }
  ],
  "createdAt": "2020-07-01T12:34:12Z"
}

Atualizar um equipamento

Atualiza um equipamento.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

OBS: O parâmetro customFields é opcional, não sendo necessário seu uso. A requisição será realizada com ou sem ele, ou até como um array vazio. Vale lembrar que caso seja inserido como um array vazio, ele deletará todos os customFields inseridos naquele equipamento. Serão considerados os novos valores refletindo o parâmetro insertado.

Exemplo de requisição para atualização de um equipamento:

curl -X PUT https://carchost.fieldcontrol.com.br/equipments/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "type": {
      "id": "NWI4MDZiODQtNjQ5YS00Yjg1LTlhZTAtMTY2YjhjNzJhYzM0OjE="
    },
    "customer": {
      "id": "MTox"
    },
    "location": {
      "id": "MTox"
    },
    "name": "LG DUAL Inverter 8.000 Btus",
    "number": "XG900-G9",
    "qrCode": "e799f6b1-c5ef-4453-98b1-f73e90b1d143",
    "notes": "Equipamento atualizado",
    "avatarUrl": null
  }' \
  --compressed

Exemplo de requisição para atualização de um equipamento com o nome do tipo de equipamento e o nome do cliente

curl -X PUT https://carchost.fieldcontrol.com.br/equipments/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "type": {
      "name": "Ar condicionado split"
    },
    "customer": {
      "name": "Rodrigo Alves"
    },
    "location": {
      "id": "MTox"
    },
    "name": "LG DUAL Inverter 12.000 Btus",
    "number": "XG900",
    "qrCode": "04e3a914-6d6b-4cd6-b5ec-fca2937ce8b0",
    "notes": null,
    "avatarUrl": null
  }' \
  --compressed

Exemplo de requisição para atualização de um equipamento com parâmetro customFields

curl -X PUT https://carchost.fieldcontrol.com.br/equipments/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "type": {
      "id": "NWI4MDZiODQtNjQ5YS00Yjg1LTlhZTAtMTY2YjhjNzJhYzM0OjE="
    },
    "customer": {
      "id": "MTox"
    },
    "location": {
      "id": "MTox"
    },
    "name": "LG DUAL Inverter 24.000 Btus",
    "number": "XG900",
    "qrCode": "04e3a914-6d6b-4cd6-b5ec-fca2937ce8b0",
    "notes": null,
    "avatarUrl": null,
    "customFields": [
      {
        "name": "Quantos Btus possui ?",
            "value": "24000",
            "position": "1",
            "type": "number"
      }
    ]
  }' \
  --compressed

Listar equipamentos

Lista equipamentos existentes

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de equipamentos:

Exemplo de requisição para recuperar lista de equipamentos:

curl -X GET https://carchost.fieldcontrol.com.br/equipments \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "MTdjZDYxZWItODRmMy00ZjdhLTg1NDItZDMxMjczMzBkODhiOjE=",
      "name": "Ar condicionado split 9000 Btu",
      "number": "6amzdfds1",
      "notes": "",
      "archived": false,
      "qrCode": "7bdbc830-541e-468a-8d3a-62d10c3e6e5f",
      "avatarUrl": null,
      "customer": {
        "id": "MTox"
      },
      "location": {
        "id": "MTox"
      },
      "type": {
        "id": "NDFkNzk3MDctZDI3Yy00ZTM1LWJmZGQtYTNhMTUwNzEwNmNkOjE="
      },
      "createdAt": "2020-07-01T15:37:10Z"
    },
    {
      "id": "YzkyMTA0MzgtNWVmNy00YjU4LTkxOWYtMjBmY2Y4ZDI1OTdiOjE=",
      "name": "Ar condicionado split 12000 Btu",
      "number": "4as57n9c7",
      "notes": "Localizado no canto esquerdo da sala de reuniões",
      "archived": false,
      "qrCode": "5f40c7a6-3889-4b5c-afc2-8484af60bae6",
      "avatarUrl": null,
      "customer": {
        "id": "MTox"
      },
      "location": {
        "id": "MTox"
      },
      "type": {
        "id": "NDFkNzk3MDctZDI3Yy00ZTM1LWJmZGQtYTNhMTUwNzEwNmNkOjE="
      },
      "createdAt": "2020-07-01T12:34:12Z"
    }
  ],
  "totalCount": 2
}

Valores disponíveis para ordenação de resultados:

Campos customizados

Os campos customizados são questões personalizadas para um tipo de equipamento.

Parâmetros

Eles podem ser obtidos ao recuperar um equipamento, correspondente ao parâmetro customFields.

Tipos de Equipamentos

Os tipos de equipamentos definem o tipo do equipamento, por exemplo: ar condicionado, forno, freezer, etc.

Parâmetros

Criar um tipo de equipamento

Cria um tipo de equipamento.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para criação de um tipo de equipamento:

curl -X POST https://carchost.fieldcontrol.com.br/equipment-types \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Exaustor",
    "archived": false
  }' \
  --compressed

Exemplo de resposta de sucesso

curl -X POST https://carchost.fieldcontrol.com.br/equipments \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "id": "OTcyODg0MjItZGY0Ni00ZGZlLWIzNDctYzA0ZmFiYTMwZWM0OjE=",
    "name": "Exaustor",
    "archived": false,
    "createdAt": "2020-04-15T14:51:04Z"
  }' \
  --compressed

Recuperar um tipo de equipamento

Recupera um tipo de equipamento pelo identificador.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar um tipo de equipamento:

curl -X GET https://carchost.fieldcontrol.com.br/equipment-types/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "OTcyODg0MjItZGY0Ni00ZGZlLWIzNDctYzA0ZmFiYTMwZWM0OjE=",
  "name": "Exaustor",
  "archived": false,
  "createdAt": "2020-04-15T14:51:04Z"
}

Atualizar um tipo de equipamento

Atualiza um tipo de equipamento.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualização de um tipo de equipamento:

curl -X PUT https://carchost.fieldcontrol.com.br/equipment-types/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Exaustor de parede"
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "OTcyODg0MjItZGY0Ni00ZGZlLWIzNDctYzA0ZmFiYTMwZWM0OjE=",
  "name": "Exaustor de parede",
  "archived": false,
  "createdAt": "2020-04-15T14:51:04Z"
}

Listar tipos de equipamentos

Lista os tipos de equipamentos.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de equipamentos:

Exemplo de requisição para recuperar lista de equipamentos:

curl -X GET https://carchost.fieldcontrol.com.br/equipment-types \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "MGU5NWViYmYtNmFhNC00YjAyLTk2MjgtNGJkZTNhZjI0ZjNkOjE=",
      "name": "Computador",
      "archived": false,
      "createdAt": "2020-04-15T14:51:04.300Z"
    },
    {
      "id": "M2RjYTBhZDgtYjA3Yi00MGJkLTg3OWEtOTBkNmQzN2EyOTU0OjE=",
      "name": "Elevador",
      "archived": false,
      "createdAt": "2020-04-15T14:59:40.300Z"
    },
    {
      "id": "NDFkNzk3MDctZDI3Yy00ZTM1LWJmZGQtYTNhMTUwNzEwNmNkOjE=",
      "name": "Ar condicionado",
      "archived": false,
      "createdAt": "2020-04-20T19:06:23.300Z"
    }
  ],
  "totalCount": 3
}

Marcas de Veículos

Marcas de Veículos disponíveis para a utilização nos veículos

Parâmetros

Listar marcas de veículos

Lista marcas de veículos existentes

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de marcas veículos:

Exemplo de requisição para recuperar lista de marcas de veículos:

curl -X GET https://carchost.fieldcontrol.com.br/vehicles-brands \

  -H 'Content-Type: application/json;charset=UTF-8' \

  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [{
    "id": "YTUhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
    "name": "HONDA",
    "createdAt": "2020-06-12T15:35:06Z"
  },
  {
    "id": "YTKhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
    "name": "FIAT",
    "createdAt": "2021-06-12T15:35:06Z"
  }],
  "totalCount": 2
}

Valores disponíveis para ordenação de resultados:

Modelos de Veículos

Modelos de Veículos disponíveis para a utilização nos veículos

Parâmetros

Listar modelos de veículos

Lista modelos de veículos existentes
Um modelo pertence a uma marca (brand) de veículos

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de marcas veículos:

Exemplo de requisição para recuperar lista de marcas de veículos:

curl -X GET https://carchost.fieldcontrol.com.br/vehicles-brands \

  -H 'Content-Type: application/json;charset=UTF-8' \

  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [{
    "id": "YTUhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
    "name": "BIZ",
    "brand": {
      "id": "YTUhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
      "name": "HONDA"
    },
    "createdAt": "2020-06-12T15:35:06Z"
  },
  {
    "id": "YTKhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
    "name": "PALIO",
    "brand": {
      "id": "YTVhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
      "name": "FIAT"
    },
    "createdAt": "2021-06-12T15:35:06Z"
  }],
  "totalCount": 2
}

Valores disponíveis para ordenação de resultados:

Veículos

Veículos disponíveis para a utilização dos colaboradores

Parâmetros

Criar um veículo

Cria um novo veículo

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para criação de um veículo:

curl -X POST https://carchost.fieldcontrol.com.br/vehicles \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "veiculo teste",
    "color": "red",
    "licensePlate": "333-AAA",
    "origin": "company",
    "register": "verdade",
    "status": "available",
    "type": "truck",
    "year": "2018",
    "archived": false,
    "description": "um caminhao",
    "imageUrl": "url_da_imagem.jpg",
    "originalTravelingDistance": 5555,
    "qrCode": "qr_code_do_veiculo",
    "brand": {
      "name": "HONDA"
    },
    "model": {
      "name": "BIZ"
    }
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NDdjYTQyZT",
  "name": "veiculo teste",
  "color": "red",
  "licensePlate": "333-AAA",
  "origin": "company",
  "register": "verdade",
  "status": "available",
  "type": "truck",
  "year": "2018",
  "archived": false,
  "description": "um caminhao",
  "imageUrl": "url_da_imagem.jpg",
  "originalTravelingDistance": 5555,
  "qrCode": "qr_code_do_veiculo",
  "brand": {
    "name": "HONDA"
  },
  "model": {
    "name": "BIZ"
  }
}

Listar veículos

Lista veículos existentes

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de veículos:

Exemplo de requisição para recuperar lista de veículos:

curl -X GET https://carchost.fieldcontrol.com.br/vehicles \

  -H 'Content-Type: application/json;charset=UTF-8' \

  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [{
    "id": "YTNhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
    "name": "Motocicleta em uso",
    "archived": false,
    "register": null,
    "color": "black",
    "status": "unavailable",
    "type": "motorcycle",
    "year": 2012,
    "licensePlate": "PAC-2243",
    "origin": "rented",
    "brand": {
      "name": "HONDA"
    },
    "model": {
      "name": "CB 500"
    }
  }],
  "totalCount": 1
}

Valores disponíveis para ordenação de resultados:

Recuperar um veículo

Recupera um veículo existente pelo identificador.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar um veículo:

curl -X GET https://carchost.fieldcontrol.com.br/vehicles/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "YTNhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
  "name": "Caminhão de entrega",
  "archived": false,
  "register": null,
  "color": "black",
  "status": "available",
  "type": "truck",
  "year": 2018,
  "licensePlate": "PFG-4629",
  "origin": "company",
  "brand": {
    "name": "VOLKSWAGEN"
  },
  "model": {
    "name": "D-6000"
  }
}

Atualizar um veículo

Atualiza um veículo

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualização de um veículo:

curl -X PUT https://carchost.fieldcontrol.com.br/vehicles/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "veiculo atualzado",
    "color": "red",
    "licensePlate": "444-AAA",
    "origin": "employee",
    "register": "verdade",
    "status": "unavailable",
    "type": "car",
    "year": "2018",
    "archived": false,
    "description": "um caminhao",
    "imageUrl": "url_da_imagem.jpg",
    "originalTravelingDistance": 5555,
    "qrCode": "qr_code_do_veiculo",
    "brand": {
      "name": "FIAT"
    },
    "model": {
      "name": "210"
    }
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "name": "veiculo atualzado",
  "color": "red",
  "licensePlate": "444-AAA",
  "origin": "employee",
  "register": "verdade",
  "status": "unavailable",
  "type": "car",
  "year": "2018",
  "archived": false,
  "description": "um caminhao",
  "imageUrl": "url_da_imagem.jpg",
  "originalTravelingDistance": 5555,
  "qrCode": "qr_code_do_veiculo",
  "brand": {
    "name": "FIAT"
  },
  "model": {
    "name": "210"
  }
}

Histórico de Uso

Histórico de Uso dos veículos disponíveis para a utilização dos colaboradores

Parâmetros

Listar histórico de Uso

Lista histórico de uso dos veículos existentes

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de históricos de uso:

Exemplo de requisição para recuperar lista de históricos de uso:

curl -X GET https://carchost.fieldcontrol.com.br/vehicles-usages \

  -H 'Content-Type: application/json;charset=UTF-8' \

  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [{
    "id": "YTNhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
    "createdAt": "2020-03-07T21:00:00.000Z",
    "duration": "187200000",
    "archived": false,
    "pickupAt": "2022-01-05T21:00:00.000Z",
    "pickupDescription": null,
    "pickupImageUrl": null,
    "pickupTravellingDistance": 50300,
    "returnedAt": "2022-01-05T21:00:00.000Z",
    "returnedDescription": null,
    "returnedImageUrl": null,
    "returnedTravellingDistance": 50600,
    "travellingDistance": 300,
    "employee": {
      "id": "YTNhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE="
    },
    "vehicle": {
      "id": "YTNhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE="
    }
  }],
  "totalCount": 1
}

Valores disponíveis para ordenação de resultados:

Recuperar um histórico de uso

Recupera um histórico de uso existente pelo identificador.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar um histórico de uso:

curl -X GET https://carchost.fieldcontrol.com.br/vehicles-usages/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "YTNhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
  "createdAt": "2020-03-07T21:00:00.000Z",
  "duration": "187200000",
  "archived": false,
  "pickupAt": "2022-01-05T21:00:00.000Z",
  "pickupDescription": null,
  "pickupImageUrl": null,
  "pickupTravellingDistance": 50300,
  "returnedAt": "2022-01-05T21:00:00.000Z",
  "returnedDescription": null,
  "returnedImageUrl": null,
  "returnedTravellingDistance": 50600,
  "travellingDistance": 300,
  "employee": {
    "id": "YTNhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE="
  },
  "vehicle": {
    "id": "YTNhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE="
  }
}

Solicitação de serviço

Uma solicitação de serviço é, basicamente, um pedido de atendimento, ele pode ser um novo negócio, um problema de um cliente já existente e entre outras utilizações.

Parâmetros

É possível visualizar as solicitações de serviço via Painel de gestão pelo link: https://app.fieldcontrol.com.br/#/chamados-e-oportunidades

A propriedade equipments tem seus valores populados somente em solicitações que tem como origem o sistema de Gestão de fornecedores ou a Área do Cliente.

Criar uma solicitação de serviço

Cria uma nova solicitação de serviço.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para criação de uma solicitação de serviço:

curl -X POST https://carchost.fieldcontrol.com.br/tickets \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Luiz Freneda",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
    "subject": "Manutenção preventiva",
    "external": {
      "id": "e33876bc-7707-4108-a684-33a7c9bdc24b"
    },
    "contact": {
      "email": "email@fieldcontrol.com.br",
      "phone": "11963427191"
    },
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "M2JlYTAyNDctODAyNC00Mzc5LTkwNWQtYTM5ZWRhYWMzM2NmOjE=",
  "name": "Luiz Freneda",
  "status": "pending",
  "createdAt": "2024-11-25T18:00:00.386Z",
  "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
  "subject": "Manutenção preventiva",
  "external": {
    "id": "e33876bc-7707-4108-a684-33a7c9bdc24b"
  },
  "contact": {
    "email": "email@fieldcontrol.com.br",
    "phone": "11963427191"
  },
  "archived": false,
  "customer": null,
  "service": null,
  "location": null,
  "equipments": []
}

A seguir um exemplo de requisição para criação de uma solicitação de serviço com identifier:

curl -X POST https://carchost.fieldcontrol.com.br/tickets \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Luiz Freneda",
    "identifier": "K",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
    "subject": "Manutenção preventiva",
    "external": {
      "id": null
    },
    "contact": {
      "email": "email@fieldcontrol.com.br",
      "phone": "11963427191"
    }
  }' \
  --compressed

Exemplo de resposta de sucesso com identifier:

{
  "id": "M2JlYTAyNDctODAyNC00Mzc5LTkwNWQtYTM5ZWRhYWMzM2NmOjE=",
  "name": "Luiz Freneda",
  "status": "pending",
  "createdAt": "2024-11-25T18:00:00.386Z",
  "identifier": "K",
  "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
  "subject": "Manutenção preventiva",
  "contact": {
    "email": "email@fieldcontrol.com.br",
    "phone": "11963427191"
  },
  "external": {
    "id": null
  },
  "archived": false,
  "customer": null,
  "service": null,
  "location": null,
  "equipments": []
}

A seguir um exemplo de requisição para criação de uma solicitação de serviço com id do cliente:

curl -X POST https://carchost.fieldcontrol.com.br/tickets \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Luiz Freneda",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
    "subject": "Manutenção preventiva",
    "contact": {
      "email": "email@fieldcontrol.com.br",
      "phone": "11963427191"
    },
    "customer": {
      "id": "MTox"
    }
  }' \
  --compressed

Exemplo de resposta de sucesso com id do cliente:

{
  "id": "M2JlYTAyNDctODAyNC00Mzc5LTkwNWQtYTM5ZWRhYWMzM2NmOjE=",
  "name": "Luiz Freneda",
  "status": "pending",
  "createdAt": "2024-11-25T18:00:00.386Z",
  "external": {
    "id": null
  },
  "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
  "subject": "Manutenção preventiva",
  "contact": {
    "email": "email@fieldcontrol.com.br",
    "phone": "11963427191"
  },
  "archived": false,
  "customer": {
    "id": "MTox"
  },
  "equipments": []
}

A seguir um exemplo de requisição para criação de uma solicitação de serviço com id do serviço:

curl -X POST https://carchost.fieldcontrol.com.br/tickets \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Luiz Freneda",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
    "subject": "Manutenção preventiva",
    "contact": {
      "email": "email@fieldcontrol.com.br",
      "phone": "11963427191"
    },
    "service": {
      "id": "MTox"
    }
  }' \
  --compressed

A seguir um exemplo de requisição para criação de uma solicitação de serviço com id da localização:

curl -X POST https://carchost.fieldcontrol.com.br/tickets \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Luiz Freneda",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
    "subject": "Manutenção preventiva",
    "contact": {
      "email": "email@fieldcontrol.com.br",
      "phone": "11963427191"
    },
    "customer": {
      "id": "MTox"
    },
    "location": {
      "id": "ZTE2N2Q3MjctODk4OS00MTY3LTg5ZGMtMTI5NmQxM2VjYTQ5OjE=",
    },
  }' \
  --compressed

Exemplo de resposta de sucesso com id do serviço:

{
  "id": "M2JlYTAyNDctODAyNC00Mzc5LTkwNWQtYTM5ZWRhYWMzM2NmOjE=",
  "name": "Luiz Freneda",
  "status": "pending",
  "createdAt": "2024-11-25T18:00:00.386Z",
  "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
  "subject": "Manutenção preventiva",
  "contact": {
    "email": "email@fieldcontrol.com.br",
    "phone": "11963427191"
  },
  "archived": false,
  "customer": {
    "id": "MTox"
  },
  "equipments": []
}

A seguir um exemplo de requisição para criação de uma solicitação de serviço com id externo:

curl -X POST https://carchost.fieldcontrol.com.br/tickets \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Luiz Freneda",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
    "external": {
      "id": null
    },
    "subject": "Manutenção preventiva",
    "contact": {
      "email": "email@fieldcontrol.com.br",
      "phone": "11963427191"
    },
    "customer": {
      "id": "MTox"
    },
    "location": {
      "id": "ZTE2N2Q3MjctODk4OS00MTY3LTg5ZGMtMTI5NmQxM2VjYTQ5OjE=",
    },
  }' \
  --compressed

Exemplo de resposta de sucesso com id externo:

{
  "id": "M2JlYTAyNDctODAyNC00Mzc5LTkwNWQtYTM5ZWRhYWMzM2NmOjE=",
  "name": "Luiz Freneda",
  "status": "pending",
  "createdAt": "2024-11-25T18:00:00.386Z",
  "external": {
    "id": "d7a9dd0b-730c-4182-82c0-1ac80e0c8a4d"
  },
  "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
  "subject": "Manutenção preventiva",
  "contact": {
    "email": "email@fieldcontrol.com.br",
    "phone": "11963427191"
  },
  "archived": false,
  "customer": {
    "id": "MTox"
  },
  "equipments": []
}

Recuperar uma solicitação de serviço

Recupera uma solicitação de serviço existente por id

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar uma solicitação de serviço:

curl -X GET https://carchost.fieldcontrol.com.br/tickets/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "ZTg1ZGRkYjctNWU0NS00MDg3LWIxODgtNTVjNGNmNTQ2NWFlOjE=",
  "name": "Luiz Freneda",
  "status": "pending",
  "createdAt": "2024-11-25T18:00:00.386Z",
  "external": {
    "id": null
  },
  "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada.",
  "subject": "Manutenção preventiva",
  "contact": {
    "email": "email@fieldcontrol.com.br",
    "phone": "11963427191"
  },
  "archived": false,
  "customer": {
    "id":  "MTox"
  },
  "service": {
    "id": "MzAwOjE="
  },
  "location": {
    "id": "ZTE2N2Q3MjctODk4OS00MTY3LTg5ZGMtMTI5NmQxM2VjYTQ5OjE=",
  },
  "equipments": [
    {
      "number": "1997",
      "qrCode": "58079516-198e-4227-9430-c77286c7f2a3"
    }
  ]
}

Atualizar uma solicitação de serviço

Atualiza uma solicitação de serviço existente

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualização de uma solicitação de serviço:

curl -X PUT https://carchost.fieldcontrol.com.br/tickets/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Renan",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
    "external": {
      "id": "8ee186e5-4a7b-4cd2-bad1-01aacefdf49f"
    },
    "subject": "Manutenção mensal",
    "contact": {
      "email": "renan@field.com.br",
      "phone": "17993528763"
    },
    "archived": false
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "M2JlYTAyNDctODAyNC00Mzc5LTkwNWQtYTM5ZWRhYWMzM2NmOjE=",
  "name": "Renan",
  "status": "pending",
  "createdAt": "2024-11-25T18:00:00.386Z",
  "external": {
    "id": "8ee186e5-4a7b-4cd2-bad1-01aacefdf49f"
  },
  "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.",
  "subject": "Manutenção mensal",
  "contact": {
    "email": "renan@field.com.br",
    "phone": "17993528763"
  },
  "archived": false,
  "customer": null,
  "service": null,
  "location": null,
  "equipments": []
}

Listar solicitações de serviço

Lista solicitações de serviço existentes

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de solicitações de serviço:

Ordenações disponíveis para a listagem de solicitações de serviço:

Exemplo de requisição para recuperar lista de solicitações de serviço:

curl -X GET https://carchost.fieldcontrol.com.br/tickets \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "MTgxYzhmMzQtMGJjMC00ODQwLWI5OTEtMDFlNzFjMWM5Nzk0OjE=",
      "name": "Eduardo Zagari",
      "status": "pending",
      "createdAt": "2024-11-25T18:00:00.386Z",
      "external": {
        "id": null
      },
      "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "subject": "Limpeza",
      "identifier": "15987264",
      "contact": {
        "email": "eduardo.zagari@fieldcontrol.com.br",
        "phone": "11963427098"
      },
      "archived": false,
      "customer": null,
      "service": null,
      "location": null,
      "equipments": []
    },
    {
      "id": "MWEwMWQzYjItZDcwMC00MjYzLTljNTktNDI0ZWMwMTFkYmRhOjE=",
      "name": "Nicola Zagari",
      "status": "pending",
      "createdAt": "2024-11-25T18:05:36.386Z",
      "external": {
        "id": null
      },
      "message": "Bacon ipsum dolor amet shoulder leberkas tenderloin cupim. Meatball chuck turkey biltong short loin. Boudin burgdoggen alcatra, pork belly flank ground round sausage frankfurter doner pig ham hock spare ribs drumstick.",
      "subject": "Limpeza",
      "identifier": "15987266",
      "contact": {
        "email": "zagari@fieldcontrol.com.br",
        "phone": "11963427098"
      },
      "archived": false,
      "customer": null,
      "service": null,
      "location": null,
      "equipments": []
    }
  ],
  "totalCount": 2
}

Atividades

Atividades são os registros das visitas e serviços realizados aos clientes.

Na prática, funciona assim: dado uma ordem de serviço, agora é preciso agendar o atendimento até o local da prestação de serviço (cadastrado na OS).

É necessário atribuir uma data, opcionalmente um horário e um colaborador. As atividades são enviadas para os celulares dos técnicos formando sua agenda de atendimento. Vale ressaltar que é possível criar uma ou mais atividades (visitas) para a mesma ordem de serviço.

Parâmetros

Atenção: As propriedades com * são obrigatórias

Recuperar uma atividade

Recupera uma atividade existente pelo identificador

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar uma atividade:

curl -X GET https://carchost.fieldcontrol.com.br/tasks/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "YTNhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
  "duration": 60,
  "position": 1,
  "archived": false,
  "status": "scheduled",
  "startedAt": null,
  "completedAt": null,
  "description": null,
  "statusDescription": null,
  "order": {
    "id": "MTox"
  },
  "employee": {
    "id": "Mzox"
  },
  "scheduling": {
    "type": "scheduled-date",
    "date": null,
    "time": null
  },
  "coords": {
    "latitude": -23.573005,
    "longitude": -46.695866
  },
  "startCoords": {
    "latitude:": -25.576005,
    "longitude": -46.965874
  },
  "completeCoords": {
    "latitude:": -25.585005,
    "longitude": -46.965974
  },
  "createdAt": "2020-05-30T09:23:14Z",
  "updatedAt": "2020-05-30T09:23:14Z",
  "receivedAt": "2020-05-30T09:24:36Z",
  "viewedAt": "2020-05-30T09:30:12Z"
}

Listar atividades

Lista atividades

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de atividades:

Exemplo de requisição para recuperar lista de atividades:

curl -X GET https://carchost.fieldcontrol.com.br/tasks \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "NzFhYzUxNjYtNDNmYS00MGY4LWE1ZmMtOTE1MjZmNjJmZWM1OjE=",
      "duration": 60,
      "position": 1,
      "archived": false,
      "status": "scheduled",
      "startedAt": null,
      "completedAt": null,
      "description": null,
      "statusDescription": null,
      "order": {
        "id": "MTox"
      },
      "employee": {
        "id": "Mzox"
      },
      "scheduling": {
        "type": "scheduled-date",
        "date": null,
        "time": null
      },
      "coords": {
        "latitude": -23.573005,
        "longitude": -46.695866
      },
      "startCoords": {
        "latitude": -23.573664,
        "longitude": -46.695987
      },
      "completeCoords": {
        "latitude": -24.569745,
        "longitude": -47.594578
      },
      "createdAt": "2020-03-26T09:37:15Z",
      "updatedAt": "2020-05-30T09:23:14Z",
      "receivedAt": null,
      "viewedAt": null
    },
    {
      "id": "YTNhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
      "duration": 60,
      "position": 1,
      "archived": false,
      "status": "scheduled",
      "startedAt": null,
      "completedAt": null,
      "description": null,
      "statusDescription": null,
      "order": {
        "id": "MTox"
      },
      "employee": {
        "id": "Mzox"
      },
      "scheduling": {
        "type": "scheduled-date",
        "date": null,
        "time": null
      },
      "coords": {
        "latitude": -23.573005,
        "longitude": -46.695866
      },
       "startCoords": {
        "latitude:": -25.576005,
        "longitude": -46.965874
      },
      "completeCoords": {
        "latitude:": -25.585005,
        "longitude": -46.965974
      },
      "createdAt": "2020-02-25T12:56:00Z",
      "updatedAt": "2020-05-30T09:23:14Z",
      "receivedAt": null,
      "viewedAt": null
    }
  ],
  "totalCount": 2
}

Valores disponíveis para ordenação de resultados:

Colaboradores secundários

Colaboradores secundários são os demais colaboradores além do colaborador principal de uma atividade.

Para atualizar os colaboradores secundários são utilizadas, uma de adição de um colaborador como secundário e outra de remoção de um colaborador secundário, a adição possui algumas regras que também são validadas ao atualizar uma atividade normalmente:

• Não se pode adicionar colaboradores secundários sem um primário e não se pode remover o primário se houver secundários
• Os colaboradores secundários devem ser únicos
• O colaborador principal não pode ser o mesmo de algum dos secundários
• Todos os colaboradores secundários devem possuir identificadores válidos e que existam em sua conta

Parâmetros

Atenção: As propriedades com * são obrigatórias

Listar Colaboradores secundários de uma Atividade

Liste todas os colaboradores secundários da ordem de serviço.

Exemplo de requisição para listagem de colaboradores secundários:

curl -X GET https://carchost.fieldcontrol.com.br/tasks/:task_id/secondary-employees \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "NDox"
    },
    {
      "id": "MTox"
    }
  ],
  "totalCount": 2
}

Adicionar colaborador secundário a uma atividade

Adiciona um colaborador secundário a uma atividade existente

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para adição de um colaborador secundário de uma atividade:

curl -X POST https://carchost.fieldcontrol.com.br/tasks/:task_id/secondary-employees/:employee_id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "MTox",
  "name": "Colaborador Teste",
  "email": "teste@teste.com",
  "avatarUrl": null,
  "isActive": true,
  "createdAt": "2025-04-14T23:22:57.632Z"
}

Remover colaborador secundário de uma atividade

Remove um colaborador secundário de uma atividade existente

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para remoção de um colaborador secundário de uma atividade:

curl -X DELETE https://carchost.fieldcontrol.com.br/tasks/:task_id/secondary-employees/:employee_id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Resposta de sucesso não possui informações no corpo da mensagem

Tipos de OS

Tipos de OS são serviços prestados pela empresa. Exemplos: instalação, manutenção, reparo, etc..

Parâmetros

Usuários com perfil de administrador podem gerenciar os tipos de OSs no Painel de gestão pelo link: https://app.fieldcontrol.com.br/#/tipos-de-os

Criar um tipo de OS

Cria um novo tipo de OS

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para criação de um tipo de OS:

curl -X POST https://carchost.fieldcontrol.com.br/services \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Instalação manual",
    "duration": 120
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "MzUxMzE6MjI5MTU=",
  "name": "Reparo",
  "duration": 120,
  "archived": false
}

Recuperar um tipo de OS

Recupera um tipo de OS existente por id

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar um tipo de OS:

curl -X GET https://carchost.fieldcontrol.com.br/services/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "MzA0ODY6MjI5MTU=",
  "name": "Reforma",
  "duration": 240,
  "archived": false
}

Atualizar um tipo de OS

Atualiza um tipo de OS existente

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualização de um tipo de OS:

curl -X PUT https://carchost.fieldcontrol.com.br/services/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "name": "Reforma",
    "duration": 240
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "MzA0ODY6MjI5MTU=",
  "name": "Reforma",
  "duration": 240,
  "archived": false
}

Listar tipos de OS

Lista tipos de OS existentes

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de tipos de OS:

Exemplo de requisição para recuperar lista de tipos de OS:

curl -X GET https://carchost.fieldcontrol.com.br/services \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "MzA0ODY6MjI5MTU=",
      "name": "Reforma",
      "duration": 240,
      "archived": false
    }
  ],
  "totalCount": 1
}

Ordem de Serviço (OS)

Uma ordem de serviço é a formalização do serviço a ser prestado.

Na prática, funciona assim: o cliente chega até você com uma demanda, solicita um orçamento, há uma negociação e, assim que ela é concluída, é preciso emitir uma OS para organizar internamente o trabalho a ser realizado.

O conteúdo de uma OS varia conforme a atividade exercida por sua empresa e o próprio serviço que será executado. Mas há algumas informações básicas e essenciais presentes em todo documento. Veja quais são elas:

• Número da ordem de serviço
• Dados do cliente
• Serviço a ser realizado
• Data de emissão.

Parâmetros

Criar uma ordem de serviço

Cria uma nova ordem de serviço.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Para criar uma ordem de serviço, é necessário criar ao menos uma atividade.

Exemplo de requisição para criação de uma ordem de serviço:

curl -X POST https://carchost.fieldcontrol.com.br/orders \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "identifier": "695860",
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada.",
    "external": {
      "id": null
    },
    "customer": {
      "id": "MTox"
    },
    "service": {
      "id": "MTox"
    },
    "address": {
      "zipCode": "05005900",
      "city": "Sao Paulo",
      "state": "SP",
      "street": "Rua Turiassu",
      "number": "902",
      "complement": null,
      "neighborhood": null,
      "coords": {
        "latitude": -23.52702,
        "longitude": -46.680823
      }
    },
    "metadata": {
      "shagrat": {
        "a": 1,
        "b": true
      },
    },
    "tasks": [
      {
        description: null,
        "employee": {
          "id": "MTAxOjE="
        },
        "status": "done",
        "duration": 30,
        "scheduling": {
          "date": "2019-08-20",
          "time": "15:00:00"
        },
        "coords": {
          "latitude": -23.52702,
          "longitude": -46.680823
        }
      }
    ],
    "location": {
      "id": "NDUwODQ4MDQtNGZjNS00MTY1LTliYWEtYTU1NDA2MzEwNDNmOjE="
    },
    "deadlineContract": {
      "id": "YTUhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE="
    }
  }' \
  --compressed

Para facilitar, é possível definir um cliente (customer) e/ou um tipo de OS (service) e/ou uma localização do cliente (location) por nome na requisição.

Exemplo de requisição para criação de uma ordem de serviço com cliente (customer) e tipo de OS (service) definidos por nome:

curl -X POST https://carchost.fieldcontrol.com.br/orders \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "identifier": "695860",
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada.",
    "external": {
      "id": null
    },
    "customer": {
      "name": "Luiz Freneda"
    },
    "service": {
      "name": "Instalação de Ar Condicionado"
    },
    "address": {
      "zipCode": "05005900",
      "city": "Sao Paulo",
      "state": "SP",
      "street": "Rua Turiassu",
      "number": "902",
      "complement": null,
      "neighborhood": null,
      "coords": {
        "latitude": -23.52702,
        "longitude": -46.680823
      }
    },
    "tasks": [
      {
        description: null,
        "employee": {
          "id": "MTAxOjE="
        },
        "status": "done",
        "duration": 30,
        "scheduling": {
          "date": "2019-08-20",
          "time": "15:00:00"
        },
        "coords": {
          "latitude": -23.52702,
          "longitude": -46.680823
        }
      }
    ],
    "location": {
      "name": "Sede São Paulo"
    }
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjE=",
  "identifier": "695860",
  "description": "Pork chop salami sausage bresaola turkey. Picanha tri-tip turkey, pork loin rump salami strip steak hamburger kevin cow.",
  "link": "https://app.fieldcontrol.com.br/relacionamento-cliente/#/relatorio/c0a43e7d-3630-44ab-988d-ab9c693b7b29",
  "archived": false,
  "external": {
    "id": null
  },
  "customer": {
    "id": "MTox"
  },
  "service": {
    "id": "MTox"
  },
  "address": {
    "zipCode": "05005900",
    "city": "Sao Paulo",
    "state": "SP",
    "street": "Rua Turiassu",
    "number": "902",
    "complement": null,
    "neighborhood": null,
    "coords": {
      "latitude": -23.52702,
      "longitude": -46.680823
    }
  },
  "createdAt": "2020-06-12T12:00:15Z",
  "tasks": [
    {
      "order": {
        "id": "ZmY1Y2MwOWQtNjAzZi00NmQxLWJiYjUtNDE1OGU3MTEzNmQ1OjE="
      },
      "description": "Short ribs spare ribs rump, dale.",
      "employee": {
        "id": "MTAxOjE="
      },
      "status": "done",
      "startedAt": "2020-02-29T11:38:54Z",
      "completedAt": "2020-02-29T12:12:26Z",
      "duration": 30,
      "scheduling": {
        "date": "2019-08-20",
        "time": "15:00:00"
      },
      "coords": {
        "latitude": -23.52702,
        "longitude": -46.680823
      },
      "updatedAt": "2020-02-29T12:12:26Z"
    }
  ],
  "location": {
    "id": "NDUwODQ4MDQtNGZjNS00MTY1LTliYWEtYTU1NDA2MzEwNDNmOjE="
  },
  "updatedAt": "2020-02-29T12:12:26Z"
}

Recuperar uma ordem de serviço

Recupera uma ordem de serviço existente por id

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar uma ordem de serviço:

curl -X GET https://carchost.fieldcontrol.com.br/orders/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "NTVlMzYxMTktZWJiZi00YmE5LTkzM2YtM2Q5MWU1NjlmMjliOjE=",
  "identifier": "695861",
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar.",
  "archived": false,
  "external": {
    "id": "55ffbc10-db39-42d7-9bd8-6ccafe4740e2"
  },
  "link": "https://app.fieldcontrol.com.br/relacionamento-cliente/#/relatorio/42b1d4c4-9cf8-45a6-8622-b3c76cf942c8",
  "customer": {
    "id": "MTox"
  },
  "service": {
    "id": "MTox"
  },
  "address": {
    "zipCode": "05005900",
    "city": "Sao Paulo",
    "state": "SP",
    "street": "Rua Turiassu",
    "number": "902",
    "complement": null,
    "neighborhood": null,
    "coords": {
      "latitude": -23.527028,
      "longitude": -46.680823
    }
  },
  "createdAt": "2020-06-12T13:20:15Z",
  "updatedAt": "2020-02-29T12:12:26Z",
  "location": {
    "id": "NDUwODQ4MDQtNGZjNS00MTY1LTliYWEtYTU1NDA2MzEwNDNmOjE="
  }
}

Atualizar uma ordem de serviço

Atualiza uma ordem de serviço existente

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualização de uma ordem de serviço:

curl -X PUT https://carchost.fieldcontrol.com.br/orders/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "identifier": "695869",
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada.",
    "external": {
      "id": "360fddc7-721d-499a-8d40-9b3b6ce41a97"
    },
    "customer": {
      "id": "MTox"
    },
    "service": {
      "id": "MTox"
    },
    "address": {
      "zipCode": "15057560",
      "street": "Avenida Brasil",
      "number": "898",
      "neighborhood": null,
      "complement": null,
      "city": "Rio de Janeiro",
      "state": "RJ",
      "coords": {
        "latitude": -23.573005,
        "longitude": -46.695866
      }
    }
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NTVlMzYxMTktZWJiZi00YmE5LTkzM2YtM2Q5MWU1NjlmMjliOjE=",
  "identifier": "695869",
  "external": {
    "id": "360fddc7-721d-499a-8d40-9b3b6ce41a97"
  },
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada.",
  "archived": false,
  "link": "https://app.fieldcontrol.com.br/relacionamento-cliente/#/relatorio/42b1d4c4-9cf8-45a6-8622-b3c76cf942c8",
  "customer": {
    "id": "MTox"
  },
  "service": {
    "id": "MTox"
  },
  "address": {
    "zipCode": "15057560",
    "street": "Avenida Brasil",
    "number": "898",
    "neighborhood": null,
    "complement": null,
    "city": "Rio de Janeiro",
    "state": "RJ",
    "coords": {
      "latitude": -23.573005,
      "longitude": -46.695866
    }
  },
  "metadata": {
    "shagrat": {
      "a": 1
    },
  },
  "createdAt": "2020-06-12T16:00:00Z",
  "updatedAt": "2020-02-29T12:12:26Z",
  "location": {
    "id": "NDUwODQ4MDQtNGZjNS00MTY1LTliYWEtYTU1NDA2MzEwNDNmOjE="
  }
}

Listar ordens de serviço

Lista ordens de serviço existentes

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de ordens de serviço:

Exemplo de requisição para recuperar lista de ordens de serviço:

curl -X GET https://carchost.fieldcontrol.com.br/orders \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "MDRlYjVjY2YtZjBmZC00NjBjLTk2NWItOWI3MDBiNGJiYjgxOjE=",
      "identifier": "695865",
      "archived": false,
      "description": null,
      "external": {
        "id": null
      },
      "link": "https://app.fieldcontrol.com.br/relacionamento-cliente/#/relatorio/42b1d4c4-9cf8-45a6-8622-b3c76cf942c8",
      "customer": {
        "id": "MTox"
      },
      "service": {
        "id": "MTox"
      },
      "ticket": {
        "id": "MTox"
      },
      "address": {
        "zipCode": "15085480",
        "street": "Rua dos Pinheiros",
        "number": "383",
        "neighborhood": null,
        "complement": null,
        "city": "Sao paulo",
        "state": "SP",
        "coords": {
          "latitude": -23.573005,
          "longitude": -46.695866
        }
      },
      "metadata": {
        "shagrat": {
          "a": 1,
          "b": true
        },
      },
      "createdAt": "2020-06-12T12:00:15Z",
      "updatedAt": "2020-02-29T12:12:26Z",
      "location": {
        "id": "NDUwODQ4MDQtNGZjNS00MTY1LTliYWEtYTU1NDA2MzEwNDNmOjE="
      },
      "deadlineContract": {
        "id": "YTUhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE="
      }
    },
    {
      "id": "MDRlYjVjY2YtZjBmZC00NjBjLTk2NWItOWI3MDBiNGJiYjgyOjE=",
      "identifier": "695866",
      "description": null,
      "archived": false,
      "external": {
        "id": null
      },
      "customer": {
        "id": "MTox"
      },
      "service": {
        "id": "MTox"
      },
      "ticket": {
        "id": "MTox"
      },
      "address": {
        "zipCode": "15085480",
        "street": "Rua dos Pinheiros",
        "number": "383",
        "neighborhood": null,
        "complement": null,
        "city": "Sao paulo",
        "state": "SP",
        "coords": {
          "latitude": -23.573005,
          "longitude": -46.695866
        }
      },
      "metadata": {
        "shagrat": {
          "a": 1
        },
      },
      "createdAt": "2020-06-12T12:00:15Z",
      "updatedAt": "2020-02-29T12:12:26Z",
      "location": {
        "id": "NzRkMDgyYWMtNDQ0YS00Zjc3LTg5NjMtOTZlOTFjMzlmOTdkOjE="
      },
      "deadlineContract": null
    }
  ],
  "totalCount": 205
}

Valores disponíveis para ordenação de resultados:

Criar uma atividade

Cria uma nova atividade para ordem de serviço.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para criação de uma atividade:

curl -X POST https://carchost.fieldcontrol.com.br/orders/:order_id/tasks \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "duration": 120,
    "position": 1,
    "status": "reported",
    "statusDescription": "O associado não atende as ligações",
    "description": null,
    "employee": {
      "id": "MTox"
    },
    "scheduling": {
      "type": "scheduled-date",
      "date": "2019-07-01"
    },
    "coords": {
      "latitude": -20.811812,
      "longitude": -49.382726
    }
  }' \
  --compressed

Na criação da atividade é possível definir o colaborador (employee) por nome na requisição.

Exemplo de requisição para criação de uma atividade com colaborador (employee) definido por nome:

curl -X POST https://carchost.fieldcontrol.com.br/orders/:order_id/tasks \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "duration": 120,
    "position": 1,
    "status": "done",
    "description": null,
    "employee": {
      "name": "Ronaldo Gaúcho"
    },
    "scheduling": {
      "type": "scheduled-date",
      "date": "2019-07-01"
    },
    "coords": {
      "latitude": -20.811812,
      "longitude": -49.382726
    }
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "ZDk5MDVmYTAtYzRhOC00MTY4LWI5NjgtNTUxZDJjZTIyN2ZmOjIyOTE1",
  "duration": 120,
  "position": 1,
  "status": "done",
  "archived": false,
  "startedAt": "2020-02-29T11:38:54Z",
  "completedAt": "2020-02-29T12:12:26Z",
  "statusDescription": null,
  "ratingLink": "https://app.fieldcontrol.com.br/relacionamento-cliente/#/avaliacao-do-atendimento/251d5676-232f-407f-90ef-f25ecfa64621",
  "order": {
    "id": "MTox"
  },
  "description": null,
  "employee": {
    "id": "NDoyMjkxNQ=="
  },
  "scheduling": {
    "type": "scheduled-date",
    "date": "2019-07-01",
    "time": null
  },
  "coords": {
    "latitude": -20.811812,
    "longitude": -49.382726
  },
  "createdAt": "2020-06-13T18:25:00Z",
  "receivedAt": null,
  "viewedAt": null
}

Recuperar uma atividade de uma OS

Recupera uma atividade de uma ordem de serviço

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar uma atividade:

curl -X GET https://carchost.fieldcontrol.com.br/orders/:order_id/tasks/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "YTNhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
  "duration": 60,
  "position": 1,
  "archived": false,
  "status": "scheduled",
  "startedAt": null,
  "completedAt": null,
  "statusDescription": null,
  "order": {
    "id": "MTox"
  },
  "description": null,
  "employee": {
    "id": "Mzox"
  },
  "scheduling": {
    "type": "scheduled-date",
    "date": null,
    "time": null
  },
  "coords": {
    "latitude": -23.573005,
    "longitude": -46.695866
  },
  "createdAt": "2020-05-30T09:23:14Z",
  "receivedAt": "2020-05-30T09:32:48Z",
  "viewedAt": null
}

Atualizar uma atividade

Atualiza uma atividade existente de uma ordem de serviço

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para atualização de uma atividade:

curl -X POST https://carchost.fieldcontrol.com.br/orders/:order_id/tasks/:id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "duration": 120,
    "position": 1,
    "status": "done",
    "description": null,
    "employee": {
      "name": "Ronaldo Gaúcho"
    },
    "scheduling": {
      "type": "scheduled-date",
      "date": "2019-07-01"
    },
    "coords": {
      "latitude": -20.811812,
      "longitude": -49.382726
    }
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "ZDk5MDVmYTAtYzRhOC00MTY4LWI5NjgtNTUxZDJjZTIyN2ZmOjIyOTE1",
  "duration": 120,
  "position": 1,
  "archived": false,
  "status": "done",
  "startedAt": "2020-02-29T11:38:54Z",
  "completedAt": "2020-02-29T12:12:26Z",
  "statusDescription": null,
  "ratingLink": "https://app.fieldcontrol.com.br/relacionamento-cliente/#/avaliacao-do-atendimento/1b80618e-2197-488a-9e07-06e97de0e61b",
  "order": {
    "id": "MTox"
  },
  "description": null,
  "employee": {
    "id": "NDoyMjkxNQ=="
  },
  "scheduling": {
    "type": "scheduled-date",
    "date": "2019-07-01",
    "time": null
  },
  "coords": {
    "latitude": -20.811812,
    "longitude": -49.382726
  },
  "createdAt": "2020-04-01T10:40:39Z",
  "receivedAt": "2020-04-01T10:42:48Z",
  "viewedAt": null
}

Listar atividades de uma OS

Lista atividades de uma ordem de serviço

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Filtros disponíveis para a listagem de atividades:

Exemplo de requisição para recuperar lista de atividades:

curl -X GET https://carchost.fieldcontrol.com.br/orders/:order_id/tasks \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "NzFhYzUxNjYtNDNmYS00MGY4LWE1ZmMtOTE1MjZmNjJmZWM1OjE=",
      "duration": 60,
      "position": 1,
      "archived": false,
      "status": "scheduled",
      "startedAt": null,
      "completedAt": null,
      "statusDescription": null,
      "order": {
        "id": "MTox"
      },
      "description": null,
      "employee": {
        "id": "Mzox"
      },
      "scheduling": {
        "type": "scheduled-date",
        "date": null,
        "time": null
      },
      "coords": {
        "latitude": -23.573005,
        "longitude": -46.695866
      },
      "createdAt": "2020-03-26T09:37:15Z",
      "receivedAt": null,
      "viewedAt": null
    },
    {
      "id": "YTNhYjFmOGEtYTU4MS00OTg0LWJkOTYtNjhmYWIwNzI5OWRhOjE=",
      "duration": 60,
      "position": 1,
      "archived": false,
      "status": "scheduled",
      "startedAt": null,
      "completedAt": null,
      "statusDescription": null,
      "order": {
        "id": "MTox"
      },
      "description": null,
      "employee": {
        "id": "Mzox"
      },
      "scheduling": {
        "type": "scheduled-date",
        "date": null,
        "time": null
      },
      "coords": {
        "latitude": -23.573005,
        "longitude": -46.695866
      },
      "createdAt": "2020-02-25T12:56:00Z",
      "receivedAt": null,
      "viewedAt": null
    }
  ],
  "totalCount": 2
}

Valores disponíveis para ordenação de resultados:

Recuperar um formulário

Formulários são informações estruturadas por perguntas e respostas usadas para coletar e organizar informações sobre uma ordem de serviço

Parâmetros

Recupera um formulário respondido existente por id

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar um formulário:

curl -X GET https://carchost.fieldcontrol.com.br/orders/:order_id/forms/ZTg1ZGRkYjctNWU0NS00MDg3LWIxODgtNTVjNGNmNTQ2NWFlOjE= \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "id": "NzU4MjJmYWItY2M0My00MWJlLWE1N2UtN2YzYjZlN2IxZDIxOjE=",
  "name": "Instalação de Internet",
  "archived": false,
  "score": 10,
  "order": {
    "id": "DzU5tjJmYWItY2M0My00MWJlLWE1N2UtN2YzYjZlN2IxZDIxOjE="
  }
  "questions": [
    {
      "type": "multiple-choice",
      "position": 1,
      "required": true,
      "title": "Qual era o meio de acesso à internet que o cliente possuía?",
      "answer": "Fibra Ótica",
      "options": [
        {
          "position": 1,
          "value": "ADSL",
          "score": null
        },
        {
          "position": 2,
          "value": "Fibra Ótica",
          "score": 10
        },
        {
          "position": 3,
          "value": "Via Rádio",
          "score": 5
        }
      ],
      "conditions": []
    },
    {
      "type": "short-answer",
      "position": 2,
      "required": false,
      "title": "Qual era a operadora de internet?",
      "answer": "NET",
      "conditions": [
        {
        "question": {
          "title": "Qual era o meio de acesso à internet que o cliente possuía?"
        },
        "condition": "equal",
        "value": "ADSL"
        }
      ]
    }
  ]
}

Listar formulários

Lista formulários respondidos existentes para uma ordem de serviço

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar lista de formulários de uma ordem de serviço:

curl -X GET https://carchost.fieldcontrol.com.br/orders/:order_id/forms \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'

Exemplo de resposta de sucesso:

{
  "items": [
    {
      "id": "MDNiNDdhYTgtNzAxNC00NGEzLWJhYjItMTRjMjBjODQ1YTViOjE=",
      "name": "Instalação de ar-condicionado",
      "archived": false,
      "createdAt": "2019-08-07T11:10:45.366Z",
      "order": {
        "id": "DzU5tjJmYWItY2M0My00MWJlLWE1N2UtN2YzYjZlN2IxZDIxOjE="
      }
    },
    {
      "id": "NTA3ZjFiMWYtZDUzZC00MTdkLWFkMzAtNDE4ZjA2ZmZhYjQxOjE=",
      "name": "Instalação de internet",
      "archived": false,
      "createdAt": "2019-08-07T13:21:23.337Z",
      "order": {
        "id": "DzU5tjJmYWItY2M0My00MWJlLWE1N2UtN2YzYjZlN2IxZDIxOjE="
      }
    }
  ],
  "totalCount": 2
}

Inserir equipamentos em uma OS

Insere um equipamento em uma ordem de serviço.

Parâmetros

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para inserção de um equipamento em uma OS:

curl -X POST https://carchost.fieldcontrol.com.br/orders/:order_id/equipments \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here' \
  --data-binary \
  '{
    "equipment": {
      "id": "NjAwNzc0NDEtMDZkNS00MDJkLWFiNzMtMTFmMmZhNzQ2MGRmOjIxNjQ1"
    }
  }' \
  --compressed

Exemplo de resposta de sucesso:

{
  "id": "NjAwNzc0NDEtMDZkNS00MDJkLWFiNzMtMTFmMmZhNzQ2MGRmOjIxNjQ1",
  "name": "Venax FI109",
  "number": "4as57n9c7",
  "notes": "Localizado no centro da cozinha",
  "archived": false,
  "qrCode": "5f40c7a6-3889-4b5c-afc2-8484af60bae6",
  "avatarUrl": null,
  "customer": {
    "id": "MTox"
  },
  "type": {
    "id": "NDFkNzk3MDctZDI3Yy00ZTM1LWJmZGQtYTNhMTUwNzEwNmNkOjE="
  },
  "locationSector": {
    "id": "NDFkNzk3MDctZDI3Yy00ZTM1LWJmZGQtYTNhMTUwNzEwNmNkOjE="
  },
  "locationEnvironment": {
    "id": "NDFkNzk3MDctZDI3Yy00ZTM1LWJmZGQtYTNhMTUwNzEwNmNkOjE="
  },
  "customFields": [
    {
      "id": "ZDRhODlmNDYtOWE1MS00Njg1LThmMGUtNmU3MTIyZTJjY2MwOjIyOTE1",
      "name": "Qual a data de fabricação do forno?",
      "value": "2020-02-19T16:40:43.671Z",
      "position": 1
    },
    {
      "id": "ZWQ0NjE5MjgtNzhkMy00Y2YyLWI4NDAtMmZjZTI2ZGE4MjVjOjIyOTE1",
      "name": "Qual a potência do forno?",
      "value": "4.5",
      "position": 2
    },
    {
      "id": "ZjM4MDAwMDMtZjc2Zi00ODdlLWJlYjMtYzQyODczZTBiYWQ3OjIyOTE1",
      "name": "Selecione a marca:",
      "value": "Venax",
      "position": 3
    }
  ],
  "createdAt": "2020-07-01T12:34:12Z"
}

Recuperar um equipamento de uma OS

Recupera um equipamento associado a uma ordem de serviço.

Para retornos com http status code 422, um objeto de erro é retornado como resposta contendo uma descrição detalhada do erro ocorrido.

Exemplo de requisição para recuperar um equipamento:

curl -X GET https://carchost.fieldcontrol.com.br/orders/:order_id/equipments/:equip_id \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'X-Api-Key: token-here'