---
title: Load Data from Web Services
product: Form Library
description: View free demo for JavaScript and learn how to load data to a web form using RESTful API.
framework: Vue 3
source: https://surveyjs.io/form-library/examples/dropdown-menu-load-data-from-restful-service/vue3js
index: https://surveyjs.io/form-library/examples/overview.md
---

# Load Data from Web Services (Vue 3)

SurveyJS Form Library allows you to populate drop-down menus with data loaded from a REST API web service. For this purpose, drop-down form fields include the [`choicesByUrl`](https://surveyjs.io/form-library/documentation/api-reference/dropdown-menu-model#choicesByUrl) property.<!-- cut --> It accepts an object with the following properties:

- `url`: string     
A RESTful service's URL. It may include [placeholders](https://surveyjs.io/form-library/documentation/design-survey/conditional-logic#dynamic-texts) that allow you to use question values as URL query parameters (see the `reg_country` question in this demo).

- `valueName`: string       
Specifies which field contains choice values.

- `titleName`: string       
Specifies which field contains display texts for choice values.

- `path`: string       
A path to the array of choices. Specify `path` only if the array of choices is nested within the object returned by the service. The following path separators are allowed: semicolon (`;`), comma (`,`).

When you use `choicesByUrl`, the form field queries an entire dataset in a single request. This technique may decrease performance on large datasets. In this case, we recommend that you implement [lazy loading](https://surveyjs.io/form-library/examples/lazy-loading-dropdown/).

## Files

### `public/index.html`

```html
<div id="app" style="position: absolute; top: 0; left: 0; right: 0; bottom: 0; height:100%"></div>
```

### `src/App.vue`

```html
<template>
    <SurveyComponent :model="survey" />
</template>
<script setup lang="ts">
    import { Model } from "survey-core";
    import { SurveyComponent } from "survey-vue3-ui";
    import "survey-core/survey-core.min.css";
    import "./index.css";
    import { json } from "./json";

    const survey = new Model(json);
    survey.onComplete.add((sender, options) => {
        console.log(JSON.stringify(sender.data, null, 3));
    });
</script>
```

### `src/index.css`

```css
/* You can add your custom CSS here. */
```

### `src/json.ts`

```ts
export const json = {
  "elements": [{
    "type": "dropdown",
    "name": "country",
    "title": "Select a country",
    "description": "A full list of countries is queried from a RESTful web service.",
    "choicesByUrl": {
      "url": "https://surveyjs.io/api/CountriesExample",
      "valueName": "name"
    }
  }, {
    "type": "panel",
    "name": "countriesByRegion",
    "title": "Filter countries by selected region",
    "description": "Only countries from the selected region are queried.",
    "elements": [{
      "type": "dropdown",
      "name": "region",
      "title": "Select a region",
      "choices": ["Africa", "Americas", "Asia", "Europe", "Oceania"]
    }, {
      "type": "dropdown",
      "name": "reg_country",
      "title": "Select a country",
      "choicesByUrl": {
        "url": "https://surveyjs.io/api/CountriesExample?region={region}",
        "valueName": "name"
      }
    }]
  }]
};
```

### `src/main.ts`

```ts
import { createApp } from "vue";
import App from "./App.vue";

const app = createApp(App);
app.mount("#app");
```

### `src/shims-vue.d.ts`

```ts
/* eslint-disable */
declare module "*.vue" {
    import type { DefineComponent } from "vue"
    const component: DefineComponent<{}, {}, any>
    export default component
}
```

### `src/theme.ts`

```ts
export const themeJson = {};
```

### `.eslintrc.js`

```js
module.exports = {
    root: true,
    env: {
        node: true
    },
    extends: [
        "plugin:vue/vue3-essential",
        "eslint:recommended",
        "@vue/typescript/recommended",
        "@vue/prettier",
        "@vue/prettier/@typescript-eslint"
    ],
    parserOptions: {
        ecmaVersion: 2020
    },
    rules: {
        "no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
        "no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off"
    },
    overrides: [
        {
            files: [
                "**/__tests__/*.{j,t}s?(x)",
                "**/tests/unit/**/*.spec.{j,t}s?(x)"
            ],
            env: {
                jest: true
            }
        }
    ]
};
```

### `babel.config.js`

```js
module.exports = {
  presets: ["@vue/cli-plugin-babel/preset"]
};
```

### `package.json`

```json
{
  "name": "surveyjs-library-vue3",
  "version": "0.1.0",
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint"
  },
  "dependencies": {
    "core-js": "^3.6.5",
    "tslib": "2.6.1",
    "vue": "^3.4.1",
    "survey-core": "latest",
    "survey-vue3-ui": "latest",
    "vue-router": "^4.0.0-0",
    "vuex": "^4.0.0-0"
  },
  "devDependencies": {
    "@typescript-eslint/eslint-plugin": "^2.33.0",
    "@typescript-eslint/parser": "^2.33.0",
    "@vue/cli-plugin-babel": "~4.5.0",
    "@vue/cli-plugin-eslint": "~4.5.0",
    "@vue/cli-plugin-pwa": "~4.5.0",
    "@vue/cli-plugin-router": "~4.5.0",
    "@vue/cli-plugin-typescript": "~4.5.0",
    "@vue/cli-plugin-vuex": "~4.5.0",
    "@vue/cli-service": "~4.5.0",
    "@vue/compiler-sfc": "^3.0.0",
    "@vue/eslint-config-prettier": "^6.0.0",
    "@vue/eslint-config-typescript": "^5.0.2",
    "@vue/test-utils": "^2.0.0-0",
    "eslint": "^6.7.2",
    "eslint-plugin-prettier": "^3.1.3",
    "eslint-plugin-vue": "^7.0.0-0",
    "node-sass": "^4.12.0",
    "prettier": "^1.19.1",
    "sass-loader": "^8.0.2",
    "typescript": "~3.9.3"
  }
}
```

### `tsconfig.json`

```json
{
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "strict": true,
    "jsx": "preserve",
    "importHelpers": true,
    "moduleResolution": "node",
    "skipLibCheck": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "sourceMap": true,
    "baseUrl": ".",
    "types": [
      "webpack-env",
      "jest"
    ],
    "paths": {
      "@/*": [
        "src/*"
      ]
    },
    "lib": [
      "esnext",
      "dom",
      "dom.iterable",
      "scripthost"
    ]
  },
  "include": [
    "src/**/*.ts",
    "src/**/*.tsx",
    "src/**/*.vue",
    "tests/**/*.ts",
    "tests/**/*.tsx"
  ],
  "exclude": [
    "node_modules"
  ]
}
```

## Other Frameworks

- [Angular](https://surveyjs.io/form-library/examples/dropdown-menu-load-data-from-restful-service/angular.md)
- [React](https://surveyjs.io/form-library/examples/dropdown-menu-load-data-from-restful-service/reactjs.md)
- [jQuery](https://surveyjs.io/form-library/examples/dropdown-menu-load-data-from-restful-service/jquery.md)
- [Vanilla JS](https://surveyjs.io/form-library/examples/dropdown-menu-load-data-from-restful-service/vanillajs.md)