Language Support

The SPF-API supports three languages for question sets; English, Spanish, and French. Language selection can be specified by using the Accept-Language HTTP header.

The following values can be set for the Accept-Language header:

  • en - English (default language if the Accept-Language header is not provided)
  • es - Spanish
  • fr - French
curl --location --request GET 'https://api-staging.symmetry.com/spf/formQuestionSet/W4101/QS1' \
--header 'Accept: application/json' \
--header 'Accept-Language: fr'

More information about the Accept-Language request HTTP header can be found at MDN web docs. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language

API Endpoints Supporting the Accept-Language Header

The following endpoints support language variations

Sample Response

The example response below is from the formQuestionSet​ endpoint with the Accept-Language: fr specified:

{
    "id": "QS1",
    "questions": [
        {
            "id": "isNra",
            "questionText": "Êtes-vous un étranger non-résident?",
            "notes": [
                {
                    "htmlType": "PARAGRAPH",
                    "text": "La sélection de Oui entraînera la sélection d'un état matrimonial de célibataire ou marié séparément indépendamment de l'état matrimonial réel. Voir l'Avis 1392 pour plus de détails."
                },
                {
                    "htmlType": "PARAGRAPH",
                    "text": "Remarque: les étrangers non résidents peuvent être exonérés de retenues salariales sur une partie ou la totalité de leur rémunération pour les services personnels à charge en vertu d'une convention fiscale. Si vous demandez une exemption de retenue à la source en vertu d'une convention fiscale, ne remplissez pas le formulaire W-4. Remplissez plutôt le formulaire 8233, Exemption de retenue sur l'indemnisation pour les services personnels indépendants (et certaines personnes à charge) d'un étranger non-résident, et remettez-le à chaque agent chargé de la retenue de qui les sommes seront reçues."
                }
            ],
            "validationRegex": "^(true|false)$",
            "validationErrorMessage": "Cette valeur est obligatoire",
            "htmlType": "INPUT",
            "displayType": "RADIO",
            "required": {
                "whenRequired": "ALWAYS"
            },
            "questionOptions": [
                {
                    "label": "Oui",
                    "value": true
                },
                {
                    "label": "Non",
                    "value": false
                }
            ]
        }
    ],
    "breadcrumbTitle": "Étranger non-résident",
    "navigation": {
        "navigationType": "VARIABLE",
        "questionId": "isNra",
        "navigationMappings": {
            "false": {
                "nextQuestionSetId": "QS2",
                "hasMoreQuestions": true
            },
            "true": {
                "nextQuestionSetId": "QS8",
                "hasMoreQuestions": true
            }
        }
    }
}

Jump to top