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.

Response cached for 86400
10 Via email
110 Via app
120 Via API
20 Via web
21 Via web - link
22 Via web - iframe
23 Via web - pop-up
24 Via web - sign-in
30 Via paper
31 Via paper - sign-in
32 Via paper - flyer
33 Via paper - manual
34 Via paper - scan
40 Via telephone
50 Via kiosk
60 Face to face
70 Via SMS
80 Via panel provider
90 Tool revision
99 Via demo data

Request information

NameDescriptionTypeAdditional information
lang

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

string

Optional

Response information


NameDescriptionTypeAdditional information
Meta

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

MetaData

Data

The actual data returned by the request.

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.

Hateoas

Sample:
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2019-01-17T16:09:51.6975426Z",
    "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>2019-01-17T16:09:51.6975426+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>