API QWS — Lieux personnalisés

Sommaire de la documentation

Authentification — /auth, /auth/refresh
Régions, sites & groupes — /regions, /sites, /groups
Véhicules & chauffeurs — /vehicles, /drivers
Suivi en temps réel — /vehicles/live, /drivers/live
Résumés de trajets — /vehicles/tripsummary, /drivers/tripsummary
Détail des trajets — /vehicles/trips, /drivers/trips
Itinéraires détaillés — /vehicles/route, /drivers/route
Kilométrage — /vehicles/odometer
Gestion des véhicules — /vehicles/management
Lieux personnalisés — /locations
Paramètres utilisateur — /settings

/locations

GET /locations

https://qws.quartix.net/api/v2/locations?RegionID=0&SiteID=0&ExpiryStartDate=2016-07-05T16:20:30.655Z&ExpiryEndDate=2016-07-05T16:20:30.655Z

Récupère le détail des lieux personnalisés d'un client. Les deux paramètres ExpiryStartDate et ExpiryEndDate sont optionnels. Si ExpiryStartDate est fourni, seuls les lieux expirant à cette date ou après sont renvoyés. Si ExpiryEndDate est fourni, seuls les lieux expirant à cette date ou avant sont renvoyés. Si les deux sont présents, les lieux expirant dans l'intervalle de dates sont renvoyés.

Paramètres

Nom	Description	Type	Emplacement
`AccessToken`	Un jeton web JSON (JWT) contenant les informations nécessaires pour restaurer une session utilisateur. Ce paramètre peut être transmis soit dans l'en-tête (header), soit sous forme de cookie HTTPS uniquement. Une valeur de cookie remplace une valeur d'en-tête (même si elle est invalide) : par exemple, une valeur d'en-tête valide avec un cookie invalide sera ignorée au profit du cookie.	string	header
`RefreshToken`	Le jeton de rafraîchissement fourni lors de l'authentification. Ce jeton a une durée de vie plus longue que l'AccessToken et est utilisé, une fois l'AccessToken expiré, pour poursuivre la session de façon transparente. Les jetons de rafraîchissement peuvent être révoqués. Lorsqu'un jeton de rafraîchissement est utilisé, les droits d'accès de l'utilisateur sont actualisés (en cas de changement de rôle ou de permissions depuis la dernière connexion ou utilisation de l'AccessToken).	string	header
`RegionID`	La région utilisée pour filtrer les résultats.	int32	query
`SiteID`	Le site utilisé pour filtrer les résultats.	int32	query
`ExpiryStartDate`	Date de début de la plage d'expiration.	datetime	query
`ExpiryEndDate`	Date de fin de la plage d'expiration.	datetime	query

Réponses

200 — Réponse réussie

{
  "Meta": {
    "Code": 0,
    "Message": ""
  },
  "Data": [
    {
      "LocationID": 0,
      "SiteID": 0,
      "Name": "",
      "Latitude": 0.5,
      "Longitude": 0.5,
      "MaxRadius": 0,
      "ExpiryDate": "2016-07-05T16:20:30.655Z"
    }
  ]
}

400 — Requête invalide, par exemple une combinaison de paramètres ou de valeurs de paramètres non valide.

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

401 — Aucune information d'authentification n'est présente (ou elle est invalide).

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

403 — Tentative de filtrage par des valeurs non autorisées pour l'utilisateur authentifié.

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

POST /locations

https://qws.quartix.net/api/v2/locations?ExpiryDate=2016-07-05T16:20:30.655Z

Ajoute un ensemble de lieux personnalisés. Si une latitude et une longitude sont fournies pour un lieu donné de l'ensemble, cette position est utilisée. En l'absence de latitude/longitude, l'adresse fournie est recherchée. Si un lieu unique est trouvé à partir de l'adresse, il est utilisé. Si plusieurs lieux correspondants sont trouvés, ils sont renvoyés pour sélection par le client. L'ajout en base n'aura pas lieu si aucun lieu unique n'est identifié, si le même nom existe déjà pour ce SiteID, ou si le lieu existe déjà dans le rayon défini. La réponse à cet appel renvoie les ajouts demandés en deux groupes : ceux qui ont réussi, avec le LocationID, la latitude et la longitude pour un traitement ultérieur ; et ceux qui ont échoué, avec un message d'échec et, éventuellement, une liste de lieux alternatifs si l'échec est dû au fait que la recherche d'adresse a renvoyé plusieurs lieux possibles.

Paramètres

Nom	Description	Type	Emplacement
`AccessToken`	Un jeton web JSON (JWT) contenant les informations nécessaires pour restaurer une session utilisateur. Ce paramètre peut être transmis soit dans l'en-tête (header), soit sous forme de cookie HTTPS uniquement. Une valeur de cookie remplace une valeur d'en-tête (même si elle est invalide) : par exemple, une valeur d'en-tête valide avec un cookie invalide sera ignorée au profit du cookie.	string	header
`RefreshToken`	Le jeton de rafraîchissement fourni lors de l'authentification. Ce jeton a une durée de vie plus longue que l'AccessToken et est utilisé, une fois l'AccessToken expiré, pour poursuivre la session de façon transparente. Les jetons de rafraîchissement peuvent être révoqués. Lorsqu'un jeton de rafraîchissement est utilisé, les droits d'accès de l'utilisateur sont actualisés (en cas de changement de rôle ou de permissions depuis la dernière connexion ou utilisation de l'AccessToken).	string	header
`ExpiryDate`	Date d'expiration optionnelle pour les lieux. Ceci est destiné uniquement au traitement côté client : les lieux n'expirent pas automatiquement.	datetime	query
`LocationsToAdd`	Tableau de lieux à ajouter. La validation et le succès/échec sont appliqués élément par élément. `[ { "SiteID": 0, "Name": "", "Latitude": 0.5, "Longitude": 0.5, "MaxRadius": 0, "Address": "" } ]`	tableau	body

Réponses

200 — Réponse détaillant les ajouts demandés, répartis entre ceux qui ont réussi et ceux qui ont échoué

{
  "Meta": {
    "Code": 0,
    "Message": ""
  },
  "Data": {
    "Succeeded": [
      {
        "LocationID": 0,
        "SiteID": 0,
        "Name": "",
        "Latitude": 0.5,
        "Longitude": 0.5,
        "MaxRadius": 0,
        "ExpiryDate": "2016-07-05T16:20:30.655Z"
      }
    ],
    "Failed": [
      {
        "Data": {
          "Request": [
            {
              "SiteID": 0,
              "Name": "",
              "Latitude": 0.5,
              "Longitude": 0.5,
              "MaxRadius": 0,
              "Address": ""
            }
          ],
          "Alternates": [
            {
              "LookupAddress": "",
              "Latitude": 0.5,
              "Longitude": 0.5
            }
          ]
        },
        "Meta": {
          "Code": 0,
          "Message": ""
        }
      }
    ]
  }
}

400 — Requête invalide, par exemple une combinaison de paramètres ou de valeurs de paramètres non valide.

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

401 — Aucune information d'authentification n'est présente (ou elle est invalide).

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

403 — Tentative de filtrage par des valeurs non autorisées pour l'utilisateur authentifié.

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

PUT /locations

https://qws.quartix.net/api/v2/locations

Met à jour les lieux personnalisés d'un client. Les champs non inclus dans la mise à jour conservent leur valeur antérieure. La réponse à cet appel renvoie les mises à jour demandées en deux groupes : celles qui ont réussi, et celles qui ont échoué, avec un message d'échec.

Paramètres

Nom	Description	Type	Emplacement
`AccessToken`	Un jeton web JSON (JWT) contenant les informations nécessaires pour restaurer une session utilisateur. Ce paramètre peut être transmis soit dans l'en-tête (header), soit sous forme de cookie HTTPS uniquement. Une valeur de cookie remplace une valeur d'en-tête (même si elle est invalide) : par exemple, une valeur d'en-tête valide avec un cookie invalide sera ignorée au profit du cookie.	string	header
`RefreshToken`	Le jeton de rafraîchissement fourni lors de l'authentification. Ce jeton a une durée de vie plus longue que l'AccessToken et est utilisé, une fois l'AccessToken expiré, pour poursuivre la session de façon transparente. Les jetons de rafraîchissement peuvent être révoqués. Lorsqu'un jeton de rafraîchissement est utilisé, les droits d'accès de l'utilisateur sont actualisés (en cas de changement de rôle ou de permissions depuis la dernière connexion ou utilisation de l'AccessToken).	string	header
`LocationsToUpdate`	Tableau de lieux à mettre à jour. La validation et le succès/échec sont appliqués élément par élément. `[ { "LocationID": 0, "Name": "", "Latitude": 0.5, "Longitude": 0.5, "MaxRadius": 0, "ExpiryDate": "2016-07-05" } ]`	tableau	body

Réponses

200 — Réponse détaillant les ajouts demandés, répartis entre ceux qui ont réussi et ceux qui ont échoué

{
  "Meta": {
    "Code": 0,
    "Message": ""
  },
  "Data": {
    "Succeeded": [
      {
        "LocationID": 0,
        "SiteID": 0,
        "Name": "",
        "Latitude": 0.5,
        "Longitude": 0.5,
        "MaxRadius": 0,
        "ExpiryDate": "2016-07-05T16:20:30.655Z"
      }
    ],
    "Failed": [
      {
        "Request": [
          {
            "LocationID": 0,
            "Name": "",
            "Latitude": 0.5,
            "Longitude": 0.5,
            "MaxRadius": 0,
            "ExpiryDate": "2016-07-05"
          }
        ],
        "Response": {
          "ResponseCode": 0,
          "ResponseMessage": ""
        }
      }
    ]
  }
}

400 — Requête invalide, par exemple une combinaison de paramètres ou de valeurs de paramètres non valide.

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

401 — Aucune information d'authentification n'est présente (ou elle est invalide).

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

403 — Tentative de filtrage par des valeurs non autorisées pour l'utilisateur authentifié.

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

DELETE /locations

https://qws.quartix.net/api/v2/locations

Supprime un ensemble de lieux personnalisés à partir de leur LocationID. Il n'existe pas de fonction d'annulation : les lieux supprimés sont retirés définitivement de la base de données Quartix. La réponse à cet appel renvoie les suppressions demandées en deux groupes : celles qui ont réussi, et celles qui ont échoué, avec un motif d'échec.

Paramètres

Nom	Description	Type	Emplacement
`AccessToken`	Un jeton web JSON (JWT) contenant les informations nécessaires pour restaurer une session utilisateur. Ce paramètre peut être transmis soit dans l'en-tête (header), soit sous forme de cookie HTTPS uniquement. Une valeur de cookie remplace une valeur d'en-tête (même si elle est invalide) : par exemple, une valeur d'en-tête valide avec un cookie invalide sera ignorée au profit du cookie.	string	header
`RefreshToken`	Le jeton de rafraîchissement fourni lors de l'authentification. Ce jeton a une durée de vie plus longue que l'AccessToken et est utilisé, une fois l'AccessToken expiré, pour poursuivre la session de façon transparente. Les jetons de rafraîchissement peuvent être révoqués. Lorsqu'un jeton de rafraîchissement est utilisé, les droits d'accès de l'utilisateur sont actualisés (en cas de changement de rôle ou de permissions depuis la dernière connexion ou utilisation de l'AccessToken).	string	header
`LocationsToDelete`	Tableau de lieux à supprimer. La validation et le succès/échec sont appliqués élément par élément. `[ { "LocationID": 0 } ]`	tableau	body

Réponses

200 — Réponse détaillant les suppressions demandées, réparties entre celles qui ont réussi et celles qui ont échoué

{
  "Meta": {
    "Code": 0,
    "Message": ""
  },
  "Data": {
    "Succeeded": [
      {
        "LocationID": 0,
        "SiteID": 0,
        "Name": "",
        "Latitude": 0.5,
        "Longitude": 0.5,
        "MaxRadius": 0,
        "ExpiryDate": "2016-07-05T16:20:30.655Z"
      }
    ],
    "Failed": [
      {
        "Data": [
          {
            "LocationID": 0
          }
        ],
        "Meta": {
          "Code": 0,
          "Message": ""
        }
      }
    ]
  }
}

400 — Requête invalide, par exemple une combinaison de paramètres ou de valeurs de paramètres non valide.

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

401 — Aucune information d'authentification n'est présente (ou elle est invalide).

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

403 — Tentative de filtrage par des valeurs non autorisées pour l'utilisateur authentifié.

{
  "Meta": {
    "Code": 0,
    "Message": ""
  }
}

« Gestion des véhicules Paramètres utilisateur »