Programmer un transfert

POST /api/transfers

Obsolète depuis la version 0.2.0: La propriété de la requête sourcePath a été remplacée par la propriété file.

Obsolète depuis la version 0.2.0: La propriété de la requête destPath a été remplacée par la propriété output.

Programme un nouveau transfert avec les informations renseignées en format JSON dans le corps de la requête.

En-têtes de requête:
Objet JSON de requête:

  • isServer (bool) – Précise si transfer était à l’origine du transfert

  • rule (string) – L’identifiant de la règle utilisée

  • isSend (bool) – Indique le transfert est un envoi (true) ou une réception (false).

  • account (string) – Le nom du compte ayant demandé le transfert

  • partner (string) – Le nom du serveur/partenaire auquel le transfert a été demandé

  • partner – Le nom du serveur/partenaire auquel le transfert a été demandé

  • sourcePath (string) – Le chemin du fichier source (déprécié)

  • destPath (string) – Le chemin de destination du fichier (déprécié)

  • file (string) – Le chemin du fichier à transférer

  • output (string) – Le chemin de destination du fichier

  • start (date) – La date de début du transfert (en format ISO 8601)

  • transferInfo (object) – Des informations de transfert personnalisées sous la forme d’une liste de pairs clé:valeur, c’est-à-dire sous forme d’un objet JSON.

Status Codes:
En-têtes de réponse:

  • Location – Le chemin d’accès au nouveau transfert créé

Exemple de requête

POST https://my_waarp_transfer.net/api/transfers HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
Content-Length: 212

{
  "isServer": false,
  "rule": "règle_1",
  "account": "toto",
  "partner": "waarp_r66",
  "file": "chemin/du/fichier",
  "output": "destination/du/fichier",
  "start": "2019-01-01T02:00:00+02:00",
  "transferInfo": { "key1": "val1", "key2": 2, "key3": true }
}

Exemple de réponse

HTTP/1.1 202 ACCEPTED
Location: https://my_waarp_transfer.net/api/transfers/123