OkApi - rkokno.cz rest API

Release notes

• Added mapping between online tracking events and attachment categories

• Contract of contract extended with "prilohy"

• Contract detail "secret_url" renamed to "secret_owner_url"
• Contract detail extanded with "secret_buyer_url"

• New search parameter "from" added to "contrats/" endpoint

• Removed some contract events

• Contract of contract detail enhanced with field "pudorys_checksum" (Hexa MD5 checksum)
• Contract of contract photo enhanced with field "checksum" (Hexa MD5 checksum)

• Contract of contract search extended with additional field: preview
• No public vs internal filter is applied when retrieving contracts - now all contracts are returned
• Contracts of contracts unified - "contrats/" and "contracts/{id|url|secret_url}" and "/contracts/{id}/related" and "/contracts-recent" now return same response type

• Contract detail extended with additional fields: url, secret_url, preview

• New endpoint for contract syncing "contracts-sync"

• Removed field "foto_vertical" in contract of contract
• Search for contract via its url does not apply any restrictions anymore

• Contract of contract enhanced with "profi_photo" boolean

• Contract of reference now contains new field "inzerat_foto"

• Contract of contract photos now contains "foto_bez_loga_1" as the very first photo

• Contract of contract detail enhanced with field "foto_bez_loga_1"

• Contract of contract now correctly returns integer instead of strings

• Contract of contract detail enhanced with field "virtualni_prohlidka"

• Removed duplicated field `velikost_text` in contract contract

• Fix customer role (buyer or seller) in references

• References routes updated to follow DB merge of buyers and sellers

• Added route '/contracts/{id}/related' which returns other related Contracts

• Contract of contract detail enhanced with field "pudorys"
• Contract of contract detail enhanced with field "foto_vertical"

• Added route '/contracts-recent' which returns recently created Contracts

• Fix: Contracts in some categories in Contract search were not returned correctly

• Added missing "description" in contract of route '/contracts/{id}/'
• Remove useless photo related fields in contract of route '/contracts/{id}/' (route '/contracts/{id}/photos' should be used to retrieve photo related info)
• Added route '/contracts/{url}/' to which returns same contract as '/contracts/{id}/' but the search is based on URL

• New route for getting references added: '/references[/{id}]'
• Enhance contract search result to contain "state" field (e.g. to identify booked estates)

• Fixed contract search to support fulltext search e.g. 'contracts?typ=prodej&id_kategorie=3&id_okres=14&lokalita=olesna&fulltext=les&cena=2000000%2C5000000'
• New route for getting contract events (online tracking for customers) added: '/contract-events/{hash}'

• Branch route now returns the whole image path instead of just the name
• New route for getting finance specialist added: '/employees/finance'

• New route for getting district/districts added: '/districts[/{id}]'
• New route for getting offer/contract types added: '/offer-types'

• New route for getting main contract categories added: '/contracts/categories/main'

• Contract of contract detail now contains estate agent id so his/her details can be retrieved via '/employees/{id}' query
• New route for getting photos of a specific contract added: '/contracts/{id}/photos'
• Internal refactoring and optimisations

• Management route moved from '/management' under '/employees/management'
• Added new routes to get all employees '/employees' and one employee by id '/employees/{id}'
• Employee contract now contains the relative path to the photo instead of just the filename

• Split contract related rotes - either get detailed info about one contract or brief info about multiple contracts
• New type for contract search
• Contract now contains the relative path to the images/photos instead of just the filename

• Contract search
  • Example search query: https://okapi.rkokno.cz/contracts?typ=prodej&id_kategorie=2&id_okres=3&lokalita=brno&cena=969000%2C5969000&page=1&search-request=filter
  • Params:

    typ:

    prodej|podnajem

    id_kategorie:

    no query yet - check kategorie dropdown at https://www.rkokno.cz/hledam

    id_okres:

    no query yet - check kategorie dropdown at https://www.rkokno.cz/hledam

    lokalita:

    fulltext search against location

    cena

    min,max e.g. 969000,5969000

    page

    to loop through the results

  • Route is returning ContractDetail but more specific contract will be created soon
• CORS (untested)
• Contacts - management
  • new route: https://okapi.rkokno.cz/management