Objets

Référence de l'entreprise

Identifie une entreprise de façon unique.

Nom du champ Type de données Description
companyId string Uniquement en sortie. ID de l'entreprise, attribué par le serveur.
vendor enum Samsung ou Google.

Entreprise

Représente une entreprise.

Nom du champ Type de données Description
companyReference object(CompanyReference) Objet de référence de l'entreprise.
companyName string Nom de l'entreprise. Exemple : XYZ Corp. Visible auprès des employés de l'entreprise sur le portail d'inscription sans contact.
vendorParams map Champs supplémentaires dans les paires clé-valeur spécifiées par le fournisseur.

Type d'appareil

Un appareil Android enregistré pour l'enregistrement.

Nom du champ Type de données Description
deviceId string Uniquement en sortie. ID de l'appareil, attribué par le serveur.
deviceIdentifier object(DeviceIdentifier) ID matériels qui identifient un appareil fabriqué.
customer object(CompanyReference) ID des entreprises auxquelles les appareils sont attribués.
orderNumber string Numéro de commande.
vendorParams map Champs supplémentaires dans les paires clé-valeur spécifiées par le fournisseur.

DeviceIdentifier

Encapsule le matériel et les ID produit pour identifier l'appareil du fabricant.

Les appareils Samsung nécessitent l'un des champs suivants:

  • IMEI
  • serialNumber
  • meid

Tous les autres champs, comme model, sont ignorés.

Pour tous les autres appareils Android:

  • Les appareils mobiles nécessitent imei et manufacturer.
  • Les appareils Wi-Fi uniquement nécessitent serialNumber, manufacturer et model.
Nom du champ Type de données Description
imei string Numéro IMEI de l'appareil. Validé à l'entrée.
serialNumber string Numéro de série du fabricant de l'appareil. Cette valeur peut ne pas être unique sur les différents modèles d'appareils.
meid string Numéro MEID de l'appareil.
manufacturer string Nom du fabricant de l'appareil. Correspond à la valeur intégrée de l'appareil renvoyée par android.os.Build.MANUFACTURER. Les valeurs autorisées sont indiquées dans la liste des fabricants.
model string Nom du modèle de l'appareil. Correspond à la valeur intégrée de l'appareil renvoyée par android.os.Build.MODEL. Les valeurs autorisées sont listées dans les modèles.

Operations

Cette ressource contient l'état d'un appel d'API asynchrone. Il existe quatre états possibles:

  • IN_PROGRESS: l'opération est en cours.
  • COMPLETE: tous les appareils ont bien été traités.
  • COMPLETE_WITH_ERRORS: l'opération a été traitée, mais des erreurs se sont produites. Toutes les erreurs sont listées dans la liste deviceErrors.
  • FAILED: l'opération a échoué et aucun élément operationId n'est renvoyé.
Nom du champ Type de données Description
operationId string ID de l'opération, précédé de samsung/ ou google/. Si ce champ est vide, state est FAILED.
operationType enum(operationType) Type d'opération : CLAIM_DEVICES ou UNCLAIM_DEVICES.
state enum(operationState) État de l'opération : IN_PROGRESS, COMPLETE, COMPLETE_WITH_ERRORS, FAILED.
deviceErrors Liste de object(DeviceOperationError) Liste des erreurs de fonctionnement de l'appareil.
vendorParams map Champs supplémentaires dans les paires clé-valeur spécifiées par le fournisseur.

Erreur de fonctionnement de l'appareil

Une erreur spécifique à l'appareil dans un Operation. Chaque ressource contient les mêmes deviceId et deviceIdentifier que la requête ayant démarré l'opération.

Nom du champ Type de données Description
deviceId string Uniquement en sortie. ID de l'appareil, attribué par le serveur.
deviceIdentifier object(DeviceIdentifier) ID matériels qui identifient un appareil fabriqué.
error object(Error) Erreur de fonctionnement de l'appareil.

Exception commune

Exception pouvant être levée par toutes les API synchrones.

Nom de propriété Valeur Description
error object(Error) Erreur d'opération synchrone.

Erreur

Objet contenant des détails sur une erreur.

Nom de propriété Valeur Description
code enum(ErrorCode) Code d'erreur. Par exemple, INVALID_REQUESET ou PERMISSION_DENIED
message string Message d'erreur.
vendorMsg string Explication détaillée de l'erreur du fournisseur.
errorId string Identifiant d'erreur interne.
vendorParams map Champs supplémentaires dans les paires clé-valeur spécifiées par le fournisseur.

ErrorCode

Erreurs courantes.

Enum Description
INVALID_PARAM_DEFAULT Paramètre d'entrée non valide. Pour plus d'informations, consultez le fournisseur.
INVALID_PAGE_TOKEN Le jeton de page fourni n'est pas valide.
INVALID_CUSTOMER_ID L'ID client fourni n'est pas valide.
INVALID_DEVICE_IMEI Code IMEI incorrect.
INVALID_DEVICE_MEID Code MEID non valide.
INVALID_DEVICE_SERIAL Numéro de série incorrect.
INVALID_OPERATION_ID L'ID de l'opération fourni n'est pas valide.
INVALID_RESELLER_ID L'identifiant du revendeur fourni n'est pas valide.
INVALID_MANUFACTURER Le fabricant indiqué n'est pas valide ou n'est pas compatible.
INVALID_IDENTIFIER_SET L'ensemble d'identifiants fourni n'est pas suffisant pour la requête. Pour en savoir plus sur les ensembles d'identifiants autorisés, consultez DeviceIdentifier.
INVALID_MODEL Le modèle fourni n'est pas valide / non compatible.
INVALID_DEVICE_ID L'ID d'appareil fourni n'est pas valide.
INVALID_DEVICE L'appareil fourni n'existe pas. Il s'agit d'un code d'erreur propre à Samsung.
DUPLICATE_DEVICE L'appareil a déjà été revendiqué au même client. Aucune action corrective n'est requise.
DEVICE_UPLOAD_COUNT_EXCEEDED La demande contient plus d'appareils que la limite (actuellement 100 000).
AUTHORIZATION_FAIL Vous n'avez pas accès à une ressource donnée (appareil ou client, par exemple) ou la ressource n'existe pas. Consultez vendorMsg pour en savoir plus.
INTERNAL_SERVER_ERROR Erreur de serveur interne non spécifiée. Consultez le fournisseur de la messagerie pour en savoir plus. De nouvelles tentatives peuvent être effectuées en fonction de la nature de l'erreur de serveur.
NOT_IMPLEMENTED La méthode de requête n'est pas compatible avec le serveur.