{"id":22286192,"url":"https://github.com/ximex/ris-bka","last_synced_at":"2025-07-28T22:31:37.156Z","repository":{"id":29087482,"uuid":"32615801","full_name":"ximex/ris-bka","owner":"ximex","description":"Javascript lib for request to ris.bka.gv.at","archived":false,"fork":false,"pushed_at":"2015-04-19T21:27:20.000Z","size":616,"stargazers_count":6,"open_issues_count":7,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-07T19:58:27.225Z","etag":null,"topics":["bka","gesetz","law","recht","ris"],"latest_commit_sha":null,"homepage":"https://www.ris.bka.gv.at/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ximex.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-21T01:44:43.000Z","updated_at":"2022-08-09T07:18:54.000Z","dependencies_parsed_at":"2022-08-09T09:15:27.481Z","dependency_job_id":null,"html_url":"https://github.com/ximex/ris-bka","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ximex%2Fris-bka","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ximex%2Fris-bka/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ximex%2Fris-bka/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ximex%2Fris-bka/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ximex","download_url":"https://codeload.github.com/ximex/ris-bka/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227961858,"owners_count":17847836,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bka","gesetz","law","recht","ris"],"created_at":"2024-12-03T16:55:03.451Z","updated_at":"2024-12-03T16:55:04.304Z","avatar_url":"https://github.com/ximex.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RIS-BKA\n\n[![Build Status](https://travis-ci.org/ximex/ris-bka.svg)](https://travis-ci.org/ximex/ris-bka)\n[![Code Climate](https://codeclimate.com/github/ximex/ris-bka/badges/gpa.svg)](https://codeclimate.com/github/ximex/ris-bka)\n[![Test Coverage](https://codeclimate.com/github/ximex/ris-bka/badges/coverage.svg)](https://codeclimate.com/github/ximex/ris-bka)\n[![Dependency Status](https://david-dm.org/ximex/ris-bka.svg)](https://david-dm.org/ximex/ris-bka)\n[![devDependency Status](https://david-dm.org/ximex/ris-bka/dev-status.svg)](https://david-dm.org/ximex/ris-bka#info=devDependencies)\n\n## Usage\n\n```bash\n$ npm install\n```\n```javascript\n// In your project import the 'ris-bka' module\nvar RisBka = require('ris-bka');\n// Use this object to execute methods (listed below)\n```\n\n### Methods\n- **getVersion:** `RisBka.getVersion(cbOk, [cbFail])`\n- **searchDocuments:** `RisBka.searchDocuments(query, cbOk, [cbFail])`\n- **getDocument:** `RisBka.getDocument(docId, cbOk, [cbFail])`\n\n### Callbacks\n- **cbOk:** `function (soapBody, [raw]) { ... }` - Executed if all works fine\n- **cbFail:** `function (err, soapBody, [raw]) { ... }` - Executed if any error appears\n\n### Parameter\n- **query:**\n  - Type: `Object`\n  - More: Look *Query-Structure*\n- **docId:**\n  - Type: `String`\n  - Example: `'NOR40091435'`\n- **err:**\n  - Type: `Object`\n  - Structure: `{ errorType: 'String', error: { ... } }`\n- **soapBody:**\n  - Type: `Object`\n  - More: Look *soapBody-Structure*\n- **raw:**\n  - Type: `Object`\n  - Structure: `{ error: { ... }, response: { ... }, body: { ... } }`\n  - Info: Response parameters from **request** module\n\n### Object-Structure\n\n#### Query\n```javascript\n{\n  searchTerms: {}, // SearchExpression\n  title: {}, // SearchExpression\n  index: {}, // SearchExpression\n  section: {\n    number: {\n      start: 1, // Start-Number (Integer)\n      end: 2 // End-Number (Integer)\n    },\n    character: {\n      start: 'a', // Start-Character\n      end: 'z' // End-Character\n    },\n    typ: '' // \"Alle\", \"Artikel\", \"Paragraph\", \"Anlage\"\n  },\n  versionDate: '', // Date\n  announcementInstitution: '', // PhraseSearchExpression\n  announcementInstitutionNumber: '', // PhraseSearchExpression\n  includedDate: '', // \"Undefined\", \"EinerWoche\", \"ZweiWochen\", \"EinemMonat\", \"DreiMonaten\", \"SechsMonaten\", \"EinemJahr\"\n  paging: {\n    docsPerPage: '', // \"Ten\", \"Twenty\", \"Fifty\", \"OneHundred\"\n    page: 1 // Integer [required]\n  },\n  sort: {\n    direction: '', // \"Ascending\", \"Descending\" [required]\n    column: '' // \"ArtikelParagraphAnlage\", \"Kurzinformation\" [required]\n  }\n}\n```\n\n##### SearchExpression\n`{}` represents a search expression\n```javascript\n// AND\n{\n  and: [{}, ...]\n}\n// OR\n{\n  or: [{}, ...]\n}\n// NOT\n// NOT IMPLEMENTED YET!!!\n//{\n//  not: {}\n//}\n// MASK\n{\n  mask: 'SearchString' // automatically gets '*' attached -\u003e 'SearchString*'\n}\n// VALUE\n{\n  value: 'SearchString'\n}\n// SHORTCUT\n'SearchString' // Same as VALUE\n```\n\n#### soapBody\n\n##### getVersion\n```javascript\n'OGD_1.3.0'\n```\n\n##### searchDocuments\n```javascript\n{\n  paging: {\n    page: 'Integer',\n    size: 'Integer',\n    count: 'Integer'\n  },\n  results: [\n    {\n      application: 'String',\n      documentNumber: 'String',\n      articleParagraphAttachment: 'String',\n      shortInformation: 'String',\n      documentUrl: 'String'\n    },\n    { ... }\n  ]\n}\n```\n\n##### getDocument\n```javascript\n{\n  application: 'String',\n  documentNumber: 'String',\n  shortTitle: 'String',\n  announcementInstitution: 'String',\n  typ: 'String',\n  articleParagraphAttachment: 'String',\n  comeIntoForceDate: 'Date',\n  exceptIntoForceDate: 'Date',\n  abbreviation: 'String',\n  signingDate: 'Date',\n  indices: ['String', ... ],\n  transitionLaw: 'String',\n  considerForWholeLaw: 'String',\n  consider: 'String',\n  change: 'String',\n  longTitle: 'String',\n  languages: 'String',\n  states: 'String',\n  noteForWholeLaw: 'String',\n  note: 'String',\n  keywords: 'String',\n  releaseDate: 'Date',\n  changeDate: 'Date',\n  lawNumber: 'String',\n  oldDocumentNumber: 'String',\n  documentContent: [\n    {\n      contentType: 'String',\n      name: 'String',\n      dataType: 'String',\n      risDoc: {\n        metaData: { ... },\n        userData: { ... },\n        layoutData: { ... }\n      }\n    },\n    { ... }\n  ]\n}\n```\n\n\n## Useful URLs\n- https://www.data.gv.at/katalog/dataset/31430a9f-c8ba-4654-ab68-c9c3dff0361b\n- https://www.ris.bka.gv.at/Bundesrecht/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fximex%2Fris-bka","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fximex%2Fris-bka","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fximex%2Fris-bka/lists"}