Aller au contenu principal

postFormsData

Création d'un objet de données de formulaire enregistrant des informations.

Cette méthode retourne un objet FormDataEntity créé. Si vous souhaitez changer la langue, il vous suffit de le passer en tant que deuxième argument.

FormData.postFormsData( body, langCode );

Les méthodes avec une requête POST acceptent comme corps de requête un objet avec le champ de données de formulaire, qui correspond au type d'information envoyée. Voici des exemples d'objets de données de formulaire pour différents types de données.

Exemple minimal​

const body = {
"formIdentifier": "contact_us",
"formData": [
{
"marker": "last_name",
"type": "string"
"value": "Andrey"
}
]
};

const value = await FormData.postFormsData(body)

Schéma des paramètres​

Schéma (body)

body(required): objet
Corps de la requête
exemple:

{
  "formIdentifier": "form",
  "formData": [
    {
      "marker": "name",
      "type": "string",
      "value": "Jack"
    }
  ]
}

langCode: chaîne
Code de langue. Par défaut : "en_US"
exemple: "en_US"

body.formIdentifier: chaîne
L'identifiant du formulaire
exemple: "contact-form"

body.formData: chaîne
**
exemple:

[
  {
    "marker": "name",
    "type": "string",
    "value": "Jack"
  }
]

body.formData.marker: chaîne
Marqueur d'attribut de formulaire
exemple: "name"

body.formData.type: chaîne
Type d'attribut de formulaire
exemple: "string"

body.formData.value: chaîne
Valeur de l'attribut de formulaire
exemple: "Jack"

Exemple avec un attribut de type simple "string", "number", "float"​

{
  "marker": "last_name",
  "type": "string",
  "value": "Username"
}

Exemple avec un attribut de type simple "date", "dateTime", "time"​

{
  "marker": "birthday",
  "type": "date",
  "value": {
    "fullDate": "2024-05-07T21:02:00.000Z",
    "formattedValue": "08-05-2024 00:02",
    "formatString": "DD-MM-YYYY HH:mm"
  }
}

Exemple avec un attribut de type simple "text"​

{
  "marker": "about",
  "type": "text",
  "value": {
    "htmlValue": "<p>Hello world</p>",
    "plainValue": "",
    "params": {
      "isEditorDisabled": false,
      "isImageCompressed": true
    }
  }
}

Exemple avec un attribut de type simple "textWithHeader"​

{
  "marker": "about",
  "type": "textWithHeader",
  "value": {
    "header": "Titre",
    "htmlValue": "<p>Hello World</p>",
    "plainValue": "",
    "params": {
      "isEditorDisabled": false,
      "isImageCompressed": true
    }
  }
}

Exemple avec un attribut de type simple "image" ou "groupOfImages"​

{
  "marker": "avatar",
  "type": "image",
  "value": [
    {
      "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
      "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
      "size": 392585,
      "previewLink": "",
      "params": {
        "isImageCompressed": true
      }
    }
  ]
}

Exemple avec un attribut de type simple "files"​

{
  "marker": "picture",
  "type": "file",
  "value": [
    {
      "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
      "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
      "size": 392585
    }
  ]
}

Exemple avec un attribut de type simple "radioButton" ou "list"​

{
  "marker": "selector",
  "type": "list",
  "value": [
    {
      "title": "rouge",
      "value": "1",
      "extended": {
        "value": "red",
        "type": "string"
      }
    }
  ]
}

Exemple avec un attribut de type "entity" (liste imbriquée)​

{
  "formIdentifier": "entity_form",
  "formData": {
    "en_US": [
      {
        "marker": "entity-marker",
        "type": "entity",
        "value": [25, 32, 24]
      }
    ]
  }
}

Valeur - identifiants numériques pour les pages et identifiants de chaîne pour les produits. Les identifiants pour les produits doivent inclure le préfixe 'p-', par exemple, 'p-1-', 'p-2-', etc. p-[parentId]-[productId]

Exemple avec un attribut de type "timeInterval"​

{
  "formIdentifier": "reg",
  "formData": {
    "en_US": [
      {
        "marker": "interval",
        "type": "timeInterval",
        "value": [
          [
            "2025-02-11T16:00:00:000Z",
            "2025-02-13T16:00:00:000Z"
          ]
        ]
      }
    ]
  }
}

valeur — tableau de tableaux d'intervalles au format ISO 8601. par exemple 2025-02-11T16:00:00:000Z

2025 — année; 02 — mois; 11 — jour du mois; T — séparateur entre la date et l'heure; 16:00:00 — heure au format heures:minutes:secondes; 000Z — indication des millisecondes et du fuseau horaire. Z signifie que l'heure est spécifiée au format UTC.

Exemple de retour :​

{
  "formData": {
    "formIdentifier": "test-form",
    "time": "2025-07-21T09:40:06.587Z",
    "formData": [
      {
        "marker": "name",
        "type": "string",
        "value": "Test"
      }
    ],
    "id": 286
  },
  "actionMessage": ""
}

Schéma de réponse​

Schéma : IFormDataEntity

formIdentifier: chaîne
L'identifiant de la page.
exemple: "contact_form"

time: Date | chaîne
L'identifiant du formulaire.
exemple:

"2023-10-01T12:00:00Z"

formData: FormDataType[]
Données de formulaire.
exemple:

[
  {
    "marker": "name",
    "type": "string",
    "value": "Test"
  }
]

id: nombre
L'identifiant unique de la page de formulaire.
exemple: 12345

actionMessage: chaîne | null
Message d'action pour les données de formulaire.
exemple: "Formulaire soumis avec succès"

attributeSetIdentifier: chaîne | null
Identifiant textuel (marqueur) de l'ensemble d'attributs utilisé.
exemple: "product_attributes"