Return values

Container elements

Element Description
GeoResult If the location information is not unique, a list with the locations specified in question is returned. The search is started with the first address in the list, which is then also displayed in the result
Paging Information about the current page
AddressResult The list of addresses found according to the search criteria.
If the search is done via an identifier (ID), you get detailed
information, otherwise only basic data. A more detailed description can be found here.
RelatedBranches If there are related industries, they will be listed in this list
returned
SearchData Parameters used for the search
AddressItemsCopyright Copyright information on the returned addresses
Memoitem Opening hours of the returned addresses, if specified

Opening hours: value types

The opening hours values, as part of the mask data, are provided as one of the following two types:

Type 1: with delimiter ":"

Example:

1|08:00|20:00|09:00|20:00|10:00|15:00

Type 2: without delimiter

Example:

1|0800|2000|0900|2000|1000|1500

In above cases the delimiter can be desired delimiter can be chosen. We recommend to add the character as the third character from the right.

Opening hours: Masks

In some cases the opening hours are structured, then the "mask" provides the mask or structure to interpret the content.

Type 0 / free text (Enum: NONE)

If no type is specified in the field, it is interpreted as free text.

Type 1 (Enum: MASK_1)

The opening hours are deposited from Monday to Friday, Saturday and Sunday.

Example:

1|08:00|20:00|09:00|20:00|10:00|15:00

Output:

  • Monday to Friday from [1] to [2
  • Saturday from [3] to [4]
  • Sunday from [5] to [6]

Type 2 (Enum: MASK_2)

The opening hours are stored separately for each day of the week.

Example:

2|06:00|22:00|06:00|21:00|06:00|22:00|08:00|20:00|06:00|22:00|09:00|22:
00|11:00|16:00

Output:

  • Monday from [1] to [2]
  • ...
  • Friday from [9] to [10]
  • Saturday from [11] to [12]
  • Sunday from [13] to [14]

Type 3 (Enum: MASK_3)

Same mask as type 2, except that the field for a long Saturday is added. Note that in the following example the last two fields are left empty and therefore closed on Sunday.

Example:

3|10.00|20.00|10.00|20.00|10.00|20.00|10.00|20.00|10.00|20.00|12.00|18.
00|10.00|20.00||

Output:

  • Monday from [1] to [2]
  • ...
  • Saturday from [11] to [12]
  • Long saturday from [13] to [14]
  • Sunday closed

Type 4 (Enum: MASK_4)

The fourth mask contains opening hours for each day of the week, both for the morning and for the evening.
A long Saturday cannot be specified here.

Example:

4|08:00|12:00|13:00|18:00|08:00|12:00|13:00|18:00|08:00|12:00|13:00|18:
00|08:00|12:00|13:00|18:00|08:00|12:00|13:00|18:00|08:00|12:00||||||

Output:

  • Monday morning from [1] to [2]
  • Monday afternoon from [3] to [4]
  • ...
  • Saturday morning from [21] to [22]
  • Saturday afternoon from [23] to [24]
  • Sunday closed

Typ 5 (Enum: MASK_5)

The fifth mask is an exception. It contains a list of any length. The elements are separated by pipes.

Example:

The individual list elements have the form:
[Tag 2-Stellig]#[von]#[bis](#[Exception Date])  
Example:
Mo#0900#2100#2021-06-14
Or only:
Di#0800#2000#
Complete example:
5|Di#0800#2000#|Mi#0830#2000#|Fr#0800#1100#|Fr#1500#2100#

Output:

  • Tuesday from 08:00 to 20:00
  • Wednesday from 08:30 to 20:00
  • Friday from 08:00 to 11:00
  • Friday from 15:00 to 21:00

Info: The exception date represents a special opening time on a specified date, which is independent of the opening time specified for the weekday.

XML


<AddressSearchResult>
 <GeoResult>
 <GeoItem>
 <Country>String</Country>
 […]
 </GeoItem>
 <GeoItem>
 […]
 </GeoResult>
 <Paging>
 <Page>Unsigned Integer</Page>
 <MaxPage>Unsigned Integer</MaxPage>
 <Count>Unsigned Integer</Count>
 </Paging>
 <AddressResult>
 <AddressItem>
 […]
 </AddressItem>
 </AddressResult>
 <RelatedBranches>
 […]
 </RelatedBranches>
 <SearchData>
 […]
 </SearchData>
 <AddressItemsCopyright>
 […]
 </AddressItemsCopyright>
</AddressSearchResult>

Information about the input parameters of the circumference search can be found in the parameter overview.