Aller au contenu principal

Entreprises

Substituez votre jeton par le placeholder entre crochets dans l'en-tête, et votre sous-domaine de localisation dans la portion URL comme indiqué ci-dessous.

Liste​

Vous pouvez récupérer la liste des entreprises en utilisant l'appel API suivant :

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

Si votre jeton API est 12345 et votre sous-domaine de localisation est toronto-acme, cela ressemblerait à :

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

Vous pouvez passer les paramètres suivants pour filtrer la liste des entreprises retournées :

Filtrage​

company_type​

  • Type : Chaîne de caractères
  • Description : Le type d'entreprises à filtrer. C'est une correspondance exacte si fourni.
  • Valeurs possibles : Peut être "carrier", "customer" ou "both". Cela est requis.
curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/companies?company_type=customer

name​

  • Type : Chaîne de caractères
  • Description : Le nom de l'entreprise à filtrer. C'est une correspondance floue si fourni.
curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/companies?name=s

company_number​

  • Type : Chaîne de caractères
  • Description : Le numéro de société pour filtrer. C'est une correspondance exacte si fourni.
curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/companies?company_number=B83582616848

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/companies?company_type=customer&name=s

Exemple de charge utile​

[
  {
    "id": 1,
    "parent_id": null,
    "company_type": "carrier",
    "name": "Joe's Shipping",
    "company_number": "A17727959343",
    "email": "ingo@joesshipping.com",
    "phone": "+14161231234",
    "street": "1 Yonge St.",
    "unit": null,
    "city": "Toronto",
    "province": "ON",
    "country": "CA",
    "postal": "M8H 1G1",
    "category": null,
    "auto_approve_appointments": true,
    "can_create_carriers": false,
    "notifications": true,
    "custom_values": {
      "ap_contact": "Sue Brown",
      "sales_contact": "Tim Jones",
      "facility_contact": "John Green"
    }
  },
  {
    "id": 2,
    "parent_id": null,
    "company_type": "customer",
    "name": "Spatula City",
    "company_number": "B83582616848",
    "email": "info@spatulacity.com",
    "phone": "+14161231234",
    "street": "1 Yonge St.",
    "unit": "4",
    "city": "Toronto",
    "province": "ON",
    "country": "CA",
    "postal": "M8H 1G1",
    "category": null,
    "auto_approve_appointments": false,
    "can_create_carriers": true,
    "notifications": false,
    "custom_values": {
      "ap_contact": "",
      "sales_contact": "Al Yankovic",
      "facility_contact": ""
    }
  }
]

Champs​

id​

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

parent_id​

  • Type : Entier
  • Requis : Non
  • Description : Identifiant unique interne de DataDocks qui pointe vers l'entreprise qui l'a créé.
  • Valeurs possibles : Doit correspondre à un autre identifiant d'entreprise.

company_type​

  • Type : Chaîne de caractères
  • Requis : Oui
  • Description : Le type de l'entreprise.
  • Valeurs possibles : carrier ou customer

name​

  • Type : Chaîne de caractères
  • Requis : Oui
  • Description : Nom de l'entreprise.

company_number​

  • Type : Chaîne de caractères
  • Requis : Oui
  • Description : Identifiant unique externe attribué à l'entreprise.

email​

  • Type : Chaîne de caractères
  • Requis : Non
  • Description : Adresse e-mail principale.

phone​

  • Type : Chaîne de caractères
  • Requis : Non
  • Description : Numéro de téléphone principal.

street​

  • Type : Chaîne de caractères
  • Requis : Non
  • Description : Adresse (rue).

unit​

  • Type : Chaîne de caractères
  • Requis : Non
  • Description : Numéro de bâtiment ou suite.

city​

  • Type : Chaîne de caractères
  • Requis : Non
  • Description : Ville

province​

  • Type : Chaîne de caractères
  • Requis : Non
  • Description : Province ou État.

country​

  • Type : Chaîne de caractères
  • Requis : Non
  • Description : Pays - veuillez utiliser le code pays à deux lettres. Par exemple US pour États-Unis

postal​

  • Type : Chaîne de caractères
  • Requis : Non
  • Description : Code postal ou Zip.

category​

  • Type : Chaîne de caractères
  • Requis : Non
  • Description : ?

auto_approve_appointments​

  • Type : Booléen
  • Requis : Non
  • Description : Les rendez-vous créés par les utilisateurs de cette entreprise sont-ils automatiquement approuvés (réservés) ?

can_create_carriers​

  • Type : Booléen
  • Requis : Non
  • Description : Les utilisateurs de cette entreprise peuvent-ils créer d'autres transporteurs eux-mêmes ?

notifications​

  • Type : Booléen
  • Requis : Non
  • Description : Les utilisateurs de cette entreprise doivent-ils être abonnés aux notifications de rendez-vous.

custom_values​

  • Type : Hachage
  • Requis : Non
  • Description : Un hachage (objet) de paires clé / valeur des champs personnalisés qui ont été remplis pour l'entreprise.

Création d'entreprises​

Vous pouvez créer une entreprise en utilisant l'appel API suivant et en fournissant les données de l'entreprise au format JSON.

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token [api_token]" \
  -X POST \
  -d '{"company": {"name": "My Shipping Co.", "company_type": "carrier", "company_number": "MSC1234"}}' \
  https://[location_subdomain].datadocks.com/api/v1/companies

Si votre jeton API est 12345 et votre sous-domaine de localisation est toronto-acme, cela ressemblerait à :

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token 12345" \
  -X POST \
  -d '{"company": {"name": "My Shipping Co.", "company_type": "carrier", "company_number": "MSC1234"}}' \
  https://toronto-acme.datadocks.com/api/v1/companies

Mise à jour des entreprises​

Vous pouvez mettre à jour une entreprise en utilisant l'appel API suivant et en fournissant les données de l'entreprise au format JSON. Notez que l'URL nécessite l'ID de l'entreprise à la fin (l'ID de l'entreprise DataDocks).

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token [api_token]" \
  -X PUT \
  -d '{"company": {"name": "Name Changed"}}' \
  https://[location_subdomain].datadocks.com/api/v1/companies/[company_id]

Si votre jeton API est 12345, votre sous-domaine de localisation est toronto-acme et l'ID de l'entreprise 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 '{"company": {"name": "Name Changed"}}' \
  https://toronto-acme.datadocks.com/api/v1/companies/1