Objets

CompanyReference

Identifie une entreprise de manière unique.

Nom du champ Type de données Description
companyId string Uniquement en sortie. Identifiant 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. Par exemple, Société XYZ. Affiché aux employés de l'entreprise sur le portail d'enregistrement sans contact.
vendorParams map Champs supplémentaires dans les paires clé-valeur spécifiées par le fournisseur.

Appareil

Un appareil Android enregistré pour l'enregistrement

Nom du champ Type de données Description
deviceId string Uniquement en sortie. Identifiant de l'appareil, attribué par le serveur.
deviceIdentifier object(DeviceIdentifier) ID matériel qui identifient un appareil fabriqué.
customer object(CompanyReference) ID des entreprises qui identifient l'entreprise à laquelle 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 les ID produit et matériel pour identifier l'appareil d'un 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 ne disposant que du Wi-Fi nécessitent serialNumber, manufacturer et model.
Nom du champ Type de données Description
imei string Code IMEI de l'appareil. Validé lors de la saisie.
serialNumber string Numéro de série du fabricant de l'appareil. Il est possible que cette valeur ne soit pas unique d'un modèle à l'autre.
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 manufacturers.
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 répertoriées dans la liste des modèles.

Opération

Cette ressource contient l'état d'un appel d'API asynchrone. Il y a 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 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 défini sur 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.

DeviceOperationError

Erreur spécifique à l'appareil dans une Operation. Chaque ressource contient deviceId et deviceIdentifier comme requête ayant lancé l'opération.

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

CommonException

Une exception qui peut ê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. Exemples : INVALID_REQUESET ou PERMISSION_DENIED
message string Message d'erreur.
vendorMsg string Une explication détaillée de l'erreur par le fournisseur.
errorId string Identifiant de l'erreur interne.
vendorParams map Champs supplémentaires dans les paires clé-valeur spécifiées par le fournisseur.

ErrorCode

Erreurs courantes

Énumération Description
INVALID_PARAM_DEFAULT Paramètre d'entrée non spécifié non spécifié. Pour en savoir plus, consultez le message "vendorMsg".
INVALID_PAGE_TOKEN Le pageToken fourni n'est pas valide.
INVALID_CUSTOMER_ID L'identifiant customerId fourni n'est pas valide.
INVALID_DEVICE_IMEI Code IMEI incorrect.
INVALID_DEVICE_MEID Code MEID incorrect.
INVALID_DEVICE_SERIAL Numéro de série non valide.
INVALID_OPERATION_ID L'identifiant operationId fourni n'est pas valide.
INVALID_RESELLER_ID L'ID de revendeur fourni n'est pas valide.
INVALID_MANUFACTURER Le nom du fabricant n'est pas valide ou n'est pas pris en charge.
INVALID_IDENTIFIER_SET L'ensemble d'identifiants fourni n'est pas suffisant pour la demande. Pour en savoir plus sur les ensembles d'identifiants autorisés, consultez la section DeviceIdentifier.
INVALID_MODEL Le modèle fourni n'est pas valide ou n'est pas pris en charge.
INVALID_DEVICE_ID L'ID d'appareil fourni n'est pas valide.
INVALID_DEVICE L'appareil indiqué n'existe pas. Ce code d'erreur est spécifique à Samsung.
DUPLICATE_DEVICE Cet appareil a déjà été revendiqué par le même client. Aucune action corrective n'est requise.
DEVICE_UPLOAD_COUNT_EXCEEDED La requête contient plus d'appareils que la limite autorisée (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 interne du serveur non spécifiée. Pour en savoir plus, consultez le rapport "vendorMsg". Ces requêtes peuvent faire l'objet de nouvelles tentatives en fonction de la nature de l'erreur du serveur.
NOT_IMPLEMENTED La méthode de requête n'est pas compatible avec le serveur.