Aller au contenu principal

appointments

---
id: appointments
title: Rendez-vous
---

Remplacez votre jeton par l'espace réservé entre crochets dans la partie d'en-tête, et votre sous-domaine d'emplacement dans la partie URL comme indiqué ci-dessous.

## Listing

Vous pouvez récupérer la liste des rendez-vous en utilisant l'appel d'API suivant :

curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/appointments


Si votre jeton d'API est `12345`, et votre sous-domaine d'emplacement est `toronto-acme`, cela ressemblerait à :

curl -H "Authorization: Token 12345" https://toronto-acme.datadocks.com/api/v1/appointments


Vous pouvez passer les paramètres suivants pour filtrer la liste des rendez-vous retournés :

### Pagination

Lors de la liste des rendez-vous, la réponse est paginée pour rendre les données plus gérables. Chaque page affichera 20 rendez-vous par défaut. Pour naviguer à travers les pages, vous devez ajouter le paramètre `page` à la chaîne de requête dans votre appel d'API comme suit :

curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/appointments?page=2


Remplacez `[api_token]` par votre véritable jeton d'API et `[location_subdomain]` par votre véritable sous-domaine d'emplacement. Pour accéder à une page différente, il suffit de changer le nombre dans le paramètre `page` par le numéro de page que vous souhaitez voir.

### Filtrage

#### po_number

* Type: Chaîne
* Description: Le numéro de bon de commande pour filtrer. Il s'agit d'une correspondance exacte si fourni.

curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/appointments?po_number=12345


#### from

* Type: Représentation de chaîne d'une date / heure.
* Description: Filtrer les résultats programmés à partir de la date / heure passée ou après. La date / heure passée sera localisée au fuseau horaire de l'emplacement.

curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/appointments?from=2020-01-01%2012:00%20PM


#### to

* Type: Représentation de chaîne d'une date / heure.
* Description: Filtrer les résultats programmés avant la date / heure passée. La date / heure passée sera localisée au fuseau horaire de l'emplacement.

curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/appointments?to=2020-01-02%2012:00%20PM


#### Combinaison de filtres

Vous pouvez combiner des paramètres en les séparant par un esperluette comme suit :

curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/appointments?po_number=12345&from=2020-01-01%2012:00%20PM&to=2020-01-02%2012:00%20PM


### Exemple de Charge utile

[ { "id": 1, "appointment_number": 1, "state": "left", "duration": 120, "shipping_number": "57886", "trailer_number": "2222222", "bol_number": "922", "carrier_name": "FastCo", "driver_name": "Jason Smith", "created_by": "Sysadmin", "outbound": false, "drop_trailer": false, "queued": false, "dock_name": "Dock 2", "yard_name": null, "free_until": null, "scheduled_at": "2020-09-30T06:00:00-04:00", "approved_at": "2020-09-22T13:35:00-04:00", "arrived_at": null, "started_at": "2020-09-24T13:35:00-04:00", "completed_at": "2020-09-24T13:35:00-04:00", "left_at": "2020-09-25T13:35:00-04:00", "cancelled_at": null, "custom_values": { "expected_at": "2020-10-01", "travel_type": "Truck", "forklift_operator": "Sue", "inspection_passed": "1" }, "packing_lists": [ { "id": 4, "po_number": "A-2000", "customer_name": "FishCo", "product_name": "Trout", "unit_name": "Skid", "booked_quantity": 10, "booked_weight": 152, "actual_quantity": 12, "actual_weight": 160, "custom_values": { "barcode": "11223344", "dimensions": "S", "temperature_celcius": "-5" } } ], "notes": [ { "id": 3, "body": "First note." }, { "id": 4, "body": "Second note." }, { "id": 5, "body": "Third note." } ], "documents": [] }, { "id": 2, "appointment_number": 2, "state": "left", "duration": 180, "shipping_number": "18234", "trailer_number": "432233222", "bol_number": "37014", "carrier_name": "FastCo", "driver_name": "Brad Jones", "created_by": "Sysadmin", "outbound": true, "drop_trailer": false, "queued": false, "dock_name": null, "yard_name": "Yard A", "free_until": null, "scheduled_at": "2020-09-22T13:00:00-04:00", "approved_at": "2020-09-22T13:35:00-04:00", "arrived_at": null, "started_at": "2020-09-24T13:35:00-04:00", "completed_at": "2020-09-24T13:35:00-04:00", "left_at": "2020-09-25T13:35:00-04:00", "cancelled_at": null, "custom_values": { "expected_at": "2020-09-22", "travel_type": "Ship", "forklift_operator": "Mary" }, "packing_lists": [ { "id": 5, "po_number": "A-4000", "customer_name": "FishCo", "product_name": "Trout", "unit_name": "Skid", "booked_quantity": 13, "booked_weight": 298, "actual_quantity": 12, "actual_weight": 290, "custom_values": { "barcode": "33222311", "dimensions": "M", "temperature_celcius": "-4" } }, { "id": 6, "po_number": "B-4000", "customer_name": "FishCo", "product_name": "Trout", "unit_name": "Skid", "booked_quantity": 16, "booked_weight": 111, "actual_quantity": 17, "actual_weight": 120, "custom_values": { "barcode": "23302911", "dimensions": "L", "temperature_celcius": "-2" } } ], "notes": [ { "id": 1, "body": "This is a note." }, { "id": 2, "body": "This is another note." } ], "documents": [ { "id": 1, "filename": "File1.pdf", "presigned_url": "https://datadocksv2.s3.amazonaws.com/..." } ] } ]


## Champs

### id

* Type: Entier
* Obligatoire: True
* Description: Identifiant unique interne de DataDocks.
* Valeurs possibles: Ne peut pas être défini à l'externe.

### appointment_number

* Type: Entier
* Obligatoire: True
* Description: Le numéro séquentiel automatique pour le rendez-vous.
* Valeurs possibles: Ne peut pas être défini à l'externe.

### state

* Type: Chaîne
* Obligatoire: True
* Description: L'état / statut des rendez-vous.
* Valeurs possibles :
    * `needs_booking` (Besoin de réservation)
    * `pending` (En attente d'approbation)
    * `booked`
    * `arrived`
    * `started` (Démarré)
    * `completed` (Terminé)
    * `left`
    * `cancelled`

### duration

* Type: Entier
* Obligatoire: True
* Description: La durée du rendez-vous en minutes.
* Valeurs possibles: Doit être supérieur à 0.

### shipping_number

* Type: Chaîne
* Obligatoire: False
* Description: Le numéro d'expédition.

### trailer_number

* Type: Chaîne
* Obligatoire: False
* Description: Le numéro de la remorque.

### bol_number

* Type: Chaîne
* Obligatoire: False
* Description: Le numéro de BOL.

### carrier_name

* Type: Chaîne
* Obligatoire: False
* Description: Le nom du transporteur auquel le rendez-vous est assigné.

### carrier_email

* Type: Chaîne
* Obligatoire: False
* Description: L'email du transporteur auquel le rendez-vous est assigné si aucun transporteur n'était trouvé / spécifié.

### driver_name

* Type: Chaîne
* Obligatoire: False
* Description: Le conducteur.

### created_by

* Type: Chaîne
* Obligatoire: False
* Description: Le nom de l'utilisateur qui a créé le rendez-vous.

### outbound

* Type: Booléen
* Obligatoire: True
* Description: True si c'est un rendez-vous sortant, False si c'est un rendez-vous entrant. Par défaut, False.

### drop_trailer

* Type: Booléen
* Obligatoire: True
* Description: Indique si c'est une remorque déposée. Par défaut, False.

### queued

* Type: Booléen
* Obligatoire: True
* Description: Indique si elle a été mise en file d'attente pour une date spécifique, mais pas encore planifiée. Par défaut, False.

### dock_name

* Type: Chaîne
* Obligatoire: False
* Description: Le nom du quai auquel le rendez-vous est assigné.
* Valeurs possibles: Un quai valide à l'emplacement du rendez-vous.

### yard_name

* Type: Chaîne
* Obligatoire: False
* Description: Le nom de la cour auquel le rendez-vous est assigné.
* Valeurs possibles: Une cour valide à l'emplacement du rendez-vous.

### free_until

* Type: DateTime
* Obligatoire: False
* Description: ?

### scheduled_at

* Type: DateTime
* Obligatoire: False
* Description: Quand le rendez-vous est prévu.

### approved_at

* Type: DateTime
* Obligatoire: False
* Description: Quand le rendez-vous a été approuvé.

### arrived_at

* Type: DateTime
* Obligatoire: False
* Description: Quand le rendez-vous est arrivé.

### started_at

* Type: DateTime
* Obligatoire: False
* Description: Quand le rendez-vous a commencé à être traité.

### completed_at

* Type: DateTime
* Obligatoire: False
* Description: Quand le rendez-vous a terminé le traitement.

### left_at

* Type: DateTime
* Obligatoire: False
* Description: Quand le rendez-vous a quitté la propriété.

### cancelled_at

* Type: DateTime
* Obligatoire: False
* Description: Quand le rendez-vous a été annulé.

### custom_values

* Type: Hachage
* Obligatoire: False
* Description: Un hachage (objet) de paires clé / valeur des champs personnalisés qui ont été remplis pour le rendez-vous.

### packing_lists

* Type: Tableau
* Obligatoire: False
* Description: Les listes d'emballage appartenant au rendez-vous.

#### packing_lists > id

* Type: Entier
* Obligatoire: True
* Description: Identifiant unique interne de DataDocks.
* Valeurs possibles: Ne peut pas être défini à l'externe.

#### packing_lists > po_number

* Type: Chaîne
* Obligatoire: False
* Description: Numéro de bon de commande auquel la liste d'emballage est associée.

#### packing_lists > customer_name

* Type: Chaîne
* Obligatoire: False
* Description: Le nom du client auquel la liste d'emballage est associée.

#### packing_lists > product_name

* Type: Chaîne
* Obligatoire: False
* Description: Le nom du produit auquel la liste d'emballage est associée.

#### packing_lists > unit_name

* Type: Chaîne
* Obligatoire: False
* Description: Le nom de l'unité auquel la liste d'emballage est associée.

#### packing_lists > booked_quantity

* Type: Décimal
* Obligatoire: False
* Description: La quantité réservée.

#### packing_lists > booked_weight

* Type: Décimal
* Obligatoire: False
* Description: Le poids réservé.

#### packing_lists > actual_quantity

* Type: Décimal
* Obligatoire: False
* Description: La quantité réelle.

#### packing_lists > actual_weight

* Type: Décimal
* Obligatoire: False
* Description: Le poids réel.

#### packing_lists > custom_values

* Type: Hachage
* Obligatoire: False
* Description: Un hachage (objet) de paires clé / valeur des champs personnalisés qui ont été remplis pour la liste d'emballage.

### notes

* Type: Tableau
* Obligatoire: False
* Description: Les notes attachées au rendez-vous.

#### notes > id

* Type: Entier
* Obligatoire: True
* Description: Identifiant unique interne de DataDocks.
* Valeurs possibles: Ne peut pas être défini à l'externe.

#### notes > body

* Type: Chaîne
* Obligatoire: True
* Description: Le contenu / corps de la note.

### documents

* Type: Tableau
* Obligatoire: False
* Description: Les documents attachés au rendez-vous.

#### documents > id

* Type: Entier
* Description: Identifiant unique interne de DataDocks.

#### documents > filename

* Type: Chaîne
* Description: Nom d'origine du fichier.

#### documents > presigned_url

* Type: Chaîne
* Description: Une URL qui fournit un accès de téléchargement temporaire à un document, expirant dans 15 minutes.

## Création de rendez-vous

Vous pouvez créer un rendez-vous en utilisant l'appel d'API suivant et en fournissant les données de rendez-vous au format JSON.

curl -v \ -H "Accept: application/json" \ -H "Content-type: application/json" \ -H "Authorization: Token [api_token]" \ -X POST \ -d '{"appointment": {"carrier_name": "My Shipping Co.", "shipping_number": "AA11223344"}}' \ https://[location_subdomain].datadocks.com/api/v1/appointments


Si votre jeton d'API est `12345`, et votre sous-domaine d'emplacement est `toronto-acme`, cela ressemblerait à :

curl -v \ -H "Accept: application/json" \ -H "Content-type: application/json" \ -H "Authorization: Token 12345" \ -X POST \ -d '{"appointment": {"carrier_name": "My Shipping Co.", "shipping_number": "AA11223344"}}' \ https://toronto-acme.datadocks.com/api/v1/appointments


## Mise à jour des rendez-vous

Vous pouvez mettre à jour un rendez-vous en utilisant l'appel d'API suivant et en fournissant les données de rendez-vous au format JSON. Notez que l'URL nécessite l'identifiant du rendez-vous à la fin (l'identifiant du rendez-vous DataDocks).

curl -v \ -H "Accept: application/json" \ -H "Content-type: application/json" \ -H "Authorization: Token [api_token]" \ -X PUT \ -d '{"appointment": {"shipping_number": "BB55667788"}}' \ https://[location_subdomain].datadocks.com/api/v1/appointments/[appointment_id]


Si votre jeton d'API est `12345`, votre sous-domaine d'emplacement est `toronto-acme`, et l'identifiant du rendez-vous que vous souhaitez mettre à jour est `1`, cela ressemblerait à :

curl -v \ -H "Accept: application/json" \ -H "Content-type: application/json" \ -H "Authorization: Token 12345" \ -X PUT \ -d '{"appointment": {"shipping_number": "BB55667788"}}' \ https://toronto-acme.datadocks.com/api/v1/appointments/1