v1 > Lookups > PropertyDetailsLookup

Lookup details for a given property.

  • URL

    /connect/v1/properties/{code}

  • Method:

    GET

  • URL Params

Param Type Required Description Domain of value
code string Yes The code of the property you want to obtain the details See PropertiesLookup for a list of possible values
locale string Yes An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'

  • Sample URL

    /connect/v1/properties/IDEALPROJECTS?locale=en

  • Request :

    The request has no body.

  • Response :
Field Type Presence Description Domain of value
status object Always The execution status A status object
status.state string Always The state of execution 'SUCCESS' or 'ERROR'
status.code string On error The general error code and message See Errors reference
status.messages[] array of string On error List of errors causes A validation message or other causes
result object On success The execution result A result object
result.entityType string On success The type of entity this result is about 'PROPERTY'
result.propertyResource object On success A property values PropertyResource object
result.propertyResource.locale string On success An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
result.propertyResource.name string On success The name of this property A string
result.propertyResource.code string On success The unique code of this property A string
result.propertyResource.possibleValues[] array of object On success The list of possible values of this property A PropertyValues object(s)
result.propertyResource.possibleValues[].name string On success The value name A string
result.propertyResource.possibleValues[].code string On success The value unique code A string
result.propertyResource.possibleUnits[] array of object On success The list of possible units of this property A PropertyUnits object(s)
result.propertyResource.possibleUnits[].name string On success The unit name A string
result.propertyResource.possibleUnits[].code string On success The unit unique code A string
connectRequest object Always The exact request sent that produced this response A PropertyDetailsLookup request

  • Sample Response (Success): ideal project values

    HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"PROPERTY",
    "propertyResource": {      
      "locale":"en",
      "name":"Ideal Projects",
      "code":"IDEALPROJECTS",
      "possibleValues":[
        {
          "name":"Commercial",
          "code":"COMMERCIAL"
        },
        {
          "name":"Educational",
          "code":"EDUCATIONAL"
        },
        {
          "name":"Healthcare",
          "code":"HEALTHCARE"
        },
        {
          "name":"Hospitality",
          "code":"HOSPITALITY"
        },
        {
          "name":"Institutional",
          "code":"INSTITUTIONAL"
        },
        {
          "name":"Residential",
          "code":"RESIDENTIAL"
        },
        {
          "name":"Retail",
          "code":"RETAIL"
        },
        {
          "name":"Multi-Residential",
          "code":"MULTI-RES"
        },
        {
          "name":"Other",
          "code":"OTHER"
        }
      ]
    }
  },
  "connectRequest":{
    "locale":"en",
    "code":"idealprojects"
  }
}

  • Sample Response (Success): weight units

    HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"PROPERTY",
    "propertyResource": {
      "locale":"en",
      "name":"Weight",
      "code":"WEIGHT",
      "possibleUnits":[
        {
          "name":"g",
          "code":"GRAM"
        },
        {
          "name":"kg",
          "code":"KILOGRAM"
        },
        {
          "name":"lb",
          "code":"POUND"
        }
      ]
    }    
  },
  "connectRequest":{
    "locale":"en",
    "code":"weight"
  }
}

  • Sample Response (Error):

    HTTP Code : 400, 500

{
    "status": {
        "state": "ERROR",
        "code": "CE00001 - Connect request failed validation. Refer to provided messages for details.",
        "messages": [
            "Request has invalid value 'es' for field locale. Allowed value(s) : [de, es_MX, en, fr, zh_CN]"
        ]
    },
    "connectRequest": {
        "locale": "es"
    }
}

results matching ""

    No results matching ""