/mlit_etsuran/vacation_rental_managers/search

POST /api/mlit_etsuran/vacation_rental_managers/search

Price: 5 credits

Search Japan's national register of vacation-rental (minpaku) management companies (住宅宿泊管理業者) by name or kana reading, registration number range and office prefecture: one row per office with the id, renewal count and registration number, name, representative, office name and address

How to use it

Rows are offices, so one company appears once per office unless head_office_only is set. Pass license_id to mlit_etsuran/vacation_rental_managers for the registration record.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• name string nullable — Text of the company or trade name (examples: "鹿島建設", "三井不動産"; minLength: 1)
• name_kana string nullable — Text of the name's katakana reading (examples: "トヨタ", "ミツイフドウサン"; minLength: 1)
• license_number_from integer nullable — Lowest licence or registration number (examples: 10000; min: 0)
• license_number_to integer nullable — Highest licence or registration number (examples: 20000; min: 0)
• prefecture string nullable — Prefecture where an office of the licence holder is (one of: "hokkaido", "aomori", "iwate", "miyagi", "akita", "yamagata", "fukushima", "ibaraki", "tochigi", "gunma", "saitama", "chiba", "tokyo", "kanagawa", "niigata", "toyama", "ishikawa", "fukui", "yamanashi", "nagano", "gifu", "shizuoka", "aichi", "mie", "shiga", "kyoto", "osaka", "hyogo", "nara", "wakayama", "tottori", "shimane", "okayama", "hiroshima", "yamaguchi", "tokushima", "kagawa", "ehime", "kochi", "fukuoka", "saga", "nagasaki", "kumamoto", "oita", "miyazaki", "kagoshima", "okinawa")
• head_office_only boolean — Keep only head-office rows (default: false)
• sort_order string — Sort direction (default: "asc"; one of: "asc", "desc")
• count integer required — Max number of results (min: 1; max: 15000)
• sort_by string — Sort key (default: "registration_number"; one of: "registration_number", "name", "representative", "address")

Response

• @type string (default: "MlitEtsuranVacationRentalManagerListing")
• license_id string required
• authority string nullable
• renewal_count integer nullable
• license_number string nullable
• name string required
• representative string nullable
• office_name string nullable
• address string nullable

Errors

• 422 — Both name and name_kana were passed, or license_number_from is above license_number_to Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.