Cette page est soutenue par un contrat indépendant éditable. Valider les opérations de rédaction avec des données de test avant utilisation de production.
/api/job
Flux de travail prêts à l'emploi
Flux de travail prêts à l'emploi
01
Commencez à utiliser Job
Utilisez un jeton API dédié et validez d'abord les opérations de lecture avec les données de test.
Gardez le jeton côté serveur et envoyez-le dans l'en-tête Authorization.
Vérifiez les paramètres requis et élargissez le schéma de demande ou de réponse.
Traiter l'état HTTP et le champ stable error dans les erreurs d'application.
Les modèles sont énumérés une fois ici et peuvent également être étendus directement depuis les terminaux qui les utilisent.
Job11 champs
idinteger · int32
Id.
namestring
Nom.
categoryClassstring
Classe de catégorie.
clientIdinteger · int64
Nom du client.
deletedboolean
Il a été supprimé.
positionIdinteger · int64
Identification de la position.
versionIdinteger · int64
- La version ID.
createdUserstring
Créé par l'utilisateur.
createdDatestring · date-time
Date créée.
pricenumber · double
Le prix.
tariffsJobTariff[]
Les tarifs.
JobTariff8 champs
idinteger · int64
Id.
jobIdinteger · int32
Nom de travail.
pricenumber · double
Le prix.
brandIdinteger · int32
Nom de marque.
categoryClassstring
Classe de catégorie.
categoryIdinteger · int32
Identification de catégorie
priorityinteger · int32
La priorité.
productIdinteger · int64
Identification du produit.
Contrats d'erreur
Comment les erreurs d'application sont retournées
Le code error est identique dans chaque locale, tandis que le message d'utilisateur est traduit par le serveur.
Le projet de loi
Code stable lisible par machine pour la logique d'intégration.
Le projet de loi
Message prêt à être affiché dans la langue de l'utilisateur de jeton API.
Le projet de loi
Les valeurs interpolées par le serveur dans le modèle de message localisé.
文
localMessage utilise le champ lang de l'utilisateur qui possède le jeton API. Le langage de documentation et l'en-tête Accept-Language ne le modifient pas; le russe est utilisé lorsque l'usager n'a pas de langue configurée.
RULocalisation de l'utilisateur est ru
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}
FRFrançais (fr)
{
"error": "error_brand_already_exists",
"localMessage": "La marque Base existe déjà",
"params": {
"name": "Base"
}
}
Les points de fin
Les points de fin
PUT
Mettez le travail
/api/job/{jobId}
Token avec accès à l'écriture
Mettre le travail à l'aide de PUT /api/job/{jobId}.
Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑
401auth_required
Autentification requise
Authorization est manquant, vide ou contient un jeton non valide.
400error_access_denied
Accès refusé
Le jeton existe, mais son rôle ne peut pas effectuer cette opération.
500error_unknown
Une erreur inconnue s'est produite. Si le problème persiste, contactez le service d'assistance
Faillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.
400error_empty_category_class
Classe non spécifiée
error spécifique au point final. Utilisez le code error_empty_category_class stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_job_price
Prix pour l'exécution du travail non spécifié
error spécifique au point final. Utilisez le code error_empty_job_price stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_position
Poste non spécifié
error spécifique au point final. Utilisez le code error_empty_position stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_tariff_price
Prix non spécifié pour le tarif n°{position}
error spécifique au point final. Utilisez le code error_empty_tariff_price stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_tariff_priority
Priorité non spécifiée pour le tarif
error spécifique au point final. Utilisez le code error_empty_tariff_priority stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_tariffs
Tarifs non spécifiés
error spécifique au point final. Utilisez le code error_empty_tariffs stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_job_already_exists
La tâche avec le nom {jobName} existe déjà
error spécifique au point final. Utilisez le code error_job_already_exists stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_job_modified
Les données du travail sont déjà mises à jour. Actualisez la page.
error spécifique au point final. Utilisez le code error_job_modified stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_job_tariff_wrong_product_id
Identifiant du produit incorrectement spécifié : {id}
error spécifique au point final. Utilisez le code error_job_tariff_wrong_product_id stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_no_client
Client introuvable ou supprimé. Écrivez au support
error spécifique au point final. Utilisez le code error_no_client stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_subscription_expired
Votre abonnement a expiré. Veuillez payer l'abonnement pour continuer à utiliser le service.
error spécifique au point final. Utilisez le code error_subscription_expired stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
DELETE
Enlevez Job
/api/job/{jobId}
Token avec accès à l'écriture
Supprimer le travail à l'aide de DELETE /api/job/{jobId}.
Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑
401auth_required
Autentification requise
Authorization est manquant, vide ou contient un jeton non valide.
400error_access_denied
Accès refusé
Le jeton existe, mais son rôle ne peut pas effectuer cette opération.
500error_unknown
Une erreur inconnue s'est produite. Si le problème persiste, contactez le service d'assistance
Faillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.
400error_job_modified
Les données du travail sont déjà mises à jour. Actualisez la page.
error spécifique au point final. Utilisez le code error_job_modified stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_no_client
Client introuvable ou supprimé. Écrivez au support
error spécifique au point final. Utilisez le code error_no_client stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_subscription_expired
Votre abonnement a expiré. Veuillez payer l'abonnement pour continuer à utiliser le service.
error spécifique au point final. Utilisez le code error_subscription_expired stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑
401auth_required
Autentification requise
Authorization est manquant, vide ou contient un jeton non valide.
400error_access_denied
Accès refusé
Le jeton existe, mais son rôle ne peut pas effectuer cette opération.
500error_unknown
Une erreur inconnue s'est produite. Si le problème persiste, contactez le service d'assistance
Faillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.
400error_empty_category_class
Classe non spécifiée
error spécifique au point final. Utilisez le code error_empty_category_class stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_job_price
Prix pour l'exécution du travail non spécifié
error spécifique au point final. Utilisez le code error_empty_job_price stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_position
Poste non spécifié
error spécifique au point final. Utilisez le code error_empty_position stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_tariff_price
Prix non spécifié pour le tarif n°{position}
error spécifique au point final. Utilisez le code error_empty_tariff_price stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_tariff_priority
Priorité non spécifiée pour le tarif
error spécifique au point final. Utilisez le code error_empty_tariff_priority stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_empty_tariffs
Tarifs non spécifiés
error spécifique au point final. Utilisez le code error_empty_tariffs stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_job_already_exists
La tâche avec le nom {jobName} existe déjà
error spécifique au point final. Utilisez le code error_job_already_exists stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_job_tariff_wrong_product_id
Identifiant du produit incorrectement spécifié : {id}
error spécifique au point final. Utilisez le code error_job_tariff_wrong_product_id stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.
400error_no_client
Client introuvable ou supprimé. Écrivez au support
error spécifique au point final. Utilisez le code error_no_client stable dans la logique de l'application; localMessage contient la traduction indiquée ci-dessus.