From 99c8a0f240efac3c55ae5ae9546585f73d41ddd4 Mon Sep 17 00:00:00 2001 From: Alberto Abella Date: Thu, 26 Oct 2023 03:41:53 +0200 Subject: [PATCH] updated RevenueCollection/doc/spec_KO.md --- RevenueCollection/doc/spec_KO.md | 703 +++++++++++++++++++++++++++++++ 1 file changed, 703 insertions(+) create mode 100644 RevenueCollection/doc/spec_KO.md diff --git a/RevenueCollection/doc/spec_KO.md b/RevenueCollection/doc/spec_KO.md new file mode 100644 index 0000000..53f5589 --- /dev/null +++ b/RevenueCollection/doc/spec_KO.md @@ -0,0 +1,703 @@ + +[![Smart Data Models](https://smartdatamodels.org/wp-content/uploads/2022/01/SmartDataModels_logo.png "Logo")](https://smartdatamodels.org) + Entity: RevenueCollection +========================= + + [오픈 라이선스](https://github.com/smart-data-models//dataModel.PublicAccountability/blob/master/RevenueCollection/LICENSE.md) + [문서 자동 생성](https://docs.google.com/presentation/d/e/2PACX-1vTs-Ng5dIAwkg91oTTUdt8ua7woBXhPnwavZ0FxgR8BsAI_Ek3C5q97Nd94HS8KhP-r_quD4H0fgyt3/pub?start=false&loop=false&delayms=3000#slide=id.gb715ace035_0_60) + + + 글로벌 설명: **도시 세입 징수 운영을 위한 데이터 모델입니다. + 버전: 0.0.1 + + + + ## 속성 목록 + + [*] 속성에 유형이 없는 것은 여러 유형 또는 다른 형식/패턴을 가질 수 있기 때문입니다. +- `address[object]`: 우편 주소 . Model: [https://schema.org/address](https://schema.org/address) - `addressCountry[string]`: 국가. 예를 들어, 스페인 . Model: [https://schema.org/addressCountry](https://schema.org/addressCountry) + - `addressLocality[string]`: 도로명 주소가 있는 지역 및 해당 지역에 속한 지역 . Model: [https://schema.org/addressLocality](https://schema.org/addressLocality) + - `addressRegion[string]`: 해당 지역이 위치한 지역과 해당 국가의 지역 . Model: [https://schema.org/addressRegion](https://schema.org/addressRegion) + - `district[string]`: 지구는 일부 국가에서는 지방 정부에서 관리하는 행정 구역의 일종입니다. + - `postOfficeBoxNumber[string]`: 사서함 주소의 우체국 사서함 번호입니다. 예: 03578 . Model: [https://schema.org/postOfficeBoxNumber](https://schema.org/postOfficeBoxNumber) + - `postalCode[string]`: 우편 번호입니다. 예: 24004 . Model: [https://schema.org/https://schema.org/postalCode](https://schema.org/https://schema.org/postalCode) + - `streetAddress[string]`: 거리 주소 . Model: [https://schema.org/streetAddress](https://schema.org/streetAddress) + - `streetNr[string]`: 공공 도로의 특정 건물을 식별하는 번호 +- `alternateName[string]`: 이 항목의 대체 이름 - `amountCollected[number]`: 이 관찰에 해당하는 서비스를 위해 수집된 금액 - `areaServed[string]`: 서비스 또는 제공 품목이 제공되는 지리적 영역 . Model: [https://schema.org/Text](https://schema.org/Text) - `dataProvider[string]`: 조화된 데이터 엔티티의 공급자를 식별하는 일련의 문자 - `dateCreated[date-time]`: 엔티티 생성 타임스탬프. 이는 일반적으로 스토리지 플랫폼에서 할당합니다. - `dateModified[date-time]`: 엔티티의 마지막 수정 타임스탬프입니다. 이는 일반적으로 스토리지 플랫폼에서 할당합니다. - `dateObserved[date-time]`: ISO8601 UTC 형식의 이 관측 날짜 및 시간 - `description[string]`: 이 항목에 대한 설명 - `enrollmentCertificateRecoveryAmount[number]`: 연간 기준으로 시설에서 등록 증명서를 위해 징수한 금액 - `id[*]`: 엔티티의 고유 식별자 - `location[*]`: 항목에 대한 지오숀 참조입니다. 포인트, 라인 문자열, 다각형, 멀티포인트, 멀티라인 문자열 또는 멀티폴리곤일 수 있습니다. - `month[string]`: 이 관측에 해당하는 월이며 MM 형식으로 설명됩니다(예: 5월의 경우 '05'). - `municipalityInfo[object]`: 이 관측에 해당하는 지자체 정보 - `addressLocality`: + - `addressRegion`: + - `cityId`: + - `district`: + - `ulbName`: + - `wardNum`: + - `zoneId`: +- `name[string]`: 이 항목의 이름 - `owner[array]`: 소유자의 고유 ID를 참조하는 JSON 인코딩된 문자 시퀀스가 포함된 목록입니다. - `registrationCertificateRecoveryAmount[number]`: 직원당 사업장으로부터 매월 등록 증명서를 위해 징수한 금액 - `revenueCollectionType[string]`: 시 당국이 수입을 징수하는 출처의 유형은 재산세, 차량 등록, 파티장 예약, 커뮤니티 홀 예약, 강당 예약 등이 될 수 있습니다. - `seeAlso[*]`: 항목에 대한 추가 리소스를 가리키는 URL 목록 - `source[string]`: 엔티티 데이터의 원본 소스를 URL로 제공하는 문자 시퀀스입니다. 소스 공급자의 정규화된 도메인 이름 또는 소스 개체에 대한 URL을 사용하는 것이 좋습니다. - `totalCount[number]`: 이 관찰에 해당하는 수익 수금 서비스의 개수 - `type[string]`: NGSI 엔티티 유형. RevenueCollection이어야 합니다. - `vehicleType[string]`: 구조적 특성의 관점에서 본 차량 유형. 이는 차량 카테고리와는 다릅니다. 다음 값은 _VehicleTypeEnum_ 및 _VehicleTypeEnum2_, [DATEX 2 버전 2.3](http://d2docs.ndwcloud.nu/_static/umlmodel/v2.3/index.htm)에서 정의합니다. - `vehicleTypeCode[string]`: 이 관측에 해당하는 차량 유형 코드입니다. 예: '1' - 오토바이/스쿠터, '2' - 모터사이클, '4' - 자가용/지프차, '21' - 템포, '26' - 버스 등 - `year[string]`: 이 관측에 해당하는 연도이며, '2020'과 같이 YYYY 형식으로 설명됩니다. + + 필수 속성 + + + + + ## 속성에 대한 데이터 모델 설명 + 알파벳순으로 정렬(자세한 내용을 보려면 클릭) + + +
full yaml details + ```yaml +RevenueCollection: + description: A Data Model for city revenue collection operations. + properties: + address: + description: The mailing address + properties: + addressCountry: + description: 'The country. For example, Spain' + type: string + x-ngsi: + model: https://schema.org/addressCountry + type: Property + addressLocality: + description: 'The locality in which the street address is, and which is in the region' + type: string + x-ngsi: + model: https://schema.org/addressLocality + type: Property + addressRegion: + description: 'The region in which the locality is, and which is in the country' + type: string + x-ngsi: + model: https://schema.org/addressRegion + type: Property + district: + description: 'A district is a type of administrative division that, in some countries, is managed by the local government' + type: string + x-ngsi: + type: Property + postOfficeBoxNumber: + description: 'The post office box number for PO box addresses. For example, 03578' + type: string + x-ngsi: + model: https://schema.org/postOfficeBoxNumber + type: Property + postalCode: + description: 'The postal code. For example, 24004' + type: string + x-ngsi: + model: https://schema.org/https://schema.org/postalCode + type: Property + streetAddress: + description: The street address + type: string + x-ngsi: + model: https://schema.org/streetAddress + type: Property + streetNr: + description: Number identifying a specific property on a public street + type: string + x-ngsi: + type: Property + type: object + x-ngsi: + model: https://schema.org/address + type: Property + alternateName: + description: An alternative name for this item + type: string + x-ngsi: + type: Property + amountCollected: + description: Amount collected towards the service corresponding to this observation + type: number + x-ngsi: + type: Property + areaServed: + description: The geographic area where a service or offered item is provided + type: string + x-ngsi: + model: https://schema.org/Text + type: Property + dataProvider: + description: A sequence of characters identifying the provider of the harmonised data entity + type: string + x-ngsi: + type: Property + dateCreated: + description: Entity creation timestamp. This will usually be allocated by the storage platform + format: date-time + type: string + x-ngsi: + type: Property + dateModified: + description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform + format: date-time + type: string + x-ngsi: + type: Property + dateObserved: + description: The date and time of this observation in ISO8601 UTC format + format: date-time + type: string + x-ngsi: + type: Property + description: + description: A description of this item + type: string + x-ngsi: + type: Property + enrollmentCertificateRecoveryAmount: + description: Amount collected towards Enrollment Certificate from the establishment on annual basis + type: number + x-ngsi: + type: Property + id: + anyOf: + - description: Identifier format of any NGSI entity + maxLength: 256 + minLength: 1 + pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$ + type: string + x-ngsi: + type: Property + - description: Identifier format of any NGSI entity + format: uri + type: string + x-ngsi: + type: Property + description: Unique identifier of the entity + x-ngsi: + type: Property + location: + description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon' + oneOf: + - description: Geojson reference to the item. Point + properties: + bbox: + items: + type: number + minItems: 4 + type: array + coordinates: + items: + type: number + minItems: 2 + type: array + type: + enum: + - Point + type: string + required: + - type + - coordinates + title: GeoJSON Point + type: object + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. LineString + properties: + bbox: + items: + type: number + minItems: 4 + type: array + coordinates: + items: + items: + type: number + minItems: 2 + type: array + minItems: 2 + type: array + type: + enum: + - LineString + type: string + required: + - type + - coordinates + title: GeoJSON LineString + type: object + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. Polygon + properties: + bbox: + items: + type: number + minItems: 4 + type: array + coordinates: + items: + items: + items: + type: number + minItems: 2 + type: array + minItems: 4 + type: array + type: array + type: + enum: + - Polygon + type: string + required: + - type + - coordinates + title: GeoJSON Polygon + type: object + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. MultiPoint + properties: + bbox: + items: + type: number + minItems: 4 + type: array + coordinates: + items: + items: + type: number + minItems: 2 + type: array + type: array + type: + enum: + - MultiPoint + type: string + required: + - type + - coordinates + title: GeoJSON MultiPoint + type: object + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. MultiLineString + properties: + bbox: + items: + type: number + minItems: 4 + type: array + coordinates: + items: + items: + items: + type: number + minItems: 2 + type: array + minItems: 2 + type: array + type: array + type: + enum: + - MultiLineString + type: string + required: + - type + - coordinates + title: GeoJSON MultiLineString + type: object + x-ngsi: + type: GeoProperty + - description: Geojson reference to the item. MultiLineString + properties: + bbox: + items: + type: number + minItems: 4 + type: array + coordinates: + items: + items: + items: + items: + type: number + minItems: 2 + type: array + minItems: 4 + type: array + type: array + type: array + type: + enum: + - MultiPolygon + type: string + required: + - type + - coordinates + title: GeoJSON MultiPolygon + type: object + x-ngsi: + type: GeoProperty + x-ngsi: + type: GeoProperty + month: + description: 'Month corresponding to this observation and is described in MM format, for eg. ''05'' for the month of May' + type: string + x-ngsi: + type: Property + municipalityInfo: + description: Municipality information corresponding to this observation + properties: + addressLocality: + type: string + addressRegion: + type: string + cityId: + type: string + district: + type: string + ulbName: + type: string + wardNum: + type: number + zoneId: + type: string + type: object + x-ngsi: + type: Property + name: + description: The name of this item + type: string + x-ngsi: + type: Property + owner: + description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s) + items: + anyOf: + - description: Identifier format of any NGSI entity + maxLength: 256 + minLength: 1 + pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$ + type: string + x-ngsi: + type: Property + - description: Identifier format of any NGSI entity + format: uri + type: string + x-ngsi: + type: Property + description: Unique identifier of the entity + x-ngsi: + type: Property + type: array + x-ngsi: + type: Property + registrationCertificateRecoveryAmount: + description: Amount collected towards Registration Certificate on monthly basis from the establishment per employee + type: number + x-ngsi: + type: Property + revenueCollectionType: + description: 'Type of source from which the city administration collects the revenue, could be property tax, vehicle registration, party hall booking, community hall booking, auditorium booking etc' + type: string + x-ngsi: + type: Property + seeAlso: + description: list of uri pointing to additional resources about the item + oneOf: + - items: + format: uri + type: string + minItems: 1 + type: array + - format: uri + type: string + x-ngsi: + type: Property + source: + description: 'A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object' + type: string + x-ngsi: + type: Property + totalCount: + description: Count of the revenue collection service corresponding to this observation + type: number + x-ngsi: + type: Property + type: + description: NGSI Entity type. It has to be RevenueCollection + enum: + - RevenueCollection + type: string + x-ngsi: + type: Property + vehicleType: + description: 'Type of vehicle from the point of view of its structural characteristics. This is different than the vehicle category . The following values defined by _VehicleTypeEnum_ and _VehicleTypeEnum2_, [DATEX 2 version 2.3](http://d2docs.ndwcloud.nu/_static/umlmodel/v2.3/index.htm)' + enum: + - agriculturalVehicle + - anyVehicle + - articulatedVehicle + - autorickshaw + - bicycle + - binTrolley + - BRT mini bus· + - BRT bus + - bus + - car + - caravan + - carOrLightVehicle + - carWithCaravan + - carWithTrailer + - cleaningTrolley + - compactor + - constructionOrMaintenanceVehicle + - dumper + - e-moped + - e-scooter + - e-motorcycle + - fourWheelDrive + - highSidedVehicle + - hopper + - lorry + - minibus + - moped + - motorcycle + - motorcycleWithSideCar + - motorscooter + - sweepingMachine + - tanker + - tempo + - threeWheeledVehicle + - tipper + - trailer + - tram + - trolley + - twoWheeledVehicle + - van + - vehicleWithoutCatalyticConverter + - vehicleWithCaravan + - vehicleWithTrailer + - withEvenNumberedRegistrationPlates + - withOddNumberedRegistrationPlates + - other + type: string + x-ngsi: + type: Property + vehicleTypeCode: + description: 'The code for vehicleType corresponding to this observation. For eg.- ''1'' - MOPED/SCOOTER, ''2'' - MOTOR CYCLE, ''4'' - PRIVATE MOTOR CAR/JEEP CAR, ''21'' - TEMPO, ''26'' - BUS, etc' + type: string + x-ngsi: + type: Property + year: + description: 'Year corresponding to this observation and is described in YYYY format, for eg. ''2020''' + type: string + x-ngsi: + type: Property + required: [] + type: object + x-derived-from: "" + x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted provided that the license conditions are met. Copyleft (c) 2022 Contributors to Smart Data Models Program' + x-license-url: https://github.com/smart-data-models/dataModel.PublicAccountability/blob/master/RevenueCollection/LICENSE.md + x-model-schema: https://smart-data-models.github.io/dataModel.PublicAccountability/RevenueCollection/schema.json + x-model-tags: IUDX + x-version: 0.0.1 +``` +
+ + + + + ## 페이로드 예시 + #### RevenueCollection NGSI-v2 키 값 예시 + 다음은 키 값으로 JSON-LD 형식의 RevenueCollection의 예입니다. 이는 `옵션=키값`을 사용할 때 NGSI-v2와 호환되며 개별 엔티티의 컨텍스트 데이터를 반환합니다. +
show/hide example + ```json + { + "id": "urn:ngsi-ld:001:rtir:0234", + "type": "RevenueCollection", + "totalCount": 436, + "registrationCertificateRecoveryAmount": 10400, + "enrollmentCertificateRecoveryAmount": 8400, + "year": "2020", + "dateObserved": "2021-11-10T01:16:01Z", + "month": "02", + "revenueCollectionType": "Property Tax", + "vehicleTypeCode": "2", + "amountCollected": 20400, + "vehicleType": "motorcycle", + "municipalityInfo": { + "district": "Bangalore Urban", + "ulbName": "BMC", + "cityId": "23", + "addressRegion": "Karnataka", + "addressLocality": "Bangalore", + "zoneId": "2", + "wardNum": 4 + } +} +``` +
+ #### RevenueCollection NGSI-v2 정규화 예제 + 다음은 정규화된 JSON-LD 형식의 RevenueCollection의 예입니다. 이는 옵션을 사용하지 않을 때 NGSI-v2와 호환되며 개별 엔티티의 컨텍스트 데이터를 반환합니다. +
show/hide example + ```json + { + "id": "urn:ngsi-ld:001:rtir:0234", + "type": "RevenueCollection", + "totalCount": { + "type": "number", + "value": 436 + }, + "registrationCertificateRecoveryAmount": { + "type": "number", + "value": 10400 + }, + "enrollmentCertificateRecoveryAmount": { + "type": "number", + "value": 8400 + }, + "year": { + "type": "Text", + "value": "2020" + }, + "dateObserved": { + "type": "Date-Time", + "value": "2021-11-10T01:16:01Z" + }, + "month": { + "type": "Text", + "value": "02" + }, + "revenueCollectionType": { + "type": "Text", + "value": "Property Tax" + }, + "vehicleTypeCode": { + "type": "Text", + "value": "2" + }, + "amountCollected": { + "type": "number", + "value": 20400 + }, + "vehicleType": { + "type": "Text", + "value": "motorcycle" + }, + "municipalityInfo": { + "type": "StructuredValue", + "value": { + "district": "Bangalore Urban", + "ulbName": "BMC", + "cityId": "23", + "addressRegion": "Karnataka", + "addressLocality": "Bangalore", + "zoneId": "2", + "wardNum": 4 + } + } +} +``` +
+ #### RevenueCollection NGSI-LD 키 값 예시 + 다음은 키 값으로 JSON-LD 형식의 RevenueCollection의 예입니다. 이는 `옵션=키값`을 사용할 때 NGSI-LD와 호환되며 개별 엔티티의 컨텍스트 데이터를 반환합니다. +
show/hide example + ```json + { + "id": "urn:ngsi-ld:001:rtir:0234", + "@context": [ + "iudx:RevenueCollection", + "https://raw.githubusercontent.com/smart-data-models/dataModel.Transportation/master/context.jsonld", + "https://raw.githubusercontent.com/smart-data-models/dataModel.PublicAccountability/master/context.jsonld" + ], + "type": "RevenueCollection", + "totalCount": 436, + "registrationCertificateRecoveryAmount": 10400, + "enrollmentCertificateRecoveryAmount": 8400, + "year": "2020", + "dateObserved": "2021-11-10T01:16:01Z", + "month": "02", + "revenueCollectionType": "Property Tax", + "vehicleTypeCode": "2", + "amountCollected": 20400, + "vehicleType": "motorcycle", + "municipalityInfo": { + "district": "Bangalore Urban", + "ulbName": "BMC", + "cityId": "23", + "addressRegion": "Karnataka", + "addressLocality": "Bangalore", + "zoneId": "2", + "wardNum": 4 + } +} +``` +
+ #### RevenueCollection NGSI-LD 정규화 예시 + 다음은 정규화된 JSON-LD 형식의 RevenueCollection의 예입니다. 이는 옵션을 사용하지 않을 때 NGSI-LD와 호환되며 개별 엔티티의 컨텍스트 데이터를 반환합니다. +
show/hide example + ```json + { + "id": "urn:ngsi-ld:001:rtir:0234", + "type": "RevenueCollection", + "totalCount": { + "type": "Property", + "value": 436 + }, + "registrationCertificateRecoveryAmount": { + "type": "Property", + "value": 10400 + }, + "enrollmentCertificateRecoveryAmount": { + "type": "Property", + "value": 8400 + }, + "year": { + "type": "Property", + "value": "2020" + }, + "dateObserved": { + "type": "Property", + "value": { + "@type": "date-time", + "@value": "2021-11-10T01:16:01Z" + } + }, + "month": { + "type": "Property", + "value": "02" + }, + "revenueCollectionType": { + "type": "Property", + "value": "Property Tax" + }, + "vehicleTypeCode": { + "type": "Property", + "value": "2" + }, + "amountCollected": { + "type": "Property", + "value": 20400 + }, + "vehicleType": { + "type": "Property", + "value": "motorcycle" + }, + "municipalityInfo": { + "type": "Property", + "value": { + "district": "Bangalore Urban", + "ulbName": "BMC", + "cityId": "23", + "addressRegion": "Karnataka", + "addressLocality": "Bangalore", + "zoneId": "2", + "wardNum": 4 + } + }, + "@context": [ + "iudx:RevenueCollection", + "https://raw.githubusercontent.com/smart-data-models/dataModel.Transportation/master/context.jsonld", + "https://raw.githubusercontent.com/smart-data-models/dataModel.PublicAccountability/master/context.jsonld" + ] +} +``` +
+ + + + [FAQ 10](https://smartdatamodels.org/index.php/faqs/)을 참조하여 규모 단위를 다루는 방법에 대한 답변을 확인하세요. + + +--- + [Smart Data Models](https://smartdatamodels.org) +++ [Contribution Manual](https://bit.ly/contribution_manual) +++ [About](https://bit.ly/Introduction_SDM)