User Tools

Site Tools


en:public:developer:template_system:tags:api:get_lookuplist_content

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

en:public:developer:template_system:tags:api:get_lookuplist_content [2013/09/26 13:53]
svanderclock [Parameters]
en:public:developer:template_system:tags:api:get_lookuplist_content [2015/02/27 14:53] (current)
svanderclock [Parameters]
Line 8: Line 8:
  
 ^ Name                                                          ^ Mandatory ^ Default ^ Description       ^        ^ Name                                                          ^ Mandatory ^ Default ^ Description       ^       
-| <html><span style="color:#008000">lookuplist_name</span></html>      | Yes       |       | The ID of the lookup list | +| <html><span style="color:#008000">lookuplist_name</span></html>      | Yes       |       | The Name of the lookup list | 
-| <html><span style="color:#008000">lookuplist_language</span></html>  | No        |       | The language in with you want the label_* fields. Empty for all languages |+| <html><span style="color:#008000">fields</span></html>               | No        |       | The list of fields we want to retrieve separated by ';' EX: fields=ids;labels.deu |
 | <html><span style="color:#008000">output_format</span></html>        | No        | REST  | **JSON** to retrieve response in [[en:public:developer:template_system:tags:api:JSON_Response_Format|JSON Format]] or **REST** to retrieve in [[en:public:developer:template_system:tags:api:REST_Response_Format|REST Format]] | | <html><span style="color:#008000">output_format</span></html>        | No        | REST  | **JSON** to retrieve response in [[en:public:developer:template_system:tags:api:JSON_Response_Format|JSON Format]] or **REST** to retrieve in [[en:public:developer:template_system:tags:api:REST_Response_Format|REST Format]] |
 | <html><span style="color:#008000">jsoncallback</span></html>         | No        |       | Callback function to use in [[en:public:developer:template_system:tags:api:JSON_Response_Format|JSON Response Format]] | | <html><span style="color:#008000">jsoncallback</span></html>         | No        |       | Callback function to use in [[en:public:developer:template_system:tags:api:JSON_Response_Format|JSON Response Format]] |
 +
 +==== List of lookupList names ====
 +
 +broker_listing_import_type\\
 +broker_subscription_duration_type\\
 +broker_subscription_package_type\\
 +broker_subscription_status\\
 +contact_classification\\
 +contact_title\\
 +contact_type\\
 +creditcard_type\\
 +currency_code\\
 +gmap_api_returncode\\
 +gmap_map_type\\
 +invoice_status\\
 +language\\
 +lead_type\\
 +listing_contract_renewal_type\\
 +listing_contract_type\\
 +measurement_system\\
 +payment_method\\
 +product_type\\
 +property_category\\
 +property_classification\\
 +property_comment_type\\
 +property_condition\\
 +property_feature_type\\
 +property_heating_combustible\\
 +property_heating_type\\
 +property_listing_type\\
 +property_orderby\\
 +property_rent_period_duration_type\\
 +property_status\\
 +property_subtype\\
 +property_transaction_fee_rate_calc\\
 +property_transaction_type\\
 +property_type\\
 +propertyrequest_classification\\
 +propertyrequest_status\\
 +resource_string\\
 +
  
 ==== Error Codes ==== ==== Error Codes ====
Line 18: Line 59:
 | <html><span style="color:#008000">119</span></html> | Wrong Params | | <html><span style="color:#008000">119</span></html> | Wrong Params |
  
-==== Example ==== 
- 
-<code html> 
- 
-<#get_lookuplist_content lookuplist_name=lead_type with_schema=1 lookuplist_language=fra> 
- 
-</code> 
- 
-will output in **REST** 
- 
-<code xml> 
- 
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
-<rsp stat="ok"> 
-  <schema> 
-    <id> 
-      <type>7</type> 
-      <sub_type>0</sub_type> 
-      <length>2</length> 
-      <precision>0</precision> 
-      <scale>0</scale> 
-      <mandatory>1</mandatory> 
-      <primary>1</primary> 
-    </id> 
-    <label_fra> 
-      <type>37</type> 
-      <sub_type>0</sub_type> 
-      <length>50</length> 
-      <precision>-1</precision> 
-      <scale>0</scale> 
-      <mandatory>0</mandatory> 
-      <primary>0</primary> 
-    </label_fra> 
-  </schema> 
-  <lookupvalues> 
-    <lookupvalue> 
-      <id>1</id> 
-      <label_fra>Email</label_fra> 
-    </lookupvalue> 
-    <lookupvalue> 
-      <id>2</id> 
-      <label_fra>Web</label_fra> 
-    </lookupvalue> 
-    <lookupvalue> 
-      <id>3</id> 
-      <label_fra>Alerte</label_fra> 
-    </lookupvalue> 
-    <lookupvalue> 
-      <id>4</id> 
-      <label_fra>Telephone</label_fra> 
-    </lookupvalue> 
-  </lookupvalues> 
-</rsp> 
- 
-</code> 
- 
-And in **JSON** 
- 
-<code javascript> 
-{ 
-    "stat": "ok", 
-    "schema": { 
-        "id": { 
-            "type": 7, 
-            "sub_type": 0, 
-            "length": 2, 
-            "precision": 0, 
-            "scale": 0, 
-            "mandatory": true, 
-            "primary": true 
-        }, 
-        "label_fra": { 
-            "type": 37, 
-            "sub_type": 0, 
-            "length": 50, 
-            "precision": -1, 
-            "scale": 0, 
-            "mandatory": false, 
-            "primary": false 
-        } 
-    }, 
-    "lookupvalues": [ 
-        { 
-            "id": "1", 
-            "label_fra": "Email" 
-        }, 
-        { 
-            "id": "2", 
-            "label_fra": "Web" 
-        }, 
-        { 
-            "id": "3", 
-            "label_fra": "Alerte" 
-        }, 
-        { 
-            "id": "4", 
-            "label_fra": "Telephone" 
-        } 
-    ] 
-} 
  
-</code> 
en/public/developer/template_system/tags/api/get_lookuplist_content.1380189189.txt.gz · Last modified: 2013/09/26 13:53 (external edit)