Common objects

These are JSON object definitions and other JSON entities shared by operations across the API.

Time interval

{
    "StartUtc": "2020-01-05T00:00:00Z",
    "EndUtc": "2020-01-10T00:00:00Z"
}

Property	Type	Contract	Description
StartUtc	string	required	Start of the interval in UTC timezone in ISO 8601 format (see Datetimes).
EndUtc	string	required	End of the interval in UTC timezone in ISO 8601 format (see Datetimes).

String update value

{
    "Value": "182a56ee-037d-4da5-b6f8-ada8006e7d5c"
}

Property	Type	Contract	Description
Value	string	optional	Value which is to be updated.

Bool update value

{
    "Value": false
}

Property	Type	Contract	Description
Value	boolean	optional	Value which is to be updated.

Number update value

{
    "Value": 6
}

Property	Type	Contract	Description
Value	number	optional	Value which is to be updated.

Integer update value

{
    "Value": 5
}

Property	Type	Contract	Description
Value	integer	optional	Value which is to be updated.

Array of strings update value

{
    "Value": 
    [
        "182a56ee-037d-4da5-b6f8-ada8006e7d5c",
        "4a1a7f12-4024-41ba-9289-f90448682d3a"
    ]
}

Property	Type	Contract	Description
Value	array of strings	optional	Value which is to be updated.

Dictionary

Dictionary is a collection of key-value pairs, where both keys and values are strings.

{
    "TaxIdentifier": "CZ8810310963",
    "CityOfRegistration": "Prague"
}

Property	Type	Contract	Description
?Key?	string	optional	Some value corresponding to the ?Key? unique identifier. Cannot be null.

Dictionary of integers

Dictionary of integers is a collection of key-value pairs, where keys are strings and the values are arrays of integer.

{
    "OutOfOrderBlocks": [0, 1, 0, 0, 1],
    "PublicAvailabilityAdjustment": [7, 5, 4, 3, 4]
}

Property	Type	Contract	Description
?Key?	array of integer	optional	A set of integer values corresponding to the ?Key? unique identifier. Cannot be null.

Activity state

• Active - indicates active record.

• Deleted- indicates deleted record.

Localized text

A Dictionary object where the keys are Language codes and the corresponding values are versions of the text in the respective language. For example:

{
    "cs-CZ": "Děti",
    "da-DK": "Børn",
    "de-CH": "Kinder",
    "de-DE": "Kinder",
    "el-GR": "Παιδιά",
    "en-GB": "Children"
}