Location Response

Returns the information of the different levels of locations in our destination tree.

/locations/countries

JSON Schema

{
  "auditData": {    
      "processTime": "",  
      "timestamp": "", 
      "requestHost": "", 
      "serverId": "",  
      "environment": "", 
      "release": ""  
  }, 
  "countries": [    
    {   
      "code": "",   
      "isoCode": "", 
      "description": {    
           "languageCode": "",     
           "content": ""      
     }
    }
  ],
  "from": 0, 
  "to": 0, 
  "total": 0  
}

Response Parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime  String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
countries Array of Countries Occurrences 0..* No Key Top Level
countries/@code String 3 Key Internal Country Code
countries/@isoCode String 2 Key ISO Country Code
countries/description Element Occurrences 0..* No Key Country Description and Language
countries/description/@languageCode String 3 No Key Language in which the content is returned
countries/description/@content String 40 No Key Country Description
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

/locations/destinations

JSON Schema

{
  "auditData": {    
      "processTime": "",  
      "timestamp": "", 
      "requestHost": "",    
      "serverId": "",    
      "environment": "",  
      "release": ""    
  }, 
  "destinations":[
    {
      "code": ""
      "name": {    
        "languageCode": "",            
        "content": ""         
      },
      "countryCode": "", 
      "isoCode": "", 
      "zones": [
       {
         "zoneCode": 0,
         "name": "",
         "description": {      
              "languageCode": "",   
              "content": ""   
         }
       }
      ],
      "groupZones": [
       {
         "groupZoneCode":"",
         "name": {
           "languageCode": "",   
           "content": ""          
         },
         "zones":[
             0
         ]
       }
     ] 
    }
   ],
   "from": 0, 
   "to": 0,
   "total": 0 
 }

Response Parameters

Node/Attribute Type Max Size KEY Description
auditData Element Occurrences 1 No Key Relevant internal information
auditData/@processTime  String Occurrences 1 No Key Server process time in milliseconds
auditData/@timestamp String Occurrences 1 No Key Date/time when the requests has been processed. Always returned at Spanish time
auditData/@requestHost String Occurrences 1 No Key IP From where the petition was sent to the system
auditData/@serverId String Occurrences 1 No Key Server code or ID(Internal use)
auditData/@environment String Occurrences 1 No Key Environment where the request has been sent and processed
auditData/@release String Occurrences 1 No Key Internal release information.
destinations Array of Destinations Occurrences 0..* No Key Top Level
destinations/@code String 3 Key Internal Destination Code
destinations/name Element Occurrences 0..* No Key Destination Description and Language
destinations/name/@languageCode String 3 No Key Language in which the content is returned
destinations/name/@content String 50 No Key Destination Description
destinations/@countryCode String 3 Key Internal Country Code
destinations/@isoCode String 2 Key ISO Country Code
destinations/zones Array of Zones Occurrences 1 No Key List of zones in which the destination is divided.
destinations/zones/@zoneCode String 3 Key Internal Zone Code
destinations/zones/@name String 50 No Key Internal zone name
destinations/zones/description Element Occurrences 0..* No Key Zone Description and Language
destinations/zones/description/@languageCode String 3 No Key Language in which the content is returned
destinations/zones/description/@content String 50 No Key Multilanguage Zone description
destinations/groupZones Array of Zone Groups Occurrences 1 No Key List of zone groups
destinations/groupZones/@groupZoneCode String 50 Key Group Zone Code
destinations/groupZones/name Element Occurrences 0..* No Key Group Zone Description and Language
destinations/groupZones/name/@languageCode String 3 No Key Language in which the content is returned
destinations/groupZones/name/@content String 50 No Key Multilanguage Group Zone description
destinations/groupZones/zones Array of Zones Occurrences 1 No Key List of zones included in the group zone
@from Integer 8 No Key Record# origin of the response
@to Integer 8 No Key Record# end of the response
@total Integer 8 No Key Total available records

 

Docs Navigation