openapi: 3.2.0
info:
  title: Decipher Rest LM Application Data API
  version: '1.0'
  description: The Decipher REST API allows comprehensive automation of your private or shared Decipher instance.
servers:
- url: https://{server}/api/v1
  description: Replace server with your instance domain.
  variables:
    server:
      default: selfserve.decipherinc.com
      description: Server domain
security:
- APIKey: []
tags:
- name: LM Application Data
paths:
  /surveys/{survey}/mls/application/data:
    get:
      operationId: getSurveyMLSApplicationData
      summary: Get Language Manager application data
      description: Returns data for the Language Manager application
      tags:
      - LM Application Data
      parameters:
      - $ref: '#/components/parameters/survey'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  DUPES:
                    type: integer
                    description: number of translations with duplicates
                  PRIMARY_LANGUAGE:
                    type: string
                    description: current primary language of the survey
                  RESOURCES:
                    type: array
                    description: information about each resource's current status
                    items:
                      type: object
                      properties:
                        dupeCount:
                          type:
                          - integer
                          - 'null'
                        resource:
                          type: string
                        resourceName:
                          type: string
                        status:
                          type: array
                          items:
                            type: object
                            properties:
                              identical:
                                type: boolean
                                description: 'is this translation the same as the original

                                  '
                              isDisplayedInThisLanguage:
                                type: boolean
                              isPrimary:
                                type: boolean
                              language:
                                type: string
                              missing:
                                type: boolean
                                description: is this translation missing
                              outdated:
                                type: boolean
                                description: 'has this resource changed, therefore making this

                                  translation outdated

                                  '
                              text:
                                type: string
                  SUMMARY:
                    type: object
                    description: 'summary of each language present in the survey; keys are

                      language identifiers

                      '
                    additionalProperties:
                      type: object
                      properties:
                        identical:
                          type: integer
                        missing:
                          type: integer
                        name:
                          type: string
                        nameFormatted:
                          type: string
                        ok:
                          type: integer
                        outdated:
                          type: integer
                        primary:
                          type: boolean
                        qualifieds:
                          type: integer
                        total:
                          type: integer
                        version:
                          type: integer
                  SURVEY_LANGUAGE_LIST:
                    type: array
                    description: languages present in the survey
                    items:
                      type: string
                  SYS_LANGUAGES:
                    type: object
                    description: 'system languages available for use, mapping language identifier

                      to language name

                      '
                    additionalProperties:
                      type: string
                  UNIQUE_DUPES:
                    type: integer
                    description: number of unique duplicates
                  UNUSED_LANGUAGE_LIST:
                    type: array
                    description: languages marked as unused in this survey
                    items:
                      type: string
              example:
                DUPES: 2
                PRIMARY_LANGUAGE: english_ca
                RESOURCES:
                - dupeCount: null
                  resource: general,name
                  resourceName: general,name
                  status:
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: false
                    language: english
                    missing: true
                    outdated: false
                    text: ''
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: true
                    language: english_ca
                    missing: false
                    outdated: false
                    text: Survey
                - dupeCount: null
                  resource: samplesources,0,invalid
                  resourceName: samplesources,0,invalid
                  status:
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: false
                    language: english
                    missing: true
                    outdated: false
                    text: ''
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: true
                    language: english_ca
                    missing: false
                    outdated: false
                    text: You are missing information in the URL. Please verify the URL with the original invite.
                - dupeCount: null
                  resource: samplesources,0,completed
                  resourceName: samplesources,0,completed
                  status:
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: false
                    language: english
                    missing: true
                    outdated: false
                    text: ''
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: true
                    language: english_ca
                    missing: false
                    outdated: false
                    text: It seems you have already entered this survey.
                - dupeCount: null
                  resource: samplesources,0,inuse
                  resourceName: samplesources,0,inuse
                  status:
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: false
                    language: english
                    missing: true
                    outdated: false
                    text: ''
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: true
                    language: english_ca
                    missing: false
                    outdated: false
                    text: Our records show that you are already taking this survey. If that's not correct, please wait 15 minutes and refresh this page. Thank you.
                - dupeCount: 2
                  resource: samplesources,0,exit:terminated,cdata
                  resourceName: samplesources,0,exit:terminated,cdata
                  status:
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: false
                    language: english
                    missing: true
                    outdated: false
                    text: ''
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: true
                    language: english_ca
                    missing: false
                    outdated: false
                    text: Thank you for taking our survey.
                - dupeCount: null
                  resource: samplesources,0,exit:qualified,cdata
                  resourceName: samplesources,0,exit:qualified,cdata
                  status:
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: false
                    language: english
                    missing: true
                    outdated: false
                    text: ''
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: true
                    language: english_ca
                    missing: false
                    outdated: false
                    text: Thank you for taking our survey. Your efforts are greatly appreciated!
                - dupeCount: 2
                  resource: samplesources,0,exit:overquota,cdata
                  resourceName: samplesources,0,exit:overquota,cdata
                  status:
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: false
                    language: english
                    missing: true
                    outdated: false
                    text: ''
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: true
                    language: english_ca
                    missing: false
                    outdated: false
                    text: Thank you for taking our survey.
                - dupeCount: null
                  resource: q1,title
                  resourceName: q1,title
                  status:
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: false
                    language: english
                    missing: true
                    outdated: false
                    text: ''
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: true
                    language: english_ca
                    missing: false
                    outdated: false
                    text: New Single Select Question
                - dupeCount: null
                  resource: q1,comment
                  resourceName: q1,comment
                  status:
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: false
                    language: english
                    missing: true
                    outdated: false
                    text: ''
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: true
                    language: english_ca
                    missing: false
                    outdated: false
                    text: Select one
                - dupeCount: null
                  resource: q1,r1,cdata
                  resourceName: q1,r1,cdata
                  status:
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: false
                    language: english
                    missing: true
                    outdated: false
                    text: ''
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: true
                    language: english_ca
                    missing: false
                    outdated: false
                    text: 'Sample Row #1'
                - dupeCount: null
                  resource: q1,r2,cdata
                  resourceName: q1,r2,cdata
                  status:
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: false
                    language: english
                    missing: true
                    outdated: false
                    text: ''
                  - identical: false
                    isDisplayedInThisLanguage: true
                    isPrimary: true
                    language: english_ca
                    missing: false
                    outdated: false
                    text: 'Sample Row #2'
                SUMMARY:
                  english:
                    identical: 0
                    missing: 11
                    name: english
                    nameFormatted: English
                    ok: 0
                    outdated: 0
                    primary: false
                    qualifieds: 0
                    total: 11
                    version: 0
                  english_ca:
                    identical: 0
                    missing: 0
                    name: english_ca
                    nameFormatted: English (Canada)
                    ok: 11
                    outdated: 0
                    primary: true
                    qualifieds: 0
                    total: 11
                    version: 0
                SURVEY_LANGUAGE_LIST:
                - english_ca
                - english
                SYS_LANGUAGES:
                  afrikaans: Afrikaans
                  albanian: Albanian
                  arabic: Arabic
                  arabic_egypt: Arabic (Egypt)
                  arabic_lebanon: Arabic (Lebanon)
                  arabic_morocco: Arabic (Morocco)
                  arabic_qatar: Arabic (Qatar)
                  arabic_saudiarabia: Arabic (Saudi Arabia)
                  arabic_uae: Arabic (UAE)
                  aus: English (Australia)
                  bulgarian: Bulgarian
                  burmese: Burmese (Myanmar)
                  canadian: French (Canada)
                  chinese: Chinese
                  croatian: Croatian
                  czech: Czech
                  danish: Danish
                  dutch: Dutch
                  dutch_belgium: Dutch (Belgium)
                  english: English
                  english_ca: English (Canada)
                  english_china: English (China)
                  english_g1: English (Generic 1)
                  english_g2: English (Generic 2)
                  english_g3: English (Generic 3)
                  english_g4: English (Generic 4)
                  english_hk: English (Hong Kong)
                  english_id: English (Indonesia)
                  english_india: English (India)
                  english_ireland: English (Ireland)
                  english_my: English (Malaysia)
                  english_nigeria: English (Nigeria)
                  english_sg: English (Singapore)
                  english_tw: English (Taiwan)
                  english_za: English (South Africa)
                  estonian: Estonian
                  finnish: Finnish
                  french: French
                  french_belgium: French (Belgium)
                  french_lu: French (Luxemborg)
                  german: German
                  german_austria: German (Austria)
                  german_lu: German (Luxemborg)
                  greek: Greek
                  hebrew: Hebrew
                  hindi: Hindi
                  hungarian: Hungarian
                  icelandic: Icelandic
                  indonesian: Indonesian
                  italian: Italian
                  japanese: Japanese
                  kannada: Kannada
                  khmer: Khmer
                  korean: Korean
                  latvian: Latvian
                  lithuanian: Lithunian
                  macedonian: Macedonian
                  malay: Malay
                  malay_sg: Malay (Singapore)
                  mongolian: Mongolian
                  norwegian: Norwegian
                  persian: Persian
                  polish: Polish
                  portuguese: Portuguese
                  portuguese_br: Portuguese (Brazil)
                  punjabi: Punjabi
                  romanian: Romanian
                  russian: Russian
                  samoan: Samoan
                  serbian: Serbian
                  simplifiedchinese: Chinese Simplified
                  simplifiedchinese_my: Simplified Chinese (Malaysia)
                  simplifiedchinese_sg: Simplified Chinese (Singapore)
                  slovak: Slovak
                  slovene: Slovene
                  slovenian: Slovenian
                  spanish: Spanish
                  spanish_argentina: Spanish (Argentina)
                  spanish_brazil: Spanish (Brazil)
                  spanish_chile: Spanish (Chile)
                  spanish_colombia: Spanish (Colombia)
                  spanish_ecuador: Spanish (Ecuador)
                  spanish_eu: Spanish (EU)
                  spanish_latin: Spanish (Latin America)
                  spanish_mexico: Spanish (Mexico)
                  spanish_peru: Spanish (Peru)
                  spanish_south: Spanish (South America)
                  spanish_venezuela: Spanish (Venezuela)
                  swahili: Swahili
                  swedish: Swedish
                  tagalog: Tagalog
                  tamil: Tamil
                  telugu: Telugu
                  thai: Thai
                  tongan: Tongan
                  traditionalchinese: Chinese Traditional
                  traditionalchinese_tw: Traditional Chinese (Taiwan)
                  turkish: Turkish
                  uk: English (UK)
                  ukrainian: Ukrainian
                  vietnamese: Vietnamese
                UNIQUE_DUPES: 1
                UNUSED_LANGUAGE_LIST: []
components:
  parameters:
    survey:
      name: survey
      in: path
      required: true
      description: The survey path.
      example: selfserve/1a/123456
      schema:
        type: string
        format: uri
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: x-apikey
      description: 'In order to access the api, you''ll need to generate an API key. Refer to the

        instructions [here](/docs/decipher/api#section/API-Keys) to generate and

        configure an API key with the appropriate permission sets. You can generate

        as many keys as required.


        Configure each request to include your API key in the request header. For example:


        ```

        x-apikey: dp48ss3mgsaucyjtybxw728h7s4cgnwzhejtszdwhf4xpe8yhmtdwpk2ntdhtwbs

        ```

        '
x-tagGroups:
- name: Autoclose
  tags:
  - Autoclose
- name: Data Input and Output
  tags:
  - Data
  - Data Feed
  - Response Summary
  - Modifying Data
  - Datasources
  - Datasources Data
  - Umerge
- name: Survey Metadata
  tags:
  - Simulated Data
  - Survey State
  - Survey Evaluate
  - Survey Quotas
  - Survey Files
  - Survey Warnings
  - Survey Terms
  - Survey Subscribers
  - Survey Users
  - Survey Tasks
- name: Panels
  tags:
  - Panel Data
  - Panel Datapoints
  - Survey Panels
- name: Research Hub
  tags:
  - Users
  - Companies
  - Categories
  - Surveys
  - Panels
  - Crosstabs
  - Archives
  - Archival Reports
  - API Keys
  - Usage
  - Warnings Summary
- name: Crosstabs
  tags:
  - Crosstabs Configuration
  - Crosstabs Execution
  - Crosstabs Nets
  - Saved Crosstabs
  - Crosstabs Table Settings
  - Crosstabs Validation
  - Crosstabs Rim Weighting
- name: Dashboards
  tags:
  - Dashboards
- name: DQ APIs
  tags:
  - DQ-Specific API Calls
  - MaxDiff API Calls
  - Discrete Choice Model API Calls
  - Media Testimonial API Calls
- name: Response Summary
  tags:
  - Share Link
- name: Sample Management
  tags:
  - Bounced Emails
  - Participant Sources
- name: Distribution
  tags:
  - Email Distribution
  - SFTP Distribution
  - Slack Distribution
- name: Campaign Manager
  tags:
  - Campaigns
  - Campaign Email Invites
  - Campaign Exports
  - Campaign Lists
  - Shared Campaign Lists
  - Campaign Sends
  - Campaign Status Lists
  - Supression Lists
- name: Question Library
  tags:
  - Company Element
  - Company Elements
  - Survey Elements
  - Survey Element Report Settings
- name: Language Manager
  tags:
  - LM Application Data
  - LM Application Translations
  - Translation Resources
  - Translations
  - Translation Deltas
  - Translation Reservations
  - Primary Survey Language
  - Other Survey Languages
  - Unused Survey Languages
- name: Project Parameters
  tags:
  - Available Project Parameters
  - Saved Project Parameters
  - Project Parameters Configuration
- name: Multi-User Editing
  tags:
  - Available Sections
  - Check Out Section
  - Check In Section
  - Sync Section
  - Section Editor
  - Abandon Section
  - Validate Section
- name: Video Management
  tags:
  - Videos
  - Watermarked Videos
- name: Miscellaneous
  tags:
  - System Information
  - Logic Nodes
  - Logic Events
  - CATI
  - Global Search
  - Miscellaneous