1. v3
  2. Lookup
  3. GET - 3/lookup/distribution

Definition

GET - 3/lookup/distribution?lang={lang}

Retrieve the distribution method id and names for the distribution methods we offer. The data will be retrieved in the requested language.

Used in Respondent - DistributionMethodId

Response cached for 86400 seconds.

10 Email
11 Email - contacts
12 Email - non-contacts
20 Web
21 Web - link
22 Web - iframe
23 Web - pop-up
24 Web - sign-in
30 Paper
31 Paper - sign-in
32 Paper - flyer
33 Paper - manual
34 Paper - scan
40 Telephone
50 Kiosk
60 Face to face
70 SMS
80 Panel provider
90 Tool revision
99 Demo data
110 App
120 API

Request information

lang

The two-letter code of the requested language, if not available we will use english


Type string
Additional info
Optional

Response information


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type Collection of SimpleLookup
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-12-03T17:28:39.3426337Z",
    "IsFiltered": true
  },
  "Data": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  ]
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <SimpleLookup z:Id="i2">
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </SimpleLookup>
    <SimpleLookup z:Ref="i2" />
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-12-03T17:28:39.3426337+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>