diff --git a/D:/New folder/sample_ai_docs.yaml b/D:/New folder/sample_ai_docs.yaml new file mode 100644 index 000000000..91e77ac5b --- /dev/null +++ b/D:/New folder/sample_ai_docs.yaml @@ -0,0 +1,271 @@ +openapi: 3.0.1 +info: + title: <> + description: |+ + <> + version: '<>' + x-additionalinfo: |+ + << additional details about the microservice eg:use case, suggestions, model details>> + x-subscribelink: <> + x-apitype: <> + x-apitypedescription: |+ + <<50 characters api description eg: FAST, REST, small files. Displayed also in platform microservice detail page>> + x-inputfilelimit: |+ + <> + x-responsetime: |+ + <> + x-billingmethod: |+ + <> + x-notes: |+ + <> + x-apidetailsdesc: |+ + <> +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v<>" + description: "Published Date - <>" +paths: + /microservices/ts<>/v<>/: + post: + tags: + - v<> + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + output: + - <> + message: Successfully Processed + status: Success + '401': ## Add all supported error response + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + output: ## sample output + type: <> ### verify types for the input type https://swagger.io/specification/ + example: > + description: <> + items: + oneOf: + - type: object + properties: + <>: + type: <> ### verify types for the input type https://swagger.io/specification/ + format: <> + example: <> + description: <> + <>: + type: <> ### verify types for the input type https://swagger.io/specification/ + format: <> + example: <> + description: <> + message: + type: string + example: Successfully Processed + description: Description of the API status + status: + type: string + example: Success + description: The status of the API call - success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + required: + - <> + - <> + properties: + <>: + x-name: <> + type: <> ### verify types for the input type https://swagger.io/specification/ + default: <> + example: <> + description: |+ + <> + + <>: + x-name: <> + type: <> ### verify types for the input type https://swagger.io/specification/ + default: <> + example: <> + description: |+ + <> + versions: + type: object + properties: + v<>: + type: array + items: + oneOf: + - type: string + example: 'Published Date - <>' + x-details: <> + description: <> + v<>: + type: array + items: + oneOf: + - type: string + example: 'Published Date - <>' + x-details: <> + description: <> + securitySchemes: ## DO NOT change of the details here + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header \ No newline at end of file diff --git a/computer_vision/demographics_classification.yaml b/computer_vision/demographics_classification.yaml new file mode 100644 index 000000000..9459c46ab --- /dev/null +++ b/computer_vision/demographics_classification.yaml @@ -0,0 +1,293 @@ +openapi: 3.0.1 +info: + title: Demographics Classification + description: |+ + This Computer Vision microservice detects for faces from an input image and predicts the demographics of each face (age, gender and race). The image is given as an input encoded using base64. The microservice will a face detector and subsequently models to predict age, gender and race. The results will then be returned back to the user as a JSON output together with bounding box coordinates for each face.Races include: Asian, Indian, White, Black, Middle Eastern and Latino Hispanic + The size of your image file should **not exceed 10 MB**, and the image dimension should be **at least 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to improve visitor experience and optimize operations in retail, leisure, and other sectors by identifying the type of demogrpahic that frequents a certain place the most. It can also be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. + version: v0.1.0 + x-subscribelink: demographics_classification +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Dec 09, 2020" +paths: + /microservices/cv/democlass/v0/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + persons: + - age: 33.21062944528088 + bbox: + bottom: 459 + left: 82 + right: 393 + top: 0 + gender: Man + race: white + + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + persons: + description: Demographic details of the detected person + example: + age: 33.21062944528088 + bbox: + bottom: 459 + left: 82 + right: 393 + top: 0 + gender: Man + race: white + items: + properties: + description: Demographic details of the detected person + example: ' ' + properties: + age: + description: Age of the detected person in the input image + example: 33.21062944528088 + type: float + bbox: + description: Bounding box of the detected person in the input image + example: ' ' + properties: + bottom: + description: Bottom coordinate of the box + example: 459 + type: integer + left: + description: Left coordinate of the box + example: 82 + type: integer + right: + description: Right coordinate of the box + example: 393 + type: integer + top: + description: Top coordinate of the box + example: 0 + type: integer + type: object + gender: + description: Gender of the detected person in the input image + example: Man + type: string + race: + description: Race of the detected person in the input image + example: white + type: string + type: object + type: object + type: array + + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 09, 2020 + description: Initial version release + input: + type: object + required: + + - image_base64 + + properties: + image_base64: + x-name: image_base64 + type: string + default: True + example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... + description: |+ + Input image file in base64 format. + + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/face_recognition_politicians_sg.yaml b/computer_vision/face_recognition_politicians_sg.yaml similarity index 79% rename from yaml/face_recognition_politicians_sg.yaml rename to computer_vision/face_recognition_politicians_sg.yaml index 8e4e5998f..b30c9408c 100644 --- a/yaml/face_recognition_politicians_sg.yaml +++ b/computer_vision/face_recognition_politicians_sg.yaml @@ -1,24 +1,31 @@ openapi: 3.0.1 info: - title: Face Recognition Politicians (SG) + title: Face Recognition description: |+ - This Computer Vision microservice recognises faces from input image files of Singapore Members of Parliament. - - This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. - version: '0.1' + This Computer Vision microservice recognises faces of Singaporean and Japanese public figures (e.g. athletes, business leaders, celebrities, politicians, TV personalities, etc). + + This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter + + Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. + The size of your image file should **not exceed 10 MB** + x-additionalinfo: |+ + Suggested Use Cases: + - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. + version: '0.1.0' + x-subscribelink: face_recognition servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" +- name: "v0.1.0" description: "Published Date - Jul 03, 2020" paths: /microservices/cv/facerecognition/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -55,12 +62,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -196,13 +209,22 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string example: Published Date - Jul 03,2020 description: Initial version release + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure input: type: object required: @@ -213,9 +235,9 @@ components: x-name: model type: string default: true - example: sg_parliament_2019 + example: sg-parliament-2019 description: |+ - Model name. “sg_parliament_2019” is trained on Singapore Members of Parliament - 2019. + Model name. “sg-parliament-2019” is trained on Singapore Members of Parliament - 2019. img_base64: x-name: img_base64 type: string @@ -229,13 +251,15 @@ components: default: false example: jpg description: |+ - Type of image file. If not specified, the type of file is detected and processed.Refers to Python Imaging Library (PIL) for supported formats: bmp, gif, jpg/jpeg, png. + Type of image file. If not specified, the type of file is detected and processed. + + Refer to Python Imaging Library (PIL) for supported formats: bmp, gif, jpg/jpeg, png. threshold: x-name: threshold - type: number + type: float format: float default: false - example: 1.0 + example: 0.5 description: |+ 0.0 to 1.0. Default is 0.4. Higher threshold will return results with higher confidence. diff --git a/computer_vision/face_recognition_v1.0.yaml b/computer_vision/face_recognition_v1.0.yaml new file mode 100644 index 000000000..9a47fab9c --- /dev/null +++ b/computer_vision/face_recognition_v1.0.yaml @@ -0,0 +1,359 @@ +openapi: 3.0.1 +info: + title: Face Recognition + description: |+ + This Computer Vision microservice recognises faces of Singaporean and Japanese public figures (e.g. athletes, business leaders, celebrities, politicians, TV personalities, etc). + + This microservice returns the identity of the person, the bounding box in image coordinates, and the confidence of the prediction. Users can further filter the results by countries, profession or even down to the individual names. + + Help us grow this microservice! [Let us know](https://www.sentient.io/contact) which other public figures you would like us this microservice to also recognise (e.g. a new country or a new category). We will expand the capability of this microservices based on user feedback and demand. + The size of your image file should **not exceed 10 MB** + version: '1.0.1' + x-additionalinfo: |+ + **Full List of Filters** + Users may choose to filter the output using any of these filters below. + + 1. Countries: + - Japan + - Singapore + + 2. Categories: + - Olympic_medalist + - Paralympic_competitors + - Paralympic_medalist + - athletes + - bloggers + - broadcast_news_analysts + - business_executives + - business_leaders + - celebrities + - chairmen_of_corporations + - chief_executives + - columnists + - female_pop_singers + - female_singers + - film_actors + - film_actresses + - film_directors + - film_people + - film_producers + - journalists + - male_pop_singers + - male_singers + - participants_in_reality_television_series + - people_of_interest + - photojournalists + - politicians + - pop_singers + - radio_people + - screenwriters + - singer-songwriters + - social_media_personalities + - sportsman + - television_actors + - television_actresses + - television_personalities + - television_presenters + + 3. Individual Names + If you happen to know the individual names of the faces you hope to recognise, you may also put in the individual names as a filter. + + **Suggested Use Cases** + - For solutions related to identifying the speaker for auto-tagging, or matching the transcription to a person that is a Singaporean politician, or a Singaporean/Japanese public figure. + + + x-subscribelink: face_recognition +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.1" + description: "Published Date - Jan 11, 2021" +paths: + /microservices/cv/facerecognition/v1/getpredictions: + post: + tags: + - v1.0.1 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + output: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + output: + type: array + example: {conf: 0.6588699206768599,identity: "Lee Hsien Loong",location: [67,339,196,210]} + description: Details of the face recognised from the image + items: + oneOf: + - type: object + properties: + conf: + type: number + format: float + example: 0.6588699206768599 + description: 0.0 to 1.0. Confidence score of identification. Higher is more confidence. + identity: + type: string + example: Lee Hsien Loong + description: Person's formal name. If identity is not known, "UNKNOWN" is returned + location: + type: array + example: [67,339,196,210] + description: bounding box of the face in pixel coordinates of top, right, bottom, left. + items: + oneOf: + - type: number + example: 67 + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.1: + type: array + items: + oneOf: + - type: string + example: Published Date - Jan 11, 2021 + description: Bug fix - Threshold value + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 09, 2020 + description: Standardizing Output JSON and model update + + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03,2020 + description: Initial version release + input: + type: object + required: + - model + - image_base64 + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image file in base64 format. + file_type: + x-name: file_type + type: string + default: false + example: jpg + description: |+ + Type of image file. If not specified, the type of file is detected and processed. + + Refer to Python Imaging Library (PIL) for supported formats: bmp, gif, jpg/jpeg, png. + threshold: + x-name: threshold + type: integer + format: float + default: false + example: 0.5 + description: |+ + 0.0 to 1.0. Default is 0.4. Higher threshold will return results with higher confidence. + filter: + x-name: filter + type: array + default: false + example: ["japan", "television_actors"] + description: |+ + Optional filters that allows the user to refine the output. There are 3 types of filters: + + 1. Countries - e.g. "Singapore", "Japan" + 2. Professions - e.g. "atheletes", "pop_singers" + 3. Individual person names - e.g. "Lee Hsien Loong". Useful if the user only wants to detect for specific people. + + See "Additional Information" section for full list of available filters + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/landmark_detection_jp.yaml b/computer_vision/landmark_detection_jp.yaml similarity index 82% rename from yaml/landmark_detection_jp.yaml rename to computer_vision/landmark_detection_jp.yaml index 2cfeca636..4a84e3101 100644 --- a/yaml/landmark_detection_jp.yaml +++ b/computer_vision/landmark_detection_jp.yaml @@ -5,20 +5,26 @@ info: This Computer Vision microservice identifies Japan landmarks from multiple input images. The microservice returns the detected landmark and confidence score. - version: '0.1' + + The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. + version: '0.1.0' + x-subscribelink: landmark_detection_jp servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" +- name: "v0.1.0" description: "Published Date - Jul 30, 2020" paths: /microservices/cv/landmarkjp/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -56,12 +62,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -184,10 +196,19 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: @@ -203,7 +224,9 @@ components: default: true example: UklGRkbiBABXQVZFZm10IBAAAAABA... description: |+ - Input image in base64 format + Input image in base64 format. + + Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. securitySchemes: APIAuthorizer: diff --git a/computer_vision/landmark_detection_jp_v1.0.yaml b/computer_vision/landmark_detection_jp_v1.0.yaml new file mode 100644 index 000000000..6b1ed05b1 --- /dev/null +++ b/computer_vision/landmark_detection_jp_v1.0.yaml @@ -0,0 +1,264 @@ +openapi: 3.0.1 +info: + title: Landmark Detection (JP) + description: |+ + This Computer Vision microservice identifies Japan landmarks from multiple input images. + + The microservice returns the detected landmark and confidence score. + + The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. + version: '1.0.0' + x-subscribelink: landmark_detection_jp +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Mar 05, 2021" +paths: + /microservices/cv/landmarkjp/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + confidence: 100% + landmark: Gion + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + confidence: + x-name: confidence + type: string + example: 100% + description: Confidence score of identification. Higher is more confidence. + landmark: + x-name: landmark + type: string + example: Gion + description: Name of the landmark + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 05, 2021 + description: |+ + 1. Standardizing Output JSON + 2. Overall model accuracy improvements + 3. Better accuracy in detecting non-landmarks + 4. Fix bug in the confidence score computation + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release + input: + type: object + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image file in base64 format. + + Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/landmark_detection_sg.yaml b/computer_vision/landmark_detection_sg.yaml similarity index 82% rename from yaml/landmark_detection_sg.yaml rename to computer_vision/landmark_detection_sg.yaml index 5b238fd93..3546a4313 100644 --- a/yaml/landmark_detection_sg.yaml +++ b/computer_vision/landmark_detection_sg.yaml @@ -5,21 +5,27 @@ info: This Computer Vision microservice identifies Singapore landmarks from multiple input images. This microservice returns the detected landmark and confidence score. - version: '0.1' + + The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. + version: '0.1.0' + x-subscribelink: landmark_detection_sg servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" +- name: "v0.1.0" description: "Published Date - Jul 30, 2020" paths: /microservices/cv/landmarksg/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -58,12 +64,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -186,10 +198,19 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: @@ -207,7 +228,9 @@ components: default: true example: UklGRkbiBABXQVZFZm10IBAAAAABA... description: |+ - Input image in base64 format + Input image in base64 format. + + Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. securitySchemes: APIAuthorizer: diff --git a/computer_vision/landmark_detection_sg_v1.0.yaml b/computer_vision/landmark_detection_sg_v1.0.yaml new file mode 100644 index 000000000..125b76136 --- /dev/null +++ b/computer_vision/landmark_detection_sg_v1.0.yaml @@ -0,0 +1,268 @@ +openapi: 3.0.1 +info: + title: Landmark Detection (SG) + description: |+ + This Computer Vision microservice identifies Singapore landmarks from multiple input images. + + This microservice returns the detected landmark and confidence score. + + The size of your image file should **not exceed 5 MB**. + x-additionalinfo: |+ + Suggested Use Cases: + - Can be used for geo-targeting apps with map feature or property development planning resource apps. + version: '1.0.0' + x-subscribelink: landmark_detection_sg +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Mar 05, 2021" +paths: + /microservices/cv/landmarksg/v1/getpredictions: + post: + tags: + - v1.0.0 + + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + confidence: 100% + landmark: Artscience Museum + message: Successfully Processed + status: Success + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + confidence: + x-name: confidence + type: string + example: 100% + description: Confidence score of identification. Higher is more confidence. + landmark: + x-name: landmark + type: string + example: Artscience Museum + description: Name of the landmark + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + + + + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 05, 2021 + description: |+ + 1. Standardizing Output JSON + 2. Overall model accuracy improvements + 3. Better accuracy in detecting non-landmarks + 4. Fix bug in the confidence score computation + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release + input: + type: object + required: + - image_base64 + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input image file in base64 format. + + Supported formats: blp, bmp, bufr, cur, dcx, dds, dib, eps, ps, fit, fits, flc, fli, fpx, ftc, ftu, gbr, gif, grib, h5, hd5, icns, ico, im, iim, jpeg, jp2, mic, mpeg, msp, pcd, pcx, pxr, png, ppm, psd, sgi, ras, tga, tiff, wmf, xbm, xpm. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/object_detection.yaml b/computer_vision/object_detection.yaml similarity index 81% rename from yaml/object_detection.yaml rename to computer_vision/object_detection.yaml index caca64189..a3ca311db 100644 --- a/yaml/object_detection.yaml +++ b/computer_vision/object_detection.yaml @@ -6,21 +6,31 @@ info: The microservice returns detected objects with their classes and their bounding boxes in the image coordinates. - The classes are: person, bicycle, car, motorbike, aeroplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, sofa, pottedplant, bed, diningtable, toilet, tvmonitor, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy bear, hair drier, toothbrush - version: '0.1' + The classes are: person, bicycle, car, motorbike, aeroplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, sofa, pottedplant, bed, diningtable, toilet, tvmonitor, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy bear, hair drier, toothbrush. + + The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - Industrial inspection - use Object Detection to automate the quality control process in manufacturing by enabling edge devices to identify defects. + + - Product search - build a product search app to find products of interest within images and visually search product catalogs. + + - Build an object detection app for the visually-impaired - help users identify daily objects that they may need aid in recognising + version: '0.1.0' + x-subscribelink: object_detection servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - May 19, 2020" +- name: "v0.1.0" + description: "Published Date - May 15, 2020" paths: /microservices/cv/objectdetection/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -57,12 +67,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -173,6 +189,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure inputfieldmissing: type: object properties: @@ -195,12 +220,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - May 19,2020 + example: Published Date - May 15, 2020 description: Initial version release input: type: object @@ -213,7 +238,9 @@ components: default: true example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... description: |+ - Input image file in base64 format + Input image file in base64 format. + + Supported formats: bmp, dib, exr, hdr, jpeg, jpg, jpe, jp2, png, pic, pbm, pgm, ppm, pxm, pnm, ras, sr, tiff, tif, webp. securitySchemes: APIAuthorizer: type: apiKey diff --git a/computer_vision/object_detection_v1.0.yaml b/computer_vision/object_detection_v1.0.yaml new file mode 100644 index 000000000..6d495acb9 --- /dev/null +++ b/computer_vision/object_detection_v1.0.yaml @@ -0,0 +1,278 @@ +openapi: 3.0.1 +info: + title: Object Detection + description: |+ + This Computer Vision microservice detects objects in the input image. + + The microservice returns detected objects with their classes and their bounding boxes in the image coordinates. + + The classes are: person, bicycle, car, motorbike, aeroplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, sofa, pottedplant, bed, diningtable, toilet, tvmonitor, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy bear, hair drier, toothbrush. + + The size of your image file should **not exceed 5 MB**, and the image dimension should be **at least 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - Industrial inspection - use Object Detection to automate the quality control process in manufacturing by enabling edge devices to identify defects. + - Product search - build a product search app to find products of interest within images and visually search product catalogs. + - Build an object detection app for the visually-impaired - help users identify daily objects that they may need aid in recognising + version: '1.0.0' + x-subscribelink: object_detection +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Jan 25, 2021" +paths: + /microservices/cv/objectdetection/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"results":{"objects": [{"bounding box": {"bottom": 742,"left": 19,"right": 1019,"top": 73},"class": "person","confidence": 1,"object id": 0}]},"message": "Successfully Processed","status": "Success"} + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + objects: + type: array + example: [{"bounding box": {"bottom": 742,"left": 19,"right": 1019,"top": 73},"class": "person","confidence": 1,"object id": 0}] + description: "Details of the detected object" + items: + oneOf: + - type: object + properties: + bounding box: + type: object + example: {"bottom": 742,"left": 19,"right": 1019,"top": 73} + description: Bounding box of the image + properties: + bottom: + type: number + example: 742 + description: Bottom coordinate of the box + left: + type: number + example: 19 + description: Left coordinate of the box + right: + type: number + example: 1019 + description: Right coordinate of the box + top: + type: number + example: 73 + description: Top coordinate of the box + class: + type: string + example: person + description: Detected object + confidence: + type: number + example: 1 + description: Confidence of the detected object. Higher confidence, more accurate the detected object. + object id: + type: number + example: 0 + description: Detected object id + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jan 25, 2021 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - May 15, 2020 + description: Initial version release + input: + type: object + required: + - image_base64 + properties: + image_base64: + x-name: image_base64 + type: string + default: true + example: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUG... + description: |+ + Input image file in base64 format. + + Supported formats: bmp, dib, exr, hdr, jpeg, jpg, jpe, jp2, png, pic, pbm, pgm, ppm, pxm, pnm, ras, sr, tiff, tif, webp. + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/people_counting.yaml b/computer_vision/people_counting.yaml similarity index 78% rename from yaml/people_counting.yaml rename to computer_vision/people_counting.yaml index 62d2e7380..f42723179 100644 --- a/yaml/people_counting.yaml +++ b/computer_vision/people_counting.yaml @@ -5,21 +5,27 @@ info: This Computer Vision microservice tracks and counts people appearing in the input video. This microservice returns the number of people detected in that video, the likelihood of overestimation/underestimation, the first appearance and the duration and confidence of each person detected. - version: '0.1' + + The size of your image file should **not exceed 10 MB**, and the image dimension should be **least more than 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - Improve visitor experience and optimize operations in retail, leisure, and other sectors - build services to count visitor traffic in venues, measure detailed movements and interactions, and visualize that data to better understand what is happening in within a certain spaces. For example, one can optimize traffic, staff and marketing strategies to increase conversion rates and profits with actionable data. Businesses can use visitor count as a benchmark to figure out the conversion rate for a certain spot to see the real performance. Efficiently allocating the number of staff according to hourly visitor traffic will also create value in terms of revenue, profit and  efficiency. + version: '0.1.0' + x-subscribelink: people_counting servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1." +- name: "v0.1.0" description: "Published Date - Jul 30, 2020" paths: /microservices/cv/peoplecounting/v0.1/getpredictions: post: tags: - - v0.1. + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -56,12 +62,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -147,6 +159,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure notfound: type: object properties: @@ -195,7 +216,7 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: @@ -213,7 +234,9 @@ components: default: true example: UklGRkbiBABXQVZFZm10IBAAAAABA... description: |+ - Input video in base64 format + Input video in base64 format. + + Supported formats: acm, anm, apc, au, avi, bfi, bmp_pipe, bmv, codec2, dsf, dss, dvd, fifo, genh, gif, gxf, hls, iff, ifv, ipod, jpeg_pipe, jv, m4v, mjpeg, mlp, mlv, mov, mp2, mp3, mp4, pbm_pipe, pmp, png_pipe, psd_pipe, psp, rawvideo, sdp, sds, sdx, tmv, uncodedframecrc, vcd, vidc, vmd, voc, vpk, wav, webm, wsd, wsvqa, wtv, xmv, xpm_pipe. securitySchemes: APIAuthorizer: diff --git a/computer_vision/people_counting_v1.0.yaml b/computer_vision/people_counting_v1.0.yaml new file mode 100644 index 000000000..ca1f580b5 --- /dev/null +++ b/computer_vision/people_counting_v1.0.yaml @@ -0,0 +1,259 @@ +openapi: 3.0.1 +info: + title: People Counting + description: |+ + This Computer Vision microservice tracks and counts people appearing in the input video. + + This microservice returns the number of people detected in that video, the likelihood of overestimation/underestimation, the first appearance and the duration and confidence of each person detected. + + The size of your image file should **not exceed 10 MB**, and the image dimension should be **least more than 416x416 pixels**. + x-additionalinfo: |+ + Suggested Use Cases: + - Improve visitor experience and optimize operations in retail, leisure, and other sectors - build services to count visitor traffic in venues, measure detailed movements and interactions, and visualize that data to better understand what is happening in within a certain spaces. For example, one can optimize traffic, staff and marketing strategies to increase conversion rates and profits with actionable data. Businesses can use visitor count as a benchmark to figure out the conversion rate for a certain spot to see the real performance. Efficiently allocating the number of staff according to hourly visitor traffic will also create value in terms of revenue, profit and  efficiency. + version: '1.0.0' + x-subscribelink: people_counting +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Jan 25, 2021" +paths: + /microservices/cv/peoplecounting/v1/getpredictions: + post: + tags: + - v1.0.0 + + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: {"results": {"counter": 11, "likelihood of overestimation": 0.76,"likelihood of underestimation": 0.39,"people": [{"assigning confidence": 1,"bounding boxes": {"frame": {"294": {"bottom": 420,"left": 249,"right": 417,"top": 207},"300": {"bottom": 420,"left": 249,"right": 417,"top": 207}}},"detection confidence": 0.76,"duration appeared": 0.20689655172413793,"first appearance": 10.137931034482758,"person id": "011"}]},"message": "Successfully Processed","status": "Success"} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + + +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + counter: + type: integer + example: 11 + description: Number of people detected in video + likelihood of overestimation: + type: number + format: float + example: 0.76 + description: How likely would there be ID spikes causing counter to increase People + likelihood of underestimation: + type: number + format: float + example: 0.39 + description: How likely the model might miss out detecting people in the video + people: + type: array + example: [{'person id': "001",'first appearance': 1.28, 'duration appeared': 7.66, 'detection confidence': 0.77, 'assigning confidence': 1,"bounding boxes": {"frame": {"294": {"bottom": 420,"left": 249,"right": 417,"top": 207},"300": {"bottom": 420,"left": 249,"right": 417,"top": 207}}}}] + description: Contains a list of individual Persons and their metadata. + items: + oneOf: + - type: object + example: {'person id': "001",'first appearance': 1.28, 'duration appeared': 7.66, 'detection confidence': 0.77, 'assigning confidence': 1,"bounding boxes": {"frame": {"294": {"bottom": 420,"left": 249,"right": 417,"top": 207},"300": {"bottom": 420,"left": 249,"right": 417,"top": 207}}}} + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jan 25, 2021 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 30,2020 + description: Initial version release + input: + type: object + required: + - video_base64 + properties: + video_base64: + x-name: video_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Input video file in base64 format. + + Supported formats: acm, anm, apc, au, avi, bfi, bmp_pipe, bmv, codec2, dsf, dss, dvd, fifo, genh, gif, gxf, hls, iff, ifv, ipod, jpeg_pipe, jv, m4v, mjpeg, mlp, mlv, mov, mp2, mp3, mp4, pbm_pipe, pmp, png_pipe, psd_pipe, psp, rawvideo, sdp, sds, sdx, tmv, uncodedframecrc, vcd, vidc, vmd, voc, vpk, wav, webm, wsd, wsvqa, wtv, xmv, xpm_pipe. + + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/amenities_hardcourts_hdb_sg.yaml b/data/amenities_hardcourts_hdb_sg.yaml similarity index 88% rename from yaml/amenities_hardcourts_hdb_sg.yaml rename to data/amenities_hardcourts_hdb_sg.yaml index fc748c982..6149a2b04 100644 --- a/yaml/amenities_hardcourts_hdb_sg.yaml +++ b/data/amenities_hardcourts_hdb_sg.yaml @@ -1,11 +1,15 @@ openapi: 3.0.1 info: title: HDB Hardcourts Locations (SG) + x-subscribelink: amenities_hardcourts_hdb_sg description: |+ This Data microservice returns the indicative outline of hardcourts for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from Singapore Land Authority (SLA) (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a solution to extract information related to the types and number of hardcourts present in an area for people buying or renting a HDB home. + Download the complete dataset using a pre-signed URL. It's a two steps process **Step 1:** Get the pre-signed URL @@ -31,20 +35,20 @@ info: | INC_CRC | Varchar | 50 | Sub Location Id | | FMEL_UPD_D | Datetime | N/A | Area of the feature | | Shape__Length | Float | N/A | Length of the feature | - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Feb 07, 2020" +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" paths: /DaaS/prod/hdb/amenities/gs/csv/hardcourt/hdb: get: tags: - - v0.1 + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -84,12 +88,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -198,15 +208,24 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Feb 07, 2020 + example: Published Date - Mar 24, 2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/data/amenities_hardcourts_hdb_sg_v1.0.yaml b/data/amenities_hardcourts_hdb_sg_v1.0.yaml new file mode 100644 index 000000000..8d31810f3 --- /dev/null +++ b/data/amenities_hardcourts_hdb_sg_v1.0.yaml @@ -0,0 +1,198 @@ +openapi: 3.0.1 +info: + title: HDB Hardcourts Locations (SG) + x-subscribelink: amenities_hardcourts_hdb_sg + description: |+ + This Data microservice returns the indicative outline of hardcourts for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from Singapore Land Authority (SLA) (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. + As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a solution to extract information related to the types and number of hardcourts present in an area for people buying or renting a HDB home. + + Download the complete dataset using a pre-signed URL. It's a two steps process + + **Step 1:** Get the pre-signed URL + + Replace the correct x-api-key, and API endpoint + + > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" <\>** + + **Step 2:** Download file + + Using the results.url (i.e) the pre-signed URL to download the dataset + + > **curl --request GET "results.url" >> "FILE_NAME"** + + **Data schema** + + | Name | Type | Size | Description | + |---|---|---|---|---| + | FEATID | Integer | N/A | Feature ID. Unique running number. | + | TYPE | Char | N/A | Captures the type of object. | + | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | + | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | + | INC_CRC | Varchar | 50 | Sub Location Id | + | FMEL_UPD_D | Datetime | N/A | Area of the feature | + | Shape__Length | Float | N/A | Length of the feature | + version: '1.0.0' +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/hardcourt/v0/getdata: + get: + tags: + - v1.0.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: "" + status: Success + message: Successfully Processed + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: pre-signed URL to download the file + example: "" + status: + type: string + example: Success + description: The status of the API call. success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the api status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized release + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/amenities_lamp_posts_hdb_sg.yaml b/data/amenities_lamp_posts_hdb_sg.yaml similarity index 86% rename from yaml/amenities_lamp_posts_hdb_sg.yaml rename to data/amenities_lamp_posts_hdb_sg.yaml index 777970c09..a05f7c6b9 100644 --- a/yaml/amenities_lamp_posts_hdb_sg.yaml +++ b/data/amenities_lamp_posts_hdb_sg.yaml @@ -1,11 +1,15 @@ openapi: 3.0.1 info: title: HDB Lamp Posts Locations (SG) + x-subscribelink: amenities_lamp_posts_hdb_sg description: |+ This Data microservice returns the indicative location of lamp posts for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from Singapore Land Authority (SLA) (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services or social service solutions - can be used as a background check solution to extract information related to lampposts present in an area for people with certain preferences when buying or renting a HDB home. For example, the elderly may prefer HDB homes surrounded with more lampposts as they require more aid in terms of lighting when walking home. + Download the complete dataset using a pre-signed URL. It's a two steps process **Step 1:** Get the pre-signed URL @@ -32,21 +36,21 @@ info: | FMEL_UPD_D | Datetime | N/A | Area of the feature | | x | Float | N/A | ESRI x coordinate | | y | Float | N/A | ESRI y coordinate | - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Feb 07, 2020" +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" paths: /DaaS/prod/hdb/amenities/gs/csv/lamppost/hdb: get: tags: - - v0.1 + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -86,12 +90,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -200,15 +210,24 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Feb 07, 2020 + example: Published Date - Mar 24, 2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/data/amenities_lamp_posts_hdb_sg_v1.0.yaml b/data/amenities_lamp_posts_hdb_sg_v1.0.yaml new file mode 100644 index 000000000..eacab3662 --- /dev/null +++ b/data/amenities_lamp_posts_hdb_sg_v1.0.yaml @@ -0,0 +1,200 @@ +openapi: 3.0.1 +info: + title: HDB Lamp Posts Locations (SG) + x-subscribelink: amenities_lamp_posts_hdb_sg + description: |+ + This Data microservice returns the indicative location of lamp posts for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from Singapore Land Authority (SLA) (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. + As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services or social service solutions - can be used as a background check solution to extract information related to lampposts present in an area for people with certain preferences when buying or renting a HDB home. For example, the elderly may prefer HDB homes surrounded with more lampposts as they require more aid in terms of lighting when walking home. + + Download the complete dataset using a pre-signed URL. It's a two steps process + + **Step 1:** Get the pre-signed URL + + Replace the correct x-api-key, and API endpoint + + > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" ** + + **Step 2:** Download file + + Using the results.url (i.e) the pre-signed URL to download the dataset + + > **curl --request GET "results.url" >> "FILE_NAME"** + + **Data schema** + + | Name | Type | Size | Description | + |---|---|---|---|---| + | FEATID | Integer | N/A | Feature ID. Unique running number. | + | TYPE | Char | N/A | Captures the type of object. | + | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | + | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | + | INC_CRC | Varchar | 50 | Sub Location Id | + | FMEL_UPD_D | Datetime | N/A | Area of the feature | + | x | Float | N/A | ESRI x coordinate | + | y | Float | N/A | ESRI y coordinate | + version: '1.0.0' +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" + +paths: + /microservices/data/lamppost/v0/getdata: + get: + tags: + - v1.0.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: "" + status: Success + message: Successfully Processed + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: pre-signed URL to download the file + example: "" + status: + type: string + example: Success + description: The status of the API call. success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the api status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized release + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/amenities_shelters_hdb_sg.yaml b/data/amenities_shelters_hdb_sg.yaml similarity index 84% rename from yaml/amenities_shelters_hdb_sg.yaml rename to data/amenities_shelters_hdb_sg.yaml index 4ebea897a..11cd958ff 100644 --- a/yaml/amenities_shelters_hdb_sg.yaml +++ b/data/amenities_shelters_hdb_sg.yaml @@ -1,11 +1,19 @@ openapi: 3.0.1 info: title: HDB Shelters Locations (SG) + x-subscribelink: amenities_shelters_hdb_sg description: |+ This Data microservice returns the indicative outline of shelters for all HDB Towns and Estates and only on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from SLA (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. Precinct Pavilions are not included in this microservice. As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a solution to extract information related to the types and number of shelters present for people buying or renting a HDB home. + + - Property background checks - can be used as a background check service for retail shops owners looking to set up their shops in HDBs, as areas with shelters may induce the likelihood of more customers. + + - Can also be used as a solution to improve user awareness and personalization - for example, a weather app can refer a user to the nearest HDB shelter in the case of a rainy day. + Download the complete dataset using a pre-signed URL. It's a two steps process **Step 1:** Get the pre-signed URL @@ -32,20 +40,20 @@ info: | FMEL_UPD_D | Datetime | N/A | Area of the feature | | Shape__Area | Float | N/A | Area of the feature | | Shape__Length | Float | N/A | Length of the feature | - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Feb 07, 2020" +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" paths: /DaaS/prod/hdb/amenities/gs/csv/shelter/hdb: get: tags: - - v0.1 + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -85,12 +93,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -199,15 +213,24 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Feb 07, 2020 + example: Published Date - Mar 24, 2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/data/amenities_shelters_hdb_sg_v1.0.yaml b/data/amenities_shelters_hdb_sg_v1.0.yaml new file mode 100644 index 000000000..3781da3de --- /dev/null +++ b/data/amenities_shelters_hdb_sg_v1.0.yaml @@ -0,0 +1,219 @@ +openapi: 3.0.1 +info: + title: HDB Shelters Locations (SG) + x-subscribelink: amenities_shelters_hdb_sg + description: |+ + This Data microservice returns the indicative outline of shelters for all HDB Towns and Estates and only on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery and manually digitised. The imagery was obtained from SLA (captured in 2014). Objects largely obstructed by trees, structures and / or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. Precinct Pavilions are not included in this microservice. + As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a solution to extract information related to the types and number of shelters present for people buying or renting a HDB home. + - Property background checks - can be used as a background check service for retail shops owners looking to set up their shops in HDBs, as areas with shelters may induce the likelihood of more customers. + - Can also be used as a solution to improve user awareness and personalization - for example, a weather app can refer a user to the nearest HDB shelter in the case of a rainy day. + + Download the complete dataset using a pre-signed URL. It's a two steps process + + **Step 1:** Get the pre-signed URL + + Replace the correct x-api-key, and API endpoint + + > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" <\>** + + **Step 2:** Download file + + Using the results.url (i.e) the pre-signed URL to download the dataset + + > **curl --request GET "results.url" >> "FILE_NAME"** + + **Data schema** + + | Name | Type | Size | Description | + |---|---|---|---|---| + | FEATID | Integer | N/A | Feature ID. Unique running number. | + | TYPE | Char | N/A | Captures the type of object. | + | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | + | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | + | INC_CRC | Varchar | 50 | Sub Location Id | + | FMEL_UPD_D | Datetime | N/A | Area of the feature | + | Shape__Area | Float | N/A | Area of the feature | + | Shape__Length | Float | N/A | Length of the feature | + version: '1.0.0' +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/shelter/v0/getdata: + get: + tags: + - v1.0.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: "" + status: Success + message: Successfully Processed + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: pre-signed URL to download the file + example: "" + status: + type: string + example: Success + description: The status of the API call. success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the api status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized release + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/building_addresses_hdb_sg.yaml b/data/building_addresses_hdb_sg.yaml similarity index 94% rename from yaml/building_addresses_hdb_sg.yaml rename to data/building_addresses_hdb_sg.yaml index a78cd8895..d5feebe5f 100644 --- a/yaml/building_addresses_hdb_sg.yaml +++ b/data/building_addresses_hdb_sg.yaml @@ -1,6 +1,7 @@ openapi: 3.0.1 info: title: HDB Block Coordinates (SG) + x-subscribelink: building_addresses_hdb_sg description: |+ This Data microservice retrieves information on the Singapore Housing Development Board building blocks in Singapore that includes addresses, postal code, latitude and longitude coordinates. Updated monthly @@ -9,6 +10,9 @@ info: **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - Information from this microservice can be used to build a geo-targeting app with precise map features. + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. @@ -86,17 +90,17 @@ info: Using a filterdata only: > filterdata = {"filter":[{"geo_distance": {"distance": "1km","location": "1.368960,103.957980"}}]} - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 10, 2019" +- name: "v0.1.0" + description: "Published Date - Nov 25, 2019" paths: /DaaS/prod/directories/searchbranch: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -138,7 +142,7 @@ paths: {"must":[{"range":{"block":{"gte":100}}}],"should":[{"range":{"block":{"lte":200}}}],"filter":[{"match_phrase":{"street":"ang mo kio"}}],"must_not":[{"match":{"street":"avenue 3"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -194,12 +198,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -376,16 +386,25 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Oct 10,2019 + example: Published Date - Nov 25,2019 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/carpark_hdb_sg.yaml b/data/carpark_hdb_sg.yaml similarity index 90% rename from yaml/carpark_hdb_sg.yaml rename to data/carpark_hdb_sg.yaml index d51736462..168c0ffb7 100644 --- a/yaml/carpark_hdb_sg.yaml +++ b/data/carpark_hdb_sg.yaml @@ -1,16 +1,22 @@ openapi: 3.0.1 info: title: HDB Carpark Locations (SG) + x-subscribelink: carpark_hdb_sg description: |+ - This Data microservice retrieves the Singapore Housing Development Board's carpark information within Singapore HDB estates that includes location address, postal code and parking lot capacity for different types of vehicle by carpark location. Updated monthly. + This Data microservice retrieves the Singapore Housing Development Board's carpark information within Singapore HDB estates and includes the location address, postal code and parking lot capacity for different types of vehicle by carpark location. Updated monthly. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - Suggested Use Cases: Geo-targeting app with map feature, property development planning resource, or planning for vehicle-sharing app. - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - Geo-targeting app with map feature, property development planning resource, or planning for vehicle-sharing app. + + - Real estate services - can be used as a background check solution to extract information related to the types and number of carparks present in an area for people with certain preferences when buying or renting a HDB home. + + - Can also be integrated into apps related to maps or parking for more detailed carpark information within Singapore HDB estates + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. @@ -114,17 +120,17 @@ info: > querystring = "bishan street 22" > filterdata = {"filter":[ {"range":{"lorry":{"gte":1}}} ]} - version: '0.1' + version: '0.2.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 10, 2019" +- name: "v0.2.0" + description: "Published Date - Sep 15, 2020" paths: /DaaS/prod/hdb/carpark: get: tags: - - v0.1 + - v0.2.0 parameters: - in: query name: querystring @@ -168,7 +174,7 @@ paths: {"must":[{"match":{"mc":0}}],"filter":[{"match":{"street":"bishan"}}],"should":[{"match_phrase":{"street":"ang mo kio"}}],"must_not":[{"match":{"postalcode":"570251"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -185,8 +191,8 @@ paths: _source: cpk_no: BE37 block: BLK 282 - street: BE37 BISHAN STREET 22 - address: BLK 282 BE37 BISHAN STREET 22 + street: BISHAN STREET 22 + address: BLK 282 BISHAN STREET 22 source: hdb xcoord: '29235.553' ycoord: '37787.1371' @@ -241,12 +247,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -456,15 +468,34 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.1: + v0.2.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Sep 15,2020 + description: |+ + The following additional fields are added: + 1. postalcode - list of postal code + 2. location - lat / log of the carpark park + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Oct 10,2019 + example: Published Date - Nov 25,2019 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/commercial_directories_hdb_sg.yaml b/data/commercial_directories_hdb_sg.yaml similarity index 94% rename from yaml/commercial_directories_hdb_sg.yaml rename to data/commercial_directories_hdb_sg.yaml index c84ba0ba1..e51741fd4 100644 --- a/yaml/commercial_directories_hdb_sg.yaml +++ b/data/commercial_directories_hdb_sg.yaml @@ -1,16 +1,19 @@ openapi: 3.0.1 info: title: HDB Commercial Directories (SG) + x-subscribelink: commercial_directories_hdb_sg description: |+ - This Data microservice retrieves the list of all retail shops in Singapore which allows you to search for a shop by its name, address, building name, postal code, latitude and longitude coordinates type of business. The resultant dataset offers useful information like the shop operating hours and contact number. Updated weekly. + This Data microservice retrieves the list of all retail shops within Singapore HDBs and allows you to search for a shop by its name, address, building name, postal code, latitude and longitude coordinates type of business. The resultant dataset offers useful information like the shop operating hours and contact number. Updated weekly. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - - Suggested Use Cases: Resident community mobile app with e-commerce collection and estate directory features. **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - Build a resident community mobile app with e-commerce collection and estate directory features. To illustrate, the app can: + Name retail shops in HDBs based on their GPS location. + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. @@ -106,17 +109,17 @@ info: > filterdata = {"filter":[{"match_phrase": {"trade":"cake shop"}},{"match": {"block":"122"}},{"match_phrase": {"street":"bukit merah lane 1"}}]} - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 31, 2018" +- name: "v0.1.0" + description: "Published Date - Dec 26, 2018" paths: /DaaS/prod/directories/hdb/searchdir: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -159,7 +162,7 @@ paths: responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -225,12 +228,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -483,15 +492,24 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Oct 31,2018 + example: Published Date - Dec 26,2018 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/data/d&b_basic_individual_search_sg.yaml b/data/d&b_basic_individual_search_sg.yaml new file mode 100644 index 000000000..642bfee25 --- /dev/null +++ b/data/d&b_basic_individual_search_sg.yaml @@ -0,0 +1,1306 @@ +openapi: 3.0.1 +info: + title: D&B Basic Individual Search (SG) + description: |+ + This Data microservice provides the information on the (Singapore-registered) business interest of an individual that includes the individual’s actual name, residential address, business and shareholding in businesses, current & previous ownership, litigation against individual and businesses, bankruptcy record and count on the times this individual has been searched on. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions that require personal checks, e.g. in the appointment of Board Members, Directorship or C-suite level hiring, where the appointee’s background is paramount to the Company and its reputation. + - Swift pre-employment screening solution - information provided by the microservice can be used to protect one's company's reputation from potential negative publicity by conducting background checks on individuals prior to hiring. + version: '0.1.0' + x-subscribelink: d&b_basic_individual_search_sg +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 15, 2019" +paths: + /dnb/prod/sbis: + post: + tags: + - v0.1.0 + summary: Adds a new user + requestBody: + content: + application/xml: + schema: + $ref: '#/components/schemas/REQUEST' + responses: + '200': + description: Ok + content: + application/xml: + schema: + $ref: '#/components/schemas/success' + example: |+ + + 25/02/2009 17:31:44.678 + + + + + + 25/02/2009 17:31:44 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - S7250163B + + + - - S7250163B + + + + + + 1 1 1 1 1 1 1 1 1 1 1 1 2017 1 + + 0 0 0 0 0 0 0 0 0 0 0 0 2016 1 + + 0 0 0 0 0 0 0 0 0 0 0 0 2015 1 + + 0 0 0 0 0 0 0 0 0 0 0 0 2017 0 + + 0 0 0 0 0 0 0 0 0 0 0 0 2016 0 + + 0 0 0 0 0 0 0 0 0 0 0 + 0 2015 0 + + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [BASIC_INFO] + [LIT_SEARCH_INFO] + [LIST_CURRENT_COMP] + [LIST_PREVIOUS_COMP] + [LIST_BANKRUPTCY] + [LIST_LIT] + [LIST_LIT_DTL] + properties: + META_INFO: + type: object + example: |+ + + + + 25/02/2009 17:31:44.678 + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + properties: + SERVICE: + type: string + example: "BIS" + description: Report Requested + SYSTEM_ID : + type: string + example: "DDP" + description: System ID + CREATION_DATE: + type: datetime + example: "25/02/2009 17:31:44.678" + description: Report Request Date + USER_ID : + type: string + example: N/A + description: Valid user id in DDP system. It is for (For internal use) + BASIC_INFO : + type: object + description: |+ + Basic Information with following children: + PA_REG_NO + ADDRESS1 + ADDRESS2 + ADDRESS3 + example: |+ + + + + + + + properties: + PA_REG_NO: + type: string + description: Public Accountant Registration No. + example: "00091" + ADDRESS1: + type: string + description: Address 1 + example: "137" + ADDRESS2: + type: string + description: Address 2 + example: "vvvvv" + ADDRESS3: + type: string + description: Address 3 + example: "470137, SINGAPORE" + LIT_SEARCH_INFO : + type: object + example: |+ + + + + + 25/02/2009 17:31:44 + + + + + description: |+ + Litigation search information with following children: + COMP_NAME + REG_NO + REPORT_TYPE + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "ENG YICK HOLDINGS PTE LTD" + REG_NO: + type: string + description: Company Registration No + example: "197803191K" + REPORT_TYPE: + type: string + description: Report Type + example: "BIS" + REQ_DATE: + type: datetime + description: Requested Date + example: "25/02/2009 17:31:44" + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197803191K" + REQ_NAME: + type: string + description: Request Name + example: "LOY KOK TOON" + REQ_DATE_STR: + type: string + description: Request Date String + example: "25/02/2009 15:04:14" + LIST_CURRENT_COMP : + type: array + description: |+ + List of current companies with following children: + [CURRENT_COMP] + example: |+ + + + + + + + + + + + + + + + + + + + items: + properties: + CURRENT_COMP: + type: object + description: |+ + Current companies detail with following children: + POSITION + APPOINTMENT_DATE + COMP_NAME + SEQ_NO + SHARE_VALUE1 + COMP_STATUS + PROFIT_VALUE + SHARE_VALUE + TEL + FAX + SIC + SIC_DESC + example: |+ + + + + + + + + + + + + + + + + + properties: + POSITION: + type: string + description: Position + example: "OWNER" + APPOINTMENT_DATE: + type: string + description: Appointment Date + example: "01/09/1971" + COMP_NAME: + type: string + description: Company Name + example: "BAN HOE LEONG COMPANY" + SEQ_NO: + type: string + description: Company Registration No. + example: "03647300J" + SHARE_VALUE1: + type: string + description: Share Percentage + example: "15.00" + COMP_STATUS: + type: string + description: Company Status + example: "LIVE" + PROFIT_VALUE1: + type: string + description: Profit Making 1 + example: "2008 = -" + PROFIT_VALUE2: + type: string + description: Profit Making 2 + example: "2007 = -" + PROFIT_VALUE3: + type: string + description: Profit Making 3 + example: "2006 = -" + SHARE_VALUE: + type: string + description: Number Of Shares + example: "150000" + TEL: + type: string + description: Telephone Number + example: "62994842" + FAX: + type: string + description: Fax Number + example: "62992797" + SIC: + type: string + description: SIC Code + example: "5012" + SIC_DESC: + type: string + description: SIC Description + example: "Automobiles and other Motor Vehicles" + LIST_PREVIOUS_COMP: + type: array + example: |+ + + + + + + + + + + + + + + + + + description: |+ + List of previous companies with following children: + [PREVIOUS_COMP] + items: + properties: + PREVIOUS_COMP : + type: object + description: |+ + Previous companies detail with following children: + POSITION + APPOINTMENT_DATE + COMP_NAME + SEQ_NO + SHARE_VALUE1 + COMP_STATUS + CESSATION_DATE + SHARE_VALUE + TEL + FAX + SIC + SIC_DESC + example: |+ + + + + + + + + + + + + + + + properties: + POSITION : + type: string + description: Position + example: "SHAREHOLDER" + APPOINTMENT_DATE: + type: string + description: Appointment Date + example: "30/06/1988" + COMP_NAME: + type: string + description: Company Name + example: "ENG YICK INDUSTRIES PTE LTD" + SEQ_NO: + type: string + description: Company Registration No. + example: "198101820Z" + SHARE_VALUE1: + type: string + description: Share Value Percentage + example: "100.00" + COMP_STATUS: + type: string + description: Company Status + example: "DISSOLVED - COMPULSORY WINDING UP (INSOLVENCY)" + CESSATION_DATE : + type: string + description: Cessation Date + example: "22/09/1992" + SHARE_VALUE: + type: string + description: Number Of Shares + example: "390002" + TEL: + type: string + description: Telephone Number + example: "62994842" + FAX: + type: string + description: Fax Number + example: "67467646" + SIC: + type: string + description: SIC Code + example: "2325" + SIC_DESC: + type: string + description: SIC Description + example: "Men’s and Boys’ Separate Trousers and Slacks" + LIST_BANKRUPTCY: + type: array + description: |+ + Bankruptcy/ Winding up with following children: + [BANKRUPTCY] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + items: + properties: + BANKRUPTCY : + type: object + description: |+ + Bankruptcy/Winding up detail with following children: + SUBJECT_NAME + COURT_CODE + CASE_CODE + CASE_YEAR + ACTION_DATE + BANKRUPTCY_ACT + HEARING_DATE + CURRENCY1 + AMOUNT1 + CURRENCY2 + AMOUNT2 + CURRENCY3 + AMOUNT3 + BANKRUPTCY_TYPE + [LIST_PLAINTIFF] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + properties: + SUBJECT_NAME : + type: string + description: Subject Name + example: + COURT_CODE: + type: string + description: Court Code + example: "CWU" + CASE_CODE: + type: string + description: Case Code + example: "381" + CASE_YEAR: + type: string + description: Case Year + example: "2000" + ACTION_DATE: + type: string + description: Action Date + example: "22/12/2000" + BANKRUPTCY_ACT: + type: string + description: Act of Bankruptcy + example: "Petition for Winding Up" + HEARING_DATE : + type: string + description: Hearing Date + example: "26/03/2009" + CURRENCY1: + type: string + description: Currency + example: + AMOUNT1: + type: string + description: Amount + example: "334,616.00" + CURRENCY2: + type: string + description: Currency + example: + AMOUNT2: + type: string + description: Amount + example: "0.00" + CURRENCY3: + type: string + description: Currency + example: + AMOUNT3: + type: string + description: Amount + example: "0.00" + BANKRUPTCY_TYPE: + type: string + description: Bankruptcy Type + example: "COMPANY WINDING UP PETITION" + LIST_PLAINTIFF: + type: array + description: |+ + List of Plaintiff with following children: + [PLAINTIFF] + example: |+ + + + + + + + + + items: + properties: + PLAINTIFF: + type: object + description: |+ + Plaintiff detail with following children: + PLA_NAME + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_FILE_REF + example: |+ + + + + + + + properties: + PLA_NAME: + type: string + description: Pla. Name + example: "B 2003 P1" + PLA_SOLICITOR: + type: string + description: Pla. Solicitor + example: "PATRICK KHOO ENG HOCK" + PLA_SOLICITOR_ID: + type: string + description: Pla. Solicitor ID + example: + PLA_FILE_REF: + type: string + description: Pla. File Ref. + example: "RSP/292668/1" + LIST_LIT: + type: array + description: |+ + List of litigation with following children: + [LIT] + example: |+ + + + + + + + + items: + properties: + LIT: + type: object + description: |+ + Basic litigation info with following children: + SUBJECT_NAME + SEQ_NO + FORMATTED_ID + [LIST_LIT_DTL] + example: |+ + + + + + + properties: + SUBJECT_NAME: + type: string + description: Name + example: "ENG YICK HOLDINGS PTE LTD" + SEQ_NO: + type: integer + description: Sequence No. + example: 1 + FORMATTED_ID: + type: string + description: Formatted ID + example: "197803191K" + LIST_LIT_DTL: + type: array + description: |+ + List of litigation detail with following children: + [LIT_DTL] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + S7250163B + + + + + + + + + - + - + S7250163B + + + + + + + + + + + + + items: + properties: + LIT_DTL: + type: object + description: |+ + Litigation detail with following children: + NATURE_OF_CLAIM + STATUS_DATE + CASE_NO + FORMATTED_ID + DOC_REMARKS + CURRENCY1 + CURRENCY2 + CURRENCY3 + CURRENCY4 + CURRENCY5 + CASE_STATUS + AMOUNT1 + AMOUNT2 + AMOUNT3 + AMOUNT4 + AMOUNT5 + [LIST_PLAINTIFF] + [LIST_DEFENDANT] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + S7250163B + + + + + + + + + - + - + S7250163B + + + + + + + + + + + + properties: + NATURE_OF_CLAIM: + type: string + description: Nature of Claim + example: "CONTRACTS-WORK DONE & SERVICES RENDERED" + STATUS_DATE: + type: string + description: Status Date + example: "13/08/2001" + CASE_NO: + type: string + description: Case No. + example: "MC 23631 / 2001" + FORMATTED_ID: + type: string + description: Formatted ID + example: "197803191K" + DOC_REMARKS: + type: string + description: Document Remark + example: "WRIT OF SUMMONS" + CURRENCY1: + type: string + description: Currency 1 + example: "SIN" + CURRENCY2: + type: string + description: Currency 2 + example: + CURRENCY3: + type: string + description: Currency 3 + example: + CURRENCY4: + type: string + description: Currency 4 + example: + CURRENCY5: + type: string + description: Currency 5 + example: + CASE_STATUS: + type: string + description: Status + example: "PENDING AS AT STATUS DATE" + AMOUNT1: + type: string + description: Amount 1 + example: "36,196.00" + AMOUNT2: + type: string + description: Amount 2 + example: "0.00" + AMOUNT3: + type: string + description: Amount 3 + example: "0.00" + AMOUNT4: + type: string + description: Amount 4 + example: "0.00" + AMOUNT5: + type: string + description: Amount 5 + example: "0.00" + LIST_PLAINTIFF: + type: array + description: |+ + List of plaintiff with following children: + [PLAINTIFF] + example: |+ + + + + + + + + + - + - + S7250163B + + + items: + properties: + PLAINTIFF: + type: object + description: |+ + Plaintiff detail with following children: + PLA_NAME + LAW_FIRM + WRITE_DATE + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_FILE_REF + PLA_STATUS + PLA_STATUS_DATE + PLA_ID + example: |+ + + + + + + + + - + - + S7250163B + + properties: + PLA_NAME: + type: string + description: Plaintiff Name + example: "ROTARY PILING PTE LTD" + LAW_FIRM: + type: string + description: Pla. Law Firm + example: "JOSEPH HOO MORRIS & KUMAR" + WRITE_DATE: + type: string + description: Writ date + example: "13/08/2001" + PLA_SOLICITOR: + type: string + description: Plaintiff Solicitor + example: "HOO JOSEPH" + PLA_SOLICITOR_ID: + type: string + description: Plaintiff Solicitor ID + example: "ORS" + PLA_FILE_REF: + type: string + description: Pla. File Ref. + example: "CHH 6253 D27" + PLA_STATUS: + type: string + description: Plaintiff Status + example: + PLA_STATUS_DATE: + type: string + description: Plaintiff Status Date + example: + PLA_ID: + type: string + description: Plaintiff ID + example: "S7250163B" + LIST_DEFENDANT: + type: array + description: |+ + List of defendant with following children: + [DEFENDANT] + example: |+ + + + + + + + + + items: + properties: + DEFENDANT: + type: object + description: |+ + Defendant detail with following children: + DEF_SOLICITOR + DEF_SOLICITOR_ID + DEF_LAW_FIRM + DEF_FILE_REF + example: |+ + + + + + + + properties: + DEF_SOLICITOR: + type: string + description: Def. Solicitor + example: + DEF_SOLICITOR_ID: + type: string + description: Def. Solicitor ID + example: N/A + DEF_LAW_FIRM: + type: string + description: Def. Law Firm + example: + DEF_FILE_REF: + type: string + description: Def. File Ref. + example: + LIST_Ddrptcount: + type: array + description: |+ + List of Search By Financial Sectors and Search By Non-Financial Sectors with following children: + [Ddrptcount] + example: |+ + + + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 2017 + 1 + + + items: + properties: + Ddrptcount: + type: object + description: |+ + 6 XML tags (open then close) displays Search By Financial Sectors (counts for 3 recent years).Search By Non-Financial Sectors (counts for 3 recent years) with following children: + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcyear + Rcsecflag + example: |+ + + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1 + 2017 + 1 + + properties: + Rcjan: + type: integer + description: Count for January + example: "1" + Rcfeb: + type: integer + description: Count for February + example: "1" + Rcmar: + type: integer + description: Count for March + example: "1" + Rcapr: + type: integer + description: Count for April + example: "1" + Rcmay: + type: integer + description: Count for May + example: "1" + Rcjun: + type: integer + description: Count for June + example: "1" + Rcjul: + type: integer + description: Count for July + example: "1" + Rcaug: + type: integer + description: Count for August + example: "1" + Rcsep: + type: integer + description: Count for September + example: "1" + Rcoct: + type: integer + description: Count for October + example: "1" + Rcnov: + type: integer + description: Count for November + example: "1" + Rcdec: + type: integer + description: Count for December + example: "1" + Rcyear: + type: integer + description: To show the year + example: "1" + Rcsecflag: + type: integer + description: Differentiate Search By Financial Sectors and Search By Non-Financial Sectors + example: "1" + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + REQUEST: + type: object + properties: + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + 197601887ETRANSTAR TRAVEL PTE LTD + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/d&b_basic_individual_search_sg_v1.0.yaml b/data/d&b_basic_individual_search_sg_v1.0.yaml new file mode 100644 index 000000000..b2af4a05a --- /dev/null +++ b/data/d&b_basic_individual_search_sg_v1.0.yaml @@ -0,0 +1,1403 @@ +openapi: 3.0.1 +info: + title: D&B Basic Individual Search (SG) + description: |+ + This Data microservice provides the information on the (Singapore-registered) business interest of an individual that includes the individual’s actual name, residential address, business and shareholding in businesses, current & previous ownership, litigation against individual and businesses, bankruptcy record and count on the times this individual has been searched on. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions that require personal checks, e.g. in the appointment of Board Members, Directorship or C-suite level hiring, where the appointee’s background is paramount to the Company and its reputation. + - Swift pre-employment screening solution - information provided by the microservice can be used to protect one's company's reputation from potential negative publicity by conducting background checks on individuals prior to hiring. + version: '1.0.0' + x-subscribelink: d&b_basic_individual_search_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/sbis/v0/getdata: + post: + tags: + - v0 + summary: Adds a new user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + REPORT: + META_INFO: + SERVICE: BIS + SYSTEM_ID: DDP + CREATION_DATE: 25/02/2009 17:31:44.678 + USER_ID: plcust102 + BASIC_INFO: + PA_REG_NO: + "@type": String + "#text": '00091' + ADDRESS1: 137, BEDOK RESERVOIR ROAD, 06 - 1451 + ADDRESS2: "-" + ADDRESS3: 470137, SINGAPORE + LIT_SEARCH_INFO: + COMP_NAME: ENG YICK HOLDINGS PTE LTD + REG_NO: 197803191K + REPORT_TYPE: BIS + REQ_DATE: 25/02/2009 17:31:44 + REQ_REG_NO: 197803191K + REQ_NAME: LOY KOK TOON + REQ_DATE_STR: 25/02/2009 15:04:14 + LIST_CURRENT_COMP: + CURRENT_COMP: + POSITION: OWNER + APPOINTMENT_DATE: 01/09/1971 + COMP_NAME: BAN HOE LEONG COMPANY + SEQ_NO: 03647300J + SHARE_VALUE1: '15.00' + COMP_STATUS: LIVE + PROFIT_VALUE1: 2008 = - + PROFIT_VALUE2: 2007 = - + PROFIT_VALUE3: 2006 = - + SHARE_VALUE: '150000' + TEL: '62994842' + FAX: '62992797' + SIC: '5012' + SIC_DESC: Automobiles and other Motor Vehicles + LIST_PREVIOUS_COMP: + PREVIOUS_COMP: + POSITION: SHAREHOLDER + APPOINTMENT_DATE: 30/06/1988 + COMP_NAME: ENG YICK INDUSTRIES PTE LTD + SEQ_NO: 198101820Z + SHARE_VALUE1: '100.00' + COMP_STATUS: DISSOLVED - COMPULSORY WINDING UP (INSOLVENCY) + CESSATION_DATE: 22/09/1992 + SHARE_VALUE: '390002' + TEL: '62994842' + FAX: '67467646' + SIC: '2325' + SIC_DESC: Menâ€TMs and Boysâ€TM Separate Trousers and Slacks + LIST_BANKRUPTCY: + BANKRUPTCY: + SUBJECT_NAME: "-" + COURT_CODE: CWU + CASE_CODE: '381' + CASE_YEAR: '2000' + ACTION_DATE: 22/12/2000 + BANKRUPTCY_ACT: Petition for Winding Up + HEARING_DATE: 26/03/2009 + CURRENCY1: "-" + AMOUNT1: '334,616.00' + CURRENCY2: "-" + AMOUNT2: '0.00' + CURRENCY3: "-" + AMOUNT3: '0.00' + BANKRUPTCY_TYPE: COMPANY WINDING UP PETITION + LIST_PLAINTIFF: + PLAINTIFF: + PLA_NAME: B 2003 P1 + PLA_SOLICITOR: PATRICK KHOO ENG HOCK + PLA_SOLICITOR_ID: "-" + PLA_FILE_REF: RSP/292668/1 + LIST_LIT: + LIT: + SUBJECT_NAME: ENG YICK HOLDINGS PTE LTD + SEQ_NO: '1' + FORMATTED_ID: 197803191K + LIST_LIT_DTL: + LIT_DTL: + NATURE_OF_CLAIM: CONTRACTS-WORK DONE & SERVICES RENDERED + STATUS_DATE: 13/08/2001 + CASE_NO: MC 23631 / 2001 + FORMATTED_ID: 197803191K + DOC_REMARKS: WRIT OF SUMMONS + CURRENCY1: SIN + CURRENCY2: "-" + CURRENCY3: "-" + CURRENCY4: "-" + CURRENCY5: "-" + CASE_STATUS: PENDING AS AT STATUS DATE + AMOUNT1: '36,196.00' + AMOUNT2: '0.00' + AMOUNT3: '0.00' + AMOUNT4: '0.00' + AMOUNT5: '0.00' + LIST_PLAINTIFF: + PLAINTIFF: + - PLA_NAME: ROTARY PILING PTE LTD + LAW_FIRM: JOSEPH HOO MORRIS & KUMAR + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: HOO JOSEPH + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 D27 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + - PLA_NAME: ABC PTE LTD + LAW_FIRM: JAMES & JOE + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: KHOO JAMES + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 X10 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + LIST_DEFENDANT: + DEFENDANT: + DEF_SOLICITOR: "-" + DEF_SOLICITOR_ID: N/A + DEF_LAW_FIRM: "-" + DEF_FILE_REF: "-" + LIST_Ddrptcount: + Ddrptcount: + - Rcjan: '1' + Rcfeb: '1' + Rcmar: '1' + Rcapr: '1' + Rcmay: '1' + Rcjun: '1' + Rcjul: '1' + Rcaug: '1' + Rcsep: '1' + Rcoct: '1' + Rcnov: '1' + Rcdec: '1' + Rcyear: '2017' + Rcsecflag: '1' + - Rcjan: '0' + Rcfeb: '0' + Rcmar: '0' + Rcapr: '0' + Rcmay: '0' + Rcjun: '0' + Rcjul: '0' + Rcaug: '0' + Rcsep: '0' + Rcoct: '0' + Rcnov: '0' + Rcdec: '0' + Rcyear: '2016' + Rcsecflag: '1' + - Rcjan: '0' + Rcfeb: '0' + Rcmar: '0' + Rcapr: '0' + Rcmay: '0' + Rcjun: '0' + Rcjul: '0' + Rcaug: '0' + Rcsep: '0' + Rcoct: '0' + Rcnov: '0' + Rcdec: '0' + Rcyear: '2015' + Rcsecflag: '1' + - Rcjan: '0' + Rcfeb: '0' + Rcmar: '0' + Rcapr: '0' + Rcmay: '0' + Rcjun: '0' + Rcjul: '0' + Rcaug: '0' + Rcsep: '0' + Rcoct: '0' + Rcnov: '0' + Rcdec: '0' + Rcyear: '2017' + Rcsecflag: '0' + - Rcjan: '0' + Rcfeb: '0' + Rcmar: '0' + Rcapr: '0' + Rcmay: '0' + Rcjun: '0' + Rcjul: '0' + Rcaug: '0' + Rcsep: '0' + Rcoct: '0' + Rcnov: '0' + Rcdec: '0' + Rcyear: '2016' + Rcsecflag: '0' + - Rcjan: '0' + Rcfeb: '0' + Rcmar: '0' + Rcapr: '0' + Rcmay: '0' + Rcjun: '0' + Rcjul: '0' + Rcaug: '0' + Rcsep: '0' + Rcoct: '0' + Rcnov: '0' + Rcdec: '0' + Rcyear: '2015' + Rcsecflag: '0' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [BASIC_INFO] + [LIT_SEARCH_INFO] + [LIST_CURRENT_COMP] + [LIST_PREVIOUS_COMP] + [LIST_BANKRUPTCY] + [LIST_LIT] + [LIST_LIT_DTL] + properties: + META_INFO: + type: object + example: + META_INFO: + SERVICE: BIS + SYSTEM_ID: DDP + CREATION_DATE: 25/02/2009 17:31:44.678 + USER_ID: plcust102 + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + properties: + SERVICE: + type: string + example: "BIS" + description: Report Requested + SYSTEM_ID : + type: string + example: "DDP" + description: System ID + CREATION_DATE: + type: datetime + example: "25/02/2009 17:31:44.678" + description: Report Request Date + USER_ID : + type: string + example: N/A + description: Valid user id in DDP system. It is for (For internal use) + BASIC_INFO : + type: object + description: |+ + Basic Information with following children: + PA_REG_NO + ADDRESS1 + ADDRESS2 + ADDRESS3 + example: + BASIC_INFO: + PA_REG_NO: + "@type": String + "#text": '00091' + ADDRESS1: 137, BEDOK RESERVOIR ROAD, 06 - 1451 + ADDRESS2: "-" + ADDRESS3: 470137, SINGAPORE + properties: + PA_REG_NO: + type: string + description: Public Accountant Registration No. + example: "00091" + ADDRESS1: + type: string + description: Address 1 + example: "137" + ADDRESS2: + type: string + description: Address 2 + example: "vvvvv" + ADDRESS3: + type: string + description: Address 3 + example: "470137, SINGAPORE" + LIT_SEARCH_INFO : + type: object + example: + LIT_SEARCH_INFO: + COMP_NAME: ENG YICK HOLDINGS PTE LTD + REG_NO: 197803191K + REPORT_TYPE: BIS + REQ_DATE: 25/02/2009 17:31:44 + REQ_REG_NO: 197803191K + REQ_NAME: LOY KOK TOON + REQ_DATE_STR: 25/02/2009 15:04:14 + description: |+ + Litigation search information with following children: + COMP_NAME + REG_NO + REPORT_TYPE + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "ENG YICK HOLDINGS PTE LTD" + REG_NO: + type: string + description: Company Registration No + example: "197803191K" + REPORT_TYPE: + type: string + description: Report Type + example: "BIS" + REQ_DATE: + type: datetime + description: Requested Date + example: "25/02/2009 17:31:44" + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197803191K" + REQ_NAME: + type: string + description: Request Name + example: "LOY KOK TOON" + REQ_DATE_STR: + type: string + description: Request Date String + example: "25/02/2009 15:04:14" + LIST_CURRENT_COMP : + type: array + description: |+ + List of current companies with following children: + [CURRENT_COMP] + example: + LIST_CURRENT_COMP: + CURRENT_COMP: + POSITION: OWNER + APPOINTMENT_DATE: 01/09/1971 + COMP_NAME: BAN HOE LEONG COMPANY + SEQ_NO: 03647300J + SHARE_VALUE1: '15.00' + COMP_STATUS: LIVE + PROFIT_VALUE1: 2008 = - + PROFIT_VALUE2: 2007 = - + PROFIT_VALUE3: 2006 = - + SHARE_VALUE: '150000' + TEL: '62994842' + FAX: '62992797' + SIC: '5012' + SIC_DESC: Automobiles and other Motor Vehicles + items: + properties: + CURRENT_COMP: + type: object + description: |+ + Current companies detail with following children: + POSITION + APPOINTMENT_DATE + COMP_NAME + SEQ_NO + SHARE_VALUE1 + COMP_STATUS + PROFIT_VALUE + SHARE_VALUE + TEL + FAX + SIC + SIC_DESC + example: + CURRENT_COMP: + POSITION: OWNER + APPOINTMENT_DATE: 01/09/1971 + COMP_NAME: BAN HOE LEONG COMPANY + SEQ_NO: 03647300J + SHARE_VALUE1: '15.00' + COMP_STATUS: LIVE + PROFIT_VALUE1: 2008 = - + PROFIT_VALUE2: 2007 = - + PROFIT_VALUE3: 2006 = - + SHARE_VALUE: '150000' + TEL: '62994842' + FAX: '62992797' + SIC: '5012' + SIC_DESC: Automobiles and other Motor Vehicles + properties: + POSITION: + type: string + description: Position + example: "OWNER" + APPOINTMENT_DATE: + type: string + description: Appointment Date + example: "01/09/1971" + COMP_NAME: + type: string + description: Company Name + example: "BAN HOE LEONG COMPANY" + SEQ_NO: + type: string + description: Company Registration No. + example: "03647300J" + SHARE_VALUE1: + type: string + description: Share Percentage + example: "15.00" + COMP_STATUS: + type: string + description: Company Status + example: "LIVE" + PROFIT_VALUE1: + type: string + description: Profit Making 1 + example: "2008 = -" + PROFIT_VALUE2: + type: string + description: Profit Making 2 + example: "2007 = -" + PROFIT_VALUE3: + type: string + description: Profit Making 3 + example: "2006 = -" + SHARE_VALUE: + type: string + description: Number Of Shares + example: "150000" + TEL: + type: string + description: Telephone Number + example: "62994842" + FAX: + type: string + description: Fax Number + example: "62992797" + SIC: + type: string + description: SIC Code + example: "5012" + SIC_DESC: + type: string + description: SIC Description + example: "Automobiles and other Motor Vehicles" + LIST_PREVIOUS_COMP: + type: array + example: + LIST_PREVIOUS_COMP: + PREVIOUS_COMP: + POSITION: SHAREHOLDER + APPOINTMENT_DATE: 30/06/1988 + COMP_NAME: ENG YICK INDUSTRIES PTE LTD + SEQ_NO: 198101820Z + SHARE_VALUE1: '100.00' + COMP_STATUS: DISSOLVED - COMPULSORY WINDING UP (INSOLVENCY) + CESSATION_DATE: 22/09/1992 + SHARE_VALUE: '390002' + TEL: '62994842' + FAX: '67467646' + SIC: '2325' + SIC_DESC: Men’s and Boys’ Separate Trousers and Slacks + description: |+ + List of previous companies with following children: + [PREVIOUS_COMP] + items: + properties: + PREVIOUS_COMP : + type: object + description: |+ + Previous companies detail with following children: + POSITION + APPOINTMENT_DATE + COMP_NAME + SEQ_NO + SHARE_VALUE1 + COMP_STATUS + CESSATION_DATE + SHARE_VALUE + TEL + FAX + SIC + SIC_DESC + example: + PREVIOUS_COMP: + POSITION: SHAREHOLDER + APPOINTMENT_DATE: 30/06/1988 + COMP_NAME: ENG YICK INDUSTRIES PTE LTD + SEQ_NO: 198101820Z + SHARE_VALUE1: '100.00' + COMP_STATUS: DISSOLVED - COMPULSORY WINDING UP (INSOLVENCY) + CESSATION_DATE: 22/09/1992 + SHARE_VALUE: '390002' + TEL: '62994842' + FAX: '67467646' + SIC: '2325' + SIC_DESC: Men’s and Boys’ Separate Trousers and Slacks + properties: + POSITION : + type: string + description: Position + example: "SHAREHOLDER" + APPOINTMENT_DATE: + type: string + description: Appointment Date + example: "30/06/1988" + COMP_NAME: + type: string + description: Company Name + example: "ENG YICK INDUSTRIES PTE LTD" + SEQ_NO: + type: string + description: Company Registration No. + example: "198101820Z" + SHARE_VALUE1: + type: string + description: Share Value Percentage + example: "100.00" + COMP_STATUS: + type: string + description: Company Status + example: "DISSOLVED - COMPULSORY WINDING UP (INSOLVENCY)" + CESSATION_DATE : + type: string + description: Cessation Date + example: "22/09/1992" + SHARE_VALUE: + type: string + description: Number Of Shares + example: "390002" + TEL: + type: string + description: Telephone Number + example: "62994842" + FAX: + type: string + description: Fax Number + example: "67467646" + SIC: + type: string + description: SIC Code + example: "2325" + SIC_DESC: + type: string + description: SIC Description + example: "Men’s and Boys’ Separate Trousers and Slacks" + LIST_BANKRUPTCY: + type: array + description: |+ + Bankruptcy/ Winding up with following children: + [BANKRUPTCY] + example: + LIST_BANKRUPTCY: + BANKRUPTCY: + SUBJECT_NAME: "-" + COURT_CODE: CWU + CASE_CODE: '381' + CASE_YEAR: '2000' + ACTION_DATE: 22/12/2000 + BANKRUPTCY_ACT: Petition for Winding Up + HEARING_DATE: 26/03/2009 + CURRENCY1: "-" + AMOUNT1: '334,616.00' + CURRENCY2: "-" + AMOUNT2: '0.00' + CURRENCY3: "-" + AMOUNT3: '0.00' + BANKRUPTCY_TYPE: COMPANY WINDING UP PETITION + LIST_PLAINTIFF: + PLAINTIFF: + PLA_NAME: B 2003 P1 + PLA_SOLICITOR: PATRICK KHOO ENG HOCK + PLA_SOLICITOR_ID: "-" + PLA_FILE_REF: RSP/292668/1 + items: + properties: + BANKRUPTCY : + type: object + description: |+ + Bankruptcy/Winding up detail with following children: + SUBJECT_NAME + COURT_CODE + CASE_CODE + CASE_YEAR + ACTION_DATE + BANKRUPTCY_ACT + HEARING_DATE + CURRENCY1 + AMOUNT1 + CURRENCY2 + AMOUNT2 + CURRENCY3 + AMOUNT3 + BANKRUPTCY_TYPE + [LIST_PLAINTIFF] + example: + BANKRUPTCY: + SUBJECT_NAME: "-" + COURT_CODE: CWU + CASE_CODE: '381' + CASE_YEAR: '2000' + ACTION_DATE: 22/12/2000 + BANKRUPTCY_ACT: Petition for Winding Up + HEARING_DATE: 26/03/2009 + CURRENCY1: "-" + AMOUNT1: '334,616.00' + CURRENCY2: "-" + AMOUNT2: '0.00' + CURRENCY3: "-" + AMOUNT3: '0.00' + BANKRUPTCY_TYPE: COMPANY WINDING UP PETITION + LIST_PLAINTIFF: + PLAINTIFF: + PLA_NAME: B 2003 P1 + PLA_SOLICITOR: PATRICK KHOO ENG HOCK + PLA_SOLICITOR_ID: "-" + PLA_FILE_REF: RSP/292668/1 + properties: + SUBJECT_NAME : + type: string + description: Subject Name + example: + COURT_CODE: + type: string + description: Court Code + example: "CWU" + CASE_CODE: + type: string + description: Case Code + example: "381" + CASE_YEAR: + type: string + description: Case Year + example: "2000" + ACTION_DATE: + type: string + description: Action Date + example: "22/12/2000" + BANKRUPTCY_ACT: + type: string + description: Act of Bankruptcy + example: "Petition for Winding Up" + HEARING_DATE : + type: string + description: Hearing Date + example: "26/03/2009" + CURRENCY1: + type: string + description: Currency + example: + AMOUNT1: + type: string + description: Amount + example: "334,616.00" + CURRENCY2: + type: string + description: Currency + example: + AMOUNT2: + type: string + description: Amount + example: "0.00" + CURRENCY3: + type: string + description: Currency + example: + AMOUNT3: + type: string + description: Amount + example: "0.00" + BANKRUPTCY_TYPE: + type: string + description: Bankruptcy Type + example: "COMPANY WINDING UP PETITION" + LIST_PLAINTIFF: + type: array + description: |+ + List of Plaintiff with following children: + [PLAINTIFF] + example: + LIST_PLAINTIFF: + PLAINTIFF: + PLA_NAME: B 2003 P1 + PLA_SOLICITOR: PATRICK KHOO ENG HOCK + PLA_SOLICITOR_ID: "-" + PLA_FILE_REF: RSP/292668/1 + items: + properties: + PLAINTIFF: + type: object + description: |+ + Plaintiff detail with following children: + PLA_NAME + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_FILE_REF + example: + PLAINTIFF: + PLA_NAME: B 2003 P1 + PLA_SOLICITOR: PATRICK KHOO ENG HOCK + PLA_SOLICITOR_ID: "-" + PLA_FILE_REF: RSP/292668/1 + properties: + PLA_NAME: + type: string + description: Pla. Name + example: "B 2003 P1" + PLA_SOLICITOR: + type: string + description: Pla. Solicitor + example: "PATRICK KHOO ENG HOCK" + PLA_SOLICITOR_ID: + type: string + description: Pla. Solicitor ID + example: + PLA_FILE_REF: + type: string + description: Pla. File Ref. + example: "RSP/292668/1" + LIST_LIT: + type: array + description: |+ + List of litigation with following children: + [LIT] + example: + LIST_LIT: + LIT: + SUBJECT_NAME: ENG YICK HOLDINGS PTE LTD + SEQ_NO: '1' + FORMATTED_ID: 197803191K + items: + properties: + LIT: + type: object + description: |+ + Basic litigation info with following children: + SUBJECT_NAME + SEQ_NO + FORMATTED_ID + [LIST_LIT_DTL] + example: + LIT: + SUBJECT_NAME: ENG YICK HOLDINGS PTE LTD + SEQ_NO: '1' + FORMATTED_ID: 197803191K + properties: + SUBJECT_NAME: + type: string + description: Name + example: "ENG YICK HOLDINGS PTE LTD" + SEQ_NO: + type: integer + description: Sequence No. + example: 1 + FORMATTED_ID: + type: string + description: Formatted ID + example: "197803191K" + LIST_LIT_DTL: + type: array + description: |+ + List of litigation detail with following children: + [LIT_DTL] + example: + LIST_LIT_DTL: + LIT_DTL: + NATURE_OF_CLAIM: CONTRACTS-WORK DONE & SERVICES RENDERED + STATUS_DATE: 13/08/2001 + CASE_NO: MC 23631 / 2001 + FORMATTED_ID: 197803191K + DOC_REMARKS: WRIT OF SUMMONS + CURRENCY1: SIN + CURRENCY2: "-" + CURRENCY3: "-" + CURRENCY4: "-" + CURRENCY5: "-" + CASE_STATUS: PENDING AS AT STATUS DATE + AMOUNT1: '36,196.00' + AMOUNT2: '0.00' + AMOUNT3: '0.00' + AMOUNT4: '0.00' + AMOUNT5: '0.00' + LIST_PLAINTIFF: + PLAINTIFF: + - PLA_NAME: ROTARY PILING PTE LTD + LAW_FIRM: JOSEPH HOO MORRIS & KUMAR + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: HOO JOSEPH + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 D27 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + - PLA_NAME: ABC PTE LTD + LAW_FIRM: JAMES & JOE + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: KHOO JAMES + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 X10 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + LIST_DEFENDANT: + DEFENDANT: + DEF_SOLICITOR: "-" + DEF_SOLICITOR_ID: N/A + DEF_LAW_FIRM: "-" + DEF_FILE_REF: "-" + items: + properties: + LIT_DTL: + type: object + description: |+ + Litigation detail with following children: + NATURE_OF_CLAIM + STATUS_DATE + CASE_NO + FORMATTED_ID + DOC_REMARKS + CURRENCY1 + CURRENCY2 + CURRENCY3 + CURRENCY4 + CURRENCY5 + CASE_STATUS + AMOUNT1 + AMOUNT2 + AMOUNT3 + AMOUNT4 + AMOUNT5 + [LIST_PLAINTIFF] + [LIST_DEFENDANT] + example: + LIT_DTL: + NATURE_OF_CLAIM: CONTRACTS-WORK DONE & SERVICES RENDERED + STATUS_DATE: 13/08/2001 + CASE_NO: MC 23631 / 2001 + FORMATTED_ID: 197803191K + DOC_REMARKS: WRIT OF SUMMONS + CURRENCY1: SIN + CURRENCY2: "-" + CURRENCY3: "-" + CURRENCY4: "-" + CURRENCY5: "-" + CASE_STATUS: PENDING AS AT STATUS DATE + AMOUNT1: '36,196.00' + AMOUNT2: '0.00' + AMOUNT3: '0.00' + AMOUNT4: '0.00' + AMOUNT5: '0.00' + LIST_PLAINTIFF: + PLAINTIFF: + - PLA_NAME: ROTARY PILING PTE LTD + LAW_FIRM: JOSEPH HOO MORRIS & KUMAR + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: HOO JOSEPH + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 D27 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + - PLA_NAME: ABC PTE LTD + LAW_FIRM: JAMES & JOE + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: KHOO JAMES + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 X10 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + LIST_DEFENDANT: + DEFENDANT: + DEF_SOLICITOR: "-" + DEF_SOLICITOR_ID: N/A + DEF_LAW_FIRM: "-" + DEF_FILE_REF: "-" + properties: + NATURE_OF_CLAIM: + type: string + description: Nature of Claim + example: "CONTRACTS-WORK DONE & SERVICES RENDERED" + STATUS_DATE: + type: string + description: Status Date + example: "13/08/2001" + CASE_NO: + type: string + description: Case No. + example: "MC 23631 / 2001" + FORMATTED_ID: + type: string + description: Formatted ID + example: "197803191K" + DOC_REMARKS: + type: string + description: Document Remark + example: "WRIT OF SUMMONS" + CURRENCY1: + type: string + description: Currency 1 + example: "SIN" + CURRENCY2: + type: string + description: Currency 2 + example: + CURRENCY3: + type: string + description: Currency 3 + example: + CURRENCY4: + type: string + description: Currency 4 + example: + CURRENCY5: + type: string + description: Currency 5 + example: + CASE_STATUS: + type: string + description: Status + example: "PENDING AS AT STATUS DATE" + AMOUNT1: + type: string + description: Amount 1 + example: "36,196.00" + AMOUNT2: + type: string + description: Amount 2 + example: "0.00" + AMOUNT3: + type: string + description: Amount 3 + example: "0.00" + AMOUNT4: + type: string + description: Amount 4 + example: "0.00" + AMOUNT5: + type: string + description: Amount 5 + example: "0.00" + LIST_PLAINTIFF: + type: array + description: |+ + List of plaintiff with following children: + [PLAINTIFF] + example: + LIST_PLAINTIFF: + PLAINTIFF: + PLA_NAME: ROTARY PILING PTE LTD + LAW_FIRM: JOSEPH HOO MORRIS & KUMAR + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: HOO JOSEPH + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 D27 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + items: + properties: + PLAINTIFF: + type: object + description: |+ + Plaintiff detail with following children: + PLA_NAME + LAW_FIRM + WRITE_DATE + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_FILE_REF + PLA_STATUS + PLA_STATUS_DATE + PLA_ID + example: + PLAINTIFF: + PLA_NAME: ROTARY PILING PTE LTD + LAW_FIRM: JOSEPH HOO MORRIS & KUMAR + WRITE_DATE: 13/08/2001 + PLA_SOLICITOR: HOO JOSEPH + PLA_SOLICITOR_ID: ORS + PLA_FILE_REF: CHH 6253 D27 + PLA_STATUS: "-" + PLA_STATUS_DATE: "-" + PLA_ID: S7250163B + properties: + PLA_NAME: + type: string + description: Plaintiff Name + example: "ROTARY PILING PTE LTD" + LAW_FIRM: + type: string + description: Pla. Law Firm + example: "JOSEPH HOO MORRIS & KUMAR" + WRITE_DATE: + type: string + description: Writ date + example: "13/08/2001" + PLA_SOLICITOR: + type: string + description: Plaintiff Solicitor + example: "HOO JOSEPH" + PLA_SOLICITOR_ID: + type: string + description: Plaintiff Solicitor ID + example: "ORS" + PLA_FILE_REF: + type: string + description: Pla. File Ref. + example: "CHH 6253 D27" + PLA_STATUS: + type: string + description: Plaintiff Status + example: + PLA_STATUS_DATE: + type: string + description: Plaintiff Status Date + example: + PLA_ID: + type: string + description: Plaintiff ID + example: "S7250163B" + LIST_DEFENDANT: + type: array + description: |+ + List of defendant with following children: + [DEFENDANT] + example: + LIST_DEFENDANT: + DEFENDANT: + DEF_SOLICITOR: "-" + DEF_SOLICITOR_ID: N/A + DEF_LAW_FIRM: "-" + DEF_FILE_REF: "-" + items: + properties: + DEFENDANT: + type: object + description: |+ + Defendant detail with following children: + DEF_SOLICITOR + DEF_SOLICITOR_ID + DEF_LAW_FIRM + DEF_FILE_REF + example: + DEFENDANT: + DEF_SOLICITOR: "-" + DEF_SOLICITOR_ID: N/A + DEF_LAW_FIRM: "-" + DEF_FILE_REF: "-" + properties: + DEF_SOLICITOR: + type: string + description: Def. Solicitor + example: + DEF_SOLICITOR_ID: + type: string + description: Def. Solicitor ID + example: N/A + DEF_LAW_FIRM: + type: string + description: Def. Law Firm + example: + DEF_FILE_REF: + type: string + description: Def. File Ref. + example: + LIST_Ddrptcount: + type: array + description: |+ + List of Search By Financial Sectors and Search By Non-Financial Sectors with following children: + [Ddrptcount] + example: + LIST_Ddrptcount: + Ddrptcount: + Rcjan: '1' + Rcfeb: '1' + Rcmar: '1' + Rcapr: '1' + Rcmay: '1' + Rcjun: '1' + Rcjul: '1' + Rcaug: '1' + Rcsep: '1' + Rcoct: '1' + Rcnov: '1' + Rcdec: '1' + Rcyear: '2017' + Rcsecflag: '1' + items: + properties: + Ddrptcount: + type: object + description: |+ + 6 XML tags (open then close) displays Search By Financial Sectors (counts for 3 recent years).Search By Non-Financial Sectors (counts for 3 recent years) with following children: + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcyear + Rcsecflag + example: + Ddrptcount: + Rcjan: '1' + Rcfeb: '1' + Rcmar: '1' + Rcapr: '1' + Rcmay: '1' + Rcjun: '1' + Rcjul: '1' + Rcaug: '1' + Rcsep: '1' + Rcoct: '1' + Rcnov: '1' + Rcdec: '1' + Rcyear: '2017' + Rcsecflag: '1' + properties: + Rcjan: + type: integer + description: Count for January + example: "1" + Rcfeb: + type: integer + description: Count for February + example: "1" + Rcmar: + type: integer + description: Count for March + example: "1" + Rcapr: + type: integer + description: Count for April + example: "1" + Rcmay: + type: integer + description: Count for May + example: "1" + Rcjun: + type: integer + description: Count for June + example: "1" + Rcjul: + type: integer + description: Count for July + example: "1" + Rcaug: + type: integer + description: Count for August + example: "1" + Rcsep: + type: integer + description: Count for September + example: "1" + Rcoct: + type: integer + description: Count for October + example: "1" + Rcnov: + type: integer + description: Count for November + example: "1" + Rcdec: + type: integer + description: Count for December + example: "1" + Rcyear: + type: integer + description: To show the year + example: "1" + Rcsecflag: + type: integer + description: Differentiate Search By Financial Sectors and Search By Non-Financial Sectors + example: "1" + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + properties: + total_items: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + subject_idno: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + subject_name: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized and Standardized results in Json Format + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/d&b_brief_financial_information_sg.yaml b/data/d&b_brief_financial_information_sg.yaml new file mode 100644 index 000000000..049d6a4f8 --- /dev/null +++ b/data/d&b_brief_financial_information_sg.yaml @@ -0,0 +1,1402 @@ +openapi: 3.0.1 +info: + title: D&B Brief Financial Information (SG) + description: This Data microservice provides the annual financial information of Singapore-registered businesses, inclusive of annual profit and loss and financial ratios. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions with functions for personal credit checks, e.g. for parties who have a vested interest (e.g. banks, investors) in the company’s performance and to evaluate the company’s gearing and acid ratios. + - Information from this microservice can be used for financial analysis - one can build models based on historical behavior. Continually update fraud patterns and compare with real-time transactions. Store and consolidate market data, trade activity, and other data, such as social and transactional data. + version: '0.1.0' + x-subscribelink: d&b_brief_financial_information_sg +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 15, 2019" +paths: + /dnb/prod/sbfe: + post: + tags: + - v0.1.0 + summary: Adds a new user + requestBody: + content: + application/xml: + schema: + $ref: '#/components/schemas/REQUEST' + responses: + '200': + description: Ok + content: + application/xml: + schema: + $ref: '#/components/schemas/success' + example: |+ + + 25/02/2009 17:31:44> + + + 2009-04-21 10:56:06.716 + 2004 2003 2002 2005 + 2006 2007 2008 2009 2008 2007 2006 2005 2004 + + 9403795.00 8617168.00 7807393.00 31467.00 162620.00 1281387.00 31467.00 162620.00 1281387.00 0.00 0.00 60318.00> 31467.00 162620.00 1341705.00 3889213.00 3395740.00 4374368.00 3359007.00 2855754.00 3546381.00 530206.00 539986.00 827987.00> 7370430.00 6845490.00 7661498.00 6739073.00 6157560.00 6435365.00 631357.00 687930.00 122133.00 -3481217.00 -3449750.00 -3287130.00 2000000.00 2000000.00 2000000.00 0.00 0.00 0.00 5481217.00 5449750.00 5287130.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + + 10877254.00 9982533.00 1121483.00 262632.00 1347380.00 262632.00 6562990.00 5424551.00 6283449.00 4948821.00 279541.00 475730.00 8434195.00 8643136.00 8434195.00 7933013.00 0.00 710123.00 -1871205.00 -3218585.00 2000000.00 2000000.00 0.00 0.00 -3,871,205.00 -5,218,585.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 0.00 + 0.00 0.00 0.00 0.00 + + 12.39 2.63 0.00 0.00 0.00 20.53 4.84 0.00 0.00 0.00 -72.01 -8.16 -0.00 -0.00 -0.00 1.66 1.84 2.42 2.54 1.78 0.74 0.62 0.50 0.46 0.55 -28.51 -59.33 -89.51 -101.59 -75.15 128.51 168.27 189.51 201.59 175.15 + + 1121483.0 10877254 2008 + + 262632.0> 9982533 2007 + + -31467.0 9403795 2006 + + -162620.0 8617168 2005 + + -1281387.0 7807393 2004 + + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + description: |+ + Report details with following children: + [META_INFO] + [FH_SEARCH_INFO] + [FH_DTL] + [XBRL_DTL] + [FH_RATIO_DTL] + [LIST_FH_CHART_INFO] + example: + properties: + META_INFO: + type: object + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + example: |+ + + + + 25/02/2009 17:31:44> + + + properties: + SERVICE: + type: string + description: Report Requested + example: "BFE" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: string + description: Report Request Date + example: "25/02/2009 17:31:44" + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: N/A + FH_SEARCH_INFO: + type: object + description: |+ + FH search information with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + FH_BEFORE_YR1 + FH_BEFORE_YR2 + FH_BEFORE_YR3 + FH_BEFORE_YR4 + FH_BEFORE_YR5 + FH_AFTER_YR1 + FH_AFTER_YR2 + FH_AFTER_YR3 + FH_AFTER_YR4 + FH_AFTER_YR5 + AC_RATIOS_YR1 + AC_RATIOS_YR2 + AC_RATIOS_YR3 + AC_RATIOS_YR4 + AC_RATIOS_YR5 + example: |+ + + + + 2009-04-21 10:56:06.716 + + + + 2004 + 2003 + 2002 + 2005 + 2006 + 2007 + 2008 + 2009 + 2008 + 2007 + 2006 + 2005 + 2004 + + properties: + COMP_NAME : + type: string + description: Company Name + example: "DUN & BRADSTREET (SINGAPORE) PTE. LTD." + REG_NO : + type: string + description: Company Registration No + example: "200003058W" + REQ_DATE : + type: datetime + description: Requested Date + example: "2009-04-21 10:56:06.716" + REQ_REG_NO : + type: string + description: Request Registration Number + example: "200003058W" + REQ_NAME : + type: string + description: Request Name + example: "DUN & BRADSTREET (SINGAPORE) PTE. LTD." + REQ_DATE_STR : + type: string + description: Request Date String + example: "21/04/2009 10:56:06" + FH_BEFORE_YR1 : + type: string + description: Financial Highlight filed before year 1 + example: "2004" + FH_BEFORE_YR2 : + type: string + description: Financial Highlight filed before year 2 + example: "2003" + FH_BEFORE_YR3 : + type: string + description: Financial Highlight filed before year 3 + example: "2002" + FH_AFTER_YR1: + type: string + description: Financial Highlight filed after year 1 + example: "2005" + FH_AFTER_YR2 : + type: string + description: Financial Highlight filed after year 2 + example: "2006" + FH_AFTER_YR3 : + type: string + description: Financial Highlight filed after year 3 + example: "2007" + FH_AFTER_YR4: + type: string + description: Financial Highlight filed after year 4 + example: "2008" + FH_AFTER_YR5: + type: string + description: Financial Highlight filed after year 5 + example: "2009" + AC_RATIOS_YR1 : + type: string + description: Account Ratio year 1 + example: "2008" + AC_RATIOS_YR2 : + type: string + description: Account Ratio year 2 + example: "2007" + AC_RATIOS_YR3 : + type: string + description: Account Ratio year 3 + example: "2006" + AC_RATIOS_YR4 : + type: string + description: Account Ratio year 4 + example: "2005" + AC_RATIOS_YR5 : + type: string + description: Account Ratio year 5 + example: "2004" + FH_DTL: + type: object + description: |+ + Financial Highlight with following children: + FH_YR1_CURR + TURNOVER1 + PL_BEF_TAX1 + PL_AFT_TAX1 + NETINC_NON_EXT1 + PL_AFT_TAX_EXT1 + TOT_ASSETS1 + TA_CURRENT1 + TA_FIXED1 + TOT_LIABILITIES1 + TL_CURRENT1 + TL_NON_CURRENT1 + SH_FUNDS1 + SH_PAIDUP_CAPITAL1 + SH_RESERVES1 + SH_ACCUM_LOSS1 + GRP_TURNOVER1 + GRP_PL_BEF_TAX1 + GRP_PL_AFT_TAX1 + GRP_NETINC_NON_EXT1 + GRP_PL_AFT_TAX_EXT1 + GRP_TOT_ASSETS1 + GRP_TA_CURRENT1 + GRP_TA_FIXED1 + GRP_TOT_LIABILITIES1 + GRP_TL_CURRENT1 + GRP_TL_NON_CURRENT1 + GRP_SH_FUNDS1 + GRP_SH_PAIDUP_CAPITAL1 + GRP_SH_RESERVES1 + GRP_SH_ACCUM_LOSS1 + GRP_INDICATOR1 + + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH data displayed in the report. + example: |+ + + + + + 9403795.00 + 8617168.00 + 7807393.00 + 31467.00 + 162620.00 + 1281387.00 + 31467.00 + 162620.00 + 1281387.00 + 0.00 + 0.00 + 60318.00> + 31467.00 + 162620.00 + 1341705.00 + 3889213.00 + 3395740.00 + 4374368.00 + 3359007.00 + 2855754.00 + 3546381.00 + 530206.00 + 539986.00 + 827987.00> + 7370430.00 + 6845490.00 + 7661498.00 + 6739073.00 + 6157560.00 + 6435365.00 + 631357.00 + 687930.00 + 122133.00 + -3481217.00 + -3449750.00 + -3287130.00 + 2000000.00 + 2000000.00 + 2000000.00 + 0.00 + 0.00 + 0.00 + 5481217.00 + 5449750.00 + 5287130.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + + + + + properties: + FH_YR1_CURR : + type: string + description: |+ + FH Before Year 1 Currency + Subsequent Years: + FH_YR2_CURR + FH_YR3_CURR + FH_YR4_CURR + FH_YR5_CURR + example: "(SGD)" + TURNOVER1 : + type: string + description: |+ + Turnover / Sales And Other Operating Revenues + Subsequent Years: + TURNOVER2 + TURNOVER3 + TURNOVER4 + TURNOVER5 + example: "9403795.00" + PL_BEF_TAX1 : + type: string + description: |+ + Profit / Loss Before Tax + Subsequent Years: + PL_BEF_TAX2 + PL_BEF_TAX3 + PL_BEF_TAX4 + PL_BEF_TAX5 + example: "31467.00" + PL_AFT_TAX1: + type: string + description: |+ + Profit / Loss After Tax + Subsequent Years: + PL_AFT_TAX2 + PL_AFT_TAX3 + PL_AFT_TAX4 + PL_AFT_TAX5 + example: "31467.00" + NETINC_NON_EXT1: + type: string + description: |+ + Net Income / Loss From Extraordinary And Non- Operating Items + Subsequent Years: + NETINC_NON_EXT2 + NETINC_NON_EXT3 + NETINC_NON_EXT4 + NETINC_NON_EXT5 + example: "0.00" + PL_AFT_TAX_EXT1 : + type: string + description: |+ + Profit / Loss After Tax and Extraordinary Items + Subsequent Years: + PL_AFT_TAX_EXT2 + PL_AFT_TAX_EXT3 + PL_AFT_TAX_EXT4 + PL_AFT_TAX_EXT5 + example: "31467.00" + TOT_ASSETS1 : + type: string + description: |+ + Total Assets + Subsequent Years: + TOT_ASSETS2 + TOT_ASSETS3 + TOT_ASSETS4 + TOT_ASSETS5 + example: "3889213.00" + TA_CURRENT1 : + type: string + description: |+ + Total Assets - Current + Subsequent Years: + TA_CURRENT2 + TA_CURRENT3 + TA_CURRENT4 + TA_CURRENT5 + example: "3359007.00" + TA_FIXED1 : + type: string + description: |+ + Total Assets – Fixed and Others + Subsequent Years: + TA_FIXED2 + TA_FIXED3 + TA_FIXED4 + TA_FIXED5 + example: "530206.00" + TOT_LIABILITIES1 : + type: string + description: |+ + Total Liabilities + Subsequent Years: + TOT_LIABILITIES2 + TOT_LIABILITIES3 + TOT_LIABILITIES4 + TOT_LIABILITIES5 + example: "7370430.00" + TL_CURRENT1 : + type: string + description: |+ + Total Liabilities - Current + Subsequent Years: + TL_CURRENT2 + TL_CURRENT3 + TL_CURRENT4 + TL_CURRENT5 + example: "6739073.00" + TL_NON_CURRENT1 : + type: string + description: |+ + Total Liabilities – Non- Current & Long Term + Subsequent Years: + TL_NON_CURRENT2 + TL_NON_CURRENT3 + TL_NON_CURRENT4 + TL_NON_CURRENT5 + example: "631357.00" + SH_FUNDS1: + type: string + description: |+ + Shareholder’s Fund + Subsequent Years: + SH_FUNDS2 + SH_FUNDS3 + SH_FUNDS4 + SH_FUNDS5 + example: "-3481217.00" + SH_PAIDUP_CAPITAL1 : + type: string + description: |+ + Shareholder’s Fund – Paid Up Capital + Subsequent Years: + SH_PAIDUP_CAPITAL2 + SH_PAIDUP_CAPITAL3 + SH_PAIDUP_CAPITAL4 + SH_PAIDUP_CAPITAL5 + example: "2000000.00" + SH_RESERVES1 : + type: string + description: |+ + Shareholder’s Fund - Reserves + Subsequent Years: + SH_RESERVES2 + SH_RESERVES3 + SH_RESERVES4 + SH_RESERVES5 + example: "0.00" + SH_ACCUM_LOSS1: + type: string + description: |+ + Shareholder’s Fund – Accumulated Loss + Subsequent Years: + SH_ACCUM_LOSS2 + SH_ACCUM_LOSS3 + SH_ACCUM_LOSS4 + SH_ACCUM_LOSS5 + example: "5481217.00" + GRP_TURNOVER1 : + type: string + description: |+ + Group Turnover / Sales and Other Operating Revenues + Subsequent Years: + GRP_TURNOVER2 + GRP_TURNOVER3 + GRP_TURNOVER4 + GRP_TURNOVER5 + example: "0.00" + GRP_PL_BEF_TAX1 : + type: string + description: |+ + Group Profit / Loss Before Tax + Subsequent Years: + GRP_PL_BEF_TAX2 + GRP_PL_BEF_TAX3 + GRP_PL_BEF_TAX4 + GRP_PL_BEF_TAX5 + example: "0.00" + GRP_PL_AFT_TAX1 : + type: string + description: |+ + Group Profit / Loss After Tax + Subsequent Years: + GRP_PL_AFT_TAX2 + GRP_PL_AFT_TAX3 + GRP_PL_AFT_TAX4 + GRP_PL_AFT_TAX5 + example: "0.00" + GRP_NETINC_NON_EXT1 : + type: string + description: |+ + Group Net Income / Loss From Extraordinary and Non-Operating Items + Subsequent Years: + GRP_NETINC_NON_EXT2 + GRP_NETINC_NON_EXT3 + GRP_NETINC_NON_EXT4 + GRP_NETINC_NON_EXT5 + example: "0.00" + GRP_PL_AFT_TAX_EXT1: + type: string + description: |+ + Group Profit / Loss After Tax and Extraordinary items + Subsequent Years: + GRP_ PL_AFT_TAX_EXT2 + GRP_ PL_AFT_TAX_EXT3 + GRP_ PL_AFT_TAX_EXT4 + GRP_ PL_AFT_TAX_EXT5 + example: "0.00" + GRP_TOT_ASSETS1: + type: string + description: |+ + Group Total Assets + Subsequent Years: + GRP_TOT_ASSETS2 + GRP_TOT_ASSETS3 + GRP_TOT_ASSETS4 + GRP_TOT_ASSETS5 + example: "0.00" + GRP_TA_CURRENT1 : + type: string + description: |+ + Group Total Assets – Current + Subsequent Years: + GRP_TA_CURRENT2 + GRP_TA_CURRENT3 + GRP_TA_CURRENT4 + GRP_TA_CURRENT5 + example: "0.00" + GRP_TA_FIXED1 : + type: string + description: |+ + Group Total Assets – Fixed and Others + Subsequent Years: + GRP_TA_FIXED2 + GRP_TA_FIXED3 + GRP_TA_FIXED4 + GRP_TA_FIXED5 + example: "0.00" + GRP_TOT_LIABILITIES1 : + type: string + description: |+ + Group Total Liabilities + Subsequent Years: + GRP_TOT_LIABILITIES2 + GRP_TOT_LIABILITIES3 + GRP_TOT_LIABILITIES4 + GRP_TOT_LIABILITIES5 + example: "0.00" + GRP_TL_CURRENT1 : + type: string + description: |+ + Group Total Liabilities - Current + Subsequent Years: + GRP_TL_CURRENT2 + GRP_TL_CURRENT3 + GRP_TL_CURRENT4 + GRP_TL_CURRENT5 + example: "0.00" + GRP_TL_NON_CURRENT1 : + type: string + description: |+ + Group Total Liabilities – Non-Current & Long Term + Subsequent Years: + GRP_TL_NON_CURRENT2 + GRP_TL_NON_CURRENT3 + GRP_TL_NON_CURRENT4 + GRP_TL_NON_CURRENT5 + example: "0.00" + GRP_SH_FUNDS1 : + type: string + description: |+ + Group Shareholder’s Fund + Subsequent Years: + GRP_ SH_FUNDS2 + GRP_ SH_FUNDS3 + GRP_ SH_FUNDS4 + GRP_ SH_FUNDS5 + example: "0.00" + GRP_SH_PAIDUP_CAPITAL1 : + type: string + description: |+ + Group Shareholder’s Fund – Paid Up Capital + Subsequent Years: + GRP_SH_PAIDUP_CAPITAL2 + GRP_SH_PAIDUP_CAPITAL3 + GRP_SH_PAIDUP_CAPITAL4 + GRP_SH_PAIDUP_CAPITAL5 + example: "0.00" + GRP_SH_RESERVES1: + type: string + description: |+ + Group Shareholder’s Fund - Reserves + Subsequent Years: + GRP_SH_RESERVES2 + GRP_SH_RESERVES3 + GRP_SH_RESERVES4 + GRP_SH_RESERVES5 + example: "0.00" + GRP_SH_ACCUM_LOSS1 : + type: string + description: |+ + Group Shareholder’s Fund – Accumulated Loss + Subsequent Years: + GRP_SH_ACCUM_LOSS2 + GRP_SH_ACCUM_LOSS3 + GRP_SH_ACCUM_LOSS4 + GRP_SH_ACCUM_LOSS5 + example: "0.00" + GRP_INDICATOR1 : + type: string + description: |+ + Company Financial Highlights Group Indicator + Subsequent Years: + GRP_INDICATOR2 + GRP_INDICATOR3 + GRP_INDICATOR4 + GRP_INDICATOR5 + example: "B" + XBRL_DTL: + type: object + description: |+ + XBRL filed after 1 Nov 2007 with following children: + XBRL_YR1_CURR + REVENUE1 + PL_BEF_TAX1 + PL_AFT_TAX1 + TOT_ASSETS1 + TA_CURRENT1 + TA_NON_CURRENT1 + TOT_LIABILITIES1 + TL_CURRENT1 + TL_NON_CURRENT1 + TOT_EQUITY1 + EQ_SH_CAPITAL1 + EQ_RESERVES1 + EQ_RETAINED_EARN1 + GRP_REVENUE1 + GRP_PL_BEF_TAX1 + GRP_PL_AFT_TAX1 + GRP_TOT_ASSETS1 + GRP_TA_CURRENT1 + GRP_TA_NON_CURRENT1 + GRP_TOT_LIABILITIES1 + GRP_TL_CURRENT1 + GRP_TL_NON_CURRENT1 + GRP_TOT_EQUITY1 + GRP_SH_CAPITAL1 + GRP_RESERVES1 + GRP_RETAINED_EARN1 + GRP_INDICATOR1 + + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of XBRL data displayed in the report. + example: |+ + + + + 10877254.00 + 9982533.00 + 1121483.00 + 262632.00 + 1347380.00 + 262632.00 + 6562990.00 + 5424551.00 + 6283449.00 + 4948821.00 + 279541.00 + 475730.00 + 8434195.00 + 8643136.00 + 8434195.00 + 7933013.00 + 0.00 + 710123.00 + -1871205.00 + -3218585.00 + 2000000.00 + 2000000.00 + 0.00 + 0.00 + -3,871,205.00 + -5,218,585.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + 0.00 + + + + + properties: + XBRL_YR1_CURR: + type: string + description: |+ + FH After Year 1 Currency + Subsequent Years: + XBRL_YR2_CURR + XBRL_YR3_CURR + XBRL_YR4_CURR + XBRL_YR5_CURR + example: "(SGD)" + REVENUE1 : + type: string + description: |+ + Revenue Amount + Subsequent Years: + REVENUE2 + REVENUE3 + REVENUE4 + REVENUE5 + example: "10877254.00" + PL_BEF_TAX1 : + type: string + description: |+ + Profit / Loss Before Tax from Continuing Operations + Subsequent Years: + PL_BEF_TAX2 + PL_BEF_TAX3 + PL_BEF_TAX4 + PL_BEF_TAX5 + example: "1121483.00" + PL_AFT_TAX1 : + type: string + description: |+ + Profit / Loss After Tax from Continuing Operations + Subsequent Years: + PL_AFT_TAX2 + PL_AFT_TAX3 + PL_AFT_TAX4 + PL_AFT_TAX5 + example: "1347380.00" + TOT_ASSETS1 : + type: string + description: |+ + Total Assets + Subsequent Years: + TOT_ASSETS2 + TOT_ASSETS3 + TOT_ASSETS4 + TOT_ASSETS5 + example: "6562990.00" + TA_CURRENT1 : + type: string + description: |+ + Total Current Assets (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TA_CURRENT2 + TA_CURRENT3 + TA_CURRENT4 + TA_CURRENT5 + example: "6283449.00" + TA_NON_CURRENT1 : + type: string + description: |+ + Total Non-Current Assets (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TA_NON_CURRENT2 + TA_NON_CURRENT3 + TA_NON_CURRENT4 + TA_NON_CURRENT5 + example: "279541.00" + TOT_LIABILITIES1 : + type: string + description: |+ + Total Liabilities + Subsequent Years: + TOT_LIABILITIES2 + TOT_LIABILITIES3 + TOT_LIABILITIES4 + TOT_LIABILITIES5 + example: "8434195.00" + TL_CURRENT1 : + type: string + description: |+ + Total Current Liabilities (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TL_CURRENT2 + TL_CURRENT3 + TL_CURRENT4 + TL_CURRENT5 + example: "8434195.00" + TL_NON_CURRENT1 : + type: string + description: |+ + Total Non-Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + TL_NON_CURRENT2 + TL_NON_CURRENT3 + TL_NON_CURRENT4 + TL_NON_CURRENT5 + example: "0.00" + TOT_EQUITY1 : + type: string + description: |+ + Total Equity (inclusive of Equity Attributable to Equity Holders of Parent and Minority Interest) + Subsequent Years: + TOT_EQUITY2 + TOT_EQUITY3 + TOT_EQUITY4 + TOT_EQUITY5 + example: "-1871205.00" + EQ_SH_CAPITAL1 : + type: string + description: |+ + Total Equity – Share Capital + Subsequent Years: + EQ_SH_CAPITAL2 + EQ_SH_CAPITAL3 + EQ_SH_CAPITAL4 + EQ_SH_CAPITAL5 + example: "2000000.00" + EQ_RESERVES1 : + type: string + description: |+ + Total Equity – Other Reserves + Subsequent Years: + EQ_RESERVES2 + EQ_RESERVES3 + EQ_RESERVES4 + EQ_RESERVES5 + example: "0.00" + EQ_RETAINED_EARN1 : + type: string + description: |+ + Total Equity – Retained Earnings (Accumulated Loss) + Subsequent Years: + EQ_RETAINED_EARN2 + EQ_RETAINED_EARN3 + EQ_RETAINED_EARN4 + EQ_RETAINED_EARN5 + example: "-3,871,205.00" + GRP_REVENUE1 : + type: string + description: |+ + Group’s Revenue Amount + Subsequent Years: + GRP_REVENUE2 + GRP_REVENUE3 + GRP_REVENUE4 + GRP_REVENUE5 + example: "0.00" + GRP_PL_BEF_TAX1 : + type: string + description: |+ + Group Profit / Loss Before Tax from Continuing Operations + Subsequent Years: + GRP_PL_BEF_TAX2 + GRP_PL_BEF_TAX3 + GRP_PL_BEF_TAX4 + GRP_PL_BEF_TAX5 + example: "0.00" + GRP_PL_AFT_TAX1 : + type: string + description: |+ + Group Profit / Loss After Tax from Continuing Operations + Subsequent Years: + GRP_PL_AFT_TAX2 + GRP_PL_AFT_TAX3 + GRP_PL_AFT_TAX4 + GRP_PL_AFT_TAX5 + example: "0.00" + GRP_TOT_ASSETS1 : + type: string + description: |+ + Group’s Total Assets + Subsequent Years: + GRP_TOT_ASSETS2 + GRP_TOT_ASSETS3 + GRP_TOT_ASSETS4 + GRP_TOT_ASSETS5 + example: "0.00" + GRP_TA_CURRENT1 : + type: string + description: |+ + Group’s Total Current Assets (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TA_CURRENT2 + GRP_TA_CURRENT3 + GRP_TA_CURRENT4 + GRP_TA_CURRENT4 + example: "0.00" + GRP_TA_NON_CURRENT1 : + type: string + description: |+ + Group’s Total Non-Current Assets (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TA_NON_CURRENT2 + GRP_TA_NON_CURRENT3 + GRP_TA_NON_CURRENT4 + GRP_TA_NON_CURRENT4 + example: "0.00" + GRP_TOT_LIABILITIES1 : + type: string + description: |+ + Group’s Total Liabilities + Subsequent Years: + GRP_TOT_LIABILITIES2 + GRP_TOT_LIABILITIES3 + GRP_TOT_LIABILITIES4 + GRP_TOT_LIABILITIES5 + example: "0.00" + GRP_TL_CURRENT1 : + type: string + description: |+ + Group’s Total Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TL_CURRENT2 + GRP_TL_CURRENT3 + GRP_TL_CURRENT4 + GRP_TL_CURRENT5 + example: "0.00" + GRP_TL_NON_CURRENT1 : + type: string + description: |+ + Group’s Total Non-Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TL_NON_CURRENT2 + GRP_TL_NON_CURRENT3 + GRP_TL_NON_CURRENT4 + GRP_TL_NON_CURRENT5 + example: "0.00" + GRP_TOT_EQUITY1 : + type: string + description: |+ + Group’s Total Equity (inclusive of Equity Attributable to Equity Holders of Parent and Minority Interest) + Subsequent Years: + GRP_TOT_EQUITY2 + GRP_TOT_EQUITY3 + GRP_TOT_EQUITY4 + GRP_TOT_EQUITY5 + example: "0.00" + GRP_SH_CAPITAL1 : + type: string + description: |+ + Group’s Share Capital + Subsequent Years: + GRP_SH_CAPITAL2 + GRP_SH_CAPITAL3 + GRP_SH_CAPITAL4 + GRP_SH_CAPITAL5 + example: "0.00" + GRP_RESERVES1 : + type: string + description: |+ + Group’s Other Reserves + Subsequent Years: + GRP_RESERVES2 + GRP_RESERVES3 + GRP_RESERVES4 + GRP_RESERVES5 + example: "0.00" + GRP_RETAINED_EARN1 : + type: string + description: |+ + Group’s – Retained Earnings (Accumulated Loss) + Subsequent Years: + GRP_RETAINED_EARN2 + GRP_RETAINED_EARN3 + GRP_RETAINED_EARN4 + GRP_RETAINED_EARN5 + example: "0.00" + GRP_INDICATOR1 : + type: string + description: |+ + XBRL Financial Highlights Group Indicator + Subsequent Years: + GRP_INDICATOR2 + GRP_INDICATOR3 + GRP_INDICATOR4 + GRP_INDICATOR5 + example: "B" + FH_RATIOS_DTL: + type: object + description: |+ + Accounting Ratios Details with following children: + RATE_NET_PROFIT1 + RET_INVESTMENT1 + RET_SH_FUNDS1 + TOT_ASSETS_TURNOVER1 + CURR_CAPITAL_RATIO1 + PROPRIETARY_RATIO1 + TOTAL_DEBT_RATIO1 + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH & XBRL data displayed in the report. + example: |+ + + 12.39 + 2.63 + 0.00 + 0.00 + 0.00 + 20.53 + 4.84 + 0.00 + 0.00 + 0.00 + -72.01 + -8.16 + -0.00 + -0.00 + -0.00 + 1.66 + 1.84 + 2.42 + 2.54 + 1.78 + 0.74 + 0.62 + 0.50 + 0.46 + 0.55 + -28.51 + -59.33 + -89.51 + -101.59 + -75.15 + 128.51 + 168.27 + 189.51 + 201.59 + 175.15 + + properties: + RATE_NET_PROFIT1 : + type: string + description: |+ + Rate of Net Profit On Sales (%) + Subsequent Years: + RATE_NET_PROFIT2 + RATE_NET_PROFIT3 + RATE_NET_PROFIT4 + RATE_NET_PROFIT5 + example: "12.39" + RET_INVESTMENT1 : + type: string + description: |+ + Return of Investment (%) + Subsequent Years: + RET_INVESTMENT2 + RET_INVESTMENT3 + RET_INVESTMENT4 + RET_INVESTMENT5 + example: "20.53" + RET_SH_FUNDS1 : + type: string + description: |+ + Return of Shareholder’s Funds (%) + Subsequent Years: + RET_SH_FUNDS2 + RET_SH_FUNDS3 + RET_SH_FUNDS4 + RET_SH_FUNDS4 + example: "-72.01" + TOT_ASSETS_TURNOVER1 : + type: string + description: |+ + Total Assets Turnover (%) + Subsequent Years: + TOT_ASSETS_TURNOVER2 + TOT_ASSETS_TURNOVER3 + TOT_ASSETS_TURNOVER4 + TOT_ASSETS_TURNOVER5 + example: "1.66" + CURR_CAPITAL_RATIO1: + type: string + description: |+ + Current / Working Capital Ratio (%) + Subsequent Years: + CURR_CAPITAL_RATIO2 + CURR_CAPITAL_RATIO3 + CURR_CAPITAL_RATIO4 + CURR_CAPITAL_RATIO5 + example: "0.74" + PROPRIETARY_RATIO1: + type: string + description: |+ + Proprietary Ratio (%) 1 + Subsequent Years: + PROPRIETARY_RATIO2 + PROPRIETARY_RATIO3 + PROPRIETARY_RATIO4 + PROPRIETARY_RATIO5 + example: "-28.51" + TOTAL_DEBT_RATIO1 : + type: string + description: |+ + Total Debt to Equity Ratio (%) 1 + Subsequent Years: + TOTAL_DEBT_RATIO2 + TOTAL_DEBT_RATIO3 + TOTAL_DEBT_RATIO4 + TOTAL_DEBT_RATIO5 + example: "128.51" + LIST_FH_CHART_INFO : + type: array + example: |+ + + + 1121483.0 + 10877254 + 2008 + + + description: |+ + List of chart info with following children: + [FH_CHART_INFO] + items: + properties: + FH_CHART_INFO: + type: object + description: |+ + Chart Info info with following children: + YEAR + REVENUE + PROFIT_LOSS + properties: + PROFIT_LOSS: + type: string + example: "1121483.0" + description: Profit / Loss Before Tax of the year + REVENUE: + type: string + example: "10877254" + description: Revenue Amount of the year + YEAR: + type: string + example: "2008" + description: Financial Year + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + REQUEST: + type: object + properties: + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + "197601887ETRANSTAR TRAVEL PTE LTD" + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/d&b_brief_financial_information_sg_v1.0.yaml b/data/d&b_brief_financial_information_sg_v1.0.yaml new file mode 100644 index 000000000..976600766 --- /dev/null +++ b/data/d&b_brief_financial_information_sg_v1.0.yaml @@ -0,0 +1,1600 @@ +openapi: 3.0.1 +info: + title: D&B Brief Financial Information (SG) + description: This Data microservice provides the annual financial information of Singapore-registered businesses, inclusive of annual profit and loss and financial ratios. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions with functions for personal credit checks, e.g. for parties who have a vested interest (e.g. banks, investors) in the company’s performance and to evaluate the company’s gearing and acid ratios. + - Information from this microservice can be used for financial analysis - one can build models based on historical behavior. Continually update fraud patterns and compare with real-time transactions. Store and consolidate market data, trade activity, and other data, such as social and transactional data. + version: '1.0.0' + x-subscribelink: d&b_brief_financial_information_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/sbfe/v0/getdata: + post: + tags: + - v1.0.0 + summary: Adds a new user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + META_INFO: + SERVICE: BFE + SYSTEM_ID: DDP + CREATION_DATE: 25/02/2009 17:31:44> + USER_ID: plcust102 + FH_SEARCH_INFO: + COMP_NAME: DUN & BRADSTREET (SINGAPORE) PTE. LTD. + REG_NO: 200003058W + REQ_DATE: '2009-04-21 10:56:06.716' + REQ_REG_NO: 200003058W + REQ_NAME: DUN & BRADSTREET (SINGAPORE) PTE. LTD. + REQ_DATE_STR: 21/04/2009 10:56:06 + FH_BEFORE_YR1: '2004' + FH_BEFORE_YR2: '2003' + FH_BEFORE_YR3: '2002' + FH_AFTER_YR1: '2005' + FH_AFTER_YR2: '2006' + FH_AFTER_YR3: '2007' + FH_AFTER_YR4: '2008' + FH_AFTER_YR5: '2009' + AC_RATIOS_YR1: '2008' + AC_RATIOS_YR2: '2007' + AC_RATIOS_YR3: '2006' + AC_RATIOS_YR4: '2005' + AC_RATIOS_YR5: '2004' + FH_DTL: + FH_YR1_CURR: "(SGD)" + FH_YR2_CURR: "(SGD)" + FH_YR3_CURR: "(SGD)" + TURNOVER1: '9403795.00' + TURNOVER2: '8617168.00' + TURNOVER3: '7807393.00' + PL_BEF_TAX1: '31467.00' + PL_BEF_TAX2: '162620.00' + PL_BEF_TAX3: '1281387.00' + PL_AFT_TAX1: '31467.00' + PL_AFT_TAX2: '162620.00' + PL_AFT_TAX3: '1281387.00' + NETINC_NON_EXT1: '0.00' + NETINC_NON_EXT2: '0.00' + NETINC_NON_EXT3: 60318.00> + PL_AFT_TAX_EXT1: '31467.00' + PL_AFT_TAX_EXT2: '162620.00' + PL_AFT_TAX_EXT3: '1341705.00' + TOT_ASSETS1: '3889213.00' + TOT_ASSETS2: '3395740.00' + TOT_ASSETS3: '4374368.00' + TA_CURRENT1: '3359007.00' + TA_CURRENT2: '2855754.00' + TA_CURRENT3: '3546381.00' + TA_FIXED1: '530206.00' + TA_FIXED2: '539986.00' + TA_FIXED3: 827987.00> + TOT_LIABILITIES1: '7370430.00' + TOT_LIABILITIES2: '6845490.00' + TOT_LIABILITIES3: '7661498.00' + TL_CURRENT1: '6739073.00' + TL_CURRENT2: '6157560.00' + TL_CURRENT3: '6435365.00' + TL_NON_CURRENT1: '631357.00' + TL_NON_CURRENT2: '687930.00' + TL_NON_CURRENT3: '122133.00' + SH_FUNDS1: "-3481217.00" + SH_FUNDS2: "-3449750.00" + SH_FUNDS3: "-3287130.00" + SH_PAIDUP_CAPITAL1: '2000000.00' + SH_PAIDUP_CAPITAL2: '2000000.00' + SH_PAIDUP_CAPITAL3: '2000000.00' + SH_RESERVES1: '0.00' + SH_RESERVES2: '0.00' + SH_RESERVES3: '0.00' + SH_ACCUM_LOSS1: '5481217.00' + SH_ACCUM_LOSS2: '5449750.00' + SH_ACCUM_LOSS3: '5287130.00' + GRP_TURNOVER1: '0.00' + GRP_TURNOVER2: '0.00' + GRP_TURNOVER3: '0.00' + GRP_PL_BEF_TAX1: '0.00' + GRP_PL_BEF_TAX2: '0.00' + GRP_PL_BEF_TAX3: '0.00' + GRP_PL_AFT_TAX1: '0.00' + GRP_PL_AFT_TAX2: '0.00' + GRP_PL_AFT_TAX3: '0.00' + GRP_NETINC_NON_EXT1: '0.00' + GRP_NETINC_NON_EXT2: '0.00' + GRP_NETINC_NON_EXT3: '0.00' + GRP_PL_AFT_TAX_EXT1: '0.00' + GRP_PL_AFT_TAX_EXT2: '0.00' + GRP_PL_AFT_TAX_EXT3: '0.00' + GRP_TOT_ASSETS1: '0.00' + GRP_TOT_ASSETS2: '0.00' + GRP_TOT_ASSETS3: '0.00' + GRP_TA_CURRENT1: '0.00' + GRP_TA_CURRENT2: '0.00' + GRP_TA_CURRENT3: '0.00' + GRP_TA_FIXED1: '0.00' + GRP_TA_FIXED2: '0.00' + GRP_TA_FIXED3: '0.00' + GRP_TOT_LIABILITIES1: '0.00' + GRP_TOT_LIABILITIES2: '0.00' + GRP_TOT_LIABILITIES3: '0.00' + GRP_TL_CURRENT1: '0.00' + GRP_TL_CURRENT2: '0.00' + GRP_TL_CURRENT3: '0.00' + GRP_TL_NON_CURRENT1: '0.00' + GRP_TL_NON_CURRENT2: '0.00' + GRP_TL_NON_CURRENT3: '0.00' + GRP_SH_FUNDS1: '0.00' + GRP_SH_FUNDS2: '0.00' + GRP_SH_FUNDS3: '0.00' + GRP_SH_PAIDUP_CAPITAL1: '0.00' + GRP_SH_PAIDUP_CAPITAL2: '0.00' + GRP_SH_PAIDUP_CAPITAL3: '0.00' + GRP_SH_RESERVES1: '0.00' + GRP_SH_RESERVES2: '0.00' + GRP_SH_RESERVES3: '0.00' + GRP_SH_ACCUM_LOSS1: '0.00' + GRP_SH_ACCUM_LOSS2: '0.00' + GRP_SH_ACCUM_LOSS3: '0.00' + GRP_INDICATOR1: B + GRP_INDICATOR2: B + GRP_INDICATOR3: B + XBRL_DTL: + XBRL_YR1_CURR: "(SGD)" + XBRL_YR2_CURR: "(SGD)" + REVENUE1: '10877254.00' + REVENUE2: '9982533.00' + PL_BEF_TAX1: '1121483.00' + PL_BEF_TAX2: '262632.00' + PL_AFT_TAX1: '1347380.00' + PL_AFT_TAX2: '262632.00' + TOT_ASSETS1: '6562990.00' + TOT_ASSETS2: '5424551.00' + TA_CURRENT1: '6283449.00' + TA_CURRENT2: '4948821.00' + TA_NON_CURRENT1: '279541.00' + TA_NON_CURRENT2: '475730.00' + TOT_LIABILITIES1: '8434195.00' + TOT_LIABILITIES2: '8643136.00' + TL_CURRENT1: '8434195.00' + TL_CURRENT2: '7933013.00' + TL_NON_CURRENT1: '0.00' + TL_NON_CURRENT2: '710123.00' + TOT_EQUITY1: "-1871205.00" + TOT_EQUITY2: "-3218585.00" + EQ_SH_CAPITAL1: '2000000.00' + EQ_SH_CAPITAL2: '2000000.00' + EQ_RESERVES1: '0.00' + EQ_RESERVES2: '0.00' + EQ_RETAINED_EARN1: "-3,871,205.00" + EQ_RETAINED_EARN2: "-5,218,585.00" + GRP_REVENUE1: '0.00' + GRP_REVENUE2: '0.00' + GRP_PL_BEF_TAX1: '0.00' + GRP_PL_BEF_TAX2: '0.00' + GRP_PL_AFT_TAX1: '0.00' + GRP_PL_AFT_TAX2: '0.00' + GRP_TOT_ASSETS1: '0.00' + GRP_TOT_ASSETS2: '0.00' + GRP_TA_CURRENT1: '0.00' + GRP_TA_CURRENT2: '0.00' + GRP_TA_NON_CURRENT1: '0.00' + GRP_TA_NON_CURRENT2: '0.00' + GRP_TOT_LIABILITIES1: '0.00' + GRP_TOT_LIABILITIES2: '0.00' + GRP_TL_CURRENT1: '0.00' + GRP_TL_CURRENT2: '0.00' + GRP_TL_NON_CURRENT1: '0.00' + GRP_TL_NON_CURRENT2: '0.00' + GRP_TOT_EQUITY1: '0.00' + GRP_TOT_EQUITY2: '0.00' + GRP_SH_CAPITAL1: '0.00' + GRP_SH_CAPITAL2: '0.00' + GRP_RESERVES1: '0.00' + GRP_RESERVES2: '0.00' + GRP_RETAINED_EARN1: '0.00' + GRP_RETAINED_EARN2: '0.00' + GRP_INDICATOR1: B + GRP_INDICATOR2: B + GRP_INDICATOR3: B + FH_RATIOS_DTL: + RATE_NET_PROFIT1: '12.39' + RATE_NET_PROFIT2: '2.63' + RATE_NET_PROFIT3: '0.00' + RATE_NET_PROFIT4: '0.00' + RATE_NET_PROFIT5: '0.00' + RET_INVESTMENT1: '20.53' + RET_INVESTMENT2: '4.84' + RET_INVESTMENT3: '0.00' + RET_INVESTMENT4: '0.00' + RET_INVESTMENT5: '0.00' + RET_SH_FUNDS1: "-72.01" + RET_SH_FUNDS2: "-8.16" + RET_SH_FUNDS3: "-0.00" + RET_SH_FUNDS4: "-0.00" + RET_SH_FUNDS5: "-0.00" + TOT_ASSETS_TURNOVER1: '1.66' + TOT_ASSETS_TURNOVER2: '1.84' + TOT_ASSETS_TURNOVER3: '2.42' + TOT_ASSETS_TURNOVER4: '2.54' + TOT_ASSETS_TURNOVER5: '1.78' + CURR_CAPITAL_RATIO1: '0.74' + CURR_CAPITAL_RATIO2: '0.62' + CURR_CAPITAL_RATIO3: '0.50' + CURR_CAPITAL_RATIO4: '0.46' + CURR_CAPITAL_RATIO5: '0.55' + PROPRIETARY_RATIO1: "-28.51" + PROPRIETARY_RATIO2: "-59.33" + PROPRIETARY_RATIO3: "-89.51" + PROPRIETARY_RATIO4: "-101.59" + PROPRIETARY_RATIO5: "-75.15" + TOTAL_DEBT_RATIO1: '128.51' + TOTAL_DEBT_RATIO2: '168.27' + TOTAL_DEBT_RATIO3: '189.51' + TOTAL_DEBT_RATIO4: '201.59' + TOTAL_DEBT_RATIO5: '175.15' + LIST_FH_CHART_INFO: + - PROFIT_LOSS: '1121483.0' + REVENUE: '10877254' + YEAR: '2008' + - PROFIT_LOSS: 262632.0> + REVENUE: '9982533' + YEAR: '2007' + - PROFIT_LOSS: "-31467.0" + REVENUE: '9403795' + YEAR: '2006' + - PROFIT_LOSS: "-162620.0" + REVENUE: '8617168' + YEAR: '2005' + - PROFIT_LOSS: "-1281387.0" + REVENUE: '7807393' + YEAR: '2004' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + description: |+ + Report details with following children: + [META_INFO] + [FH_SEARCH_INFO] + [FH_DTL] + [XBRL_DTL] + [FH_RATIO_DTL] + [LIST_FH_CHART_INFO] + example: + properties: + META_INFO: + type: object + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + example: + META_INFO: + SERVICE: BFE + SYSTEM_ID: DDP + CREATION_DATE: 25/02/2009 17:31:44> + USER_ID: plcust102 + properties: + SERVICE: + type: string + description: Report Requested + example: "BFE" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: string + description: Report Request Date + example: "25/02/2009 17:31:44" + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: N/A + FH_SEARCH_INFO: + type: object + description: |+ + FH search information with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + FH_BEFORE_YR1 + FH_BEFORE_YR2 + FH_BEFORE_YR3 + FH_BEFORE_YR4 + FH_BEFORE_YR5 + FH_AFTER_YR1 + FH_AFTER_YR2 + FH_AFTER_YR3 + FH_AFTER_YR4 + FH_AFTER_YR5 + AC_RATIOS_YR1 + AC_RATIOS_YR2 + AC_RATIOS_YR3 + AC_RATIOS_YR4 + AC_RATIOS_YR5 + example: + FH_SEARCH_INFO: + COMP_NAME: DUN & BRADSTREET (SINGAPORE) PTE. LTD. + REG_NO: 200003058W + REQ_DATE: '2009-04-21 10:56:06.716' + REQ_REG_NO: 200003058W + REQ_NAME: DUN & BRADSTREET (SINGAPORE) PTE. LTD. + REQ_DATE_STR: 21/04/2009 10:56:06 + FH_BEFORE_YR1: '2004' + FH_BEFORE_YR2: '2003' + FH_BEFORE_YR3: '2002' + FH_AFTER_YR1: '2005' + FH_AFTER_YR2: '2006' + FH_AFTER_YR3: '2007' + FH_AFTER_YR4: '2008' + FH_AFTER_YR5: '2009' + AC_RATIOS_YR1: '2008' + AC_RATIOS_YR2: '2007' + AC_RATIOS_YR3: '2006' + AC_RATIOS_YR4: '2005' + AC_RATIOS_YR5: '2004' + properties: + COMP_NAME : + type: string + description: Company Name + example: "DUN & BRADSTREET (SINGAPORE) PTE. LTD." + REG_NO : + type: string + description: Company Registration No + example: "200003058W" + REQ_DATE : + type: datetime + description: Requested Date + example: "2009-04-21 10:56:06.716" + REQ_REG_NO : + type: string + description: Request Registration Number + example: "200003058W" + REQ_NAME : + type: string + description: Request Name + example: "DUN & BRADSTREET (SINGAPORE) PTE. LTD." + REQ_DATE_STR : + type: string + description: Request Date String + example: "21/04/2009 10:56:06" + FH_BEFORE_YR1 : + type: string + description: Financial Highlight filed before year 1 + example: "2004" + FH_BEFORE_YR2 : + type: string + description: Financial Highlight filed before year 2 + example: "2003" + FH_BEFORE_YR3 : + type: string + description: Financial Highlight filed before year 3 + example: "2002" + FH_AFTER_YR1: + type: string + description: Financial Highlight filed after year 1 + example: "2005" + FH_AFTER_YR2 : + type: string + description: Financial Highlight filed after year 2 + example: "2006" + FH_AFTER_YR3 : + type: string + description: Financial Highlight filed after year 3 + example: "2007" + FH_AFTER_YR4: + type: string + description: Financial Highlight filed after year 4 + example: "2008" + FH_AFTER_YR5: + type: string + description: Financial Highlight filed after year 5 + example: "2009" + AC_RATIOS_YR1 : + type: string + description: Account Ratio year 1 + example: "2008" + AC_RATIOS_YR2 : + type: string + description: Account Ratio year 2 + example: "2007" + AC_RATIOS_YR3 : + type: string + description: Account Ratio year 3 + example: "2006" + AC_RATIOS_YR4 : + type: string + description: Account Ratio year 4 + example: "2005" + AC_RATIOS_YR5 : + type: string + description: Account Ratio year 5 + example: "2004" + FH_DTL: + type: object + description: |+ + Financial Highlight with following children: + FH_YR1_CURR + TURNOVER1 + PL_BEF_TAX1 + PL_AFT_TAX1 + NETINC_NON_EXT1 + PL_AFT_TAX_EXT1 + TOT_ASSETS1 + TA_CURRENT1 + TA_FIXED1 + TOT_LIABILITIES1 + TL_CURRENT1 + TL_NON_CURRENT1 + SH_FUNDS1 + SH_PAIDUP_CAPITAL1 + SH_RESERVES1 + SH_ACCUM_LOSS1 + GRP_TURNOVER1 + GRP_PL_BEF_TAX1 + GRP_PL_AFT_TAX1 + GRP_NETINC_NON_EXT1 + GRP_PL_AFT_TAX_EXT1 + GRP_TOT_ASSETS1 + GRP_TA_CURRENT1 + GRP_TA_FIXED1 + GRP_TOT_LIABILITIES1 + GRP_TL_CURRENT1 + GRP_TL_NON_CURRENT1 + GRP_SH_FUNDS1 + GRP_SH_PAIDUP_CAPITAL1 + GRP_SH_RESERVES1 + GRP_SH_ACCUM_LOSS1 + GRP_INDICATOR1 + + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH data displayed in the report. + example: + FH_DTL: + FH_YR1_CURR: "(SGD)" + FH_YR2_CURR: "(SGD)" + FH_YR3_CURR: "(SGD)" + TURNOVER1: '9403795.00' + TURNOVER2: '8617168.00' + TURNOVER3: '7807393.00' + PL_BEF_TAX1: '31467.00' + PL_BEF_TAX2: '162620.00' + PL_BEF_TAX3: '1281387.00' + PL_AFT_TAX1: '31467.00' + PL_AFT_TAX2: '162620.00' + PL_AFT_TAX3: '1281387.00' + NETINC_NON_EXT1: '0.00' + NETINC_NON_EXT2: '0.00' + NETINC_NON_EXT3: 60318.00> + PL_AFT_TAX_EXT1: '31467.00' + PL_AFT_TAX_EXT2: '162620.00' + PL_AFT_TAX_EXT3: '1341705.00' + TOT_ASSETS1: '3889213.00' + TOT_ASSETS2: '3395740.00' + TOT_ASSETS3: '4374368.00' + TA_CURRENT1: '3359007.00' + TA_CURRENT2: '2855754.00' + TA_CURRENT3: '3546381.00' + TA_FIXED1: '530206.00' + TA_FIXED2: '539986.00' + TA_FIXED3: 827987.00> + TOT_LIABILITIES1: '7370430.00' + TOT_LIABILITIES2: '6845490.00' + TOT_LIABILITIES3: '7661498.00' + TL_CURRENT1: '6739073.00' + TL_CURRENT2: '6157560.00' + TL_CURRENT3: '6435365.00' + TL_NON_CURRENT1: '631357.00' + TL_NON_CURRENT2: '687930.00' + TL_NON_CURRENT3: '122133.00' + SH_FUNDS1: "-3481217.00" + SH_FUNDS2: "-3449750.00" + SH_FUNDS3: "-3287130.00" + SH_PAIDUP_CAPITAL1: '2000000.00' + SH_PAIDUP_CAPITAL2: '2000000.00' + SH_PAIDUP_CAPITAL3: '2000000.00' + SH_RESERVES1: '0.00' + SH_RESERVES2: '0.00' + SH_RESERVES3: '0.00' + SH_ACCUM_LOSS1: '5481217.00' + SH_ACCUM_LOSS2: '5449750.00' + SH_ACCUM_LOSS3: '5287130.00' + GRP_TURNOVER1: '0.00' + GRP_TURNOVER2: '0.00' + GRP_TURNOVER3: '0.00' + GRP_PL_BEF_TAX1: '0.00' + GRP_PL_BEF_TAX2: '0.00' + GRP_PL_BEF_TAX3: '0.00' + GRP_PL_AFT_TAX1: '0.00' + GRP_PL_AFT_TAX2: '0.00' + GRP_PL_AFT_TAX3: '0.00' + GRP_NETINC_NON_EXT1: '0.00' + GRP_NETINC_NON_EXT2: '0.00' + GRP_NETINC_NON_EXT3: '0.00' + GRP_PL_AFT_TAX_EXT1: '0.00' + GRP_PL_AFT_TAX_EXT2: '0.00' + GRP_PL_AFT_TAX_EXT3: '0.00' + GRP_TOT_ASSETS1: '0.00' + GRP_TOT_ASSETS2: '0.00' + GRP_TOT_ASSETS3: '0.00' + GRP_TA_CURRENT1: '0.00' + GRP_TA_CURRENT2: '0.00' + GRP_TA_CURRENT3: '0.00' + GRP_TA_FIXED1: '0.00' + GRP_TA_FIXED2: '0.00' + GRP_TA_FIXED3: '0.00' + GRP_TOT_LIABILITIES1: '0.00' + GRP_TOT_LIABILITIES2: '0.00' + GRP_TOT_LIABILITIES3: '0.00' + GRP_TL_CURRENT1: '0.00' + GRP_TL_CURRENT2: '0.00' + GRP_TL_CURRENT3: '0.00' + GRP_TL_NON_CURRENT1: '0.00' + GRP_TL_NON_CURRENT2: '0.00' + GRP_TL_NON_CURRENT3: '0.00' + GRP_SH_FUNDS1: '0.00' + GRP_SH_FUNDS2: '0.00' + GRP_SH_FUNDS3: '0.00' + GRP_SH_PAIDUP_CAPITAL1: '0.00' + GRP_SH_PAIDUP_CAPITAL2: '0.00' + GRP_SH_PAIDUP_CAPITAL3: '0.00' + GRP_SH_RESERVES1: '0.00' + GRP_SH_RESERVES2: '0.00' + GRP_SH_RESERVES3: '0.00' + GRP_SH_ACCUM_LOSS1: '0.00' + GRP_SH_ACCUM_LOSS2: '0.00' + GRP_SH_ACCUM_LOSS3: '0.00' + GRP_INDICATOR1: B + GRP_INDICATOR2: B + GRP_INDICATOR3: B + properties: + FH_YR1_CURR : + type: string + description: |+ + FH Before Year 1 Currency + Subsequent Years: + FH_YR2_CURR + FH_YR3_CURR + FH_YR4_CURR + FH_YR5_CURR + example: "(SGD)" + TURNOVER1 : + type: string + description: |+ + Turnover / Sales And Other Operating Revenues + Subsequent Years: + TURNOVER2 + TURNOVER3 + TURNOVER4 + TURNOVER5 + example: "9403795.00" + PL_BEF_TAX1 : + type: string + description: |+ + Profit / Loss Before Tax + Subsequent Years: + PL_BEF_TAX2 + PL_BEF_TAX3 + PL_BEF_TAX4 + PL_BEF_TAX5 + example: "31467.00" + PL_AFT_TAX1: + type: string + description: |+ + Profit / Loss After Tax + Subsequent Years: + PL_AFT_TAX2 + PL_AFT_TAX3 + PL_AFT_TAX4 + PL_AFT_TAX5 + example: "31467.00" + NETINC_NON_EXT1: + type: string + description: |+ + Net Income / Loss From Extraordinary And Non- Operating Items + Subsequent Years: + NETINC_NON_EXT2 + NETINC_NON_EXT3 + NETINC_NON_EXT4 + NETINC_NON_EXT5 + example: "0.00" + PL_AFT_TAX_EXT1 : + type: string + description: |+ + Profit / Loss After Tax and Extraordinary Items + Subsequent Years: + PL_AFT_TAX_EXT2 + PL_AFT_TAX_EXT3 + PL_AFT_TAX_EXT4 + PL_AFT_TAX_EXT5 + example: "31467.00" + TOT_ASSETS1 : + type: string + description: |+ + Total Assets + Subsequent Years: + TOT_ASSETS2 + TOT_ASSETS3 + TOT_ASSETS4 + TOT_ASSETS5 + example: "3889213.00" + TA_CURRENT1 : + type: string + description: |+ + Total Assets - Current + Subsequent Years: + TA_CURRENT2 + TA_CURRENT3 + TA_CURRENT4 + TA_CURRENT5 + example: "3359007.00" + TA_FIXED1 : + type: string + description: |+ + Total Assets – Fixed and Others + Subsequent Years: + TA_FIXED2 + TA_FIXED3 + TA_FIXED4 + TA_FIXED5 + example: "530206.00" + TOT_LIABILITIES1 : + type: string + description: |+ + Total Liabilities + Subsequent Years: + TOT_LIABILITIES2 + TOT_LIABILITIES3 + TOT_LIABILITIES4 + TOT_LIABILITIES5 + example: "7370430.00" + TL_CURRENT1 : + type: string + description: |+ + Total Liabilities - Current + Subsequent Years: + TL_CURRENT2 + TL_CURRENT3 + TL_CURRENT4 + TL_CURRENT5 + example: "6739073.00" + TL_NON_CURRENT1 : + type: string + description: |+ + Total Liabilities – Non- Current & Long Term + Subsequent Years: + TL_NON_CURRENT2 + TL_NON_CURRENT3 + TL_NON_CURRENT4 + TL_NON_CURRENT5 + example: "631357.00" + SH_FUNDS1: + type: string + description: |+ + Shareholder’s Fund + Subsequent Years: + SH_FUNDS2 + SH_FUNDS3 + SH_FUNDS4 + SH_FUNDS5 + example: "-3481217.00" + SH_PAIDUP_CAPITAL1 : + type: string + description: |+ + Shareholder’s Fund – Paid Up Capital + Subsequent Years: + SH_PAIDUP_CAPITAL2 + SH_PAIDUP_CAPITAL3 + SH_PAIDUP_CAPITAL4 + SH_PAIDUP_CAPITAL5 + example: "2000000.00" + SH_RESERVES1 : + type: string + description: |+ + Shareholder’s Fund - Reserves + Subsequent Years: + SH_RESERVES2 + SH_RESERVES3 + SH_RESERVES4 + SH_RESERVES5 + example: "0.00" + SH_ACCUM_LOSS1: + type: string + description: |+ + Shareholder’s Fund – Accumulated Loss + Subsequent Years: + SH_ACCUM_LOSS2 + SH_ACCUM_LOSS3 + SH_ACCUM_LOSS4 + SH_ACCUM_LOSS5 + example: "5481217.00" + GRP_TURNOVER1 : + type: string + description: |+ + Group Turnover / Sales and Other Operating Revenues + Subsequent Years: + GRP_TURNOVER2 + GRP_TURNOVER3 + GRP_TURNOVER4 + GRP_TURNOVER5 + example: "0.00" + GRP_PL_BEF_TAX1 : + type: string + description: |+ + Group Profit / Loss Before Tax + Subsequent Years: + GRP_PL_BEF_TAX2 + GRP_PL_BEF_TAX3 + GRP_PL_BEF_TAX4 + GRP_PL_BEF_TAX5 + example: "0.00" + GRP_PL_AFT_TAX1 : + type: string + description: |+ + Group Profit / Loss After Tax + Subsequent Years: + GRP_PL_AFT_TAX2 + GRP_PL_AFT_TAX3 + GRP_PL_AFT_TAX4 + GRP_PL_AFT_TAX5 + example: "0.00" + GRP_NETINC_NON_EXT1 : + type: string + description: |+ + Group Net Income / Loss From Extraordinary and Non-Operating Items + Subsequent Years: + GRP_NETINC_NON_EXT2 + GRP_NETINC_NON_EXT3 + GRP_NETINC_NON_EXT4 + GRP_NETINC_NON_EXT5 + example: "0.00" + GRP_PL_AFT_TAX_EXT1: + type: string + description: |+ + Group Profit / Loss After Tax and Extraordinary items + Subsequent Years: + GRP_ PL_AFT_TAX_EXT2 + GRP_ PL_AFT_TAX_EXT3 + GRP_ PL_AFT_TAX_EXT4 + GRP_ PL_AFT_TAX_EXT5 + example: "0.00" + GRP_TOT_ASSETS1: + type: string + description: |+ + Group Total Assets + Subsequent Years: + GRP_TOT_ASSETS2 + GRP_TOT_ASSETS3 + GRP_TOT_ASSETS4 + GRP_TOT_ASSETS5 + example: "0.00" + GRP_TA_CURRENT1 : + type: string + description: |+ + Group Total Assets – Current + Subsequent Years: + GRP_TA_CURRENT2 + GRP_TA_CURRENT3 + GRP_TA_CURRENT4 + GRP_TA_CURRENT5 + example: "0.00" + GRP_TA_FIXED1 : + type: string + description: |+ + Group Total Assets – Fixed and Others + Subsequent Years: + GRP_TA_FIXED2 + GRP_TA_FIXED3 + GRP_TA_FIXED4 + GRP_TA_FIXED5 + example: "0.00" + GRP_TOT_LIABILITIES1 : + type: string + description: |+ + Group Total Liabilities + Subsequent Years: + GRP_TOT_LIABILITIES2 + GRP_TOT_LIABILITIES3 + GRP_TOT_LIABILITIES4 + GRP_TOT_LIABILITIES5 + example: "0.00" + GRP_TL_CURRENT1 : + type: string + description: |+ + Group Total Liabilities - Current + Subsequent Years: + GRP_TL_CURRENT2 + GRP_TL_CURRENT3 + GRP_TL_CURRENT4 + GRP_TL_CURRENT5 + example: "0.00" + GRP_TL_NON_CURRENT1 : + type: string + description: |+ + Group Total Liabilities – Non-Current & Long Term + Subsequent Years: + GRP_TL_NON_CURRENT2 + GRP_TL_NON_CURRENT3 + GRP_TL_NON_CURRENT4 + GRP_TL_NON_CURRENT5 + example: "0.00" + GRP_SH_FUNDS1 : + type: string + description: |+ + Group Shareholder’s Fund + Subsequent Years: + GRP_ SH_FUNDS2 + GRP_ SH_FUNDS3 + GRP_ SH_FUNDS4 + GRP_ SH_FUNDS5 + example: "0.00" + GRP_SH_PAIDUP_CAPITAL1 : + type: string + description: |+ + Group Shareholder’s Fund – Paid Up Capital + Subsequent Years: + GRP_SH_PAIDUP_CAPITAL2 + GRP_SH_PAIDUP_CAPITAL3 + GRP_SH_PAIDUP_CAPITAL4 + GRP_SH_PAIDUP_CAPITAL5 + example: "0.00" + GRP_SH_RESERVES1: + type: string + description: |+ + Group Shareholder’s Fund - Reserves + Subsequent Years: + GRP_SH_RESERVES2 + GRP_SH_RESERVES3 + GRP_SH_RESERVES4 + GRP_SH_RESERVES5 + example: "0.00" + GRP_SH_ACCUM_LOSS1 : + type: string + description: |+ + Group Shareholder’s Fund – Accumulated Loss + Subsequent Years: + GRP_SH_ACCUM_LOSS2 + GRP_SH_ACCUM_LOSS3 + GRP_SH_ACCUM_LOSS4 + GRP_SH_ACCUM_LOSS5 + example: "0.00" + GRP_INDICATOR1 : + type: string + description: |+ + Company Financial Highlights Group Indicator + Subsequent Years: + GRP_INDICATOR2 + GRP_INDICATOR3 + GRP_INDICATOR4 + GRP_INDICATOR5 + example: "B" + XBRL_DTL: + type: object + description: |+ + XBRL filed after 1 Nov 2007 with following children: + XBRL_YR1_CURR + REVENUE1 + PL_BEF_TAX1 + PL_AFT_TAX1 + TOT_ASSETS1 + TA_CURRENT1 + TA_NON_CURRENT1 + TOT_LIABILITIES1 + TL_CURRENT1 + TL_NON_CURRENT1 + TOT_EQUITY1 + EQ_SH_CAPITAL1 + EQ_RESERVES1 + EQ_RETAINED_EARN1 + GRP_REVENUE1 + GRP_PL_BEF_TAX1 + GRP_PL_AFT_TAX1 + GRP_TOT_ASSETS1 + GRP_TA_CURRENT1 + GRP_TA_NON_CURRENT1 + GRP_TOT_LIABILITIES1 + GRP_TL_CURRENT1 + GRP_TL_NON_CURRENT1 + GRP_TOT_EQUITY1 + GRP_SH_CAPITAL1 + GRP_RESERVES1 + GRP_RETAINED_EARN1 + GRP_INDICATOR1 + + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of XBRL data displayed in the report. + example: + XBRL_DTL: + XBRL_YR1_CURR: "(SGD)" + XBRL_YR2_CURR: "(SGD)" + REVENUE1: '10877254.00' + REVENUE2: '9982533.00' + PL_BEF_TAX1: '1121483.00' + PL_BEF_TAX2: '262632.00' + PL_AFT_TAX1: '1347380.00' + PL_AFT_TAX2: '262632.00' + TOT_ASSETS1: '6562990.00' + TOT_ASSETS2: '5424551.00' + TA_CURRENT1: '6283449.00' + TA_CURRENT2: '4948821.00' + TA_NON_CURRENT1: '279541.00' + TA_NON_CURRENT2: '475730.00' + TOT_LIABILITIES1: '8434195.00' + TOT_LIABILITIES2: '8643136.00' + TL_CURRENT1: '8434195.00' + TL_CURRENT2: '7933013.00' + TL_NON_CURRENT1: '0.00' + TL_NON_CURRENT2: '710123.00' + TOT_EQUITY1: "-1871205.00" + TOT_EQUITY2: "-3218585.00" + EQ_SH_CAPITAL1: '2000000.00' + EQ_SH_CAPITAL2: '2000000.00' + EQ_RESERVES1: '0.00' + EQ_RESERVES2: '0.00' + EQ_RETAINED_EARN1: "-3,871,205.00" + EQ_RETAINED_EARN2: "-5,218,585.00" + GRP_REVENUE1: '0.00' + GRP_REVENUE2: '0.00' + GRP_PL_BEF_TAX1: '0.00' + GRP_PL_BEF_TAX2: '0.00' + GRP_PL_AFT_TAX1: '0.00' + GRP_PL_AFT_TAX2: '0.00' + GRP_TOT_ASSETS1: '0.00' + GRP_TOT_ASSETS2: '0.00' + GRP_TA_CURRENT1: '0.00' + GRP_TA_CURRENT2: '0.00' + GRP_TA_NON_CURRENT1: '0.00' + GRP_TA_NON_CURRENT2: '0.00' + GRP_TOT_LIABILITIES1: '0.00' + GRP_TOT_LIABILITIES2: '0.00' + GRP_TL_CURRENT1: '0.00' + GRP_TL_CURRENT2: '0.00' + GRP_TL_NON_CURRENT1: '0.00' + GRP_TL_NON_CURRENT2: '0.00' + GRP_TOT_EQUITY1: '0.00' + GRP_TOT_EQUITY2: '0.00' + GRP_SH_CAPITAL1: '0.00' + GRP_SH_CAPITAL2: '0.00' + GRP_RESERVES1: '0.00' + GRP_RESERVES2: '0.00' + GRP_RETAINED_EARN1: '0.00' + GRP_RETAINED_EARN2: '0.00' + GRP_INDICATOR1: B + GRP_INDICATOR2: B + GRP_INDICATOR3: B + properties: + XBRL_YR1_CURR: + type: string + description: |+ + FH After Year 1 Currency + Subsequent Years: + XBRL_YR2_CURR + XBRL_YR3_CURR + XBRL_YR4_CURR + XBRL_YR5_CURR + example: "(SGD)" + REVENUE1 : + type: string + description: |+ + Revenue Amount + Subsequent Years: + REVENUE2 + REVENUE3 + REVENUE4 + REVENUE5 + example: "10877254.00" + PL_BEF_TAX1 : + type: string + description: |+ + Profit / Loss Before Tax from Continuing Operations + Subsequent Years: + PL_BEF_TAX2 + PL_BEF_TAX3 + PL_BEF_TAX4 + PL_BEF_TAX5 + example: "1121483.00" + PL_AFT_TAX1 : + type: string + description: |+ + Profit / Loss After Tax from Continuing Operations + Subsequent Years: + PL_AFT_TAX2 + PL_AFT_TAX3 + PL_AFT_TAX4 + PL_AFT_TAX5 + example: "1347380.00" + TOT_ASSETS1 : + type: string + description: |+ + Total Assets + Subsequent Years: + TOT_ASSETS2 + TOT_ASSETS3 + TOT_ASSETS4 + TOT_ASSETS5 + example: "6562990.00" + TA_CURRENT1 : + type: string + description: |+ + Total Current Assets (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TA_CURRENT2 + TA_CURRENT3 + TA_CURRENT4 + TA_CURRENT5 + example: "6283449.00" + TA_NON_CURRENT1 : + type: string + description: |+ + Total Non-Current Assets (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TA_NON_CURRENT2 + TA_NON_CURRENT3 + TA_NON_CURRENT4 + TA_NON_CURRENT5 + example: "279541.00" + TOT_LIABILITIES1 : + type: string + description: |+ + Total Liabilities + Subsequent Years: + TOT_LIABILITIES2 + TOT_LIABILITIES3 + TOT_LIABILITIES4 + TOT_LIABILITIES5 + example: "8434195.00" + TL_CURRENT1 : + type: string + description: |+ + Total Current Liabilities (Only for Balance Sheet by Current / Non-Current) + Subsequent Years: + TL_CURRENT2 + TL_CURRENT3 + TL_CURRENT4 + TL_CURRENT5 + example: "8434195.00" + TL_NON_CURRENT1 : + type: string + description: |+ + Total Non-Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + TL_NON_CURRENT2 + TL_NON_CURRENT3 + TL_NON_CURRENT4 + TL_NON_CURRENT5 + example: "0.00" + TOT_EQUITY1 : + type: string + description: |+ + Total Equity (inclusive of Equity Attributable to Equity Holders of Parent and Minority Interest) + Subsequent Years: + TOT_EQUITY2 + TOT_EQUITY3 + TOT_EQUITY4 + TOT_EQUITY5 + example: "-1871205.00" + EQ_SH_CAPITAL1 : + type: string + description: |+ + Total Equity – Share Capital + Subsequent Years: + EQ_SH_CAPITAL2 + EQ_SH_CAPITAL3 + EQ_SH_CAPITAL4 + EQ_SH_CAPITAL5 + example: "2000000.00" + EQ_RESERVES1 : + type: string + description: |+ + Total Equity – Other Reserves + Subsequent Years: + EQ_RESERVES2 + EQ_RESERVES3 + EQ_RESERVES4 + EQ_RESERVES5 + example: "0.00" + EQ_RETAINED_EARN1 : + type: string + description: |+ + Total Equity – Retained Earnings (Accumulated Loss) + Subsequent Years: + EQ_RETAINED_EARN2 + EQ_RETAINED_EARN3 + EQ_RETAINED_EARN4 + EQ_RETAINED_EARN5 + example: "-3,871,205.00" + GRP_REVENUE1 : + type: string + description: |+ + Group’s Revenue Amount + Subsequent Years: + GRP_REVENUE2 + GRP_REVENUE3 + GRP_REVENUE4 + GRP_REVENUE5 + example: "0.00" + GRP_PL_BEF_TAX1 : + type: string + description: |+ + Group Profit / Loss Before Tax from Continuing Operations + Subsequent Years: + GRP_PL_BEF_TAX2 + GRP_PL_BEF_TAX3 + GRP_PL_BEF_TAX4 + GRP_PL_BEF_TAX5 + example: "0.00" + GRP_PL_AFT_TAX1 : + type: string + description: |+ + Group Profit / Loss After Tax from Continuing Operations + Subsequent Years: + GRP_PL_AFT_TAX2 + GRP_PL_AFT_TAX3 + GRP_PL_AFT_TAX4 + GRP_PL_AFT_TAX5 + example: "0.00" + GRP_TOT_ASSETS1 : + type: string + description: |+ + Group’s Total Assets + Subsequent Years: + GRP_TOT_ASSETS2 + GRP_TOT_ASSETS3 + GRP_TOT_ASSETS4 + GRP_TOT_ASSETS5 + example: "0.00" + GRP_TA_CURRENT1 : + type: string + description: |+ + Group’s Total Current Assets (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TA_CURRENT2 + GRP_TA_CURRENT3 + GRP_TA_CURRENT4 + GRP_TA_CURRENT4 + example: "0.00" + GRP_TA_NON_CURRENT1 : + type: string + description: |+ + Group’s Total Non-Current Assets (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TA_NON_CURRENT2 + GRP_TA_NON_CURRENT3 + GRP_TA_NON_CURRENT4 + GRP_TA_NON_CURRENT4 + example: "0.00" + GRP_TOT_LIABILITIES1 : + type: string + description: |+ + Group’s Total Liabilities + Subsequent Years: + GRP_TOT_LIABILITIES2 + GRP_TOT_LIABILITIES3 + GRP_TOT_LIABILITIES4 + GRP_TOT_LIABILITIES5 + example: "0.00" + GRP_TL_CURRENT1 : + type: string + description: |+ + Group’s Total Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TL_CURRENT2 + GRP_TL_CURRENT3 + GRP_TL_CURRENT4 + GRP_TL_CURRENT5 + example: "0.00" + GRP_TL_NON_CURRENT1 : + type: string + description: |+ + Group’s Total Non-Current Liabilities (Only for Balance Sheet by Current / Non- Current) + Subsequent Years: + GRP_TL_NON_CURRENT2 + GRP_TL_NON_CURRENT3 + GRP_TL_NON_CURRENT4 + GRP_TL_NON_CURRENT5 + example: "0.00" + GRP_TOT_EQUITY1 : + type: string + description: |+ + Group’s Total Equity (inclusive of Equity Attributable to Equity Holders of Parent and Minority Interest) + Subsequent Years: + GRP_TOT_EQUITY2 + GRP_TOT_EQUITY3 + GRP_TOT_EQUITY4 + GRP_TOT_EQUITY5 + example: "0.00" + GRP_SH_CAPITAL1 : + type: string + description: |+ + Group’s Share Capital + Subsequent Years: + GRP_SH_CAPITAL2 + GRP_SH_CAPITAL3 + GRP_SH_CAPITAL4 + GRP_SH_CAPITAL5 + example: "0.00" + GRP_RESERVES1 : + type: string + description: |+ + Group’s Other Reserves + Subsequent Years: + GRP_RESERVES2 + GRP_RESERVES3 + GRP_RESERVES4 + GRP_RESERVES5 + example: "0.00" + GRP_RETAINED_EARN1 : + type: string + description: |+ + Group’s – Retained Earnings (Accumulated Loss) + Subsequent Years: + GRP_RETAINED_EARN2 + GRP_RETAINED_EARN3 + GRP_RETAINED_EARN4 + GRP_RETAINED_EARN5 + example: "0.00" + GRP_INDICATOR1 : + type: string + description: |+ + XBRL Financial Highlights Group Indicator + Subsequent Years: + GRP_INDICATOR2 + GRP_INDICATOR3 + GRP_INDICATOR4 + GRP_INDICATOR5 + example: "B" + FH_RATIOS_DTL: + type: object + description: |+ + Accounting Ratios Details with following children: + RATE_NET_PROFIT1 + RET_INVESTMENT1 + RET_SH_FUNDS1 + TOT_ASSETS_TURNOVER1 + CURR_CAPITAL_RATIO1 + PROPRIETARY_RATIO1 + TOTAL_DEBT_RATIO1 + Note: Each tag will consist of maximum 5 sets with suffix 1 to 5. But it is optional, depending on how many years of FH & XBRL data displayed in the report. + example: + FH_RATIOS_DTL: + RATE_NET_PROFIT1: '12.39' + RATE_NET_PROFIT2: '2.63' + RATE_NET_PROFIT3: '0.00' + RATE_NET_PROFIT4: '0.00' + RATE_NET_PROFIT5: '0.00' + RET_INVESTMENT1: '20.53' + RET_INVESTMENT2: '4.84' + RET_INVESTMENT3: '0.00' + RET_INVESTMENT4: '0.00' + RET_INVESTMENT5: '0.00' + RET_SH_FUNDS1: "-72.01" + RET_SH_FUNDS2: "-8.16" + RET_SH_FUNDS3: "-0.00" + RET_SH_FUNDS4: "-0.00" + RET_SH_FUNDS5: "-0.00" + TOT_ASSETS_TURNOVER1: '1.66' + TOT_ASSETS_TURNOVER2: '1.84' + TOT_ASSETS_TURNOVER3: '2.42' + TOT_ASSETS_TURNOVER4: '2.54' + TOT_ASSETS_TURNOVER5: '1.78' + CURR_CAPITAL_RATIO1: '0.74' + CURR_CAPITAL_RATIO2: '0.62' + CURR_CAPITAL_RATIO3: '0.50' + CURR_CAPITAL_RATIO4: '0.46' + CURR_CAPITAL_RATIO5: '0.55' + PROPRIETARY_RATIO1: "-28.51" + PROPRIETARY_RATIO2: "-59.33" + PROPRIETARY_RATIO3: "-89.51" + PROPRIETARY_RATIO4: "-101.59" + PROPRIETARY_RATIO5: "-75.15" + TOTAL_DEBT_RATIO1: '128.51' + TOTAL_DEBT_RATIO2: '168.27' + TOTAL_DEBT_RATIO3: '189.51' + TOTAL_DEBT_RATIO4: '201.59' + TOTAL_DEBT_RATIO5: '175.15' + properties: + RATE_NET_PROFIT1 : + type: string + description: |+ + Rate of Net Profit On Sales (%) + Subsequent Years: + RATE_NET_PROFIT2 + RATE_NET_PROFIT3 + RATE_NET_PROFIT4 + RATE_NET_PROFIT5 + example: "12.39" + RET_INVESTMENT1 : + type: string + description: |+ + Return of Investment (%) + Subsequent Years: + RET_INVESTMENT2 + RET_INVESTMENT3 + RET_INVESTMENT4 + RET_INVESTMENT5 + example: "20.53" + RET_SH_FUNDS1 : + type: string + description: |+ + Return of Shareholder’s Funds (%) + Subsequent Years: + RET_SH_FUNDS2 + RET_SH_FUNDS3 + RET_SH_FUNDS4 + RET_SH_FUNDS4 + example: "-72.01" + TOT_ASSETS_TURNOVER1 : + type: string + description: |+ + Total Assets Turnover (%) + Subsequent Years: + TOT_ASSETS_TURNOVER2 + TOT_ASSETS_TURNOVER3 + TOT_ASSETS_TURNOVER4 + TOT_ASSETS_TURNOVER5 + example: "1.66" + CURR_CAPITAL_RATIO1: + type: string + description: |+ + Current / Working Capital Ratio (%) + Subsequent Years: + CURR_CAPITAL_RATIO2 + CURR_CAPITAL_RATIO3 + CURR_CAPITAL_RATIO4 + CURR_CAPITAL_RATIO5 + example: "0.74" + PROPRIETARY_RATIO1: + type: string + description: |+ + Proprietary Ratio (%) 1 + Subsequent Years: + PROPRIETARY_RATIO2 + PROPRIETARY_RATIO3 + PROPRIETARY_RATIO4 + PROPRIETARY_RATIO5 + example: "-28.51" + TOTAL_DEBT_RATIO1 : + type: string + description: |+ + Total Debt to Equity Ratio (%) 1 + Subsequent Years: + TOTAL_DEBT_RATIO2 + TOTAL_DEBT_RATIO3 + TOTAL_DEBT_RATIO4 + TOTAL_DEBT_RATIO5 + example: "128.51" + LIST_FH_CHART_INFO : + type: array + example: + LIST_FH_CHART_INFO: + FH_CHART_INFO: + PROFIT_LOSS: '1121483.0' + REVENUE: '10877254' + YEAR: '2008' + description: |+ + List of chart info with following children: + [FH_CHART_INFO] + items: + properties: + FH_CHART_INFO: + type: object + description: |+ + Chart Info info with following children: + YEAR + REVENUE + PROFIT_LOSS + properties: + PROFIT_LOSS: + type: string + example: "1121483.0" + description: Profit / Loss Before Tax of the year + REVENUE: + type: string + example: "10877254" + description: Revenue Amount of the year + YEAR: + type: string + example: "2008" + description: Financial Year + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + properties: + total_items: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + subject_idno: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + subject_name: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized and Standardized results in Json format + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/d&b_business_check_plus_sg.yaml b/data/d&b_business_check_plus_sg.yaml new file mode 100644 index 000000000..ccdf9f248 --- /dev/null +++ b/data/d&b_business_check_plus_sg.yaml @@ -0,0 +1,1704 @@ +openapi: 3.0.1 +info: + title: D&B Business Check Plus (SG) + description: The Data microservice provides key business information, litigation information (High and Subordinate Courts) and Winding Up Trace of a company including the Business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholder, litigation information. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions targeted at corporate finance and legal domains, e.g. in cases of mergers, joint ventures or partnerships. + - Aside from being able to protect your business via litigation checks to safeguard against reputational risk by avoiding companies potentially involved in financial crimes, the information from this microservice can serve as a quick solution for analysts or lawyers in a company whom are looking to draft documents related to cooperate finance or legal domains with one quick search. + version: '0.1.0' + x-subscribelink: d&b_business_check_plus_sg +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 15, 2019" +paths: + /dnb/prod/sbcp: + post: + tags: + - v0.1.0 + summary: Adds a new user + requestBody: + content: + application/xml: + schema: + $ref: '#/components/schemas/REQUEST' + responses: + '200': + description: Ok + content: + application/xml: + schema: + $ref: '#/components/schemas/success' + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 300 + + + + + + + + + + + + + + + + + + + + + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + ANGELA ANG + S1633336D + Liquidator + KING FINANCIAL ADVISORY SERVICES LEVEL 17 MLC CENTRE 19029 MARTIN PLACE SYDNEY NSW 2000 AUSTRALIA 18/02/2009 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ + + + + + + + + 30000.00 + + 28000.00 + + 27,000.00 + + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [REGISTRY_DETAIL] + [REQ_SEARCH_INFO] + [EMPLOYEE_SIZE] + [LIST_BIZ_BRANCH] + [LIST_REG_CHARGES] + [LIST_LIQUIDATOR] + [LIST_WINDING_UP] + [LIST_LITIGATION] + [LIST_SHARE_INTEREST_COMP] + [LIST_NAME_CHANGE] + [LIST_SHAREHOLDER] + [LIST_CAPITAL] + [LIST_OFFICER_OWNER] + [LIST_SALES_REVENUE_AMOUNT] + properties: + META_INFO: + type: object + example: |+ + + + + + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + CLASS + properties: + SERVICE: + type: string + description: Report requested + example: "BCP" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: datetime + description: Report request date + example: Wed Apr 08 11:37:51 MYT 2009 + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: N/A + CLASS: + type: string + description: Class location for metabean. It is for (For internal use) + example: N/A + REGISTRY_DETAIL : + type: object + example: |+ + + + + + + + + + + + + + + + + + + + + + + description: |+ + Registry Details with following children: + RENEWAL_DATE + ADDRESS1 + ADDRESS2 + ADDRESS3 + ADDRESS4 + COMP_TYPE_CODE + REG_DATE + REG_ACTIVITY1 + REG_ACTIVITY2 + ACC_DATE + STATUS_EFFECT_DATE + NAME_EFFECT_DATE + EXPIRY_DATE + COMP_TYPE + CHANGE_ADDR_DATE + COMP_STATUS + REG_ACTIVITY_DESC1 + REG_ACTIVITY_DESC2 + AUDITOR + AUDITOR_APPMT_DATE + LAST_AR_DATE + LAST_AGM_DATE + COUNTRY_INCORP + properties: + RENEWAL_DATE: + type: string + description: Renewal Date + example: "23/12/2008" + ADDRESS1: + type: string + description: Address Line 1 + example: "1 HARBOURFRONT AVENUE , 18 - 01" + ADDRESS2: + type: string + description: Address Line 2 + example: "KEPPEL BAY TOWER" + ADDRESS3: + type: string + description: Address Line 3 + example: "098632" + ADDRESS4: + type: string + description: Address Line 4 + example: "SINGAPORE" + COMP_TYPE_CODE: + type: string + example: CP + description: |+ + Report Code. Available values are: + 1. CP Corporate + 2. SP Sole Proprietor + REG_DATE: + type: string + description: Registration Date + example: "14/10/1974" + REG_ACTIVITY1: + type: string + description: Registered Activities 1 + example: "OTHER INVESTMENT HOLDING COMPANIES" + REG_ACTIVITY2: + type: string + description: Registered Activities 2 + example: "SHIP MANAGEMENT SERVICES" + ACC_DATE: + type: string + description: Account Date + example: "31/12/2007" + STATUS_EFFECT_DATE: + type: string + description: Status Effective Date + example: "14/10/1974" + NAME_EFFECT_DATE: + type: string + description: Name Effective Date + example: "14/10/1974" + EXPIRY_DATE: + type: string + description: Expiry Date + example: "25/10/2009" + COMP_TYPE: + type: string + description: Company Type + example: "LIMITED PRIVATE COMPANY" + CHANGE_ADDR_DATE: + type: string + description: Change Address Date + example: "09/05/2003" + COMP_STATUS: + type: string + description: Company Status + example: "Live Company" + REG_ACTIVITY_DESC1: + type: string + description: Registered Activities Description + example: + REG_ACTIVITY_DESC2: + type: string + description: Registered Activities Description + example: + AUDITOR: + type: string + description: Auditor Name + example: + AUDITOR_APPMT_DATE: + type: string + description: Auditor Appointment Date + example: "13/06/1990" + LAST_AR_DATE: + type: string + description: Date of Last AR + example: "30/06/2008" + LAST_AGM_DATE: + type: string + description: Date of Last AGM + example: "11/06/2008" + COUNTRY_INCORP: + type: string + description: Country Incorporated + example: "SINGAPORE" + REQ_SEARCH_INFO : + type: object + example: |+ + + + + + + + description: |+ + Request criteria & search record with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REG_NO: + type: string + description: Subject’s ID Number (individual) or Registration Number (company/business) + example: "197401835M" + REQ_DATE: + type: datetime + description: Report Requested Date + example: 2009-04-08 11:36:03.611 + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197401835M" + REQ_NAME: + type: string + description: Request Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REQ_DATE_STR: + type: string + description: Request Date String + example: "08/04/2009 11:36:03" + EMPLOYEE_SIZE : + type: object + description: |+ + Employee Size details with following children: + ELEMENTS + AMOUNT + example: |+ + + + 300 + + properties: + ELEMENTS: + type: string + description: Description + example: "Employee Size" + AMOUNT: + type: integer + description: Number of employee + example: 300 + LIST_BIZ_BRANCH : + type: array + description: |+ + List of Business Branches with following children: + [BIZ_BRANCH] + example: |+ + + + + + + + items: + properties: + BIZ_BRANCH : + type: object + description: |+ + Business Branches with following children: + ADDR_BUILDING + ADDR_POSTCODE + ADDR_ADDRESS1 + example: |+ + + + + + + properties: + ADDR_BUILDING: + type: string + description: Building Name + example: + ADDR_POSTCODE: + type: string + description: Postcode + example: 289848 + ADDR_ADDRESS1: + type: string + description: Address + example: 251A ARCADIA ROAD + LIST_REG_CHARGES: + type: array + description: |+ + List of Registered Charges with following children: + [REG_CHARGES] + example: |+ + + + + + + + + + + items: + properties: + REG_CHARGES : + type: object + description: |+ + Registered Charges details with following children: + CHARGE_NO + CHARGE_DATE + CHARGEE_COMP + CURRENCY + AMT_SECURED + STATUS_SATISFACTION + example: |+ + + + + + + + + + properties: + CHARGE_NO : + type: string + description: Charge No. + example: 8205117 + CHARGE_DATE: + type: string + description: Charge Date + example: 26/11/1982 + CHARGEE_COMP: + type: string + description: Charges Company + example: UNITED OVERSEAS BANK LIMITED + CURRENCY: + type: string + description: Currency + example: + AMT_SECURED: + type: string + description: Amount Secured + example: 1000.00 + STATUS_SATISFACTION: + type: string + description: Status of Satisfaction + example: + LIST_LIQUIDATOR: + type: array + description: |+ + List of Liquidator / Receiver / Judicial Manager with following children: + [LIQUIDATOR] + example: |+ + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + + items: + properties: + LIQUIDATOR : + type: object + description: |+ + Liquidator details with following children: + LIQ_POSITION + LIQ_ID + LIQ_NAME + LIQ_COMP + LIQ_ADDRESS1 + LIQ_ADDRESS2 + LIQ_ADDRESS3 + LIQ_ADDRESS4 + LIQ_APPOINTMENT_DATE + example: |+ + + ABUTHAHIR ABDUL GAFOOR + S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + 1 RAFFLES PLACE + #20-01 + OUB CENTRE + SINGAPORE 048616 + 30/03/2009 + + properties: + LIQ_POSITION: + type: string + description: Liquidator / Receiver / Judicial Manager Position + example: Liquidator + LIQ_ID: + type: string + description: Liquidator / Receiver / Judicial Manager ID + example: S1676216D + LIQ_NAME : + type: string + description: Liquidator / Receiver / Judicial Manager Name + example: ABUTHAHIR ABDUL GAFOOR + LIQ_COMP: + type: string + description: Liquidator / Receiver / Judicial Manager Company Name + example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: + type: string + description: Liquidator / Receiver / Judicial Manager Address 1 + example: 1 RAFFLES PLACE + LIQ_ADDRESS2: + type: string + description: Liquidator / Receiver / Judicial Manager Address 2 + example: #20-01 + LIQ_ADDRESS3: + type: string + description: Liquidator / Receiver / Judicial Manager Address 3 + example: OUB CENTRE + LIQ_ADDRESS4: + type: string + description: Liquidator / Receiver / Judicial Manager Address 4 + example: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: + type: string + description: Liquidator / Receiver / Judicial Manager Appointment Date + example: 30/03/2009 + LIST_WINDING_UP : + type: array + description: |+ + List of Winding Up with following children: + [WINDING_UP] + example: |+ + + + + + + + + + + + + + + + + + + + + + items: + properties: + WINDING_UP : + type: object + description: |+ + Winding Up details with following children: + CASE_CODE + CASE_YEAR + PLAINTIFF + PLA_SOLICITOR_ID + PLA_FILE_REF + PLA_LAW_FIRM + SUBJECT_NAME + COURT_CODE + CASE_TYPE + CURRENCY1 + AMOUNT1 + CURRENCY2 + AMOUNT2 + CURRENCY3 + AMOUNT3 + ACTION_DATE + BANKRUPTCY_ACT + HEARING_DATE + PLA_SOLICITOR + example: |+ + + + + + + + + + + + + + + + + + + + + properties: + CASE_CODE : + type: string + description: Case Code + example: 40000 + CASE_YEAR : + type: string + description: Case Year + example: 1999 + PLAINTIFF : + type: string + description: Plaintiff Name + example: + PLA_SOLICITOR_ID : + type: string + description: Pla. Solicitor ID + example: + PLA_FILE_REF : + type: string + description: Pla. File Ref. + example: + PLA_LAW_FIRM : + type: string + description: Pla. Law Firm + example: NAME2 + SUBJECT_NAME : + type: string + description: Subject Name + example: PROACTIVE BUILDERS + COURT_CODE : + type: string + description: Court Code + example: CWU + CASE_TYPE : + type: string + description: Case Type + example: COMPANY WINDING UP PETITION + CURRENCY1 : + type: string + description: Currency 1 + example: SGD + AMOUNT1 : + type: string + description: Amount 1 + example: 41,424.52 + CURRENCY2 : + type: string + description: Currency 2 + example: MYR + AMOUNT2 : + type: string + description: Amount 2 + example: 0.00 + CURRENCY3 : + type: string + description: Currency 3 + example: + AMOUNT3 : + type: string + description: Amount 3 + example: 0.00 + ACTION_DATE : + type: string + description: Action Date + example: 11/05/2007 + BANKRUPTCY_ACT : + type: string + description: Act of Bankruptcy + example: Petition for Winding Up + HEARING_DATE : + type: string + description: Hearing Date + example: 15/12/2007 + PLA_SOLICITOR : + type: string + description: Pla. Solicitor + example: + LIST_LITIGATION : + type: array + description: |+ + List of Winding Up with following children: + [LITIGATION] + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + items: + properties: + LITIGATION : + type: object + description: |+ + List of Winding Up with following children: + SUBJECT_NAME + NATURE_OF_CLAIM + STATUS_DATE + CASE_NO + DOC_REMARK + CURRENCY1 + CURRENCY2 + CURRENCY3 + CURRENCY4 + CURRENCY5 + DEF_SOLICITOR + DEF_SOLICITOR_ID + DEF_LAW_FIRM + DEF_FILE_REF + DATE_OF_WRIT + STATUS + AMOUNT1 + AMOUNT2 + AMOUNT3 + AMOUNT4 + AMOUNT5 + PLAINTIFF + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_LAW_FIRM + PLA_FILE_REF + PLA_ID + PLA_STATUS + PLA_STATUS_DATE + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + properties: + SUBJECT_NAME : + type: string + description: Subject Name + example: "SOON SOON SEAFOOD" + NATURE_OF_CLAIM : + type: string + example: "CONTRACT 3" + description: Nature of Claim + STATUS_DATE : + type: string + example: "01/05/2008" + description: Status Date + CASE_NO : + type: string + example: "MC 40001 / 1999" + description: Case No + DOC_REMARKS : + type: string + example: "NOTICE OF DISCONTINUANCE/WITHDRAWAL 3" + description: Document Remark + CURRENCY1 : + type: string + example: "SGD" + description: Currency 1 + CURRENCY2 : + type: string + example: "MYR" + description: Currency 2 + CURRENCY3 : + type: string + example: "USD" + description: Currency 3 + CURRENCY4 : + type: string + example: "-" + description: Currency 4 + CURRENCY5 : + type: string + example: "-" + description: Currency 5 + DEF_SOLICITOR : + type: string + example: "SOL2" + description: Def. Solicitor + DEF_SOLICITOR_ID : + type: string + example: "20000000" + description: Def. Solicitor ID + DEF_LAW_FIRM : + type: string + example: "NAME2" + description: Def. Law Firm + DEF_FILE_REF : + type: string + example: "FILE2" + description: Def. File Ref. + DATE_OF_WRIT : + type: string + example: "01/01/2008" + description: Date Writ + STATUS : + type: string + example: "CONCLUDED 3" + description: Status + AMOUNT1 : + type: string + example: "100.00" + description: Amount 1 + AMOUNT2 : + type: string + example: "200.00" + description: Amount 2 + AMOUNT3 : + type: string + example: "0.00" + description: Amount 3 + AMOUNT4 : + type: string + example: "400.00" + description: Amount 4 + AMOUNT5 : + type: string + example: "0.00" + description: Amount 5 + PLAINTIFF : + type: string + example: "MC 40001" + description: Plaintiff Name + PLA_SOLICITOR: + type: string + example: "SOL2" + description: plantiff Solicitor + PLA_SOLICITOR_ID: + type: string + example: "20000000" + description: plantiff Solicitor ID + PLA_LAW_FIRM : + type: string + example: "NAME2" + description: Pla. Law Firm + PLA_FILE_REF : + type: string + example: "FILE2" + description: Pla. File Ref. + PLA_ID: + type: string + example: "S0739038F" + description: Plaintiff ID + PLA_STATUS: + type: string + example: "SETTLED - BEFORE SET DOWN" + description: Plaintiff Status + PLA_STATUS_DATE : + type: string + example: "17/10/2016" + description: Plaintiff Status Date + LIST_SHARE_INTEREST_COMP : + type: array + description: |+ + List of Share Interest In Companies with following children: + [SHARE_INTEREST_COMP] + example: |+ + + + + + + + + + items: + properties: + SHARE_INTEREST_COMP : + type: object + description: |+ + Share Interest In Companies details with following children: + COMP_NAME + SHARE_OWNED_UNIT + SHARE_OWNED_PERCENT + STATUS + example: |+ + + + + + + + properties: + COMP_NAME : + type: string + description: Company Name + example: ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT : + type: string + description: Shares Owned Unit + example: 500000 + SHARE_OWNED_PERCENT : + type: string + description: Shares Owned Value (%) + example: 100.00 + STATUS : + type: string + description: Status + example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE : + type: array + description: |+ + List of Change of Company/Business Name(s) with following children: + [NAME_CHANGE] + example: |+ + + + + + + + items: + properties: + NAME_CHANGE : + type: object + description: |+ + Change of Company/Business Name(s) with following children: + PREV_NAME + EFFECT_DATE + example: |+ + + + + + properties: + PREV_NAME : + type: string + description: Previous Name + example: HUA XI EATING HOUSE + EFFECT_DATE : + type: string + description: Effective Date + example: 25/10/1997 00:00:00 + LIST_SHAREHOLDER : + type: array + description: |+ + List of Shareholders with following children: + [SHAREHOLDER] + example: |+ + + +
+ + + + + + + + + + items: + properties: + SHAREHOLDER : + type: object + description: |+ + Shareholders details with following children: + ADDRESS + COMP_ID + NO_OF_SHARE + CURRENCY + SHAREHOLDER_TYPE + SHARE_TYPE + SHAREHOLDER_NAME + CHANGE_ADDR_DATE + ADDR_TYPE + NATIONALITY + example: |+ + +
+ + + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID : + type: string + description: Company/ Identity No. + example: 198200406H + NO_OF_SHARE : + type: string + description: No. of Shares + example: 657 + CURRENCY : + type: string + description: Currency + example: UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE : + type: string + description: |+ + Indicator for Shareholder type. + Possible values are: + 1 Individual + 2 Company + 3 Unregistered foreign company + 4 Unregistered local company + example: 2 + SHARE_TYPE : + type: string + description: Share Type + example: Preference + SHAREHOLDER_NAME : + type: string + description: Shareholder Name + example: KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 09/05/2003 + ADDR_TYPE : + type: string + description: |+ + Address Type, indicates if it is Singapore or foreign address. + Possible values are: + S Indicates Singapore address + - Indicates foreign address + example: S + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE + LIST_CAPITAL : + type: array + description: |+ + List of Capital details with following children: + [CAPITAL] + example: |+ + + + + + + + + + + items: + properties: + CAPITAL : + type: object + description: |+ + Capital details with following children: + CAPITAL_CATEGORY + CAPITAL_TYPE + CURRENCY + CAPITAL_AMT + NO_OF_SHARES + example: |+ + + + + + + + + properties: + CAPITAL_CATEGORY : + type: string + description: Capital Category + example: Issued + CAPITAL_TYPE : + type: string + description: Capital Type + example: Ordinary + CURRENCY : + type: string + description: Currency + example: SINGAPORE, DOLLARS + CAPITAL_AMT : + type: string + description: Capital Amount + example: 100,000.00 + NO_OF_SHARES : + type: string + description: Nos. of Shares + example: 100,000 + LIST_OFFICER_OWNER : + type: array + description: |+ + List of Officer(s) / Owner(s) with following children: + [OFFICER_OWNER] + example: |+ + + +
+ + + + + + + + items: + properties: + OFFICER_OWNER : + type: object + description: |+ + Officer(s) / Owner(s) details with following children: + ADDRESS + IDENTITY_ID + PA_REG_NO + POSITION + ADDR_TYPE + CESSATION_DATE + OFFICER_NAME + CHANGE_ADDR_DATE + APPMT_DATE + NATIONALITY + example: |+ + +
+ + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE + IDENTITY_ID : + type: string + description: Identity No. + example: S1674174D + PA_REG_NO : + type: string + description: Public Accountant Registration No. + example: 00091 + POSITION : + type: string + description: Position + example: DIRECTOR + ADDR_TYPE : + type: string + description: |+ + Address Type, indicates if it is Singapore or foreign address. + Possible values are: + S Indicates Singapore address + - Indicates foreign address + example: S + CESSATION_DATE : + type: string + description: Cessation Date + example: 30/10/2003 + OFFICER_NAME : + type: string + description: Officer Name + example: HENRY GOH + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 30/10/2003 + APPMT_DATE : + type: string + description: Appointment Date + example: 30/10/2003 + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT : + type: array + description: |+ + List of Sales Revenue Amount with following children: + [SALES_REVENUE_AMOUNT] + example: |+ + + + 30000.00 + + + items: + properties: + SALES_REVENUE_AMOUNT : + type: object + description: |+ + Sales Revenue Amount details with following children: + ELEMENTS + YEAR + CURRENCY + AMOUNT + example: |+ + + + + + 30000.00 + + properties: + ELEMENTS : + type: string + description: Description + example: Sales Revenue Amount + YEAR : + type: string + description: Year + example: 2008 + CURRENCY : + type: string + description: Currency + example: SGD + AMOUNT : + type: string + description: Amount. Amount values that higher than 1000 have a comma to delimit every 3 digits of the amount value. + example: 30000.00 + LIST_Ddrptcount : + type: array + description: |+ + List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: + [Ddrptcount] + example: + items: + properties: + Ddrptcount : + type: object + description: |+ + 6 XML tags (open then close) displays + Search By Financial Sectors (counts for 3 recent years) + Search By Non- Financial Sectors (counts for 3 recent years) + Following children are: + Rcyear + RcFlag (only respond for the year exists) + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) + Rcsecflag + LastUpdateDate (only respond for the year exists) + example: + properties: + Rcyear : + type: string + description: To show the year + example: 2017 + RcFlag : + type: string + description: Internal database value + example: N/A + Rcjan : + type: integer + description: Count for January + example: 1 + Rcfeb : + type: integer + description: Count for February + example: 1 + Rcmar : + type: integer + description: Count for March + example: 1 + Rcapr : + type: integer + description: Count for April + example: 1 + Rcmay : + type: integer + description: Count for May + example: 1 + Rcjun : + type: integer + description: Count for June + example: 1 + Rcjul : + type: integer + description: Count for July + example: 1 + Rcaug : + type: integer + description: Count for August + example: 1 + Rcsep : + type: integer + description: Count for September + example: 1 + Rcoct : + type: integer + description: Count for October + example: 1 + Rcnov : + type: integer + description: Count for November + example: 1 + Rcdec : + type: integer + description: Count for December + example: 1 + Rcid : + type: string + description: |+ + Internal database value, respond value from table Primary Key ID + It is for (For internal use) + example: N/A + Rcreg : + type: string + description: Company Registration Number + example: + Rcrptyid : + type: string + description: |+ + Product Type. Possible values are: + 1. Biz Check: 0001 + 2. Biz Check Plus: 0002 + example: 0001 + Rcsecflag : + type: integer + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + example: 1 + LastUpdateDate : + type: datetime + description: Last update date + example: YYYY-MM-DD 00:00:00.0 + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + REQUEST: + type: object + properties: + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + 197601887ETRANSTAR TRAVEL PTE LTD + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/d&b_business_check_plus_sg_v1.0.yaml b/data/d&b_business_check_plus_sg_v1.0.yaml new file mode 100644 index 000000000..f1126ecc7 --- /dev/null +++ b/data/d&b_business_check_plus_sg_v1.0.yaml @@ -0,0 +1,2486 @@ +openapi: 3.0.1 +info: + title: D&B Business Check Plus (SG) + description: The Data microservice provides key business information, litigation information (High and Subordinate Courts) and Winding Up Trace of a company including the Business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholder, litigation information. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - Software solutions targeted at corporate finance and legal domains, e.g. in cases of mergers, joint ventures or partnerships. + - Aside from being able to protect your business via litigation checks to safeguard against reputational risk by avoiding companies potentially involved in financial crimes, the information from this microservice can serve as a quick solution for analysts or lawyers in a company whom are looking to draft documents related to cooperate finance or legal domains with one quick search. + version: '1.0.0' + x-subscribelink: d&b_business_check_plus_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/sbcp/v0/getdata: + post: + tags: + - v1.0.0 + summary: Adds a new user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + REPORT: + META_INFO: + SERVICE: + "@type": String + "#text": BCP + SYSTEM_ID: + "@type": String + "#text": DDP + CREATION_DATE: + "@type": Date + "#text": Wed Apr 08 11:37:51 MYT 2009 + USER_ID: + "@type": String + CLASS: + "@type": String + "#text": class com.technodex.ddp.xmlbean.MetaBean + REGISTRY_DETAIL: + "@className": com.technodex.ddp.report.bean.CommercialBizRegistryBean + RENEWAL_DATE: + "@type": String + "#text": 23/12/2008 + ADDRESS1: + "@type": String + "#text": 1 HARBOURFRONT AVENUE , 18 - 01 + ADDRESS2: + "@type": String + "#text": KEPPEL BAY TOWER + ADDRESS3: + "@type": String + "#text": '098632' + ADDRESS4: + "@type": String + "#text": SINGAPORE + COMP_TYPE_CODE: + "@type": String + "#text": CP + REG_DATE: + "@type": String + "#text": 14/10/1974 + REG_ACTIVITY1: + "@type": String + "#text": OTHER INVESTMENT HOLDING COMPANIES + REG_ACTIVITY2: + "@type": String + "#text": SHIP MANAGEMENT SERVICES + ACC_DATE: + "@type": String + "#text": 31/12/2007 + STATUS_EFFECT_DATE: + "@type": String + "#text": 14/10/1974 + NAME_EFFECT_DATE: + "@type": String + "#text": 14/10/1974 + EXPIRY_DATE: + "@type": String + "#text": 25/10/2009 + COMP_TYPE: + "@type": String + "#text": LIMITED PRIVATE COMPANY + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + COMP_STATUS: + "@type": String + "#text": Live Company + REG_ACTIVITY_DESC1: + "@type": String + "#text": "-" + REG_ACTIVITY_DESC2: + "@type": String + "#text": "-" + AUDITOR: + "@type": String + "#text": "-" + AUDITOR_APPMT_DATE: + "@type": String + "#text": 13/06/1990 + LAST_AR_DATE: + "@type": String + "#text": 30/06/2008 + LAST_AGM_DATE: + "@type": String + "#text": 11/06/2008 + COUNTRY_INCORP: + "@type": String + "#text": SINGAPORE + REQ_SEARCH_INFO: + "@className": com.technodex.ddp.report.bean.LitigationSearchInfoBean + COMP_NAME: + "@type": String + "#text": KAPAL MANAGEMENT (PRIVATE) LIMITED + REG_NO: + "@type": String + "#text": 197401835M + REQ_DATE: + "@type": Date + "#text": '2009-04-08 11:36:03.611' + REQ_REG_NO: + "@type": String + "#text": 197401835M + REQ_NAME: + "@type": String + "#text": KAPAL MANAGEMENT (PRIVATE) LIMITED + REQ_DATE_STR: + "@type": String + "#text": '08/04/2009 11:36:03' + EMPLOYEE_SIZE: + ELEMENTS: Employee Size + AMOUNT: '300' + LIST_BIZ_BRANCH: + "@className": com.technodex.ddp.report.bean.CommercialBizBranchBean + BIZ_BRANCH: + ADDR_BUILDING: + "@type": String + "#text": "-" + ADDR_POSTCODE: + "@type": String + "#text": '289848' + ADDR_ADDRESS1: + "@type": String + "#text": 251A ARCADIA ROAD , - - - + LIST_REG_CHARGES: + "@className": com.technodex.ddp.report.bean.CommercialBizChgRegBean + REG_CHARGES: + - CHARGE_NO: + "@type": String + "#text": '8205117' + CHARGE_DATE: + "@type": String + "#text": 26/11/1982 + CHARGEE_COMP: + "@type": String + "#text": UNITED OVERSEAS BANK LIMITED + CURRENCY: + "@type": String + "#text": "-" + AMT_SECURED: + "@type": String + "#text": '1000.00' + STATUS_SATISFACTION: + "@type": String + "#text": "-" + - CHARGE_NO: + "@type": String + "#text": '8000976' + CHARGE_DATE: + "@type": String + "#text": 21/04/1980 + CHARGEE_COMP: + "@type": String + "#text": THE DEVELOPMENT BANK OF SINGAPORE LIMITED + CURRENCY: + "@type": String + "#text": "-" + AMT_SECURED: + "@type": String + "#text": All Monies + STATUS_SATISFACTION: + "@type": String + "#text": "-" + LIST_LIQUIDATOR: + LIQUIDATOR: + - LIQ_NAME: ABUTHAHIR ABDUL GAFOOR + LIQ_ID: S1676216D + LIQ_POSITION: Liquidator + LIQ_COMP: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: 1 RAFFLES PLACE + LIQ_ADDRESS2: "#20-01" + LIQ_ADDRESS3: OUB CENTRE + LIQ_ADDRESS4: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: 30/03/2009 + - LIQ_NAME: ANGELA ANG + LIQ_ID: S1633336D + LIQ_POSITION: Liquidator + LIQ_COMP: KING FINANCIAL ADVISORY SERVICES + LIQ_ADDRESS1: LEVEL 17 MLC CENTRE 19029 + LIQ_ADDRESS2: MARTIN PLACE SYDNEY NSW 2000 AUSTRALIA + LIQ_APPOINTMENT_DATE: 18/02/2009 + LIST_WINDING_UP: + "@className": com.technodex.ddp.report.bean.CommercialBizWindingupBean + WINDING_UP: + CASE_CODE: + "@type": String + "#text": '40000' + CASE_YEAR: + "@type": String + "#text": '1999' + PLAINTIFF: + "@type": String + "#text": "-" + PLA_SOLICITOR_ID: + "@type": String + "#text": "-" + PLA_FILE_REF: + "@type": String + "#text": "-" + COURT_CODE: + "@type": String + "#text": CWU + CASE_TYPE: + "@type": String + "#text": COMPANY WINDING UP PETITION + CURRENCY1: + "@type": String + "#text": SGD + AMOUNT1: + "@type": String + "#text": '41,424.52' + CURRENCY2: + "@type": String + "#text": MYR + AMOUNT2: + "@type": String + "#text": '0.00' + CURRENCY3: + "@type": String + "#text": "-" + AMOUNT3: + "@type": String + "#text": '0.00' + BANKRUPTCY_ACT: + "@type": String + "#text": Petition for Winding Up + HEARING_DATE: + "@type": String + "#text": 15/12/2007 + ACTION_DATE: + "@type": String + "#text": 11/05/2007 + SUBJECT_NAME: + "@type": String + "#text": PROACTIVE BUILDERS + PLA_SOLICITOR: + "@type": String + "#text": "-" + PLA_LAW_FIRM: + "@type": String + "#text": NAME2 + LIST_LITIGATION: + "@className": com.technodex.ddp.report.bean.CommercialBizLitigationBean + LITIGATION: + SUBJECT_NAME: + "@type": String + "#text": SOON SOON SEAFOOD + NATURE_OF_CLAIM: + "@type": String + "#text": CONTRACT 3 + STATUS_DATE: + "@type": String + "#text": 01/05/2008 + CASE_NO: + "@type": String + "#text": MC 40001 / 1999 + DOC_REMARKS: + "@type": String + "#text": NOTICE OF DISCONTINUANCE/WITHDRAWAL 3 + CURRENCY1: + "@type": String + "#text": SGD + CURRENCY2: + "@type": String + "#text": MYR + CURRENCY3: + "@type": String + "#text": USD + CURRENCY4: + "@type": String + "#text": "-" + CURRENCY5: + "@type": String + "#text": "-" + DEF_SOLICITOR: + "@type": String + "#text": SOL2 + DEF_SOLICITOR_ID: + "@type": String + "#text": '20000000' + DEF_LAW_FIRM: + "@type": String + "#text": NAME2 + DEF_FILE_REF: + "@type": String + "#text": FILE2 + DATE_OF_WRIT: + "@type": String + "#text": 01/01/2008 + STATUS: + "@type": String + "#text": CONCLUDED 3 + AMOUNT1: + "@type": String + "#text": '100.00' + AMOUNT2: + "@type": String + "#text": '200.00' + AMOUNT3: + "@type": String + "#text": '0.00' + AMOUNT4: + "@type": String + "#text": '400.00' + AMOUNT5: + "@type": String + "#text": '0.00' + PLAINTIFF: + "@type": String + "#text": MC 40001 + PLA_SOLICITOR: + "@type": String + "#text": SOL2 + PLA_SOLICITOR_ID: + "@type": String + "#text": '20000000' + PLA_LAW_FIRM: + "@type": String + "#text": NAME2 + PLA_FILE_REF: + "@type": String + "#text": FILE2 + PLA_ID: + "@type": String + "#text": S0739038F + PLA_STATUS: + "@type": String + "#text": SETTLED - BEFORE SET DOWN + PLA_STATUS_DATE: + "@type": String + "#text": 17/10/2016 + LIST_SHARE_INTEREST_COMP: + "@className": com.technodex.ddp.report.bean.CommercialShareInterestBean + SHARE_INTEREST_COMP: + - COMP_NAME: + "@type": String + "#text": ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT: + "@type": String + "#text": '500000' + SHARE_OWNED_PERCENT: + "@type": String + "#text": '100.00' + STATUS: + "@type": String + "#text": DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + - COMP_NAME: + "@type": String + "#text": ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT: + "@type": String + "#text": '436' + SHARE_OWNED_PERCENT: + "@type": String + "#text": '100.00' + STATUS: + "@type": String + "#text": DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE: + "@className": com.technodex.ddp.report.bean.CommercialBizChgCmpBean + NAME_CHANGE: + - PREV_NAME: + "@type": String + "#text": HUA XI EATING HOUSE + EFFECT_DATE: + "@type": String + "#text": 25/10/1997 00:00:00 + - PREV_NAME: + "@type": String + "#text": SOON-SOON FISH-HEAD CURRY + EFFECT_DATE: + "@type": String + "#text": 10/06/1991 00:00:00 + LIST_SHAREHOLDER: + "@className": com.technodex.ddp.report.bean.CommercialShareHoldersBean + SHAREHOLDER: + - ADDRESS: + "@type": String + "#text": 1 HARBOURFRONT AVENUE , 18 - 01; KEPPEL BAY TOWER; 098632,SINGAPORE + COMP_ID: + "@type": String + "#text": 198200406H + NO_OF_SHARE: + "@type": String + "#text": '657' + CURRENCY: + "@type": String + "#text": UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE: + "@type": String + "#text": '2' + SHARE_TYPE: + "@type": String + "#text": Preference + SHAREHOLDER_NAME: + "@type": String + "#text": KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + ADDR_TYPE: + "@type": String + "#text": "-" + NATIONALITY: + "@type": String + "#text": SINGAPORE + - ADDRESS: + "@type": String + "#text": 1 HARBOURFRONT AVENUE , 18 - 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID: + "@type": String + "#text": 196500115G + NO_OF_SHARE: + "@type": String + "#text": '100,000' + CURRENCY: + "@type": String + "#text": SINGAPORE, DOLLARS + SHAREHOLDER_TYPE: + "@type": String + "#text": '2' + SHARE_TYPE: + "@type": String + "#text": Ordinary + SHAREHOLDER_NAME: + "@type": String + "#text": KEPPEL TELECOMMUNICATIONS & TRANSPORTATION LTD + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + ADDR_TYPE: + "@type": String + "#text": "-" + NATIONALITY: + "@type": String + "#text": SINGAPORE + LIST_CAPITAL: + "@className": com.technodex.ddp.report.bean.CommercialBizCapitalBean + CAPITAL: + - CAPITAL_CATEGORY: + "@type": String + "#text": Issued + CAPITAL_TYPE: + "@type": String + "#text": Ordinary + CURRENCY: + "@type": String + "#text": SINGAPORE, DOLLARS + CAPITAL_AMT: + "@type": String + "#text": '100,000.00' + NO_OF_SHARES: + "@type": String + "#text": '100,000' + - CAPITAL_CATEGORY: + "@type": String + "#text": Issued + CAPITAL_TYPE: + "@type": String + "#text": Preference + CURRENCY: + "@type": String + "#text": UNITED STATES OF AMERICA, DOLLARS + CAPITAL_AMT: + "@type": String + "#text": '14,600,511.00' + NO_OF_SHARES: + "@type": String + "#text": '657' + LIST_OFFICER_OWNER: + "@className": com.technodex.ddp.report.bean.CommercialBizOfficeOwerBean + OFFICER_OWNER: + - ADDRESS: + "@type": String + "#text": 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742,SINGAPORE + IDENTITY_ID: + "@type": String + "#text": S1674174D + POSITION: + "@type": String + "#text": DIRECTOR + ADDR_TYPE: + "@type": String + "#text": S + CESSATION_DATE: + "@type": String + "#text": "-" + OFFICER_NAME: + "@type": String + "#text": NGIAM SHARE CHING + CHANGE_ADDR_DATE: + "@type": String + "#text": 25/10/2008 + APPMT_DATE: + "@type": String + "#text": 30/09/2008 + NATIONALITY: + "@type": String + "#text": SINGAPORE CITIZEN + - ADDRESS: + "@type": String + "#text": 52 HUME AVENUE, 05 - 10 ; SUMMERHILL; 596230, SINGAPORE + IDENTITY_ID: + "@type": String + "#text": S2504825C + PA_REG_NO: + "@type": String + "#text": '00091' + POSITION: + "@type": String + "#text": DIRECTOR + ADDR_TYPE: + "@type": String + "#text": S + CESSATION_DATE: + "@type": String + "#text": "-" + OFFICER_NAME: + "@type": String + "#text": HENRY GOH + CHANGE_ADDR_DATE: + "@type": String + "#text": 30/10/2003 + APPMT_DATE: + "@type": String + "#text": 07/03/2006 + NATIONALITY: + "@type": String + "#text": SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT: + SALES_REVENUE_AMOUNT: + - ELEMENTS: Sales Revenue Amount + YEAR: '2008' + CURRENCY: SGD + AMOUNT: '30000.00' + - ELEMENTS: Sales Revenue Amount + YEAR: '2007' + CURRENCY: SGD + AMOUNT: '28000.00' + - ELEMENTS: Sales Revenue Amount + YEAR: '2006' + CURRENCY: SGD + AMOUNT: '27,000.00' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [REGISTRY_DETAIL] + [REQ_SEARCH_INFO] + [EMPLOYEE_SIZE] + [LIST_BIZ_BRANCH] + [LIST_REG_CHARGES] + [LIST_LIQUIDATOR] + [LIST_WINDING_UP] + [LIST_LITIGATION] + [LIST_SHARE_INTEREST_COMP] + [LIST_NAME_CHANGE] + [LIST_SHAREHOLDER] + [LIST_CAPITAL] + [LIST_OFFICER_OWNER] + [LIST_SALES_REVENUE_AMOUNT] + properties: + META_INFO: + type: object + example: + META_INFO: + SERVICE: + "@type": String + "#text": BCP + SYSTEM_ID: + "@type": String + "#text": DDP + CREATION_DATE: + "@type": Date + "#text": Wed Apr 08 11:37:51 MYT 2009 + USER_ID: + "@type": String + CLASS: + "@type": String + "#text": class com.technodex.ddp.xmlbean.MetaBean + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + CLASS + properties: + SERVICE: + type: string + description: Report requested + example: "BCP" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: datetime + description: Report request date + example: Wed Apr 08 11:37:51 MYT 2009 + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: N/A + CLASS: + type: string + description: Class location for metabean. It is for (For internal use) + example: N/A + REGISTRY_DETAIL : + type: object + example: + REGISTRY_DETAIL: + "@className": com.technodex.ddp.report.bean.CommercialBizRegistryBean + RENEWAL_DATE: + "@type": String + "#text": 23/12/2008 + ADDRESS1: + "@type": String + "#text": 1 HARBOURFRONT AVENUE , 18 - 01 + ADDRESS2: + "@type": String + "#text": KEPPEL BAY TOWER + ADDRESS3: + "@type": String + "#text": '098632' + ADDRESS4: + "@type": String + "#text": SINGAPORE + COMP_TYPE_CODE: + "@type": String + "#text": CP + REG_DATE: + "@type": String + "#text": 14/10/1974 + REG_ACTIVITY1: + "@type": String + "#text": OTHER INVESTMENT HOLDING COMPANIES + REG_ACTIVITY2: + "@type": String + "#text": SHIP MANAGEMENT SERVICES + ACC_DATE: + "@type": String + "#text": 31/12/2007 + STATUS_EFFECT_DATE: + "@type": String + "#text": 14/10/1974 + NAME_EFFECT_DATE: + "@type": String + "#text": 14/10/1974 + EXPIRY_DATE: + "@type": String + "#text": 25/10/2009 + COMP_TYPE: + "@type": String + "#text": LIMITED PRIVATE COMPANY + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + COMP_STATUS: + "@type": String + "#text": Live Company + REG_ACTIVITY_DESC1: + "@type": String + "#text": "-" + REG_ACTIVITY_DESC2: + "@type": String + "#text": "-" + AUDITOR: + "@type": String + "#text": "-" + AUDITOR_APPMT_DATE: + "@type": String + "#text": 13/06/1990 + LAST_AR_DATE: + "@type": String + "#text": 30/06/2008 + LAST_AGM_DATE: + "@type": String + "#text": 11/06/2008 + COUNTRY_INCORP: + "@type": String + "#text": SINGAPORE + description: |+ + Registry Details with following children: + RENEWAL_DATE + ADDRESS1 + ADDRESS2 + ADDRESS3 + ADDRESS4 + COMP_TYPE_CODE + REG_DATE + REG_ACTIVITY1 + REG_ACTIVITY2 + ACC_DATE + STATUS_EFFECT_DATE + NAME_EFFECT_DATE + EXPIRY_DATE + COMP_TYPE + CHANGE_ADDR_DATE + COMP_STATUS + REG_ACTIVITY_DESC1 + REG_ACTIVITY_DESC2 + AUDITOR + AUDITOR_APPMT_DATE + LAST_AR_DATE + LAST_AGM_DATE + COUNTRY_INCORP + properties: + RENEWAL_DATE: + type: string + description: Renewal Date + example: "23/12/2008" + ADDRESS1: + type: string + description: Address Line 1 + example: "1 HARBOURFRONT AVENUE , 18 - 01" + ADDRESS2: + type: string + description: Address Line 2 + example: "KEPPEL BAY TOWER" + ADDRESS3: + type: string + description: Address Line 3 + example: "098632" + ADDRESS4: + type: string + description: Address Line 4 + example: "SINGAPORE" + COMP_TYPE_CODE: + type: string + example: CP + description: |+ + Report Code. Available values are: + 1. CP Corporate + 2. SP Sole Proprietor + REG_DATE: + type: string + description: Registration Date + example: "14/10/1974" + REG_ACTIVITY1: + type: string + description: Registered Activities 1 + example: "OTHER INVESTMENT HOLDING COMPANIES" + REG_ACTIVITY2: + type: string + description: Registered Activities 2 + example: "SHIP MANAGEMENT SERVICES" + ACC_DATE: + type: string + description: Account Date + example: "31/12/2007" + STATUS_EFFECT_DATE: + type: string + description: Status Effective Date + example: "14/10/1974" + NAME_EFFECT_DATE: + type: string + description: Name Effective Date + example: "14/10/1974" + EXPIRY_DATE: + type: string + description: Expiry Date + example: "25/10/2009" + COMP_TYPE: + type: string + description: Company Type + example: "LIMITED PRIVATE COMPANY" + CHANGE_ADDR_DATE: + type: string + description: Change Address Date + example: "09/05/2003" + COMP_STATUS: + type: string + description: Company Status + example: "Live Company" + REG_ACTIVITY_DESC1: + type: string + description: Registered Activities Description + example: + REG_ACTIVITY_DESC2: + type: string + description: Registered Activities Description + example: + AUDITOR: + type: string + description: Auditor Name + example: + AUDITOR_APPMT_DATE: + type: string + description: Auditor Appointment Date + example: "13/06/1990" + LAST_AR_DATE: + type: string + description: Date of Last AR + example: "30/06/2008" + LAST_AGM_DATE: + type: string + description: Date of Last AGM + example: "11/06/2008" + COUNTRY_INCORP: + type: string + description: Country Incorporated + example: "SINGAPORE" + REQ_SEARCH_INFO : + type: object + example: + REQ_SEARCH_INFO: + "@className": com.technodex.ddp.report.bean.LitigationSearchInfoBean + COMP_NAME: + "@type": String + "#text": KAPAL MANAGEMENT (PRIVATE) LIMITED + REG_NO: + "@type": String + "#text": 197401835M + REQ_DATE: + "@type": Date + "#text": '2009-04-08 11:36:03.611' + REQ_REG_NO: + "@type": String + "#text": 197401835M + REQ_NAME: + "@type": String + "#text": KAPAL MANAGEMENT (PRIVATE) LIMITED + REQ_DATE_STR: + "@type": String + "#text": '08/04/2009 11:36:03' + description: |+ + Request criteria & search record with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REG_NO: + type: string + description: Subject’s ID Number (individual) or Registration Number (company/business) + example: "197401835M" + REQ_DATE: + type: datetime + description: Report Requested Date + example: 2009-04-08 11:36:03.611 + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197401835M" + REQ_NAME: + type: string + description: Request Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REQ_DATE_STR: + type: string + description: Request Date String + example: "08/04/2009 11:36:03" + EMPLOYEE_SIZE : + type: object + description: |+ + Employee Size details with following children: + ELEMENTS + AMOUNT + example: + EMPLOYEE_SIZE: + ELEMENTS: Employee Size + AMOUNT: '300' + properties: + ELEMENTS: + type: string + description: Description + example: "Employee Size" + AMOUNT: + type: integer + description: Number of employee + example: 300 + LIST_BIZ_BRANCH : + type: array + description: |+ + List of Business Branches with following children: + [BIZ_BRANCH] + example: + LIST_BIZ_BRANCH: + "@className": com.technodex.ddp.report.bean.CommercialBizBranchBean + BIZ_BRANCH: + ADDR_BUILDING: + "@type": String + "#text": "-" + ADDR_POSTCODE: + "@type": String + "#text": '289848' + ADDR_ADDRESS1: + "@type": String + "#text": 251A ARCADIA ROAD , - - - + items: + properties: + BIZ_BRANCH : + type: object + description: |+ + Business Branches with following children: + ADDR_BUILDING + ADDR_POSTCODE + ADDR_ADDRESS1 + example: + BIZ_BRANCH: + ADDR_BUILDING: + "@type": String + "#text": "-" + ADDR_POSTCODE: + "@type": String + "#text": '289848' + ADDR_ADDRESS1: + "@type": String + "#text": 251A ARCADIA ROAD , - - - + properties: + ADDR_BUILDING: + type: string + description: Building Name + example: + ADDR_POSTCODE: + type: string + description: Postcode + example: 289848 + ADDR_ADDRESS1: + type: string + description: Address + example: 251A ARCADIA ROAD + LIST_REG_CHARGES: + type: array + description: |+ + List of Registered Charges with following children: + [REG_CHARGES] + example: + LIST_REG_CHARGES: + "@className": com.technodex.ddp.report.bean.CommercialBizChgRegBean + REG_CHARGES: + CHARGE_NO: + "@type": String + "#text": '8205117' + CHARGE_DATE: + "@type": String + "#text": 26/11/1982 + CHARGEE_COMP: + "@type": String + "#text": UNITED OVERSEAS BANK LIMITED + CURRENCY: + "@type": String + "#text": "-" + AMT_SECURED: + "@type": String + "#text": '1000.00' + STATUS_SATISFACTION: + "@type": String + "#text": "-" + items: + properties: + REG_CHARGES : + type: object + description: |+ + Registered Charges details with following children: + CHARGE_NO + CHARGE_DATE + CHARGEE_COMP + CURRENCY + AMT_SECURED + STATUS_SATISFACTION + example: + REG_CHARGES: + CHARGE_NO: + "@type": String + "#text": '8205117' + CHARGE_DATE: + "@type": String + "#text": 26/11/1982 + CHARGEE_COMP: + "@type": String + "#text": UNITED OVERSEAS BANK LIMITED + CURRENCY: + "@type": String + "#text": "-" + AMT_SECURED: + "@type": String + "#text": '1000.00' + STATUS_SATISFACTION: + "@type": String + "#text": "-" + properties: + CHARGE_NO : + type: string + description: Charge No. + example: 8205117 + CHARGE_DATE: + type: string + description: Charge Date + example: 26/11/1982 + CHARGEE_COMP: + type: string + description: Charges Company + example: UNITED OVERSEAS BANK LIMITED + CURRENCY: + type: string + description: Currency + example: + AMT_SECURED: + type: string + description: Amount Secured + example: 1000.00 + STATUS_SATISFACTION: + type: string + description: Status of Satisfaction + example: + LIST_LIQUIDATOR: + type: array + description: |+ + List of Liquidator / Receiver / Judicial Manager with following children: + [LIQUIDATOR] + example: + LIST_LIQUIDATOR: + LIQUIDATOR: + LIQ_NAME: ABUTHAHIR ABDUL GAFOOR + LIQ_ID: S1676216D + LIQ_POSITION: Liquidator + LIQ_COMP: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: 1 RAFFLES PLACE + LIQ_ADDRESS2: "#20-01" + LIQ_ADDRESS3: OUB CENTRE + LIQ_ADDRESS4: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: 30/03/2009 + items: + properties: + LIQUIDATOR : + type: object + description: |+ + Liquidator details with following children: + LIQ_POSITION + LIQ_ID + LIQ_NAME + LIQ_COMP + LIQ_ADDRESS1 + LIQ_ADDRESS2 + LIQ_ADDRESS3 + LIQ_ADDRESS4 + LIQ_APPOINTMENT_DATE + example: + LIQUIDATOR: + LIQ_NAME: ABUTHAHIR ABDUL GAFOOR + LIQ_ID: S1676216D + LIQ_POSITION: Liquidator + LIQ_COMP: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: 1 RAFFLES PLACE + LIQ_ADDRESS2: "#20-01" + LIQ_ADDRESS3: OUB CENTRE + LIQ_ADDRESS4: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: 30/03/2009 + properties: + LIQ_POSITION: + type: string + description: Liquidator / Receiver / Judicial Manager Position + example: Liquidator + LIQ_ID: + type: string + description: Liquidator / Receiver / Judicial Manager ID + example: S1676216D + LIQ_NAME : + type: string + description: Liquidator / Receiver / Judicial Manager Name + example: ABUTHAHIR ABDUL GAFOOR + LIQ_COMP: + type: string + description: Liquidator / Receiver / Judicial Manager Company Name + example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: + type: string + description: Liquidator / Receiver / Judicial Manager Address 1 + example: 1 RAFFLES PLACE + LIQ_ADDRESS2: + type: string + description: Liquidator / Receiver / Judicial Manager Address 2 + example: #20-01 + LIQ_ADDRESS3: + type: string + description: Liquidator / Receiver / Judicial Manager Address 3 + example: OUB CENTRE + LIQ_ADDRESS4: + type: string + description: Liquidator / Receiver / Judicial Manager Address 4 + example: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: + type: string + description: Liquidator / Receiver / Judicial Manager Appointment Date + example: 30/03/2009 + LIST_WINDING_UP : + type: array + description: |+ + List of Winding Up with following children: + [WINDING_UP] + example: + LIST_WINDING_UP: + "@className": com.technodex.ddp.report.bean.CommercialBizWindingupBean + WINDING_UP: + CASE_CODE: + "@type": String + "#text": '40000' + CASE_YEAR: + "@type": String + "#text": '1999' + PLAINTIFF: + "@type": String + "#text": "-" + PLA_SOLICITOR_ID: + "@type": String + "#text": "-" + PLA_FILE_REF: + "@type": String + "#text": "-" + COURT_CODE: + "@type": String + "#text": CWU + CASE_TYPE: + "@type": String + "#text": COMPANY WINDING UP PETITION + CURRENCY1: + "@type": String + "#text": SGD + AMOUNT1: + "@type": String + "#text": '41,424.52' + CURRENCY2: + "@type": String + "#text": MYR + AMOUNT2: + "@type": String + "#text": '0.00' + CURRENCY3: + "@type": String + "#text": "-" + AMOUNT3: + "@type": String + "#text": '0.00' + BANKRUPTCY_ACT: + "@type": String + "#text": Petition for Winding Up + HEARING_DATE: + "@type": String + "#text": 15/12/2007 + ACTION_DATE: + "@type": String + "#text": 11/05/2007 + SUBJECT_NAME: + "@type": String + "#text": PROACTIVE BUILDERS + PLA_SOLICITOR: + "@type": String + "#text": "-" + PLA_LAW_FIRM: + "@type": String + "#text": NAME2 + items: + properties: + WINDING_UP : + type: object + description: |+ + Winding Up details with following children: + CASE_CODE + CASE_YEAR + PLAINTIFF + PLA_SOLICITOR_ID + PLA_FILE_REF + PLA_LAW_FIRM + SUBJECT_NAME + COURT_CODE + CASE_TYPE + CURRENCY1 + AMOUNT1 + CURRENCY2 + AMOUNT2 + CURRENCY3 + AMOUNT3 + ACTION_DATE + BANKRUPTCY_ACT + HEARING_DATE + PLA_SOLICITOR + example: + WINDING_UP: + CASE_CODE: + "@type": String + "#text": '40000' + CASE_YEAR: + "@type": String + "#text": '1999' + PLAINTIFF: + "@type": String + "#text": "-" + PLA_SOLICITOR_ID: + "@type": String + "#text": "-" + PLA_FILE_REF: + "@type": String + "#text": "-" + COURT_CODE: + "@type": String + "#text": CWU + CASE_TYPE: + "@type": String + "#text": COMPANY WINDING UP PETITION + CURRENCY1: + "@type": String + "#text": SGD + AMOUNT1: + "@type": String + "#text": '41,424.52' + CURRENCY2: + "@type": String + "#text": MYR + AMOUNT2: + "@type": String + "#text": '0.00' + CURRENCY3: + "@type": String + "#text": "-" + AMOUNT3: + "@type": String + "#text": '0.00' + BANKRUPTCY_ACT: + "@type": String + "#text": Petition for Winding Up + HEARING_DATE: + "@type": String + "#text": 15/12/2007 + ACTION_DATE: + "@type": String + "#text": 11/05/2007 + SUBJECT_NAME: + "@type": String + "#text": PROACTIVE BUILDERS + PLA_SOLICITOR: + "@type": String + "#text": "-" + PLA_LAW_FIRM: + "@type": String + "#text": NAME2 + properties: + CASE_CODE : + type: string + description: Case Code + example: 40000 + CASE_YEAR : + type: string + description: Case Year + example: 1999 + PLAINTIFF : + type: string + description: Plaintiff Name + example: + PLA_SOLICITOR_ID : + type: string + description: Pla. Solicitor ID + example: + PLA_FILE_REF : + type: string + description: Pla. File Ref. + example: + PLA_LAW_FIRM : + type: string + description: Pla. Law Firm + example: NAME2 + SUBJECT_NAME : + type: string + description: Subject Name + example: PROACTIVE BUILDERS + COURT_CODE : + type: string + description: Court Code + example: CWU + CASE_TYPE : + type: string + description: Case Type + example: COMPANY WINDING UP PETITION + CURRENCY1 : + type: string + description: Currency 1 + example: SGD + AMOUNT1 : + type: string + description: Amount 1 + example: 41,424.52 + CURRENCY2 : + type: string + description: Currency 2 + example: MYR + AMOUNT2 : + type: string + description: Amount 2 + example: 0.00 + CURRENCY3 : + type: string + description: Currency 3 + example: + AMOUNT3 : + type: string + description: Amount 3 + example: 0.00 + ACTION_DATE : + type: string + description: Action Date + example: 11/05/2007 + BANKRUPTCY_ACT : + type: string + description: Act of Bankruptcy + example: Petition for Winding Up + HEARING_DATE : + type: string + description: Hearing Date + example: 15/12/2007 + PLA_SOLICITOR : + type: string + description: Pla. Solicitor + example: + LIST_LITIGATION : + type: array + description: |+ + List of Winding Up with following children: + [LITIGATION] + example: + LIST_LITIGATION: + "@className": com.technodex.ddp.report.bean.CommercialBizLitigationBean + LITIGATION: + SUBJECT_NAME: + "@type": String + "#text": SOON SOON SEAFOOD + NATURE_OF_CLAIM: + "@type": String + "#text": CONTRACT 3 + STATUS_DATE: + "@type": String + "#text": 01/05/2008 + CASE_NO: + "@type": String + "#text": MC 40001 / 1999 + DOC_REMARKS: + "@type": String + "#text": NOTICE OF DISCONTINUANCE/WITHDRAWAL 3 + CURRENCY1: + "@type": String + "#text": SGD + CURRENCY2: + "@type": String + "#text": MYR + CURRENCY3: + "@type": String + "#text": USD + CURRENCY4: + "@type": String + "#text": "-" + CURRENCY5: + "@type": String + "#text": "-" + DEF_SOLICITOR: + "@type": String + "#text": SOL2 + DEF_SOLICITOR_ID: + "@type": String + "#text": '20000000' + DEF_LAW_FIRM: + "@type": String + "#text": NAME2 + DEF_FILE_REF: + "@type": String + "#text": FILE2 + DATE_OF_WRIT: + "@type": String + "#text": 01/01/2008 + STATUS: + "@type": String + "#text": CONCLUDED 3 + AMOUNT1: + "@type": String + "#text": '100.00' + AMOUNT2: + "@type": String + "#text": '200.00' + AMOUNT3: + "@type": String + "#text": '0.00' + AMOUNT4: + "@type": String + "#text": '400.00' + AMOUNT5: + "@type": String + "#text": '0.00' + PLAINTIFF: + "@type": String + "#text": MC 40001 + PLA_SOLICITOR: + "@type": String + "#text": SOL2 + PLA_SOLICITOR_ID: + "@type": String + "#text": '20000000' + PLA_LAW_FIRM: + "@type": String + "#text": NAME2 + PLA_FILE_REF: + "@type": String + "#text": FILE2 + PLA_ID: + "@type": String + "#text": S0739038F + PLA_STATUS: + "@type": String + "#text": SETTLED - BEFORE SET DOWN + PLA_STATUS_DATE: + "@type": String + "#text": 17/10/2016 + items: + properties: + LITIGATION : + type: object + description: |+ + List of Winding Up with following children: + SUBJECT_NAME + NATURE_OF_CLAIM + STATUS_DATE + CASE_NO + DOC_REMARK + CURRENCY1 + CURRENCY2 + CURRENCY3 + CURRENCY4 + CURRENCY5 + DEF_SOLICITOR + DEF_SOLICITOR_ID + DEF_LAW_FIRM + DEF_FILE_REF + DATE_OF_WRIT + STATUS + AMOUNT1 + AMOUNT2 + AMOUNT3 + AMOUNT4 + AMOUNT5 + PLAINTIFF + PLA_SOLICITOR + PLA_SOLICITOR_ID + PLA_LAW_FIRM + PLA_FILE_REF + PLA_ID + PLA_STATUS + PLA_STATUS_DATE + example: + LITIGATION: + SUBJECT_NAME: + "@type": String + "#text": SOON SOON SEAFOOD + NATURE_OF_CLAIM: + "@type": String + "#text": CONTRACT 3 + STATUS_DATE: + "@type": String + "#text": 01/05/2008 + CASE_NO: + "@type": String + "#text": MC 40001 / 1999 + DOC_REMARKS: + "@type": String + "#text": NOTICE OF DISCONTINUANCE/WITHDRAWAL 3 + CURRENCY1: + "@type": String + "#text": SGD + CURRENCY2: + "@type": String + "#text": MYR + CURRENCY3: + "@type": String + "#text": USD + CURRENCY4: + "@type": String + "#text": "-" + CURRENCY5: + "@type": String + "#text": "-" + DEF_SOLICITOR: + "@type": String + "#text": SOL2 + DEF_SOLICITOR_ID: + "@type": String + "#text": '20000000' + DEF_LAW_FIRM: + "@type": String + "#text": NAME2 + DEF_FILE_REF: + "@type": String + "#text": FILE2 + DATE_OF_WRIT: + "@type": String + "#text": 01/01/2008 + STATUS: + "@type": String + "#text": CONCLUDED 3 + AMOUNT1: + "@type": String + "#text": '100.00' + AMOUNT2: + "@type": String + "#text": '200.00' + AMOUNT3: + "@type": String + "#text": '0.00' + AMOUNT4: + "@type": String + "#text": '400.00' + AMOUNT5: + "@type": String + "#text": '0.00' + PLAINTIFF: + "@type": String + "#text": MC 40001 + PLA_SOLICITOR: + "@type": String + "#text": SOL2 + PLA_SOLICITOR_ID: + "@type": String + "#text": '20000000' + PLA_LAW_FIRM: + "@type": String + "#text": NAME2 + PLA_FILE_REF: + "@type": String + "#text": FILE2 + PLA_ID: + "@type": String + "#text": S0739038F + PLA_STATUS: + "@type": String + "#text": SETTLED - BEFORE SET DOWN + PLA_STATUS_DATE: + "@type": String + "#text": 17/10/2016 + properties: + SUBJECT_NAME : + type: string + description: Subject Name + example: "SOON SOON SEAFOOD" + NATURE_OF_CLAIM : + type: string + example: "CONTRACT 3" + description: Nature of Claim + STATUS_DATE : + type: string + example: "01/05/2008" + description: Status Date + CASE_NO : + type: string + example: "MC 40001 / 1999" + description: Case No + DOC_REMARKS : + type: string + example: "NOTICE OF DISCONTINUANCE/WITHDRAWAL 3" + description: Document Remark + CURRENCY1 : + type: string + example: "SGD" + description: Currency 1 + CURRENCY2 : + type: string + example: "MYR" + description: Currency 2 + CURRENCY3 : + type: string + example: "USD" + description: Currency 3 + CURRENCY4 : + type: string + example: "-" + description: Currency 4 + CURRENCY5 : + type: string + example: "-" + description: Currency 5 + DEF_SOLICITOR : + type: string + example: "SOL2" + description: Def. Solicitor + DEF_SOLICITOR_ID : + type: string + example: "20000000" + description: Def. Solicitor ID + DEF_LAW_FIRM : + type: string + example: "NAME2" + description: Def. Law Firm + DEF_FILE_REF : + type: string + example: "FILE2" + description: Def. File Ref. + DATE_OF_WRIT : + type: string + example: "01/01/2008" + description: Date Writ + STATUS : + type: string + example: "CONCLUDED 3" + description: Status + AMOUNT1 : + type: string + example: "100.00" + description: Amount 1 + AMOUNT2 : + type: string + example: "200.00" + description: Amount 2 + AMOUNT3 : + type: string + example: "0.00" + description: Amount 3 + AMOUNT4 : + type: string + example: "400.00" + description: Amount 4 + AMOUNT5 : + type: string + example: "0.00" + description: Amount 5 + PLAINTIFF : + type: string + example: "MC 40001" + description: Plaintiff Name + PLA_SOLICITOR: + type: string + example: "SOL2" + description: plantiff Solicitor + PLA_SOLICITOR_ID: + type: string + example: "20000000" + description: plantiff Solicitor ID + PLA_LAW_FIRM : + type: string + example: "NAME2" + description: Pla. Law Firm + PLA_FILE_REF : + type: string + example: "FILE2" + description: Pla. File Ref. + PLA_ID: + type: string + example: "S0739038F" + description: Plaintiff ID + PLA_STATUS: + type: string + example: "SETTLED - BEFORE SET DOWN" + description: Plaintiff Status + PLA_STATUS_DATE : + type: string + example: "17/10/2016" + description: Plaintiff Status Date + LIST_SHARE_INTEREST_COMP : + type: array + description: |+ + List of Share Interest In Companies with following children: + [SHARE_INTEREST_COMP] + example: + LIST_SHARE_INTEREST_COMP: + "@className": com.technodex.ddp.report.bean.CommercialShareInterestBean + SHARE_INTEREST_COMP: + COMP_NAME: + "@type": String + "#text": ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT: + "@type": String + "#text": '500000' + SHARE_OWNED_PERCENT: + "@type": String + "#text": '100.00' + STATUS: + "@type": String + "#text": DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + items: + properties: + SHARE_INTEREST_COMP : + type: object + description: |+ + Share Interest In Companies details with following children: + COMP_NAME + SHARE_OWNED_UNIT + SHARE_OWNED_PERCENT + STATUS + example: + SHARE_INTEREST_COMP: + COMP_NAME: + "@type": String + "#text": ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT: + "@type": String + "#text": '500000' + SHARE_OWNED_PERCENT: + "@type": String + "#text": '100.00' + STATUS: + "@type": String + "#text": DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + properties: + COMP_NAME : + type: string + description: Company Name + example: ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT : + type: string + description: Shares Owned Unit + example: 500000 + SHARE_OWNED_PERCENT : + type: string + description: Shares Owned Value (%) + example: 100.00 + STATUS : + type: string + description: Status + example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE : + type: array + description: |+ + List of Change of Company/Business Name(s) with following children: + [NAME_CHANGE] + example: + LIST_NAME_CHANGE: + "@className": com.technodex.ddp.report.bean.CommercialBizChgCmpBean + NAME_CHANGE: + PREV_NAME: + "@type": String + "#text": HUA XI EATING HOUSE + EFFECT_DATE: + "@type": String + "#text": 25/10/1997 00:00:00 + items: + properties: + NAME_CHANGE : + type: object + description: |+ + Change of Company/Business Name(s) with following children: + PREV_NAME + EFFECT_DATE + example: + NAME_CHANGE: + PREV_NAME: + "@type": String + "#text": HUA XI EATING HOUSE + EFFECT_DATE: + "@type": String + "#text": 25/10/1997 00:00:00 + properties: + PREV_NAME : + type: string + description: Previous Name + example: HUA XI EATING HOUSE + EFFECT_DATE : + type: string + description: Effective Date + example: 25/10/1997 00:00:00 + LIST_SHAREHOLDER : + type: array + description: |+ + List of Shareholders with following children: + [SHAREHOLDER] + example: + LIST_SHAREHOLDER: + "@className": com.technodex.ddp.report.bean.CommercialShareHoldersBean + SHAREHOLDER: + ADDRESS: + "@type": String + "#text": |- + 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, + SINGAPORE + COMP_ID: + "@type": String + "#text": 198200406H + NO_OF_SHARE: + "@type": String + "#text": '657' + CURRENCY: + "@type": String + "#text": UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE: + "@type": String + "#text": '2' + SHARE_TYPE: + "@type": String + "#text": Preference + SHAREHOLDER_NAME: + "@type": String + "#text": |- + KEPPEL COMMUNICATIONS PTE + LTD + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + ADDR_TYPE: + "@type": String + "#text": "-" + NATIONALITY: + "@type": String + "#text": SINGAPORE + items: + properties: + SHAREHOLDER : + type: object + description: |+ + Shareholders details with following children: + ADDRESS + COMP_ID + NO_OF_SHARE + CURRENCY + SHAREHOLDER_TYPE + SHARE_TYPE + SHAREHOLDER_NAME + CHANGE_ADDR_DATE + ADDR_TYPE + NATIONALITY + example: + SHAREHOLDER: + ADDRESS: + "@type": String + "#text": |- + 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, + SINGAPORE + COMP_ID: + "@type": String + "#text": 198200406H + NO_OF_SHARE: + "@type": String + "#text": '657' + CURRENCY: + "@type": String + "#text": UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE: + "@type": String + "#text": '2' + SHARE_TYPE: + "@type": String + "#text": Preference + SHAREHOLDER_NAME: + "@type": String + "#text": |- + KEPPEL COMMUNICATIONS PTE + LTD + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + ADDR_TYPE: + "@type": String + "#text": "-" + NATIONALITY: + "@type": String + "#text": SINGAPORE + properties: + ADDRESS : + type: string + description: Address + example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID : + type: string + description: Company/ Identity No. + example: 198200406H + NO_OF_SHARE : + type: string + description: No. of Shares + example: 657 + CURRENCY : + type: string + description: Currency + example: UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE : + type: string + description: |+ + Indicator for Shareholder type. + Possible values are: + 1 Individual + 2 Company + 3 Unregistered foreign company + 4 Unregistered local company + example: 2 + SHARE_TYPE : + type: string + description: Share Type + example: Preference + SHAREHOLDER_NAME : + type: string + description: Shareholder Name + example: KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 09/05/2003 + ADDR_TYPE : + type: string + description: |+ + Address Type, indicates if it is Singapore or foreign address. + Possible values are: + S Indicates Singapore address + - Indicates foreign address + example: S + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE + LIST_CAPITAL : + type: array + description: |+ + List of Capital details with following children: + [CAPITAL] + example: + LIST_CAPITAL: + "@className": com.technodex.ddp.report.bean.CommercialBizCapitalBean + CAPITAL: + CAPITAL_CATEGORY: + "@type": String + "#text": Issued + CAPITAL_TYPE: + "@type": String + "#text": Ordinary + CURRENCY: + "@type": String + "#text": SINGAPORE, DOLLARS + CAPITAL_AMT: + "@type": String + "#text": '100,000.00' + NO_OF_SHARES: + "@type": String + "#text": '100,000' + items: + properties: + CAPITAL : + type: object + description: |+ + Capital details with following children: + CAPITAL_CATEGORY + CAPITAL_TYPE + CURRENCY + CAPITAL_AMT + NO_OF_SHARES + example: + CAPITAL: + CAPITAL_CATEGORY: + "@type": String + "#text": Issued + CAPITAL_TYPE: + "@type": String + "#text": Ordinary + CURRENCY: + "@type": String + "#text": SINGAPORE, DOLLARS + CAPITAL_AMT: + "@type": String + "#text": '100,000.00' + NO_OF_SHARES: + "@type": String + "#text": '100,000' + properties: + CAPITAL_CATEGORY : + type: string + description: Capital Category + example: Issued + CAPITAL_TYPE : + type: string + description: Capital Type + example: Ordinary + CURRENCY : + type: string + description: Currency + example: SINGAPORE, DOLLARS + CAPITAL_AMT : + type: string + description: Capital Amount + example: 100,000.00 + NO_OF_SHARES : + type: string + description: Nos. of Shares + example: 100,000 + LIST_OFFICER_OWNER : + type: array + description: |+ + List of Officer(s) / Owner(s) with following children: + [OFFICER_OWNER] + example: + LIST_OFFICER_OWNER: + "@className": com.technodex.ddp.report.bean.CommercialBizOfficeOwerBean + OFFICER_OWNER: + ADDRESS: + "@type": String + "#text": |- + 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, + SINGAPORE + IDENTITY_ID: + "@type": String + "#text": S1674174D + POSITION: + "@type": String + "#text": DIRECTOR + ADDR_TYPE: + "@type": String + "#text": S + CESSATION_DATE: + "@type": String + "#text": "-" + OFFICER_NAME: + "@type": String + "#text": NGIAM SHARE CHING + CHANGE_ADDR_DATE: + "@type": String + "#text": 25/10/2008 + APPMT_DATE: + "@type": String + "#text": 30/09/2008 + NATIONALITY: + "@type": String + "#text": SINGAPORE CITIZEN + items: + properties: + OFFICER_OWNER : + type: object + description: |+ + Officer(s) / Owner(s) details with following children: + ADDRESS + IDENTITY_ID + PA_REG_NO + POSITION + ADDR_TYPE + CESSATION_DATE + OFFICER_NAME + CHANGE_ADDR_DATE + APPMT_DATE + NATIONALITY + example: + OFFICER_OWNER: + ADDRESS: + "@type": String + "#text": |- + 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, + SINGAPORE + IDENTITY_ID: + "@type": String + "#text": S1674174D + POSITION: + "@type": String + "#text": DIRECTOR + ADDR_TYPE: + "@type": String + "#text": S + CESSATION_DATE: + "@type": String + "#text": "-" + OFFICER_NAME: + "@type": String + "#text": NGIAM SHARE CHING + CHANGE_ADDR_DATE: + "@type": String + "#text": 25/10/2008 + APPMT_DATE: + "@type": String + "#text": 30/09/2008 + NATIONALITY: + "@type": String + "#text": SINGAPORE CITIZEN + properties: + ADDRESS : + type: string + description: Address + example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE + IDENTITY_ID : + type: string + description: Identity No. + example: S1674174D + PA_REG_NO : + type: string + description: Public Accountant Registration No. + example: 00091 + POSITION : + type: string + description: Position + example: DIRECTOR + ADDR_TYPE : + type: string + description: |+ + Address Type, indicates if it is Singapore or foreign address. + Possible values are: + S Indicates Singapore address + - Indicates foreign address + example: S + CESSATION_DATE : + type: string + description: Cessation Date + example: 30/10/2003 + OFFICER_NAME : + type: string + description: Officer Name + example: HENRY GOH + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 30/10/2003 + APPMT_DATE : + type: string + description: Appointment Date + example: 30/10/2003 + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT : + type: array + description: |+ + List of Sales Revenue Amount with following children: + [SALES_REVENUE_AMOUNT] + example: + LIST_SALES_REVENUE_AMOUNT: + SALES_REVENUE_AMOUNT: + ELEMENTS: Sales Revenue Amount + YEAR: '2008' + CURRENCY: SGD + AMOUNT: '30000.00' + items: + properties: + SALES_REVENUE_AMOUNT : + type: object + description: |+ + Sales Revenue Amount details with following children: + ELEMENTS + YEAR + CURRENCY + AMOUNT + example: + SALES_REVENUE_AMOUNT: + ELEMENTS: Sales Revenue Amount + YEAR: '2008' + CURRENCY: SGD + AMOUNT: '30000.00' + properties: + ELEMENTS : + type: string + description: Description + example: Sales Revenue Amount + YEAR : + type: string + description: Year + example: 2008 + CURRENCY : + type: string + description: Currency + example: SGD + AMOUNT : + type: string + description: Amount. Amount values that higher than 1000 have a comma to delimit every 3 digits of the amount value. + example: 30000.00 + LIST_Ddrptcount : + type: array + description: |+ + List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: + [Ddrptcount] + example: + items: + properties: + Ddrptcount : + type: object + description: |+ + 6 XML tags (open then close) displays + Search By Financial Sectors (counts for 3 recent years) + Search By Non- Financial Sectors (counts for 3 recent years) + Following children are: + Rcyear + RcFlag (only respond for the year exists) + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) + Rcsecflag + LastUpdateDate (only respond for the year exists) + example: + properties: + Rcyear : + type: string + description: To show the year + example: 2017 + RcFlag : + type: string + description: Internal database value + example: N/A + Rcjan : + type: integer + description: Count for January + example: 1 + Rcfeb : + type: integer + description: Count for February + example: 1 + Rcmar : + type: integer + description: Count for March + example: 1 + Rcapr : + type: integer + description: Count for April + example: 1 + Rcmay : + type: integer + description: Count for May + example: 1 + Rcjun : + type: integer + description: Count for June + example: 1 + Rcjul : + type: integer + description: Count for July + example: 1 + Rcaug : + type: integer + description: Count for August + example: 1 + Rcsep : + type: integer + description: Count for September + example: 1 + Rcoct : + type: integer + description: Count for October + example: 1 + Rcnov : + type: integer + description: Count for November + example: 1 + Rcdec : + type: integer + description: Count for December + example: 1 + Rcid : + type: string + description: |+ + Internal database value, respond value from table Primary Key ID + It is for (For internal use) + example: N/A + Rcreg : + type: string + description: Company Registration Number + example: + Rcrptyid : + type: string + description: |+ + Product Type. Possible values are: + 1. Biz Check: 0001 + 2. Biz Check Plus: 0002 + example: 0001 + Rcsecflag : + type: integer + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + example: 1 + LastUpdateDate : + type: datetime + description: Last update date + example: YYYY-MM-DD 00:00:00.0 + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + properties: + total_items: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + subject_idno: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + subject_name: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized and Standardized results in Json Format + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/d&b_business_check_sg.yaml b/data/d&b_business_check_sg.yaml new file mode 100644 index 000000000..a1df33953 --- /dev/null +++ b/data/d&b_business_check_sg.yaml @@ -0,0 +1,1144 @@ +openapi: 3.0.1 +info: + title: D&B Business Check (SG) + description: |+ + This Data microservice provides key business information of a Singapore-registered company and includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - For software solutions that require general background checks of a company. This microservice can provide a high level of scrutiny of potential business associates, and throw light on the risks that cannot be detected by geopolitical analysis or batch screening levels. + - For example, this microservice can be used to check if a Singapore-registered company meets regulations, such as if the company complies with anti-money laundering, anti-bribery, and corruption regulations by looking at registered activities, shareholders details, and more. + - It can also be used to simplify the due diligence process, by identify risk issues using a range of reports that meet different compliance requirements. + - It can also be used to protect your business – safeguard against reputational risk by avoiding those involved in financial crime. + - It can also be used for finance-related domains such as vehicle leasing, loans, enterprise credit terms and so on. Updated daily. + version: '0.1.0' + x-subscribelink: d&b_business_check_sg +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Aug 15, 2019" +paths: + /dnb/prod/sbc: + post: + tags: + - v0.1.0 + summary: Adds a new user + requestBody: + content: + application/xml: + schema: + $ref: '#/components/schemas/REQUEST' + responses: + '200': + description: Ok + content: + application/xml: + schema: + $ref: '#/components/schemas/success' + example: |+ + string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string string 0
string
+ string string string string string string string string string string string string string
string
+ + string string string string string string string string string string string string string string string + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [REGISTRY_DETAIL] + [REQ_SEARCH_INFO] + [EMPLOYEE_SIZE] + [LIST_BIZ_BRANCH] + [LIST_REG_CHARGES] + [LIST_LIQUIDATOR] + [LIST_SHARE_INTEREST_COMP] + [LIST_NAME_CHANGE] + [LIST_SHAREHOLDER] + [LIST_CAPITAL] + [LIST_OFFICER_OWNER] + [LIST_SALES_REVENUE_AMOUNT] + properties: + META_INFO: + type: object + example: |+ + + + + + + + + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + CLASS + properties: + SERVICE: + type: string + description: Report requested + example: "BC" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: datetime + description: Report request date + example: "Wed Apr 08 11:37:51 MYT 2009" + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: "N/A" + CLASS: + type: string + description: Class location for metabean. It is for (For internal use) + example: "N/A" + REGISTRY_DETAIL : + type: object + example: |+ + + + + + + + + + + + + + + + + + + + + + + + + + + description: |+ + Registry Details with following children: + RENEWAL_DATE + ADDRESS1 + ADDRESS2 + ADDRESS3 + ADDRESS4 + COMP_TYPE_CODE + REG_DATE + REG_ACTIVITY1 + REG_ACTIVITY2 + ACC_DATE + STATUS_EFFECT_DATE + NAME_EFFECT_DATE + EXPIRY_DATE + COMP_TYPE + CHANGE_ADDR_DATE + COMP_STATUS + REG_ACTIVITY_DESC1 + REG_ACTIVITY_DESC2 + AUDITOR + AUDITOR_APPMT_DATE + LAST_AR_DATE + LAST_AGM_DATE + COUNTRY_INCORP + properties: + RENEWAL_DATE: + type: string + description: Renewal Date + example: "23/12/2008" + ADDRESS1: + type: string + description: Address Line 1 + example: "1 HARBOURFRONT AVENUE , 18 - 01" + ADDRESS2: + type: string + description: Address Line 2 + example: "KEPPEL BAY TOWER" + ADDRESS3: + type: string + description: Address Line 3 + example: "098632" + ADDRESS4: + type: string + description: Address Line 4 + example: "SINGAPORE" + COMP_TYPE_CODE: + type: string + example: CP + description: |+ + Report Code. Available values are: + 1. CP Corporate + 2. SP Sole Proprietor + REG_DATE: + type: string + description: Registration Date + example: "14/10/1974" + REG_ACTIVITY1: + type: string + description: Registered Activities 1 + example: "OTHER INVESTMENT HOLDING COMPANIES" + REG_ACTIVITY2: + type: string + description: Registered Activities 2 + example: "SHIP MANAGEMENT SERVICES" + ACC_DATE: + type: string + description: Account Date + example: "31/12/2007" + STATUS_EFFECT_DATE: + type: string + description: Status Effective Date + example: "14/10/1974" + NAME_EFFECT_DATE: + type: string + description: Name Effective Date + example: "14/10/1974" + EXPIRY_DATE: + type: string + description: Expiry Date + example: "25/10/2009" + COMP_TYPE: + type: string + description: Company Type + example: "LIMITED PRIVATE COMPANY" + CHANGE_ADDR_DATE: + type: string + description: Change Address Date + example: "09/05/2003" + COMP_STATUS: + type: string + description: Company Status + example: "Live Company" + REG_ACTIVITY_DESC1: + type: string + description: Registered Activities Description + example: + REG_ACTIVITY_DESC2: + type: string + description: Registered Activities Description + example: + AUDITOR: + type: string + description: Auditor Name + example: + AUDITOR_APPMT_DATE: + type: string + description: Auditor Appointment Date + example: "13/06/1990" + LAST_AR_DATE: + type: string + description: Date of Last AR + example: "30/06/2008" + LAST_AGM_DATE: + type: string + description: Date of Last AGM + example: "11/06/2008" + COUNTRY_INCORP: + type: string + description: Country Incorporated + example: "SINGAPORE" + REQ_SEARCH_INFO : + type: object + example: |+ + + + + + + + + + description: |+ + Request criteria & search record with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REG_NO: + type: string + description: Subject’s ID Number (individual) or Registration Number (company/business) + example: "197401835M" + REQ_DATE: + type: string + description: Report Requested Date + example: "2009-04-08 11:36:03.611" + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197401835M" + REQ_NAME: + type: string + description: Request Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REQ_DATE_STR: + type: string + description: Request Date String + example: "08/04/2009 11:36:03" + EMPLOYEE_SIZE : + type: object + description: |+ + Employee Size details with following children: + ELEMENTS + AMOUNT + example: |+ + + + 300 + + properties: + ELEMENTS: + type: string + description: Description + example: "Employee Size" + AMOUNT: + type: string + description: Number of employee + example: "300" + LIST_BIZ_BRANCH : + type: array + description: |+ + List of Business Branches with following children: + [BIZ_BRANCH] + example: |+ + + + + + + + properties: + BIZ_BRANCH : + type: object + description: |+ + Business Branches with following children: + ADDR_BUILDING + ADDR_POSTCODE + ADDR_ADDRESS1 + example: |+ + + + + + + properties: + ADDR_BUILDING: + type: string + description: Building Name + example: + ADDR_POSTCODE: + type: string + description: Postcode + example: 289848 + ADDR_ADDRESS1: + type: string + description: Address + example: 251A ARCADIA ROAD + LIST_REG_CHARGES: + type: array + description: |+ + List of Registered Charges with following children: + [REG_CHARGES] + example: |+ + + + + + + + + + + + items: + properties: + REG_CHARGES : + type: object + description: |+ + Registered Charges details with following children: + CHARGE_NO + CHARGE_DATE + CHARGEE_COMP + CURRENCY + AMT_SECURED + STATUS_SATISFACTION + example: |+ + + + + + + + + + properties: + CHARGE_NO : + type: string + description: Charge No. + example: 8205117 + CHARGE_DATE: + type: string + description: Charge Date + example: 26/11/1982 + CHARGEE_COMP: + type: string + description: Charges Company + example: UNITED OVERSEAS BANK LIMITED + CURRENCY: + type: string + description: Currency + example: + AMT_SECURED: + type: string + description: Amount Secured + example: 0.00 + STATUS_SATISFACTION: + type: string + description: Status of Satisfaction + example: + LIST_LIQUIDATOR: + type: array + description: |+ + List of Liquidator / Receiver / Judicial Manager with following children: + [LIQUIDATOR] + example: |+ + + + ABUTHAHIR ABDUL GAFOOR S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. 1 RAFFLES PLACE #20-01 + OUB CENTRE SINGAPORE 048616 30/03/2009 + + + items: + properties: + LIQUIDATOR : + type: object + description: |+ + Liquidator details with following children: + LIQ_POSITION + LIQ_ID + LIQ_NAME + LIQ_COMP + LIQ_ADDRESS1 + LIQ_ADDRESS2 + LIQ_ADDRESS3 + LIQ_ADDRESS4 + LIQ_APPOINTMENT_DATE + example: |+ + + ABUTHAHIR ABDUL GAFOOR + S1676216D + Liquidator + EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + 1 RAFFLES PLACE + #20-01 + OUB CENTRE + SINGAPORE 048616 + 30/03/2009 + + properties: + LIQ_POSITION: + type: string + description: Liquidator / Receiver / Judicial Manager Position + example: Liquidator + LIQ_ID: + type: string + description: Liquidator / Receiver / Judicial Manager ID + example: S1676216D + LIQ_NAME : + type: string + description: Liquidator / Receiver / Judicial Manager Name + example: ABUTHAHIR ABDUL GAFOOR + LIQ_COMP: + type: string + description: Liquidator / Receiver / Judicial Manager Company Name + example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: + type: string + description: Liquidator / Receiver / Judicial Manager Address 1 + example: 1 RAFFLES PLACE + LIQ_ADDRESS2: + type: string + description: Liquidator / Receiver / Judicial Manager Address 2 + example: #20-01 + LIQ_ADDRESS3: + type: string + description: Liquidator / Receiver / Judicial Manager Address 3 + example: OUB CENTRE + LIQ_ADDRESS4: + type: string + description: Liquidator / Receiver / Judicial Manager Address 4 + example: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: + type: string + description: Liquidator / Receiver / Judicial Manager Appointment Date + example: 30/03/2009 + LIST_SHARE_INTEREST_COMP : + type: array + description: |+ + List of Share Interest In Companies with following children: + [SHARE_INTEREST_COMP] + example: |+ + + + + + + + + + items: + properties: + SHARE_INTEREST_COMP : + type: object + description: |+ + Share Interest In Companies details with following children: + COMP_NAME + SHARE_OWNED_UNIT + SHARE_OWNED_PERCENT + STATUS + example: |+ + + + + + + + properties: + COMP_NAME : + type: string + description: Company Name + example: ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT : + type: string + description: Shares Owned Unit + example: 500000 + SHARE_OWNED_PERCENT : + type: string + description: Shares Owned Value (%) + example: 100.00 + STATUS : + type: string + description: Status + example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE : + type: array + description: |+ + List of Change of Company/Business Name(s) with following children: + [NAME_CHANGE] + example: |+ + + + + + + + items: + properties: + NAME_CHANGE : + type: object + description: |+ + Change of Company/Business Name(s) with following children: + PREV_NAME + EFFECT_DATE + example: |+ + + + + + properties: + PREV_NAME : + type: string + description: Previous Name + example: HUA XI EATING HOUSE + EFFECT_DATE : + type: string + description: Effective Date + example: 25/10/1997 00:00:00 + LIST_SHAREHOLDER : + type: array + description: |+ + List of Shareholders with following children: + [SHAREHOLDER] + example: |+ + + +
+ + + + + + + + + + items: + properties: + SHAREHOLDER : + type: object + description: |+ + Shareholders details with following children: + ADDRESS + COMP_ID + NO_OF_SHARE + CURRENCY + SHAREHOLDER_TYPE + SHARE_TYPE + SHAREHOLDER_NAME + CHANGE_ADDR_DATE + ADDR_TYPE + NATIONALITY + example: |+ + +
+ + + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID : + type: string + description: Company/ Identity No. + example: 198200406H + NO_OF_SHARE : + type: string + description: No. of Shares + example: 657 + CURRENCY : + type: string + description: Currency + example: UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE : + type: string + description: Indicator for Shareholder type + example: 2 + SHARE_TYPE : + type: string + description: Share Type + example: Preference + SHAREHOLDER_NAME : + type: string + description: Shareholder Name + example: KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 09/05/2003 + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE + LIST_CAPITAL : + type: array + description: |+ + List of Capital details with following children: + [CAPITAL] + example: |+ + + + + + + + + + + items: + properties: + CAPITAL : + type: object + description: |+ + Capital details with following children: + CAPITAL_CATEGORY + CAPITAL_TYPE + CURRENCY + CAPITAL_AMT + NO_OF_SHARES + example: |+ + + + + + + + + properties: + CAPITAL_CATEGORY : + type: string + description: Capital Category + example: Issued + CAPITAL_TYPE : + type: string + description: Capital Type + example: Ordinary + CURRENCY : + type: string + description: Currency + example: SINGAPORE, DOLLARS + CAPITAL_AMT : + type: string + description: Capital Amount + example: 100,000.00 + NO_OF_SHARES : + type: string + description: Nos. of Shares + example: 100,000 + LIST_OFFICER_OWNER : + type: array + description: |+ + List of Officer(s) / Owner(s) with following children: + [OFFICER_OWNER] + example: |+ + + +
+ + + + + + + + items: + properties: + OFFICER_OWNER : + type: object + description: |+ + Officer(s) / Owner(s) details with following children: + ADDRESS + IDENTITY_ID + PA_REG_NO + POSITION + ADDR_TYPE + CESSATION_DATE + OFFICER_NAME + CHANGE_ADDR_DATE + APPMT_DATE + NATIONALITY + example: |+ + +
+ + + + + + + + + + properties: + ADDRESS : + type: string + description: Address + example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE + IDENTITY_ID : + type: string + description: Identity No. + example: S1674174D + PA_REG_NO : + type: string + description: Public Accountant Registration No. + example: 00091 + POSITION : + type: string + description: Position + example: DIRECTOR + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: S + CESSATION_DATE : + type: string + description: Cessation Date + example: 30/10/2003 + OFFICER_NAME : + type: string + description: Officer Name + example: HENRY GOH + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 30/10/2003 + APPMT_DATE : + type: string + description: Appointment Date + example: 30/10/2003 + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT : + type: array + description: |+ + List of Sales Revenue Amount with following children: + [SALES_REVENUE_AMOUNT] + example: |+ + + + 30000.00 + + + items: + properties: + SALES_REVENUE_AMOUNT : + type: object + description: |+ + Sales Revenue Amount details with following children: + ELEMENTS + YEAR + CURRENCY + AMOUNT + example: |+ + + + + + 30000.00 + + properties: + ELEMENTS : + type: string + description: Description + example: Sales Revenue Amount + YEAR : + type: integer + description: Year + example: 2008 + CURRENCY : + type: string + description: Currency + example: SGD + AMOUNT : + type: integer + description: Amount + example: 30000.00 + LIST_Ddrptcount : + type: array + description: |+ + List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: + [Ddrptcount] + example: + items: + properties: + Ddrptcount : + type: object + description: |+ + 6 XML tags (open then close) displays + Search By Financial Sectors (counts for 3 recent years) + Search By Non- Financial Sectors (counts for 3 recent years) + Following children are: + Rcyear + RcFlag (only respond for the year exists) + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) + Rcsecflag + LastUpdateDate (only respond for the year exists) + example: + properties: + Rcyear : + type: string + description: To show the year + example: 2017 + RcFlag : + type: string + description: Internal database value + example: N/A + Rcjan : + type: integer + description: Count for January + example: 1 + Rcfeb : + type: integer + description: Count for February + example: 1 + Rcmar : + type: integer + description: Count for March + example: 1 + Rcapr : + type: integer + description: Count for April + example: 1 + Rcmay : + type: integer + description: Count for May + example: 1 + Rcjun : + type: integer + description: Count for June + example: 1 + Rcjul : + type: integer + description: Count for July + example: 1 + Rcaug : + type: integer + description: Count for August + example: 1 + Rcsep : + type: integer + description: Count for September + example: 1 + Rcoct : + type: integer + description: Count for October + example: 1 + Rcnov : + type: integer + description: Count for November + example: 1 + Rcdec : + type: integer + description: Count for December + example: 1 + Rcid : + type: integer + description: Internal database value + example: + Rcreg : + type: string + description: Company Registration Number + example: + Rcrptyid : + type: string + description: Product Type + example: + Rcsecflag : + type: integer + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + example: 1 + LastUpdateDate : + type: string + description: Last update date + example: + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + REQUEST: + type: object + properties: + TOT_ITEMS: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + ENQUIRY: + type: object + example: |+ + 197601887ETRANSTAR TRAVEL PTE LTD + description: Contains information of each request details + default: true + properties: + SUBJECT_IDNO: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + SUBJECT_NAME: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/data/d&b_business_check_sg_v1.0.yaml b/data/d&b_business_check_sg_v1.0.yaml new file mode 100644 index 000000000..2cd20fc1c --- /dev/null +++ b/data/d&b_business_check_sg_v1.0.yaml @@ -0,0 +1,1473 @@ +openapi: 3.0.1 +info: + title: D&B Business Check (SG) + description: |+ + This Data microservice provides key business information of a Singapore-registered company and includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily. + x-additionalinfo: |+ + Suggested Use Cases: + - For software solutions that require general background checks of a company. This microservice can provide a high level of scrutiny of potential business associates, and throw light on the risks that cannot be detected by geopolitical analysis or batch screening levels. + - For example, this microservice can be used to check if a Singapore-registered company meets regulations, such as if the company complies with anti-money laundering, anti-bribery, and corruption regulations by looking at registered activities, shareholders details, and more. + - It can also be used to simplify the due diligence process, by identify risk issues using a range of reports that meet different compliance requirements. + - It can also be used to protect your business – safeguard against reputational risk by avoiding those involved in financial crime. + - It can also be used for finance-related domains such as vehicle leasing, loans, enterprise credit terms and so on. Updated daily. + version: '1.0.0' + x-subscribelink: d&b_business_check_sg +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/sbc/v0/getdata: + post: + tags: + - v1.0.0 + summary: Adds a new user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + success: + report: + meta_info: + service: string + system_id: string + creation_date: string + user_id: string + class: string + req_search_info: + comp_name: string + reg_no: string + req_date: string + req_reg_no: string + req_name: string + req_date_str: string + registry_detail: + comp_name: string + renewal_date: string + address1: string + address2: string + address3: string + address4: string + comp_type_code: string + reg_date: string + reg_activity1: string + reg_activity2: string + acc_date: string + status_effect_date: string + name_effect_date: string + expiry_date: string + comp_type: string + change_addr_date: string + comp_status: string + reg_activity_desc1: string + reg_activity_desc2: string + auditor: string + auditor_appmt_date: string + last_ar_date: string + last_agm_date: string + country_incorp: string + employee_size: + elements: string + amount: string + list_biz_branch: + biz_branch: + addr_building: string + addr_postcode: string + addr_address1: string + list_reg_charges: + reg_charges: + charge_no: string + charge_date: string + chargee_comp: string + currency: string + amt_secured: string + status_satisfaction: string + list_liquidator: + liquidator: + liq_name: string + liq_id: string + liq_position: string + liq_comp: string + liq_address1: string + liq_address2: string + liq_address3: string + liq_address4: string + liq_appointment_date: string + list_sales_revenue_amount: + sales_revenue_amount: + elements: string + year: string + currency: string + amount: '0' + list_shareholder: + shareholder: + address: string + comp_id: string + no_of_share: string + currency: string + shareholder_type: string + share_type: string + shareholder_name: string + change_addr_date: string + addr_type: string + nationality: string + list_share_interest_comp: + share_interest_comp: + comp_name: string + share_owned_unit: string + share_owned_percent: string + status: string + list_officer_owner: + officer_owner: + address: string + identity_id: string + position: string + addr_type: string + cessation_date: string + officer_name: string + change_addr_date: string + appmt_date: string + nationality: string + list_capital: + capital: + capital_category: string + capital_type: string + currency: string + capital_amt: string + no_of_shares: string + list_name_change: + name_change: + prev_name: string + effect_date: string + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + REPORT: + type: object + example: + description: |+ + Report details with following children: + [META_INFO] + [REGISTRY_DETAIL] + [REQ_SEARCH_INFO] + [EMPLOYEE_SIZE] + [LIST_BIZ_BRANCH] + [LIST_REG_CHARGES] + [LIST_LIQUIDATOR] + [LIST_SHARE_INTEREST_COMP] + [LIST_NAME_CHANGE] + [LIST_SHAREHOLDER] + [LIST_CAPITAL] + [LIST_OFFICER_OWNER] + [LIST_SALES_REVENUE_AMOUNT] + properties: + META_INFO: + type: object + example: + META_INFO: + SERVICE: + "@type": String + "#text": BC + SYSTEM_ID: + "@type": String + "#text": DDP + CREATION_DATE: + "@type": Date + "#text": Wed Apr 08 11:37:51 MYT 2009 + USER_ID: + "@type": String + "#text": plcust102 + CLASS: + "@type": String + "#text": class com.technodex.ddp.xmlbean.MetaBean + description: |+ + Meta Information details with following children: + SERVICE + SYSTEM_ID + CREATION_DATE + USER_ID + CLASS + properties: + SERVICE: + type: string + description: Report requested + example: "BC" + SYSTEM_ID : + type: string + description: System ID + example: "DDP" + CREATION_DATE: + type: datetime + description: Report request date + example: "Wed Apr 08 11:37:51 MYT 2009" + USER_ID : + type: string + description: Valid user id in DDP system. It is for (For internal use) + example: "N/A" + CLASS: + type: string + description: Class location for metabean. It is for (For internal use) + example: "N/A" + REGISTRY_DETAIL : + type: object + example: + REGISTRY_DETAIL: + "@className": com.technodex.ddp.report.bean.CommercialBizRegistryBean + RENEWAL_DATE: + "@type": String + "#text": 23/12/2008 + ADDRESS1: + "@type": String + "#text": 1 HARBOURFRONT AVENUE , 18 - 01 + ADDRESS2: + "@type": String + "#text": KEPPEL BAY TOWER + ADDRESS3: + "@type": String + "#text": '098632' + ADDRESS4: + "@type": String + "#text": SINGAPORE + COMP_TYPE_CODE: + "@type": String + "#text": CP + REG_DATE: + "@type": String + "#text": 14/10/1974 + REG_ACTIVITY1: + "@type": String + "#text": OTHER INVESTMENT HOLDING COMPANIES + REG_ACTIVITY2: + "@type": String + "#text": SHIP MANAGEMENT SERVICES + ACC_DATE: + "@type": String + "#text": 31/12/2007 + STATUS_EFFECT_DATE: + "@type": String + "#text ": 14/10/1974 + NAME_EFFECT_DATE: + "@type": String + "#text": 14/10/1974 + EXPIRY_DATE: + "@type": String + "#text": 25/10/2009 + COMP_TYPE: + "@type": String + "#text": LIMITED PRIVATE COMPANY + CHANGE_ADDR_DATE: + "@type": String + "#text": '09 / 05 / 2003' + COMP_STATUS: + "@type": String + "#text": Live Company + REG_ACTIVITY_DESC1: + "@type": String + "#text": " - " + REG_ACTIVITY_DESC2: + "@type": String + "#text": " - " + AUDITOR: + "@type": String + "#text": " - " + AUDITOR_APPMT_DATE: + "@type": String + "#text": 13/06/1990 + LAST_AR_DATE: + "@type": String + "#text": 30/06/2008 + LAST_AGM_DATE: + "@type": String + "#text": 11/06/2008 + COUNTRY_INCORP: + "@type": String + "#text": SINGAPORE + description: |+ + Registry Details with following children: + RENEWAL_DATE + ADDRESS1 + ADDRESS2 + ADDRESS3 + ADDRESS4 + COMP_TYPE_CODE + REG_DATE + REG_ACTIVITY1 + REG_ACTIVITY2 + ACC_DATE + STATUS_EFFECT_DATE + NAME_EFFECT_DATE + EXPIRY_DATE + COMP_TYPE + CHANGE_ADDR_DATE + COMP_STATUS + REG_ACTIVITY_DESC1 + REG_ACTIVITY_DESC2 + AUDITOR + AUDITOR_APPMT_DATE + LAST_AR_DATE + LAST_AGM_DATE + COUNTRY_INCORP + properties: + RENEWAL_DATE: + type: string + description: Renewal Date + example: "23/12/2008" + ADDRESS1: + type: string + description: Address Line 1 + example: "1 HARBOURFRONT AVENUE , 18 - 01" + ADDRESS2: + type: string + description: Address Line 2 + example: "KEPPEL BAY TOWER" + ADDRESS3: + type: string + description: Address Line 3 + example: "098632" + ADDRESS4: + type: string + description: Address Line 4 + example: "SINGAPORE" + COMP_TYPE_CODE: + type: string + example: CP + description: |+ + Report Code. Available values are: + 1. CP Corporate + 2. SP Sole Proprietor + REG_DATE: + type: string + description: Registration Date + example: "14/10/1974" + REG_ACTIVITY1: + type: string + description: Registered Activities 1 + example: "OTHER INVESTMENT HOLDING COMPANIES" + REG_ACTIVITY2: + type: string + description: Registered Activities 2 + example: "SHIP MANAGEMENT SERVICES" + ACC_DATE: + type: string + description: Account Date + example: "31/12/2007" + STATUS_EFFECT_DATE: + type: string + description: Status Effective Date + example: "14/10/1974" + NAME_EFFECT_DATE: + type: string + description: Name Effective Date + example: "14/10/1974" + EXPIRY_DATE: + type: string + description: Expiry Date + example: "25/10/2009" + COMP_TYPE: + type: string + description: Company Type + example: "LIMITED PRIVATE COMPANY" + CHANGE_ADDR_DATE: + type: string + description: Change Address Date + example: "09/05/2003" + COMP_STATUS: + type: string + description: Company Status + example: "Live Company" + REG_ACTIVITY_DESC1: + type: string + description: Registered Activities Description + example: + REG_ACTIVITY_DESC2: + type: string + description: Registered Activities Description + example: + AUDITOR: + type: string + description: Auditor Name + example: + AUDITOR_APPMT_DATE: + type: string + description: Auditor Appointment Date + example: "13/06/1990" + LAST_AR_DATE: + type: string + description: Date of Last AR + example: "30/06/2008" + LAST_AGM_DATE: + type: string + description: Date of Last AGM + example: "11/06/2008" + COUNTRY_INCORP: + type: string + description: Country Incorporated + example: "SINGAPORE" + REQ_SEARCH_INFO : + type: object + example: + REQ_SEARCH_INFO: + "@className": com.technodex.ddp.report.bean.LitigationSearchInfoBean + COMP_NAME: + "@type": String + "#text": KAPAL MANAGEMENT (PRIVATE) LIMITED + REG_NO: + "@type": String + "#text": 197401835M + REQ_DATE: + "@type": Date + "#text": '2009-04-08 11:36:03.611' + REQ_REG_NO: + "@type": String + "#text": 197401835M + REQ_NAME: + "@type": String + "#text": KAPAL MANAGEMENT (PRIVATE) LIMITED + REQ_DATE_STR: + "@type": String + "#text": '08/04/2009 11:36:03' + description: |+ + Request criteria & search record with following children: + COMP_NAME + REG_NO + REQ_DATE + REQ_REG_NO + REQ_NAME + REQ_DATE_STR + properties: + COMP_NAME: + type: string + description: Company Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REG_NO: + type: string + description: Subject’s ID Number (individual) or Registration Number (company/business) + example: "197401835M" + REQ_DATE: + type: string + description: Report Requested Date + example: "2009-04-08 11:36:03.611" + REQ_REG_NO: + type: string + description: Request Registration Number + example: "197401835M" + REQ_NAME: + type: string + description: Request Name + example: "KAPAL MANAGEMENT (PRIVATE) LIMITED" + REQ_DATE_STR: + type: string + description: Request Date String + example: "08/04/2009 11:36:03" + EMPLOYEE_SIZE : + type: object + description: |+ + Employee Size details with following children: + ELEMENTS + AMOUNT + example: + EMPLOYEE_SIZE: + ELEMENTS: Employee Size + AMOUNT: '300' + properties: + ELEMENTS: + type: string + description: Description + example: "Employee Size" + AMOUNT: + type: string + description: Number of employee + example: "300" + LIST_BIZ_BRANCH : + type: array + description: |+ + List of Business Branches with following children: + [BIZ_BRANCH] + example: + LIST_BIZ_BRANCH: + "@className": com.technodex.ddp.report.bean.CommercialBizBranchBean + BIZ_BRANCH: + ADDR_BUILDING: + "@type": String + "#text": "-" + ADDR_POSTCODE: + "@type": String + "#text": '289848' + ADDR_ADDRESS1: + "@type": String + "#text": 251A ARCADIA ROAD , - - - + properties: + BIZ_BRANCH : + type: object + description: |+ + Business Branches with following children: + ADDR_BUILDING + ADDR_POSTCODE + ADDR_ADDRESS1 + example: + BIZ_BRANCH: + ADDR_BUILDING: + "@type": String + "#text": "-" + ADDR_POSTCODE: + "@type": String + "#text": '289848' + ADDR_ADDRESS1: + "@type": String + "#text": 251A ARCADIA ROAD , - - - + properties: + ADDR_BUILDING: + type: string + description: Building Name + example: + ADDR_POSTCODE: + type: string + description: Postcode + example: 289848 + ADDR_ADDRESS1: + type: string + description: Address + example: 251A ARCADIA ROAD + LIST_REG_CHARGES: + type: array + description: |+ + List of Registered Charges with following children: + [REG_CHARGES] + example: + LIST_REG_CHARGES: + "@className": com.technodex.ddp.report.bean.CommercialBizChgRegBean + REG_CHARGES: + CHARGE_NO: + "@type": String + "#text": '8205117' + CHARGE_DATE: + "@type": String + "#text": 26/11/1982 + CHARGEE_COMP: + "@type": String + "#text": UNITED OVERSEAS BANK LIMITED + CURRENCY: + "@type": String + "#text": "-" + AMT_SECURED: + "@type": String + "#text": '0.00' + STATUS_SATISFACTION: + "@type": String + "#text": "-" + items: + properties: + REG_CHARGES : + type: object + description: |+ + Registered Charges details with following children: + CHARGE_NO + CHARGE_DATE + CHARGEE_COMP + CURRENCY + AMT_SECURED + STATUS_SATISFACTION + example: + REG_CHARGES: + CHARGE_NO: + "@type": String + "#text": '8205117' + CHARGE_DATE: + "@type": String + "#text": 26/11/1982 + CHARGEE_COMP: + "@type": String + "#text": UNITED OVERSEAS BANK LIMITED + CURRENCY: + "@type": String + "#text": "-" + AMT_SECURED: + "@type": String + "#text": '0.00' + STATUS_SATISFACTION: + "@type": String + "#text": "-" + properties: + CHARGE_NO : + type: string + description: Charge No. + example: 8205117 + CHARGE_DATE: + type: string + description: Charge Date + example: 26/11/1982 + CHARGEE_COMP: + type: string + description: Charges Company + example: UNITED OVERSEAS BANK LIMITED + CURRENCY: + type: string + description: Currency + example: + AMT_SECURED: + type: string + description: Amount Secured + example: 0.00 + STATUS_SATISFACTION: + type: string + description: Status of Satisfaction + example: + LIST_LIQUIDATOR: + type: array + description: |+ + List of Liquidator / Receiver / Judicial Manager with following children: + [LIQUIDATOR] + example: + LIST_LIQUIDATOR: + LIQUIDATOR: + LIQ_NAME: ABUTHAHIR ABDUL GAFOOR + LIQ_ID: S1676216D + LIQ_POSITION: Liquidator + LIQ_COMP: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: 1 RAFFLES PLACE + LIQ_ADDRESS2: "#20-01" + LIQ_ADDRESS3: OUB CENTRE + LIQ_ADDRESS4: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: 30/03/2009 + items: + properties: + LIQUIDATOR : + type: object + description: |+ + Liquidator details with following children: + LIQ_POSITION + LIQ_ID + LIQ_NAME + LIQ_COMP + LIQ_ADDRESS1 + LIQ_ADDRESS2 + LIQ_ADDRESS3 + LIQ_ADDRESS4 + LIQ_APPOINTMENT_DATE + example: + LIQUIDATOR: + LIQ_NAME: ABUTHAHIR ABDUL GAFOOR + LIQ_ID: S1676216D + LIQ_POSITION: Liquidator + LIQ_COMP: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: 1 RAFFLES PLACE + LIQ_ADDRESS2: "#20-01" + LIQ_ADDRESS3: OUB CENTRE + LIQ_ADDRESS4: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: 30/03/2009 + properties: + LIQ_POSITION: + type: string + description: Liquidator / Receiver / Judicial Manager Position + example: Liquidator + LIQ_ID: + type: string + description: Liquidator / Receiver / Judicial Manager ID + example: S1676216D + LIQ_NAME : + type: string + description: Liquidator / Receiver / Judicial Manager Name + example: ABUTHAHIR ABDUL GAFOOR + LIQ_COMP: + type: string + description: Liquidator / Receiver / Judicial Manager Company Name + example: EL TICI FINANCIAL ADVISORY SERVICES PTE. LTD. + LIQ_ADDRESS1: + type: string + description: Liquidator / Receiver / Judicial Manager Address 1 + example: 1 RAFFLES PLACE + LIQ_ADDRESS2: + type: string + description: Liquidator / Receiver / Judicial Manager Address 2 + example: #20-01 + LIQ_ADDRESS3: + type: string + description: Liquidator / Receiver / Judicial Manager Address 3 + example: OUB CENTRE + LIQ_ADDRESS4: + type: string + description: Liquidator / Receiver / Judicial Manager Address 4 + example: SINGAPORE 048616 + LIQ_APPOINTMENT_DATE: + type: string + description: Liquidator / Receiver / Judicial Manager Appointment Date + example: 30/03/2009 + LIST_SHARE_INTEREST_COMP : + type: array + description: |+ + List of Share Interest In Companies with following children: + [SHARE_INTEREST_COMP] + example: + LIST_SHARE_INTEREST_COMP: + "@className": com.technodex.ddp.report.bean.CommercialShareInterestBean + SHARE_INTEREST_COMP: + COMP_NAME: + "@type": String + "#text": ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT: + "@type": String + "#text": '500000' + SHARE_OWNED_PERCENT: + "@type": String + "#text": '100.00' + STATUS: + "@type": String + "#text": DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + items: + properties: + SHARE_INTEREST_COMP : + type: object + description: |+ + Share Interest In Companies details with following children: + COMP_NAME + SHARE_OWNED_UNIT + SHARE_OWNED_PERCENT + STATUS + example: + SHARE_INTEREST_COMP: + COMP_NAME: + "@type": String + "#text": ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT: + "@type": String + "#text": '500000' + SHARE_OWNED_PERCENT: + "@type": String + "#text": '100.00' + STATUS: + "@type": String + "#text": DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + properties: + COMP_NAME : + type: string + description: Company Name + example: ORCHID (HOLDINGS) PTE. LTD. + SHARE_OWNED_UNIT : + type: string + description: Shares Owned Unit + example: 500000 + SHARE_OWNED_PERCENT : + type: string + description: Shares Owned Value (%) + example: 100.00 + STATUS : + type: string + description: Status + example: DISSOLVED - MEMBERS' VOLUNTARY WINDING UP + LIST_NAME_CHANGE : + type: array + description: |+ + List of Change of Company/Business Name(s) with following children: + [NAME_CHANGE] + example: + LIST_NAME_CHANGE: + "@className": com.technodex.ddp.report.bean.CommercialBizChgCmpBean + NAME_CHANGE: + PREV_NAME: + "@type": String + "#text": HUA XI EATING HOUSE + EFFECT_DATE: + "@type": String + "#text": 25/10/1997 00:00:00 + items: + properties: + NAME_CHANGE : + type: object + description: |+ + Change of Company/Business Name(s) with following children: + PREV_NAME + EFFECT_DATE + example: + NAME_CHANGE: + PREV_NAME: + "@type": String + "#text": HUA XI EATING HOUSE + EFFECT_DATE: + "@type": String + "#text": 25/10/1997 00:00:00 + properties: + PREV_NAME : + type: string + description: Previous Name + example: HUA XI EATING HOUSE + EFFECT_DATE : + type: string + description: Effective Date + example: 25/10/1997 00:00:00 + LIST_SHAREHOLDER : + type: array + description: |+ + List of Shareholders with following children: + [SHAREHOLDER] + example: + LIST_SHAREHOLDER: + "@className": com.technodex.ddp.report.bean.CommercialShareHoldersBean + SHAREHOLDER: + ADDRESS: + "@type": String + "#text": |- + 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, + SINGAPORE + COMP_ID: + "@type": String + "#text": 198200406H + NO_OF_SHARE: + "@type": String + "#text": '657' + CURRENCY: + "@type": String + "#text": UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE: + "@type": String + "#text": '2' + SHARE_TYPE: + "@type": String + "#text": Preference + SHAREHOLDER_NAME: + "@type": String + "#text": |- + KEPPEL COMMUNICATIONS PTE + LTD + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + ADDR_TYPE: + "@type": String + "#text": "-" + NATIONALITY: + "@type": String + "#text": SINGAPORE + items: + properties: + SHAREHOLDER : + type: object + description: |+ + Shareholders details with following children: + ADDRESS + COMP_ID + NO_OF_SHARE + CURRENCY + SHAREHOLDER_TYPE + SHARE_TYPE + SHAREHOLDER_NAME + CHANGE_ADDR_DATE + ADDR_TYPE + NATIONALITY + example: + SHAREHOLDER: + ADDRESS: + "@type": String + "#text": 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID: + "@type": String + "#text": 198200406H + NO_OF_SHARE: + "@type": String + "#text": '657' + CURRENCY: + "@type": String + "#text": UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE: + "@type": String + "#text": '2' + SHARE_TYPE: + "@type": String + "#text": Preference + SHAREHOLDER_NAME: + "@type": String + "#text": KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE: + "@type": String + "#text": '09/05/2003' + ADDR_TYPE: + "@type": String + "#text": "-" + NATIONALITY: + "@type": String + "#text": SINGAPORE + properties: + ADDRESS : + type: string + description: Address + example: 1 HARBOURFRONT AVENUE , 18 – 01; KEPPEL BAY TOWER; 098632, SINGAPORE + COMP_ID : + type: string + description: Company/ Identity No. + example: 198200406H + NO_OF_SHARE : + type: string + description: No. of Shares + example: 657 + CURRENCY : + type: string + description: Currency + example: UNITED STATES OF AMERICA, DOLLARS + SHAREHOLDER_TYPE : + type: string + description: Indicator for Shareholder type + example: 2 + SHARE_TYPE : + type: string + description: Share Type + example: Preference + SHAREHOLDER_NAME : + type: string + description: Shareholder Name + example: KEPPEL COMMUNICATIONS PTE LTD + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 09/05/2003 + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE + LIST_CAPITAL : + type: array + description: |+ + List of Capital details with following children: + [CAPITAL] + example: + LIST_CAPITAL: + "@className": com.technodex.ddp.report.bean.CommercialBizCapitalBean + CAPITAL: + CAPITAL_CATEGORY: + "@type": String + "#text": Issued + CAPITAL_TYPE: + "@type": String + "#text": Ordinary + CURRENCY: + "@type": String + "#text": SINGAPORE, DOLLARS + CAPITAL_AMT: + "@type": String + "#text": '100,000.00' + NO_OF_SHARES: + "@type": String + "#text": '100,000' + items: + properties: + CAPITAL : + type: object + description: |+ + Capital details with following children: + CAPITAL_CATEGORY + CAPITAL_TYPE + CURRENCY + CAPITAL_AMT + NO_OF_SHARES + example: + CAPITAL: + CAPITAL_CATEGORY: + "@type": String + "#text": Issued + CAPITAL_TYPE: + "@type": String + "#text": Ordinary + CURRENCY: + "@type": String + "#text": SINGAPORE, DOLLARS + CAPITAL_AMT: + "@type": String + "#text": '100,000.00' + NO_OF_SHARES: + "@type": String + "#text": '100,000' + properties: + CAPITAL_CATEGORY : + type: string + description: Capital Category + example: Issued + CAPITAL_TYPE : + type: string + description: Capital Type + example: Ordinary + CURRENCY : + type: string + description: Currency + example: SINGAPORE, DOLLARS + CAPITAL_AMT : + type: string + description: Capital Amount + example: 100,000.00 + NO_OF_SHARES : + type: string + description: Nos. of Shares + example: 100,000 + LIST_OFFICER_OWNER : + type: array + description: |+ + List of Officer(s) / Owner(s) with following children: + [OFFICER_OWNER] + example: + LIST_OFFICER_OWNER: + "@className": com.technodex.ddp.report.bean.CommercialBizOfficeOwerBean + OFFICER_OWNER: + ADDRESS: + "@type": String + "#text": |- + 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, + SINGAPORE + IDENTITY_ID: + "@type": String + "#text": S1674174D + POSITION: + "@type": String + "#text": DIRECTOR + ADDR_TYPE: + "@type": String + "#text": S + CESSATION_DATE: + "@type": String + "#text": "-" + OFFICER_NAME: + "@type": String + "#text": NGIAM SHARE CHING + CHANGE_ADDR_DATE: + "@type": String + "#text": 25/10/2008 + APPMT_DATE: + "@type": String + "#text": 30/09/2008 + NATIONALITY: + "@type": String + "#text": SINGAPORE CITIZEN + items: + properties: + OFFICER_OWNER : + type: object + description: |+ + Officer(s) / Owner(s) details with following children: + ADDRESS + IDENTITY_ID + PA_REG_NO + POSITION + ADDR_TYPE + CESSATION_DATE + OFFICER_NAME + CHANGE_ADDR_DATE + APPMT_DATE + NATIONALITY + example: + OFFICER_OWNER: + ADDRESS: + "@type": String + "#text": |- + 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, + SINGAPORE + IDENTITY_ID: + "@type": String + "#text": S1674174D + POSITION: + "@type": String + "#text": DIRECTOR + ADDR_TYPE: + "@type": String + "#text": S + CESSATION_DATE: + "@type": String + "#text": "-" + OFFICER_NAME: + "@type": String + "#text": NGIAM SHARE CHING + CHANGE_ADDR_DATE: + "@type": String + "#text": 25/10/2008 + APPMT_DATE: + "@type": String + "#text": 30/09/2008 + NATIONALITY: + "@type": String + "#text": SINGAPORE CITIZEN + properties: + ADDRESS : + type: string + description: Address + example: 50A TOH TUCK ROAD, 04 - 08 ; SIGNATURE PARK; 596742, SINGAPORE + IDENTITY_ID : + type: string + description: Identity No. + example: S1674174D + PA_REG_NO : + type: string + description: Public Accountant Registration No. + example: 00091 + POSITION : + type: string + description: Position + example: DIRECTOR + ADDR_TYPE : + type: string + description: Address Type, indicates if it is Singapore or foreign address. + example: S + CESSATION_DATE : + type: string + description: Cessation Date + example: 30/10/2003 + OFFICER_NAME : + type: string + description: Officer Name + example: HENRY GOH + CHANGE_ADDR_DATE : + type: string + description: Change Address Date + example: 30/10/2003 + APPMT_DATE : + type: string + description: Appointment Date + example: 30/10/2003 + NATIONALITY : + type: string + description: Nationality + example: SINGAPORE P.R. + LIST_SALES_REVENUE_AMOUNT : + type: array + description: |+ + List of Sales Revenue Amount with following children: + [SALES_REVENUE_AMOUNT] + example: + LIST_SALES_REVENUE_AMOUNT: + SALES_REVENUE_AMOUNT: + ELEMENTS: Sales Revenue Amount + YEAR: '2008' + CURRENCY: SGD + AMOUNT: '30000.00' + items: + properties: + SALES_REVENUE_AMOUNT : + type: object + description: |+ + Sales Revenue Amount details with following children: + ELEMENTS + YEAR + CURRENCY + AMOUNT + example: + SALES_REVENUE_AMOUNT: + ELEMENTS: Sales Revenue Amount + YEAR: '2008' + CURRENCY: SGD + AMOUNT: '30000.00' + properties: + ELEMENTS : + type: string + description: Description + example: Sales Revenue Amount + YEAR : + type: integer + description: Year + example: 2008 + CURRENCY : + type: string + description: Currency + example: SGD + AMOUNT : + type: integer + description: Amount + example: 30000.00 + LIST_Ddrptcount : + type: array + description: |+ + List of Search By Financial Sectors and Search By Non- Financial Sectors with following children: + [Ddrptcount] + example: + items: + properties: + Ddrptcount : + type: object + description: |+ + 6 XML tags (open then close) displays + Search By Financial Sectors (counts for 3 recent years) + Search By Non- Financial Sectors (counts for 3 recent years) + Following children are: + Rcyear + RcFlag (only respond for the year exists) + Rcjan + Rcfeb + Rcmar + Rcapr + Rcmay + Rcjun + Rcjul + Rcaug + Rcsep + Rcoct + Rcnov + Rcdec + Rcid (only respond for the year exists) Rcreg (only respond for the year exists) Rcrptyid (only respond for the year exists) + Rcsecflag + LastUpdateDate (only respond for the year exists) + example: + properties: + Rcyear : + type: string + description: To show the year + example: 2017 + RcFlag : + type: string + description: Internal database value + example: N/A + Rcjan : + type: integer + description: Count for January + example: 1 + Rcfeb : + type: integer + description: Count for February + example: 1 + Rcmar : + type: integer + description: Count for March + example: 1 + Rcapr : + type: integer + description: Count for April + example: 1 + Rcmay : + type: integer + description: Count for May + example: 1 + Rcjun : + type: integer + description: Count for June + example: 1 + Rcjul : + type: integer + description: Count for July + example: 1 + Rcaug : + type: integer + description: Count for August + example: 1 + Rcsep : + type: integer + description: Count for September + example: 1 + Rcoct : + type: integer + description: Count for October + example: 1 + Rcnov : + type: integer + description: Count for November + example: 1 + Rcdec : + type: integer + description: Count for December + example: 1 + Rcid : + type: integer + description: Internal database value + example: + Rcreg : + type: string + description: Company Registration Number + example: + Rcrptyid : + type: string + description: Product Type + example: + Rcsecflag : + type: integer + description: Differentiate Search By Financial Sectors and Search By Non- Financial Sectors + example: 1 + LastUpdateDate : + type: string + description: Last update date + example: + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + input: + type: object + properties: + total_items: + type: number + example: 1 + description: Number of subjects being enquired relating to the Run + default: false + subject_idno: + type: string + example: 199707714C + description: "Subject’s ID Number (individual) or Registration Number (company/business) as captured in DDP" + default: true + subject_name: + type: string + example: GPS INDUSTRIES PTE LTD + description: Subjects Name as captured in DDP + default: false + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized and Standardized results in Json Format + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Aug 15, 2019 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/demographics_hdb_sg.yaml b/data/demographics_hdb_sg.yaml similarity index 91% rename from yaml/demographics_hdb_sg.yaml rename to data/demographics_hdb_sg.yaml index e87aae00c..3cbc97636 100644 --- a/yaml/demographics_hdb_sg.yaml +++ b/data/demographics_hdb_sg.yaml @@ -1,13 +1,16 @@ openapi: 3.0.1 info: title: HDB Demographics (SG) + x-subscribelink: demographics_hdb_sg description: |+ - This Data microservice returns information on Housing Development Board of Singapore (HDB) estates that includes location address, postal code, gender and age groups, down to block-level granularity. - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + This Data microservice returns information on Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, gender and age groups, down to block-level granularity.The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. @@ -76,17 +79,17 @@ info: Using a filterdata only: > {"filter":[{"terms":{"postalcode":["050034","050532"]}},{"match":{"gender":"female"}},{"terms":{"age_group_id":[6]}}]} - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Apr 24, 2020" +- name: "v0.1.0" + description: "Published Date - May 15, 2020" paths: /DaaS/prod/hdb/demographics: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -128,7 +131,7 @@ paths: {"filter":[{"match":{"age_group_id":7}},{"match":{"gender":"male"}},{"match":{"postalcode":520423}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -191,12 +194,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -410,16 +419,25 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Apr 24,2020 + example: Published Date - May 15,2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/directory_of_singapore_startups.yaml b/data/directory_of_singapore_startups.yaml similarity index 96% rename from yaml/directory_of_singapore_startups.yaml rename to data/directory_of_singapore_startups.yaml index 219b63d44..98936901e 100644 --- a/yaml/directory_of_singapore_startups.yaml +++ b/data/directory_of_singapore_startups.yaml @@ -1,9 +1,13 @@ openapi: 3.0.1 info: title: Directory of Singapore Startups + x-subscribelink: directory_of_singapore_startups description: |+ This Data microservice retrieves the list of all Singapore startup companies found on the internet through web scraping. Updated quarterly. x-additionalinfo: |+ + Suggested Use Cases: + - Build solutions related to startups in Singapore. For example, investors interested in industry analysis can use this microservice to identify the trends and patterns in Singapore's startup scene. + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. @@ -73,17 +77,17 @@ info: > "should":[{"match":{"status.e27":"active"}}], > "must_not":[{"match":{"yearestablished.e27":"2016"}}] > } - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Nov 15, 2019" +- name: "v0.1.0" + description: "Published Date - Dec 26, 2018" paths: /DaaS/prod/directories/searchdir: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -125,7 +129,7 @@ paths: {"must":[{"match":{"name":"technology"}}],"filter":[{"exists":{"field":"company.e27"}}],"should":[{"match":{"status.e27":"active"}}],"must_not":[{"match":{"yearestablished.e27":"2016"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -213,12 +217,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -510,15 +520,24 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Nov 15, 2019 + example: Published Date - Dec 26, 2018 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml b/data/fitness_stations_and_playgrounds_hdb_sg.yaml similarity index 87% rename from yaml/fitness_stations_and_playgrounds_hdb_sg.yaml rename to data/fitness_stations_and_playgrounds_hdb_sg.yaml index 3d7ca3e8e..a08e62c8a 100644 --- a/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml +++ b/data/fitness_stations_and_playgrounds_hdb_sg.yaml @@ -1,11 +1,15 @@ openapi: 3.0.1 info: title: HDB Fitness Stations and Playgrounds (SG) + x-subscribelink: fitness_stations_and_playgrounds_hdb_sg description: |+ This Data microservice captures the indicative outline of fitness stations/playgrounds for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery (2014) and manually digitized. Objects largely obstructed by trees, structures and/or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a background check solution to extract information related to the types and number of fitness stations/playgrounds present in an area for people buying or renting a HDB home. + Download the complete dataset using a pre-signed URL. It's a two steps process. **Step 1:** Get the pre-signed URL @@ -32,20 +36,20 @@ info: | Shape__Area | Float | N/A | Area of the feature | | Shape__Length | Float | N/A | Length of the feature | - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Feb 07, 2020" +- name: "v0.1.0" + description: "Published Date - Mar 24, 2020" paths: /DaaS/prod/hdb/amenities/gs/csv/fitnessstationplaygrnd/hdb: get: tags: - - v0.1 + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -85,12 +89,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -199,15 +209,24 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Feb 07, 2020 + example: Published Date - Mar 24, 2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/data/fitness_stations_and_playgrounds_hdb_sg_v1.0.yaml b/data/fitness_stations_and_playgrounds_hdb_sg_v1.0.yaml new file mode 100644 index 000000000..b339d1645 --- /dev/null +++ b/data/fitness_stations_and_playgrounds_hdb_sg_v1.0.yaml @@ -0,0 +1,244 @@ +openapi: 3.0.1 +info: + title: HDB Fitness Stations and Playgrounds (SG) + x-subscribelink: fitness_stations_and_playgrounds_hdb_sg + description: |+ + This Data microservice captures the indicative outline of fitness stations/playgrounds for all Housing Development Board of Singapore (HDB) Towns, HDB Estates and on HDB Land. The features were identified visually from high definition ortho-rectified aerial imagery (2014) and manually digitized. Objects largely obstructed by trees, structures and/or shadow are likely not captured in this dataset. The outlines of partially obstructed objects were extrapolated where possible and may not fully represent the actual shape of the actual object. + As this is a dataset download microservice, a successful call will return a pre-signed URL where the entire dataset can be downloaded as a CSV file. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + x-additionalinfo: |+ + Suggested Use Cases: + - Real estate services - can be used as a background check solution to extract information related to the types and number of fitness stations/playgrounds present in an area for people buying or renting a HDB home. + + Download the complete dataset using a pre-signed URL. It's a two steps process. + + **Step 1:** Get the pre-signed URL + + Replace the correct x-api-key, and API endpoint + + > **curl -X GET -H "Content-Type: application/json" -H "x-api-key:XXXXX" ** + **Step 2:** Download file + + Using the results.url (i.e) the pre-signed URL to download the dataset + + > **curl --request GET "results.url" >> "FILE_NAME"** + + **Data schema** + + | Name | Type | Size | Description | + |---|---|---|---|---| + | FEATID | Integer | N/A | Feature ID. Unique running number. | + | TYPE | Char | N/A | Captures the type of object. | + | LVL | Char | N/A | Captures whether the object is located at Ground level or Above Ground level. | + | QUALITY | Char | N/A | Captures whether the section of the feature was Fully Visible or Partially Visible. | + | INC_CRC | Varchar | 50 | Sub Location Id | + | FMEL_UPD_D | Datetime | N/A | Date Updated | + | Shape__Area | Float | N/A | Area of the feature | + | Shape__Length | Float | N/A | Length of the feature | + + version: '1.0.0' +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Apr 09, 2021" +paths: + /microservices/data/fitnessstationplaygrnd/v0/getdata: + get: + tags: + - v1.0.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + url: "" + status: Success + message: Successfully Processed + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: { "" } + description: Json Object of returned results + properties: + url: + type: string + description: pre-signed URL to download the file + example: "" + status: + type: string + example: Success + description: The status of the API call. success/failure + message: + type: string + example: Successfully Processed + description: Detail description on the api status + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Apr 09, 2021 + description: Optimized release + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Mar 24, 2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/flat_ownership_hdb_sg.yaml b/data/flat_ownership_hdb_sg.yaml similarity index 91% rename from yaml/flat_ownership_hdb_sg.yaml rename to data/flat_ownership_hdb_sg.yaml index c51acf96b..93f764f9e 100644 --- a/yaml/flat_ownership_hdb_sg.yaml +++ b/data/flat_ownership_hdb_sg.yaml @@ -1,14 +1,16 @@ openapi: 3.0.1 info: title: HDB Flat Ownership Duration (SG) + x-subscribelink: flat_ownership_hdb_sg description: |+ - This Data microservice returns information on flat ownership within Housing Development Board of Singapore (HDB) estates that includes location address, postal code, length of ownership and their quantity in units. - - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + This Data microservice returns information on flat ownership within Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, length of ownership and their quantity in units.The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme." **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - Real estate services - for example, this microservice can be used for services that are related to HDB ownership transfer (i.e. when one transfer, include, withdraw and/or substitute owners for a flat), such as when drafting up related legal documents. + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. @@ -83,17 +85,17 @@ info: > filterdata = {"filter":[{"match":{"street":"ang mo kio"}},{"match":{"len_of_ownership_id":"1"}}]} - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Apr 24, 2020" +- name: "v0.1.0" + description: "Published Date - May 15, 2020" paths: /DaaS/prod/hdb/ownership: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -135,7 +137,7 @@ paths: {"must":[{"match_phrase":{"street":"serangoon+central"}}],"filter":[{"match":{"postalcode":"550209"}}],"should":[{"range":{"no_of_units":{"gte":10}}}],"must_not":[{"match":{"len_of_ownership_id":"5"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -197,12 +199,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -411,16 +419,25 @@ components: example: Input Limit Exceeded status: type: string - example: Failure + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Apr 24,2020 + example: Published Date - May 15,2020 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/data/lidar_trajectory_data.yaml b/data/lidar_trajectory_data.yaml new file mode 100644 index 000000000..f3de0846d --- /dev/null +++ b/data/lidar_trajectory_data.yaml @@ -0,0 +1,504 @@ +openapi: 3.0.1 +info: + title: LiDAR Trajectory Data + x-subscribelink: lidar_trajectory_data + description: |+ + This microservice returns information on Ishikawajima-Harima Heavy Industries(IHI) Pointcloud Data which includes the 3DLR Location of Boon Lay Way-Yuan Ching Road, Singapore. The Data comprises all the vehicle detection and does not contain any pedestrian data. The IHI LiDAR programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with IHI to manage and facilitate the sharing of data for the LiDAR Programme. + + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). + + x-additionalinfo : |+ + Suggested Use Cases: + - This microservice can be used as a solution to help businesses better understand and connect with their customers, engage new prospects and increase revenue. For example, it can be used to create intelligent prospect lists that ensure one is always maximizing their marketing investment. + + **Refining queries in the filterdata field using filter types and match types** + The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. + + **Filter Types:** + A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: + + * **must** - All of the stated conditions must match. Equivalent to an AND operator. + + > {"must":[{"match_phrase":{"identify":10}}]} + + * **must_not** - All of the stated conditions must not match. Equivalent to a NOT operator. + > {"must_not":[{"match":{"identify":10}}]} + + * **should** - At least one of the stated conditions should match. Equivalent to an OR operator. + > {"should":[{"match_phrase":{"seqno":39736}}]} + + * **filter** - All of the stated conditions that must match. However, results are not scored unlike the other filter types which returns results based on how well the conditions are met. + > {"filter":[{"match":{"targetid":"c95#10920"}}]} + + For a more detailed guide on filter types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html). + + Filter types cannot be used alone and must be used in conjunction with a match type to complete the query. + **Match Types:** + A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: + + * **match** - Search within a full text field for a single word + > {"filter":[{"match":{"dataclass": "SD"}}]} + * **match_phrase** - Search within a full text field + > {"filter":[{"match_phrase":{"targetidx": "0x1451"}}]} + * **match_phrase_prefix** - Search within a full text field with prefix + > {"filter":[{"match_phrase_prefix":{"originid":"0x145D"}}]} + * **term** - Returns results that contain an exact term in a provided field + > {"filter":[{"term":{"situation":"0x02"}}]} + * **terms** - Returns results that contain one or more exact terms in a provided field + > {"filter":[{"terms":{"identify":[10,11,12]}}]} + + * **range** - Returns results that contain terms within a stipulated range + + > {"filter":[{"range":{"detecttime":{"gte":"2020-7-7T18:28:45.365Z"}}}]} + > {"filter":[{"range":{"detecttime":{"lte":"2020-7-7T19:19:39.985Z"}}}]} + > {"filter":[{"range":{"detecttime":{"gte":"2020-7-7T18:28:45.365Z","lte":"2020-7-7T19:19:39.985Z"}}}]} + + * **exists** - Returns results that contain any indexed value for a field + + > {"filter":[{"exists":{ "field":"identify"}}]} + For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). + + **Forming sophisticated queries using combinations of filter types (in JSON)** + Multiple filter types can be combined together in one query (written in JSON format) to form a very sophisticated query. Here’s one example below: + + > { + > "must":[{"match_phrase":{"targetidx": "0x1451"}}], + > "filter":[{"exists":{ "field": "detecttime"}}], + > "should":[{"match_phrase":{"seqno":39736}}], + > "must_not":[{"match":{"identify":10}}] + > } + **Sample Queries Based on Use Cases** + + 1. **Search for the number of vehicles crossed in jamlane 'zero' with the height of 261 of different vehicle types.** + Using a filterdata only: + + > {"filter":[{"match":{"height": 261}},{"match":{"jamlane":0}},{"terms":{"identify":[10,11,12]}}]} + + 2. **Search for the different types of vehicles like Motorcycle, Normal car, Large car of dataclass "SD" in the situation “0x02”.** + Using a filterdata only: + + > {"filter":[{"match":{"dataclass": "SD"}},{"match":{"situation":"0x02"}},{"terms":{"identify":[10,11,12]}}]} + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 26, 2021" +paths: + /DaaS/dev/ihidata: + get: + tags: + - v0.1.0 + parameters: + - in: query + name: querystring + schema: + type: string + description: |+ + Simple keyword search for matches in all searchable fields. Keywords separated by spaces will return results containing any of those keywords. For exact phrase match, put entire phrase in double quotes (" "). + + If this field is set to null, by default the microservice will return all buildings (within the stated limit), which can be further refined through the filterdata field for more sophisticated queries. + + example: "SD" + default: false + - in: query + name: offset + schema: + type: integer + description: The offset of the record list ie the starting index + example: "0" + default: false + - in: query + name: limit + schema: + type: integer + description: The max records to return for the request. Default - 10, Max - 10000 + example: "10" + default: false + - in: query + name: filterdata + schema: + type: string + description: |+ + Refine the search further on any of the possible through the 4 filter types : + * must + * must_not + * should + * filter + default: false + example: |+ + {"filter":[{"match":{"_id": "64406c95#64291"}},{"match":{"dataclass": "SD"}},{"match":{"detecttime": "2020-7-7T18:28:48.671Z"}}]} + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + total: 607176 + max_score: 1.0 + hits: + - _index: index_ihi_pointcloud + _type: dir_doc + _id: "64406c95#64291" + _score: 1.0 + _source: + 1x: 682 + 1y: 6210 + 2x: 782 + 2y: 6210 + createddate: '2021-03-04T03:29:14.930Z' + lastupdated: '2021-03-04T03:29:14.930Z' + dataclass: "SD" + datalen: 936 + datanumlow: 24 + datanumup: 0 + detecttime: '2020-7-7T18:28:48.671Z' + height: 47 + identify: 12 + jamlane: 0 + length: 100 + originid: "0x145D" + sendtime: '2020-7-7T18:28:48.792Z' + seqno: 64406 + situation: "0x02" + targetid: "c95#64291" + targetidx: "0x1451" + width: 100 + xspeed: 12 + yspeed: 14 + xcoord: "357844.6167091789" + ycoord: "148684.80620664736" + location: + lat: 1.3448589781787064 + lon: 103.72224233670825 + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + results: + type: object + example: {} + description: Json Object of returned results + properties: + total: + type: number + example: 607176 + description: Total number of records + max_score: + type: number + example: 1.0 + description: The highest score value + hits: + type: array + example: [{} + description: Json Object of returned hits + properties: + 1x: + type: number + description: X direction central top position of target + example: 682 + 1y: + type: number + description: Y direction central top position of target + example: 6210 + 2x: + type: number + description: X direction central tail position of target + example: 782 + 2y: + type: number + description: Y direction central tail position of target + example: 6210 + dataclass: + type: string + description: Type of Data + example: "SD" + datalen: + type: number + description: Lenght of the information + example: 936 + datanumlow: + type: number + description: Lower data number + example: 24 + datanumup: + type: number + description: Upper data number + example: 0 + detecttime: + type: string + description: Target detected time + example: "2020-7-7T18:28:48.671Z" + height: + type: number + description: Height of target + example: 47 + identify: + type: number + description: Target vehicle type + example: 12 + jamlane: + type: number + description: Jam lane number + example: 0 + length: + type: number + description: Length of target + example: 100 + originid: + type: string + description: Origin Id + example: "0x145D" + sendtime: + type: string + description: Target send time + example: "2020-7-7T18:28:48.792Z" + createddate: + type: string + description: Record first release date on sentient + example: "2021-03-04T03:29:14.930Z" + lastupdated: + type: string + description: Record last updated date on sentient + example: "2021-03-04T03:29:14.930Z" + seqno: + type: number + description: Sequence number of target + example: 64406 + situation: + type: string + description: Situation of target + example: "0x02" + targetid: + type: string + description: Target Id + example: "c95#64291" + targetidx: + type: string + description: Target Idx + example: "0x1451" + width: + type: number + description: Width of target + example: 100 + xspeed: + type: number + description: xspeed of target + example: 12 + yspeed: + type: number + description: yspeed of target + example: 14 + xcoord: + type: string + description: SVY21 X coordinates (Note, SVY21 is a localised plane coordinate system used specifically by Singapore. For global GPS lat/long coordinates, refer to "location" object) + example: "357844.6167091789" + ycoord: + type: string + description: SVY21 Y coordinates (Note, SVY21 is a localised plane coordinate system used specifically by Singapore. For global GPS lat/long coordinates, refer to "location" object) + example: "148684.80620664736" + location: + type: object + description: WGS84 (World Geodetic System) lat/long coordinates. This is the standard coordinate system used Global Positioning System (GPS). + example: {"lat":1.3448589781787064,"lon":103.72224233670825} + properties: + lat: + type: string + description: WGS84 (GPS) latitude + example: "1.3448589781787064" + lon: + type: string + description: WGS84 (GPS) longitude + example: "103.72224233670825" + + message: + type: string + example: Successfully Processed + description: The detail description on the status + status: + type: string + example: Success + description: The status of the API call Success/Failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 26,2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/lta_faulty_traffic_lights.yaml b/data/lta_faulty_traffic_lights.yaml new file mode 100644 index 000000000..cef7f2973 --- /dev/null +++ b/data/lta_faulty_traffic_lights.yaml @@ -0,0 +1,232 @@ +openapi: 3.0.1 +info: + title: LTA Faulty Traffic Lights + x-subscribelink: ltafaultytrafficlights + description: |+ + Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance. Updated every 2 minutes or whenever there are updates. + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" +paths: + /DaaS/dev/lta/FaultyTrafficLights: + get: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights + value: + - AlarmID: GL703034136 + NodeID: 703034136 + Type: 13 + StartDate: 2014-04-12 01:58:00.0 + EndDate: 2014-04-13 01:58:00.0 + Message: (23/1)8:58 Flashing Yellow at Bedok North Interchange/Bedok North Street 1 Junc + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + odata.metadata: + type: string + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#FaultyTrafficLights + description: url + value: + type: array + items: + type: object + properties: + AlarmID: + type: string + example: GL703034136 + description: Technical alarm ID + NodeID: + type: string + example: 703034136 + description: A unique code to represent each + unique traffic light node + Type: + type: number + example: 13 + description: Type of the technical alarm + • 4 (Blackout) + • 13 (Flashing Yellow) + StartDate: + type: string + example: 2014-04-12 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + EndDate: + type: string + example: 2014-04-13 01:58:00.0 + description: YYYY-MM-DD HH:MM:SS.ms + (empty field if this is not a + scheduled maintenance) + Message: + type: string + example: (23/1)8:58 Flashing Yellow at + Bedok North Interchange/Bedok + North Street 1 Junc + description: Canning Message + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 28, 2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/lta_road_works.yaml b/data/lta_road_works.yaml new file mode 100644 index 000000000..ff3b997c6 --- /dev/null +++ b/data/lta_road_works.yaml @@ -0,0 +1,233 @@ +openapi: 3.0.1 +info: + title: LTA Road Works + x-subscribelink: ltaroadworks + description: |+ + Returns all road works being / to be carried out. Updated every 24 hours or whenever there are updates. + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" +paths: + /DaaS/dev/lta/RoadWorks: + get: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#RoadWorks + value: + - EventID: RMAPP-201512-0217 + StartDate: 2021-2-14 + EndDate: 2021-3-31 + SvcDept: SP POWERGRID LTD - REGIONAL + NETWORK CENTRAL + RoadName: ADAM DRIVE + Other: For details, please call 67273085 + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + odata.metadata: + type: string + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#RoadWorks + description: url + value: + type: array + items: + type: object + properties: + EventID: + type: string + example: RMAPP-201512-0217 + description: ID for this road work + StartDate: + type: string + example: 2021-2-14 + description: Start date for the works + performed for this road work + (in YYYY-MM-DD format) + EndDate: + type: string + example: 2021-3-31 + description: End date for works performed + for this road work + (in YYYY-MM-DD format) + SvcDept: + type: string + example: SP POWERGRID LTD - REGIONAL + NETWORK CENTRAL + description: Department or company + performing this road work + RoadName: + type: string + example: ADAM DRIVE + description: Name of road where work is + being performed. + Other: + type: string + example: For details, please call 67273085 + description: Additional information or messages. + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 28, 2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/lta_traffic_images.yaml b/data/lta_traffic_images.yaml new file mode 100644 index 000000000..5e0cc7762 --- /dev/null +++ b/data/lta_traffic_images.yaml @@ -0,0 +1,217 @@ +openapi: 3.0.1 +info: + title: LTA Traffic Images + x-subscribelink: ltatrafficimages + description: |+ + Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints. Updates every 1 to 5 minutes or whenever there are updates. + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" +paths: + /DaaS/dev/lta/Traffic-Imagesv2: + get: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 + value: + - CameraID: 1001 + Latitude: 1.3290499998616139 + Longitude: 103.87474391991731 + ImageLink: https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + odata.metadata: + type: string + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#Traffic-Imagesv2 + description: url + value: + type: array + items: + type: object + properties: + CameraID: + type: string + example: 1001 + description: A unique ID for this camera + Latitude: + type: string + example: 1.3290499998616139 + description: Latitude map coordinates + Longitude: + type: number + example: 103.87474391991731 + description: Longitude map coordinates + ImageLink: + type: string + example: 'https://dm-traffic-camera-itsc.s3.amazonaws.com/2021-02-25/15-27/1001_1523_20210225152731_1c29e4.jpg?x-amz-security-token=IQoJb3JpZ2luX2VjEA8aDmFwLXNvdXRoZWFzdC0xIkYwRAIgB9vybH4h7daI43qfBeZMS%2FSX6av1yjSu73Q0kqbTD4ICIDTHpUSoXG7OU3EOtK0z0F6NGxf1c0xQwrULNgEbaiFhKqMDCCgQAhoMMzQwNjQ1MzgxMzA0IgyLggWjvfs4g1sMc4UqgAOZXEmpoGYRlnDs9tu6COLECjNNgalDexWPvFpq1a3A9dDM%2Bp6mRAQxxuja%2Bcob2Ox1fPgE%2Bhf24arud9Xr11cNNybleHqCWnBGsjhOo6JNP2gOraux84cXhEjGarHp4%2FvwXGVFQbmF%2B1J9QQlCa2D4LW%2Ffr8hnBsNGKVMe7k7MoS1QfKePl500wUYvhDJEZqPej54BGt%2BlPGorwFBQ%2B10n8vyiwShBxd%2BHBQFxpbuf72fRS9VAYilkCyp8%2FeohmSVh%2BeJXVWvcS5rGiIKd%2FyTOK7nL91s08EiJ0uhwZNJdbu3XdZPFXPTI%2Ban%2BHSkurfa3%2B05mSo4aP%2FGm5NPxP9xzCphiu65ugpN%2BOYxUwwErT7oTPQjI1ZiUJOXvWGhSA5WpKEzVTNPx3aYDtjB8T7qDky8A%2BjsQyvKQARdxM9buz8H1pej8KDsnHr%2BAgupNy%2F9kNk9kBdxPnj67WaVot9WdIOHcj8knf4SVIZCy%2FMESBMVkXT%2BwRLJ8XJaSFR13sl4wvY3dgQY67AG3IH44KUVXKCnh36UJ5nCpEaT162Y6dleCP2Okragprp%2BhIMQHcb3spNoLRHVcq3Zj%2B53o2s4yF6%2FO6BUe1nSZ31X890J6Wao3yFwhrbyULbRAA8Ni3R%2ForYYK0l3213NtV%2FyaIp9o02EAyG7sWOhvsD7MbofMBI2GS%2FbrmEYHjdSTrMCkZje0zG6Q5L60rWgiRVBn5Sa2ogUYk0c%2F4ecnQ8taiVzEuoQsV5CTB5ou2pQVKP1fbefNyu1B18542VLLqJW8mHZ6eoYf%2FwGK7tqJaJf1sPRr2qZ0YbVtkQCo03ZYm0fetH3mXsCYWQ%3D%3D&AWSAccessKeyId=ASIAU6UAMAS4GTPW2LXI&Expires=1614238351&Signature=6xg03%2FpXKMJDVKyXV7X%2FjeLhVb8%3D' + description: |+ + • Link for downloading this image. + • Link will expire after 5 minutes + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 28, 2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/data/lta_traffic_incidents.yaml b/data/lta_traffic_incidents.yaml new file mode 100644 index 000000000..9163ee908 --- /dev/null +++ b/data/lta_traffic_incidents.yaml @@ -0,0 +1,227 @@ +openapi: 3.0.1 +info: + title: LTA Traffic Incidents + x-subscribelink: ltatrafficincidents + description: |+ + Returns incidents currently happening on the roads, such as Accidents, Vehicle Breakdowns, Road Blocks, Traffic Diversions etc. + Updated every 2 minutes or whenever there are updates. + version: '0.1.0' +servers: + - url: 'https://api.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" +paths: + /DaaS/dev/lta/TrafficIncidents: + get: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + value: + - Type: Roadwork + Latitude: 1.3765155261589948 + Longitude: 103.72976844706339 + Message: "(25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane." + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] +components: + schemas: + success: + type: object + properties: + odata.metadata: + type: string + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#IncidentSet + description: url + value: + type: array + items: + type: object + properties: + Type: + type: string + example: GL703034136 + description: |+ + Incident Types - + • Accident + • Road Works + • Vehicle Breakdown + • Weather + • Obstacle + • Road Block + • Heavy Traffic + • Misc. + • Diversion + • Unattended Vehicle + Latitude: + type: string + example: 1.3415018509600185 + description: Latitude map coordinates for the start point of this road incident + Longitude: + type: string + example: 103.71215415465709 + description: Longitude map coordinates for the start point of this incident + Message: + type: string + example: (25/2)13:13 Roadworks on Boon Lay Way (towards City) after Jalan Boon Lay. Avoid right lane. + description: Description message for this incident + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 28, 2021 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header. diff --git a/yaml/Automatic-Speech-Recognition-CHI.yaml b/data/lta_vms.yaml similarity index 60% rename from yaml/Automatic-Speech-Recognition-CHI.yaml rename to data/lta_vms.yaml index 4f0d859a2..4a61ed07d 100644 --- a/yaml/Automatic-Speech-Recognition-CHI.yaml +++ b/data/lta_vms.yaml @@ -1,31 +1,35 @@ openapi: 3.0.1 info: - title: Automatic Speech Recognition CHI (SG) - description: >- - This Voice microservice takes in the input audio file (in WAV format at 16kHz) and transcribes Mandarin speech content within the input file into text.

This microservice works best for if the audio file consists of mostly speech with no long pauses in between."

This microservice works best for if the audio file consists of mostly speech with no long pauses in between. - version: '0.1' + title: LTA VMS + x-subscribelink: ltavms + description: |+ + Returns traffic advisories (via variable message services) concerning current traffic conditions that are displayed on + EMAS signboards along expressways and arterial roads.2 minutes – whenever there are updates + version: '0.1.0' servers: - - url: 'https://apis.sentient.io' + - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Jun 18, 2018" +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" paths: - /microservices/voice/asrsch/v0.1/getpredictions: - post: + /DaaS/dev/lta/VMS: + get: tags: - - v0.1 + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: $ref: '#/components/schemas/success' - headers: - Set-Cookie: - schema: - type: string - example: x-api-key=abcde12345; Path=/; + example: + odata.metadata: http://datamall2.mytransport.sg/ltaodataservice/$metadata#VMS + value: + - EquipmentID: AVMS_01_00501 + Latitude: 1.3290499998616139 + Longitude: 103.87474391991731 + Message: ROAD|WORKS ON|BENDEMEER '401': description: Unauthorized content: @@ -56,12 +60,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -76,25 +86,36 @@ paths: $ref: '#/components/schemas/gatewaytimeout' security: - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true components: schemas: success: type: object properties: - message: + odata.metadata: + type: string + example: http://datamall2.mytransport.sg/ltaodataservice/$metadata#VMS + description: url + value: + type: array + items: + type: object + properties: + EquipmentID: + type: string + example: AVMS_01_00501 + description: EMAS equipment ID + Latitude: + type: string + example: 1.3290499998616139 + description: Latitude map coordinates of electronic signboard. + Longitude: type: string - example: 各位 同学 朋友 老师 教授 大家好 我叫 墓园 - description: Converted Text - status: - type: string - example: success - description: The status of the API call success/failure + example: 103.87474391991731 + description: Longitude map coordinates of electronic signboard. + Message: + type: string + example: ROAD|WORKS ON|BENDEMEER + description: VEH BREAKDOWN SH,AFTU.THOMSON unauthorized: type: object properties: @@ -167,12 +188,25 @@ components: status: type: string example: Failure - input: + invalidinput: type: object properties: - audio: + message: + type: string + example: Invalid Input + status: type: string - example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 28, 2021 + description: Initial version release securitySchemes: APIAuthorizer: type: apiKey diff --git a/data/realtime_weather.yaml b/data/realtime_weather.yaml new file mode 100644 index 000000000..9d58439ed --- /dev/null +++ b/data/realtime_weather.yaml @@ -0,0 +1,396 @@ +openapi: 3.0.1 +info: + title: Realtime Weather + x-subscribelink: realtime_weather + description: |+ + Current weather or realtime weather API method allows a user to get up to date current weather information. The data is returned as a Current Object. + + Current object contains current or realtime weather information for a given city. + + version: '0.1.0' +servers: + - url: 'https://dev-apis.sentient.io' +tags: +- name: "v0.1.0" + description: "Published Date - Feb 28, 2021" +paths: + /microservices/data/weather/v0/getdata: + post: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + current: + cloud: 25 + condition: + code: 1030 + icon: "//cdn.weatherapi.com/weather/64x64/day/143.png" + text: Mist + feelslike_c: 25.7 + feelslike_f: 78.3 + gust_kph: 7.9 + gust_mph: 4.9 + humidity: 83 + is_day: 1 + last_updated: 2021-02-25 08:30 + last_updated_epoch: 1614222011 + precip_in: 0 + precip_mm: 0 + pressure_in: 30.4 + pressure_mb: 1013 + temp_c: 24 + temp_f: 75.2 + uv: 1 + vis_km: 1.5 + vis_miles: 0 + wind_degree: 320 + wind_dir: NW + wind_kph: 6.1 + wind_mph: 3.8 + location: + country: India + lat: 13.08 + localtime: 2021-02-25 8:31 + localtime_epoch: 1614222076 + lon: 80.28 + name: Chennai + region: Tamil Nadu + tz_id: Asia/Kolkata + '400': + description: Restricted + content: + application/json: + schema: + $ref: '#/components/schemas/restricted' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + current: + type: object + properties: + cloud: + type: integer + example: 25 + description: Cloud cover as percentage + condition: + type: object + properties: + code: + type: number + example: 1030 + description: Weather condition unique code. + icon: + type: string + example: //cdn.weatherapi.com/weather/64x64/day/143.png + description: Weather icon url. + text: + type: string + example: mist + description: Weather condition text. + feelslike_c: + type: number + example: 25.7 + description: Feels like temperature in celsius + feelslike_f: + type: number + example: 78.3 + description: Feels like temperature in fahrenheit + gust_kph: + type: number + example: 7.9 + description: Wind gust in kilometer per hour + gust_mph: + type: number + example: 4.9 + description: Wind gust in miles per hour + humidity: + type: number + example: 83 + description: Humidity as percentage + is_day: + type: number + example: 1 + description: 1 = Yes 0 = No + Whether to show day condition icon or night icon + last_updated: + type: string + example: 2021-02-25 08:30 + description: Local time when the real time data was updated. + last_updated_epoch: + type: number + example: 21614222011 + description: Local time when the real time data was updated in unix time. + precip_in: + type: number + example: 0.0 + description: Precipitation amount in inches + precip_mm: + type: number + example: 0.0 + description: Precipitation amount in millimeters + pressure_in: + type: number + example: 30.4 + description: Pressure in inches + pressure_mb: + type: number + example: 1013.0 + description: Pressure in millibars + temp_c: + type: number + example: 24.0 + description: Temperature in celsius + temp_f: + type: number + example: 75.2 + description: Temperature in fahrenheit + uv: + type: number + example: 1.0 + description: UV Index + vis_km: + type: number + example: 1.5 + description: Average visibility in kilometer + vis_miles: + type: number + example: 0.0 + description: Average visibility in miles + wind_degree: + type: number + example: 320 + description: Wind direction in degrees + wind_dir: + type: string + example: "NW" + description: Wind direction as 16 point compass. e.g.- NSW + wind_kph: + type: number + example: 6.1 + description: Wind speed in kilometer per hour + wind_mph: + type: number + example: 3.8 + description: Wind speed in miles per hour + location: + type: object + properties: + country: + type: string + example: India + description: Name of country + lat: + type: number + example: 13.08 + description: Latitude in decimal degree + localtime: + type: string + example: 2021-02-25 8:31 + description: Latitude in decimal degree + localtime_epoch: + type: number + example: 1614222076 + description: Time as epoch + lon: + type: number + example: 80.28 + description: Longitude in decimal degree + name: + type: string + example: Chennai + description: City name + region: + type: string + example: Tamil Nadu + description: Region name + tz_id: + type: string + example: Asia/Kolkata + description: Time zone + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + restricted: + type: object + properties: + message: + type: string + example: The content is restricted + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Feb 28, 2021 + description: Initial version release + input: + type: object + required: + - city + properties: + city: + type: string + default: true + example: punggol + description: city name + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/residential_sales_and_rental_hdb_sg.yaml b/data/residential_sales_and_rental_hdb_sg.yaml similarity index 94% rename from yaml/residential_sales_and_rental_hdb_sg.yaml rename to data/residential_sales_and_rental_hdb_sg.yaml index d5ff2487d..f7e106a1d 100644 --- a/yaml/residential_sales_and_rental_hdb_sg.yaml +++ b/data/residential_sales_and_rental_hdb_sg.yaml @@ -1,16 +1,18 @@ openapi: 3.0.1 info: title: HDB Residential Occupancy Status (SG) + x-subscribelink: residential_sales_and_rental_hdb_sg description: |+ This Data microservice retreives comprehensive details of each HDB block in Singapore including the number of units for each type of flats and whether they were sold or leased. Queries based on keywords and proximity to particular locations can be performed. Updated weekly. The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - - Suggested Use Cases: Community app that benefits from geo-targeting family types and income groups by areas for non-profit charity/social organizations, real estate developers, property agencies, retail shops, marketing for educational sector, government agencies. **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - Information can be used to build a community app that benefits from geo-targeting family types and income groups by areas for non-profit charity/social organizations, real estate developers, property agencies, retail shops, marketing for educational sector, government agencies. + **Refining queries in the filterdata field using filter types and match types** The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. @@ -84,17 +86,17 @@ info: > filterdata = {"filter":[{"match_phrase": {"street":"bishan street 24"}},{"range": {"4room_sold":{"gte":1}}}]} - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 10, 2019" +- name: "v0.1.0" + description: "Published Date - Nov 25, 2019" paths: /DaaS/prod/hdb/buildinginfo: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -136,7 +138,7 @@ paths: {"must":[{"match_phrase":{"street":"serangoon+central"}}],"filter":[{"range":{"year_completed":{"gte":1}}}],"should":[{"match":{"postalcode":"650633"}}],"must_not":[{"match":{"postalcode":"650634"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -209,12 +211,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -433,6 +441,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure gatewaytimeout: type: object properties: @@ -463,12 +480,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Oct 10,2019 + example: Published Date - Nov 25,2019 description: Initial version release securitySchemes: APIAuthorizer: diff --git a/yaml/season_parking_availability_hdb_sg.yaml b/data/season_parking_availability_hdb_sg.yaml similarity index 88% rename from yaml/season_parking_availability_hdb_sg.yaml rename to data/season_parking_availability_hdb_sg.yaml index 08fa0f339..3bf6f3f0c 100644 --- a/yaml/season_parking_availability_hdb_sg.yaml +++ b/data/season_parking_availability_hdb_sg.yaml @@ -1,20 +1,21 @@ openapi: 3.0.1 info: title: HDB Season Parking Availability (SG) + x-subscribelink: season_parking_availability_hdb_sg description: |+ - This Data microservice returns season car park availability information within Housing Development Board of Singapore (HDB) estates that includes location address, postal code, branch office, vehicle type and parking lot availability for different types of vehicle by carpark location. - - The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. - - **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). + This Data microservice returns information on season car park availability within Housing Development Board of Singapore (HDB) estates and includes the location address, postal code, branch office, vehicle type and parking lot availability for different types of vehicle by carpark location. + The HDB POTH programme makes selected public and non-public datasets available to developers and companies to improve their service offerings to benefit the lives of Singapore citizens. Sentient.io is proud to partner with HDB to manage and facilitate the sharing of data for the POTH Programme. + **Note:** As this microservice uses the GET method, developers using this microservice must remember to have their app encode all the input values to be URL friendly (i.e. all spaces and special characters must be replaced). Here’s a reference on [URL encoding](https://www.w3schools.com/tags/ref_urlencode.ASP). x-additionalinfo : |+ + Suggested Use Cases: + - Real estate services - can be used as a background check solution to extract information related to season car park availability in an area for people with certain preferences when buying or renting a HDB home. + - Can also be integrated into apps related to maps or parking for more detailed carpark information within Singapore HDB estates + **Refining queries in the filterdata field using filter types and match types** - The filterdata fields use elasticsearch’s syntax (specifically filter types and match types) to help further refine search results and provide greater flexibility in structuring more sophisticated queries. **Filter Types:** - A filter type is a logic operator to which the search results must fulfill certain logical conditions to be returned. The supported match types are: * **must** - All of the stated conditions must match. Equivalent to an AND operator. @@ -39,23 +40,14 @@ info: A match type is a match operator nested within a filter type that fine-tunes the matching condition of the text search. The supported match types are: * **match** - Search within a full text field for a single word - > {"match":{"street":"serangoon"}} - * **match_phrase** - Search within a full text field - > {"match_phrase":{"street":"bishan street 24"}} - * **match_phrase_prefix** - Search within a full text field with prefix - > {"match_phrase_prefix":{"street":"bishan street 24"}} - * **term** - Returns results that contain an exact term in a provided field - > {"term":{"car_park_group":"G15"}} - * **terms** - Returns results that contain one or more exact terms in a provided field - > {"terms":{"car_park_group":["G15","G39"]}} * **range** - Returns results that contain terms within a stipulated range @@ -67,7 +59,6 @@ info: * **exists** - Returns results that contain any indexed value for a field > {"exists":{ "field": "postalcode"}} - For a more detailed guide to match types, [refer to this](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/term-level-queries.html). **Forming sophisticated queries using combinations of filter types (in JSON)** @@ -79,7 +70,6 @@ info: > "should":[{"match":{"car_park_group":"G18"}}], > "must_not":[{"match":{"postalcode":"550409"}}] > } - **Sample Queries Based on Use Cases** 1. **Search for the parking lot availability for commercial vehicle at the carpark of 503 Serangoon North Avenue 4.** @@ -88,17 +78,17 @@ info: > filterdata = {"filter":[{"match":{"street":"serangoon north avenue 4"}},{"match":{"block":"503"}},{"match":{"vehicle_type":"H"}}]} - version: '0.1' + version: '0.1.0' servers: - url: 'https://api.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 10, 2019" +- name: "v0.1.0" + description: "Published Date - May 15, 2020" paths: /DaaS/prod/hdb/carparkavailability: get: tags: - - v0.1 + - v0.1.0 parameters: - in: query name: querystring @@ -140,7 +130,7 @@ paths: {"must":[{"match_phrase":{"street":"serangoon north avenue 4"}}],"filter":[{"match":{"vehicle_type":"Y"}}],"should":[{"match":{"car_park_group":"G18"}}],"must_not":[{"match":{"postalcode":"550409"}}]} responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -203,12 +193,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -371,6 +367,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure notfound: type: object properties: @@ -419,12 +424,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Oct 10,2019 + example: Published Date - May 15,2020 description: Initial version release securitySchemes: APIAuthorizer: @@ -433,4 +438,3 @@ components: in: header x-amazon-apigateway-authtype: custom description: Authentication is done using the x-api-key in the request header. - diff --git a/yaml/download_dataset.yaml b/data_alliance/download_dataset.yaml similarity index 89% rename from yaml/download_dataset.yaml rename to data_alliance/download_dataset.yaml index 39d123a41..34c1dc112 100644 --- a/yaml/download_dataset.yaml +++ b/data_alliance/download_dataset.yaml @@ -1,9 +1,9 @@ info: title: Data Alliance - Download Dataset API - version: '0.1' + version: '0.1.0' # tags must include in to the documentation, to read the description text for published date tags: -- name: "v0.1" +- name: "v0.1.0" description: " " html: |+ diff --git a/yaml/online_command_automatic_speech_recognition_eng_sg.yaml b/voice/online_command_automatic_speech_recognition_eng_sg.yaml similarity index 79% rename from yaml/online_command_automatic_speech_recognition_eng_sg.yaml rename to voice/online_command_automatic_speech_recognition_eng_sg.yaml index 1946f9fd5..8dbaeec6a 100644 --- a/yaml/online_command_automatic_speech_recognition_eng_sg.yaml +++ b/voice/online_command_automatic_speech_recognition_eng_sg.yaml @@ -1,10 +1,10 @@ info: title: Online Command Automatic Speech Recognition ENG (SG) - version: '0.1' + version: '0.1.0' # tags must include in to the documentation, to read the description text for published date tags: -- name: "v0.1" - description: " " +- name: "v0.1.0" + description: "Published Date - Aug 31, 2020" html: |+ diff --git a/yaml/text-to-speech_chi.yaml b/voice/text-to-speech_chi.yaml similarity index 76% rename from yaml/text-to-speech_chi.yaml rename to voice/text-to-speech_chi.yaml index ce0e901f1..3ef721736 100644 --- a/yaml/text-to-speech_chi.yaml +++ b/voice/text-to-speech_chi.yaml @@ -5,20 +5,30 @@ info: This Voice microservice converts Mandarin text into speech in a female voice. The Text-to-Speech AI generated synthesized voice speaks with native Mandarin accent. - version: '0.1' + + Do ensure that your text is **within 750 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Voice bots in contact centers - Deliver a better voice experience for customer service by dynamically generating speech, instead of playing static, pre-recorded audio. Engage with synthesized voices that give callers a sense of familiarity and personalization. + + - Voice generation in devices - Enable natural communications with users by empowering your devices to speak humanlike voices. Build an end-to-end voice user interface together with Speech-to-Text and improve user experience with easy and engaging interactions. + + - Accessible EPGs (Electronic Program Guides) - Implement text-to-speech functionality in EPGs to provide a better user experience to customers and meet accessibility requirements for services and applications. + version: '0.1.0' + x-subscribelink: text-to-speech_chi servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - Oct 01, 2018" +- name: "v0.1.0" + description: "Published Date - Sep 28, 2018" paths: /microservices/voice/ttssch/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -57,12 +67,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -99,7 +115,7 @@ components: audioContent: type: string example: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= - description: Audio wav file convert to base64 encode string + description: Audio file converted to base64 encoded string. unauthorized: type: object properties: @@ -118,6 +134,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure paymentrequired: type: object properties: @@ -175,12 +200,12 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: - type: string - example: Published Date - Oct 01,2018 + example: Published Date - Sep 28,2018 description: Initial version release input: type: object diff --git a/voice/text-to-speech_eng.yaml b/voice/text-to-speech_eng.yaml new file mode 100644 index 000000000..2e11a025b --- /dev/null +++ b/voice/text-to-speech_eng.yaml @@ -0,0 +1,347 @@ +openapi: 3.0.1 +info: + title: Text-To-Speech ENG + description: | + "This Voice microservice converts English text into speech in a female voice. + + The Text-to-Speech AI generated synthesized voice speaks with Singapore English accent. + + Do ensure that your text is within **2000 characters**. + x-additionalinfo: |+ + Suggested Use Cases: + - Transcribes spoken English words, sentences or phrases into written forms + + - Voice bots in contact centers - deliver a better voice experience for customer service by dynamically generating speech, instead of playing static, pre-recorded audio. Engage with synthesized voices that give callers a sense of familiarity and personalization. + + - Voice generation in devices - enable natural communications with users by empowering your devices to speak humanlike voices. Build an end-to-end voice user interface together with Speech-to-Text and improve user experience with easy and engaging interactions. + + - Accessible EPGs (Electronic Program Guides) - implement text-to-speech functionality in EPGs to provide a better user experience to customers and meet accessibility requirements for services and applications. + version: '0.1.0' + x-subscribelink: text-to-speech_eng +servers: + - url: 'https://apis.sentient.io' +tags: + - name: v0.1.0 + description: 'Published Date - Sep 28, 2018' +paths: + /microservices/voice/ttseng/v0.1/getpredictions: + post: + tags: + - v0.1.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + audioContent: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= + message: Successfully Processed + status: Success + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true + x-codeSamples: + - lang: Python + Python3 + source: |- + import http.client + + conn = http.client.HTTPSConnection("apis.sentient.io") + + payload = "{\"text\":\"Testing microservice\"}" + + headers = { + 'content-type': "application/json", + 'x-api-key': "REPLACE_KEY_VALUE" + } + + conn.request("POST", "/microservices/voice/ttseng/v0.1/getpredictions", payload, headers) + + res = conn.getresponse() + data = res.read() + + print(data.decode("utf-8")) + - lang: Csharp + Restsharp + source: |- + var client = new RestClient("https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions"); + var request = new RestRequest(Method.POST); + request.AddHeader("content-type", "application/json"); + request.AddHeader("x-api-key", "REPLACE_KEY_VALUE"); + request.AddParameter("application/json", "{\"text\":\"Testing microservice\"}", ParameterType.RequestBody); + IRestResponse response = client.Execute(request); + - lang: Go + Native + source: "package main\n\nimport (\n\t\"fmt\"\n\t\"strings\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions\"\n\n\tpayload := strings.NewReader(\"{\\\"text\\\":\\\"Testing microservice\\\"}\")\n\n\treq, _ := http.NewRequest(\"POST\", url, payload)\n\n\treq.Header.Add(\"content-type\", \"application/json\")\n\treq.Header.Add(\"x-api-key\", \"REPLACE_KEY_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}" + - lang: Java + Unirest + source: |- + HttpResponse response = Unirest.post("https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions") + .header("content-type", "application/json") + .header("x-api-key", "REPLACE_KEY_VALUE") + .body("{\"text\":\"Testing microservice\"}") + .asString(); + - lang: Node + Native + source: |- + const http = require("https"); + + const options = { + "method": "POST", + "hostname": "apis.sentient.io", + "port": null, + "path": "/microservices/voice/ttseng/v0.1/getpredictions", + "headers": { + "content-type": "application/json", + "x-api-key": "REPLACE_KEY_VALUE" + } + }; + + const req = http.request(options, function (res) { + const chunks = []; + + res.on("data", function (chunk) { + chunks.push(chunk); + }); + + res.on("end", function () { + const body = Buffer.concat(chunks); + console.log(body.toString()); + }); + }); + + req.write(JSON.stringify({text: 'Testing microservice'})); + req.end(); + - lang: Php + Curl + source: |- + "https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions", + CURLOPT_RETURNTRANSFER => true, + CURLOPT_ENCODING => "", + CURLOPT_MAXREDIRS => 10, + CURLOPT_TIMEOUT => 30, + CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, + CURLOPT_CUSTOMREQUEST => "POST", + CURLOPT_POSTFIELDS => "{\"text\":\"Testing microservice\"}", + CURLOPT_HTTPHEADER => [ + "content-type: application/json", + "x-api-key: REPLACE_KEY_VALUE" + ], + ]); + + $response = curl_exec($curl); + $err = curl_error($curl); + + curl_close($curl); + + if ($err) { + echo "cURL Error #:" . $err; + } else { + echo $response; + } + - lang: Ruby + Native + source: |- + require 'uri' + require 'net/http' + require 'openssl' + + url = URI("https://apis.sentient.io/microservices/voice/ttseng/v0.1/getpredictions") + + http = Net::HTTP.new(url.host, url.port) + http.use_ssl = true + http.verify_mode = OpenSSL::SSL::VERIFY_NONE + + request = Net::HTTP::Post.new(url) + request["content-type"] = 'application/json' + request["x-api-key"] = 'REPLACE_KEY_VALUE' + request.body = "{\"text\":\"Testing microservice\"}" + + response = http.request(request) + puts response.read_body +components: + schemas: + success: + type: object + properties: + message: + type: string + example: Successfully Processed + description: Detail description on the api status + status: + type: string + example: Success + description: The status of the API call success/failure + audioContent: + type: string + example: UklGRiQAAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YQAAAAA= + description: Audio file converted to base64 encoded string. + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + versions: + type: object + properties: + v0.1.0: + type: array + items: + oneOf: + - type: string + example: 'Published Date - Sep 28,2018' + description: Initial version release + input: + type: object + required: + - text + properties: + text: + x-name: text + type: string + default: true + example: Testing microservice + description: | + Input text + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/voice_activity_detection_eng.yaml b/voice/voice_activity_detection_eng.yaml similarity index 80% rename from yaml/voice_activity_detection_eng.yaml rename to voice/voice_activity_detection_eng.yaml index 8528d9370..f1906f013 100644 --- a/yaml/voice_activity_detection_eng.yaml +++ b/voice/voice_activity_detection_eng.yaml @@ -5,20 +5,31 @@ info: This Voice microservice detects utterances in the input audio and outputs the start and end time of these utterances. An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. - version: '0.1' + The length of your audio should be **upto 60 seconds**. + x-additionalinfo: |+ + Suggested Use Cases: + - Narrate a blurb or chunk of text in English + + - Improve customer service - empower a customer service system by adding IVR (interactive voice response) and agent conversations to call centers. Perform analytics on conversation data to gain more insights into the calls and customers. + + - Enable voice control - implement voice commands such as “turn the volume up,” and voice search such as saying “what is the temperature in Paris?” + + - Transcribe multimedia content - transcribe audio and video to include captions and improve audience reach and experience. For example, this microservice can be used for indexing or subtitling video and/or multispeaker content; similar to video captioning on YouTube. + version: '0.1.0' + x-subscribelink: voice_activity_detection_eng servers: - url: 'https://apis.sentient.io' tags: -- name: "v0.1" - description: "Published Date - July 3, 2020" +- name: "v0.1.0" + description: "Published Date - Jul 03, 2020" paths: /microservices/voice/vad/v0.1/getpredictions: post: tags: - - v0.1 + - v0.1.0 responses: '200': - description: success response + description: Ok content: application/json: schema: @@ -56,12 +67,18 @@ paths: application/json: schema: $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded + '413': + description: Payload Too Large content: application/json: schema: - $ref: '#/components/schemas/inputlimitexceeded' + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' '500': description: Internal Server Error content: @@ -145,6 +162,15 @@ components: status: type: string example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure servererror: type: object properties: @@ -204,7 +230,7 @@ components: versions: type: object properties: - v0.1: + v0.1.0: type: array items: oneOf: diff --git a/voice/voice_activity_detection_eng_v1.0.yaml b/voice/voice_activity_detection_eng_v1.0.yaml new file mode 100644 index 000000000..d761e2224 --- /dev/null +++ b/voice/voice_activity_detection_eng_v1.0.yaml @@ -0,0 +1,266 @@ +openapi: 3.0.1 +info: + title: Voice Activity Detection ENG + description: |+ + This Voice microservice detects utterances in the input audio and outputs the start and end time of these utterances. + + An utterance is the smallest unit of speech. It is a continuous piece of speech beginning and ending with a clear pause. + The length of your audio should be **upto 60 seconds**. + version: '1.0.0' + x-additionalinfo: |+ + Suggested Use Cases: + - Narrate a blurb or chunk of text in English + - Improve customer service - empower a customer service system by adding IVR (interactive voice response) and agent conversations to call centers. Perform analytics on conversation data to gain more insights into the calls and customers. + - Enable voice control - implement voice commands such as “turn the volume up,” and voice search such as saying “what is the temperature in Paris?” + - Transcribe multimedia content - transcribe audio and video to include captions and improve audience reach and experience. For example, this microservice can be used for indexing or subtitling video and/or multispeaker content; similar to video captioning on YouTube. + x-subscribelink: voice_activity_detection_eng +servers: + - url: 'https://apis.sentient.io' +tags: +- name: "v1.0.0" + description: "Published Date - Dec 09, 2020" +paths: + /microservices/voice/vad/v1/getpredictions: + post: + tags: + - v1.0.0 + responses: + '200': + description: Ok + content: + application/json: + schema: + $ref: '#/components/schemas/success' + example: + results: + output: [{end: 23.72,seqNum: 1,start: 0.64}] + message: Successfully Processed + status: Success + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/unauthorized' + '402': + description: Payment Required + content: + application/json: + schema: + $ref: '#/components/schemas/paymentrequired' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/forbidden' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/notfound' + '419': + description: Input Field Missing + content: + application/json: + schema: + $ref: '#/components/schemas/inputfieldmissing' + '413': + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/inputlimitexceeded' + '415': + description: Unsupported Media Type + content: + application/json: + schema: + $ref: '#/components/schemas/invalidinput' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/servererror' + '504': + description: Gateway Timeout + content: + application/json: + schema: + $ref: '#/components/schemas/gatewaytimeout' + security: + - APIAuthorizer: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/input' + required: true +components: + schemas: + success: + type: object + properties: + results: + type: object + description: The result of the API call. + example: { "" } + properties: + output: + type: array + example: [{end: 23.72,seqNum: 1,start: 0.64}] + description: List of details of start and end time of utterances in the input audio + items: + oneOf: + - type: object + properties: + end: + type: number + format: float + example: 23.72 + description: End time of utterance, in seconds. Offset from the start of stream. + seqNum: + type: number + example: 1 + description: Running sequence. Starts from 1. + start: + type: number + format: float + example: 0.64 + description: Start time of utterance, in seconds. Offset from the start of stream. + message: + type: string + example: Successfully Processed + description: Detail description on the API status + status: + type: string + example: Success + description: The status of the API call success/failure + unauthorized: + type: object + properties: + message: + type: string + example: Missing Authentication Token + status: + type: string + example: Failure + forbidden: + type: object + properties: + message: + type: string + example: Access Denied Unauthorized User + status: + type: string + example: Failure + invalidinput: + type: object + properties: + message: + type: string + example: Invalid Input + status: + type: string + example: Failure + paymentrequired: + type: object + properties: + message: + type: string + example: Insufficient Credits Kindly Top Up + status: + type: string + example: Failure + notfound: + type: object + properties: + message: + type: string + example: Invalid Request URL + status: + type: string + example: Failure + servererror: + type: object + properties: + message: + type: string + example: Internal Server Error + status: + type: string + example: Failure + gatewaytimeout: + type: object + properties: + message: + type: string + example: Request Timeout + status: + type: string + example: Failure + inputfieldmissing: + type: object + properties: + message: + type: string + example: Input Field Missing + status: + type: string + example: Failure + inputlimitexceeded: + type: object + properties: + message: + type: string + example: Input Limit Exceeded + status: + type: string + example: Failure + input: + type: object + required: + - wav_base64 + properties: + wav_base64: + x-name: wav_base64 + type: string + default: true + example: UklGRkbiBABXQVZFZm10IBAAAAABA... + description: |+ + Required. Input audio file in base64 format. + threshold: + x-name: threshold + type: number + format: float + default: false + example: 0.2 + description: |+ + Optional. Threshold ranges between 0.0 and 1.0 and default is 0.4 + versions: + type: object + properties: + v1.0.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Dec 09, 2020 + description: Standardizing Output JSON + v0.1.0: + type: array + items: + oneOf: + - type: string + example: Published Date - Jul 03,2020 + description: Initial version release + securitySchemes: + APIAuthorizer: + type: apiKey + name: x-api-key + in: header + x-amazon-apigateway-authtype: custom + description: Authentication is done using the x-api-key in the request header diff --git a/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml b/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml deleted file mode 100644 index 578a7a3b1..000000000 --- a/yaml/BasicIndividualSearchDun&Bradstreet(SG).yaml +++ /dev/null @@ -1,456 +0,0 @@ -openapi: 3.0.1 -info: - title: Basic Individual Search Dun & Bradstreet (SG) - description: This Data microservice provides the information on the (Singapore-registered) business interest of an individual that includes the individual’s actual name, residential address, business and shareholding in businesses, current & previous ownership, litigation against individual and businesses, bankruptcy record and count on the times this individual has been searched on. Updated daily.

Authentication:

Authentication is done using the x-api-key in the request header. - version: '0.1' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1" - description: "Published Date - Jul 23, 2019" -paths: - /dnb/prod/sbis: - post: - tags: - - v0.1 - summary: Adds a new user - requestBody: - content: - application/xml: - schema: - type: string - examples: - xml: - summary: A sample XML response - value: ' - -1197803191K - -' - responses: - '200': - description: success response - content: - application/xml: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - REPORT: - type: object - properties: - META_INFO: - type: object - properties: - SERVICE: - type: string - SYSTEM_ID : - type: string - CREATION_DATE: - type: string - USER_ID : - type: string - BASIC_INFO : - type: object - properties: - PA_REG_NO : - type: string - ADDRESS1: - type: string - ADDRESS2: - type: string - ADDRESS3: - type: string - LIT_SEARCH_INFO : - type: object - properties: - COMP_NAME: - type: string - REG_NO: - type: string - REPORT_TYPE: - type: string - REQ_DATE: - type: string - REQ_REG_NO: - type: string - REQ_NAME: - type: string - REQ_DATE_STR: - type: string - LIST_CURRENT_COMP : - type: object - properties: - CURRENT_COMP : - type: object - properties: - POSITION: - type: string - APPOINTMENT_DATE: - type: string - COMP_NAME: - type: string - SEQ_NO: - type: string - SHARE_VALUE1: - type: string - COMP_STATUS: - type: string - PROFIT_VALUE1: - type: string - PROFIT_VALUE2: - type: string - PROFIT_VALUE3: - type: string - SHARE_VALUE: - type: string - TEL: - type: string - FAX: - type: string - SIC: - type: string - SIC_DESC: - type: string - LIST_PREVIOUS_COMP: - type: array - items: - properties: - PREVIOUS_COMP : - type: object - properties: - POSITION : - type: string - APPOINTMENT_DATE: - type: string - COMP_NAME: - type: string - SEQ_NO: - type: string - SHARE_VALUE1: - type: string - COMP_STATUS: - type: string - CESSATION_DATE : - type: string - SHARE_VALUE: - type: string - TEL: - type: string - FAX: - type: string - SIC: - type: string - SIC_DESC: - type: string - LIST_BANKRUPTCY: - type: array - items: - properties: - BANKRUPTCY : - type: object - properties: - SUBJECT_NAME : - type: string - COURT_CODE: - type: string - CASE_CODE: - type: string - CASE_YEAR: - type: string - ACTION_DATE: - type: string - BANKRUPTCY_ACT: - type: string - HEARING_DATE : - type: string - CURRENCY1: - type: string - AMOUNT1: - type: string - CURRENCY2: - type: string - AMOUNT2: - type: string - CURRENCY3: - type: string - BANKRUPTCY_TYPE: - type: string - LIST_PLAINTIFF: - type: array - items: - properties: - PLAINTIFF: - type: object - properties: - PLA_NAME: - type: string - PLA_SOLICITOR: - type: string - PLA_SOLICITOR_ID: - type: string - PLA_FILE_REF: - type: string - LIST_LIT: - type: array - items: - properties: - LIT: - type: object - properties: - SUBJECT_NAME: - type: string - SEQ_NO: - type: string - FORMATTED_ID: - type: string - LIST_LIT_DTL: - type: array - items: - properties: - LIT_DTL: - type: object - properties: - NATURE_OF_CLAIM: - type: string - STATUS_DATE: - type: string - CASE_NO: - type: string - FORMATTED_ID: - type: string - DOC_REMARKS: - type: string - CURRENCY1: - type: string - CURRENCY2: - type: string - CURRENCY3: - type: string - CURRENCY4: - type: string - CURRENCY5: - type: string - CASE_STATUS: - type: string - AMOUNT1: - type: string - AMOUNT2: - type: string - AMOUNT3: - type: string - AMOUNT4: - type: string - AMOUNT5: - type: string - LIST_PLAINTIFF: - type: array - items: - properties: - PLAINTIFF: - type: object - properties: - PLA_NAME: - type: string - LAW_FIRM: - type: string - WRITE_DATE: - type: string - PLA_SOLICITOR: - type: string - PLA_SOLICITOR_ID: - type: string - PLA_FILE_REF: - type: string - PLA_STATUS: - type: string - PLA_STATUS_DATE: - type: string - PLA_ID: - type: string - LIST_DEFENDANT: - type: array - items: - properties: - DEFENDANT: - type: object - properties: - DEF_SOLICITOR: - type: string - DEF_SOLICITOR_ID: - type: string - DEF_LAW_FIRM: - type: string - DEF_FILE_REF: - type: string - LIST_Ddrptcount: - type: array - items: - properties: - Ddrptcount: - type: object - properties: - Rcjan: - type: number - Rcfeb: - type: number - Rcmar: - type: number - Rcapr: - type: number - Rcmay: - type: number - Rcjun: - type: number - Rcjul: - type: number - Rcaug: - type: number - Rcsep: - type: number - Rcoct: - type: number - Rcnov: - type: number - Rcdec: - type: number - Rcyear: - type: number - Rcsecflag: - type: number - unauthorized: - type: array - items: - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: array - items: - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: array - items: - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: array - items: - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: array - items: - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file diff --git a/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml b/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml deleted file mode 100644 index d77c87702..000000000 --- a/yaml/BriefFinancialExtractionDun&Bradstreet(SG).yaml +++ /dev/null @@ -1,625 +0,0 @@ -openapi: 3.0.1 -info: - title: Brief Financial Info Dun & Bradstreet (SG) - description: This Data microservice provides the annual financial information of the Singapore-registered business, inclusive of annual profit and loss and financial ratios. Updated daily.

Authentication:

Authentication is done using the x-api-key in the request header. - version: '0.1' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1" - description: "Published Date - Jul 23, 2019" -paths: - /dnb/prod/sbfe: - post: - tags: - - v0.1 - summary: Adds a new user - requestBody: - content: - application/xml: - schema: - type: string - examples: - xml: - summary: A sample XML response - value: '1197803191K' - responses: - '200': - description: success response - content: - application/xml: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - REPORT: - type: object - properties: - META_INFO: - type: object - properties: - SERVICE: - type: string - SYSTEM_ID : - type: string - CREATION_DATE: - type: string - USER_ID : - type: string - FH_SEARCH_INFO: - type: object - properties: - COMP_NAME : - type: string - REG_NO : - type: string - REQ_DATE : - type: string - REQ_REG_NO : - type: string - REQ_NAME : - type: string - REQ_DATE_STR : - type: string - FH_BEFORE_YR1 : - type: string - FH_BEFORE_YR2 : - type: string - FH_BEFORE_YR3 : - type: string - FH_AFTER_YR1: - type: string - FH_AFTER_YR2 : - type: string - FH_AFTER_YR3 : - type: string - FH_AFTER_YR4: - type: string - FH_AFTER_YR5: - type: string - AC_RATIOS_YR1 : - type: string - AC_RATIOS_YR2 : - type: string - AC_RATIOS_YR3 : - type: string - AC_RATIOS_YR4 : - type: string - AC_RATIOS_YR5 : - type: string - FH_DTL: - type: object - properties: - FH_YR1_CURR : - type: string - FH_YR2_CURR : - type: string - FH_YR3_CURR : - type: string - TURNOVER1 : - type: string - TURNOVER2: - type: string - TURNOVER3 : - type: string - PL_BEF_TAX1 : - type: string - PL_BEF_TAX2 : - type: string - PL_BEF_TAX3 : - type: string - PL_AFT_TAX1: - type: string - PL_AFT_TAX2 : - type: string - PL_AFT_TAX3 : - type: string - NETINC_NON_EXT1: - type: string - NETINC_NON_EXT2: - type: string - NETINC_NON_EXT3 : - type: string - PL_AFT_TAX_EXT1 : - type: string - PL_AFT_TAX_EXT2 : - type: string - PL_AFT_TAX_EXT3 : - type: string - TOT_ASSETS1 : - type: string - TOT_ASSETS2 : - type: string - TOT_ASSETS3: - type: string - TA_CURRENT1 : - type: string - TA_CURRENT2 : - type: string - TA_CURRENT3 : - type: string - TA_FIXED1 : - type: string - TA_FIXED2: - type: string - TA_FIXED3 : - type: string - TOT_LIABILITIES1 : - type: string - TOT_LIABILITIES2: - type: string - TOT_LIABILITIES3: - type: string - TL_CURRENT1 : - type: string - TL_CURRENT2 : - type: string - TL_CURRENT3 : - type: string - TL_NON_CURRENT1 : - type: string - TL_NON_CURRENT2 : - type: string - TL_NON_CURRENT3 : - type: string - SH_FUNDS1: - type: string - SH_FUNDS2 : - type: string - SH_FUNDS3 : - type: string - SH_PAIDUP_CAPITAL1 : - type: string - SH_PAIDUP_CAPITAL2 : - type: string - SH_PAIDUP_CAPITAL3: - type: string - SH_RESERVES1 : - type: string - SH_RESERVES2 : - type: string - SH_RESERVES3: - type: string - SH_ACCUM_LOSS1: - type: string - SH_ACCUM_LOSS2 : - type: string - SH_ACCUM_LOSS3 : - type: string - GRP_TURNOVER1 : - type: string - GRP_TURNOVER2 : - type: string - GRP_TURNOVER3 : - type: string - GRP_PL_BEF_TAX1 : - type: string - GRP_PL_BEF_TAX2 : - type: string - GRP_PL_BEF_TAX3 : - type: string - GRP_PL_AFT_TAX1 : - type: string - GRP_PL_AFT_TAX2: - type: string - GRP_PL_AFT_TAX3 : - type: string - GRP_NETINC_NON_EXT1 : - type: string - GRP_NETINC_NON_EXT2 : - type: string - GRP_NETINC_NON_EXT3 : - type: string - GRP_PL_AFT_TAX_EXT1: - type: string - GRP_PL_AFT_TAX_EXT2 : - type: string - GRP_PL_AFT_TAX_EXT3 : - type: string - GRP_TOT_ASSETS1: - type: string - GRP_TOT_ASSETS2: - type: string - GRP_TOT_ASSETS3 : - type: string - GRP_TA_CURRENT1 : - type: string - GRP_TA_CURRENT2 : - type: string - GRP_TA_CURRENT3 : - type: string - GRP_TA_FIXED1 : - type: string - GRP_TA_FIXED2 : - type: string - GRP_TA_FIXED3: - type: string - GRP_TOT_LIABILITIES1 : - type: string - GRP_TOT_LIABILITIES2 : - type: string - GRP_TOT_LIABILITIES3 : - type: string - GRP_TL_CURRENT1 : - type: string - GRP_TL_CURRENT2: - type: string - GRP_TL_CURRENT3 : - type: string - GRP_TL_NON_CURRENT1 : - type: string - GRP_TL_NON_CURRENT2: - type: string - GRP_TL_NON_CURRENT3: - type: string - GRP_SH_FUNDS1 : - type: string - GRP_SH_FUNDS2 : - type: string - GRP_SH_FUNDS3 : - type: string - GRP_SH_PAIDUP_CAPITAL1 : - type: string - GRP_SH_PAIDUP_CAPITAL2 : - type: string - GRP_SH_PAIDUP_CAPITAL3 : - type: string - GRP_SH_RESERVES1: - type: string - GRP_SH_RESERVES2 : - type: string - GRP_SH_RESERVES3 : - type: string - GRP_SH_ACCUM_LOSS1 : - type: string - GRP_SH_ACCUM_LOSS2 : - type: string - GRP_SH_ACCUM_LOSS3: - type: string - GRP_INDICATOR1 : - type: string - GRP_INDICATOR2 : - type: string - GRP_INDICATOR3: - type: string - XBRL_DTL: - type: object - properties: - XBRL_YR1_CURR : - type: string - XBRL_YR2_CURR : - type: string - REVENUE1 : - type: string - REVENUE2 : - type: string - PL_BEF_TAX1: - type: string - PL_BEF_TAX2 : - type: string - PL_AFT_TAX1 : - type: string - PL_AFT_TAX2 : - type: string - PL_BEF_TAX3 : - type: string - TOT_ASSETS1: - type: string - TOT_ASSETS2 : - type: string - TA_CURRENT1 : - type: string - TA_CURRENT2: - type: string - TA_NON_CURRENT1: - type: string - TA_NON_CURRENT2 : - type: string - TOT_LIABILITIES1 : - type: string - TOT_LIABILITIES2 : - type: string - TL_CURRENT1 : - type: string - TL_CURRENT2 : - type: string - TL_NON_CURRENT1 : - type: string - TL_NON_CURRENT2: - type: string - TOT_EQUITY1 : - type: string - TOT_EQUITY2 : - type: string - EQ_SH_CAPITAL1 : - type: string - EQ_SH_CAPITAL2 : - type: string - EQ_RESERVES1: - type: string - EQ_RESERVES2 : - type: string - EQ_RETAINED_EARN1 : - type: string - EQ_RETAINED_EARN2: - type: string - GRP_REVENUE1: - type: string - GRP_REVENUE2 : - type: string - GRP_PL_BEF_TAX1 : - type: string - GRP_PL_BEF_TAX2 : - type: string - GRP_PL_AFT_TAX1 : - type: string - GRP_PL_AFT_TAX2 : - type: string - GRP_TOT_ASSETS1 : - type: string - GRP_TOT_ASSETS2: - type: string - GRP_TA_CURRENT1 : - type: string - GRP_TA_CURRENT2 : - type: string - GRP_TA_NON_CURRENT1 : - type: string - GRP_TA_NON_CURRENT2 : - type: string - GRP_TOT_LIABILITIES1: - type: string - GRP_TOT_LIABILITIES2 : - type: string - GRP_TL_CURRENT1 : - type: string - GRP_TL_CURRENT2: - type: string - GRP_TL_NON_CURRENT1: - type: string - GRP_TL_NON_CURRENT2 : - type: string - GRP_TOT_EQUITY1 : - type: string - GRP_TOT_EQUITY2 : - type: string - GRP_SH_CAPITAL1 : - type: string - GRP_SH_CAPITAL2 : - type: string - GRP_RESERVES1 : - type: string - GRP_RESERVES2 : - type: string - GRP_RETAINED_EARN1 : - type: string - GRP_RETAINED_EARN2 : - type: string - GRP_INDICATOR1: - type: string - GRP_INDICATOR2 : - type: string - GRP_INDICATOR3 : - type: string - FH_RATIOS_DTL: - type: object - properties: - RATE_NET_PROFIT1 : - type: string - RATE_NET_PROFIT2 : - type: string - RATE_NET_PROFIT3 : - type: string - RATE_NET_PROFIT4 : - type: string - RATE_NET_PROFIT5: - type: string - RET_INVESTMENT1 : - type: string - RET_INVESTMENT2 : - type: string - RET_INVESTMENT3 : - type: string - RET_INVESTMENT4 : - type: string - RET_INVESTMENT5: - type: string - RET_SH_FUNDS1 : - type: string - RET_SH_FUNDS2 : - type: string - RET_SH_FUNDS3: - type: string - RET_SH_FUNDS4: - type: string - RET_SH_FUNDS5 : - type: string - TOT_ASSETS_TURNOVER1 : - type: string - TOT_ASSETS_TURNOVER2 : - type: string - TOT_ASSETS_TURNOVER3 : - type: string - TOT_ASSETS_TURNOVER4 : - type: string - TOT_ASSETS_TURNOVER5 : - type: string - CURR_CAPITAL_RATIO1: - type: string - CURR_CAPITAL_RATIO2 : - type: string - CURR_CAPITAL_RATIO3 : - type: string - CURR_CAPITAL_RATIO4 : - type: string - CURR_CAPITAL_RATIO5 : - type: string - PROPRIETARY_RATIO1: - type: string - PROPRIETARY_RATIO2 : - type: string - PROPRIETARY_RATIO3 : - type: string - PROPRIETARY_RATIO4: - type: string - PROPRIETARY_RATIO5: - type: string - TOTAL_DEBT_RATIO1 : - type: string - TOTAL_DEBT_RATIO2 : - type: string - TOTAL_DEBT_RATIO3 : - type: string - TOTAL_DEBT_RATIO4 : - type: string - TOTAL_DEBT_RATIO5 : - type: string - LIST_FH_CHART_INFO : - type: array - items: - properties: - FH_CHART_INFO: - type: object - properties: - PROFIT_LOSS: - type: string - REVENUE: - type: string - YEAR: - type: string - unauthorized: - type: array - items: - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: array - items: - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: array - items: - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: array - items: - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: array - items: - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file diff --git a/yaml/BusinessCheckDun&Bradstreet(SG).yaml b/yaml/BusinessCheckDun&Bradstreet(SG).yaml deleted file mode 100644 index 74beee471..000000000 --- a/yaml/BusinessCheckDun&Bradstreet(SG).yaml +++ /dev/null @@ -1,430 +0,0 @@ -openapi: 3.0.1 -info: - title: Business Check Dun & Bradstreet (SG) - description: This Data microservice provides key business information of a Singapore-registered company includes the business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholders. Updated daily.

Authentication:

Authentication is done using the x-api-key in the request header.

- version: '0.1' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1" - description: "Published Date - Jul 23, 2019" -paths: - /dnb/prod/sbc: - post: - tags: - - v0.1 - summary: Adds a new user - requestBody: - content: - application/xml: - schema: - type: string - examples: - xml: - summary: A sample XML response - value: ' - -1199707714C - - GPS INDUSTRIES PTE LTD' - responses: - '200': - description: success response - content: - application/xml: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - REPORT: - type: object - properties: - META_INFO: - type: object - properties: - SERVICE: - type: string - SYSTEM_ID : - type: string - CREATION_DATE: - type: string - USER_ID : - type: string - CLASS : - type: string - REQ_SEARCH_INFO : - type: object - properties: - COMP_NAME : - type: string - REG_NO : - type: string - REQ_DATE : - type: string - REQ_REG_NO : - type: string - REQ_NAME : - type: string - REQ_DATE_STR : - type: string - REGISTRY_DETAIL : - type: object - properties: - COMP_NAME: - type: string - RENEWAL_DATE: - type: string - ADDRESS1 : - type: string - ADDRESS2 : - type: string - ADDRESS3 : - type: string - ADDRESS4: - type: string - COMP_TYPE_CODE: - type: string - REG_DATE : - type: string - REG_ACTIVITY1: - type: string - REG_ACTIVITY2: - type: string - ACC_DATE : - type: string - STATUS_EFFECT_DATE: - type: string - NAME_EFFECT_DATE: - type: string - EXPIRY_DATE : - type: string - COMP_TYPE : - type: string - CHANGE_ADDR_DATE : - type: string - COMP_STATUS : - type: string - REG_ACTIVITY_DESC1 : - type: string - REG_ACTIVITY_DESC2 : - type: string - AUDITOR : - type: string - AUDITOR_APPMT_DATE : - type: string - LAST_AR_DATE : - type: string - LAST_AGM_DATE : - type: string - COUNTRY_INCORP: - type: string - EMPLOYEE_SIZE : - type: object - properties: - ELEMENTS: - type: string - AMOUNT: - type: string - LIST_BIZ_BRANCH : - type: array - items: - properties: - BIZ_BRANCH : - type: object - properties: - ADDR_BUILDING : - type: string - ADDR_POSTCODE : - type: string - ADDR_ADDRESS1 : - type: string - LIST_REG_CHARGES : - type: array - items: - properties: - REG_CHARGES : - type: object - properties: - CHARGE_NO : - type: string - CHARGE_DATE : - type: string - CHARGEE_COMP : - type: string - CURRENCY : - type: string - AMT_SECURED : - type: string - STATUS_SATISFACTION : - type: string - LIST_LIQUIDATOR : - type: array - items: - properties: - LIQUIDATOR : - type: object - properties: - LIQ_NAME : - type: string - LIQ_ID : - type: string - LIQ_POSITION : - type: string - LIQ_COMP: - type: string - LIQ_ADDRESS1 : - type: string - LIQ_ADDRESS2 : - type: string - LIQ_ADDRESS3: - type: string - LIQ_ADDRESS4 : - type: string - LIQ_APPOINTMENT_DATE : - type: string - LIST_SALES_REVENUE_AMOUNT : - type: array - items: - properties: - SALES_REVENUE_AMOUNT: - type: object - properties: - ELEMENTS : - type: string - YEAR : - type: string - CURRENCY : - type: string - AMOUNT: - type: number - LIST_SHAREHOLDER: - type: array - items: - properties: - SHAREHOLDER: - type: object - properties: - ADDRESS: - type: string - COMP_ID: - type: string - NO_OF_SHARE: - type: string - CURRENCY: - type: string - SHAREHOLDER_TYPE: - type: string - SHARE_TYPE: - type: string - SHAREHOLDER_NAME: - type: string - CHANGE_ADDR_DATE: - type: string - ADDR_TYPE: - type: string - NATIONALITY: - type: string - LIST_SHARE_INTEREST_COMP : - type: array - items: - properties: - SHARE_INTEREST_COMP: - type: object - properties: - COMP_NAME: - type: string - SHARE_OWNED_UNIT: - type: string - SHARE_OWNED_PERCENT: - type: string - STATUS: - type: string - LIST_OFFICER_OWNER : - type: array - items: - properties: - OFFICER_OWNER: - type: object - properties: - ADDRESS : - type: string - IDENTITY_ID : - type: string - POSITION : - type: string - ADDR_TYPE: - type: string - CESSATION_DATE : - type: string - OFFICER_NAME : - type: string - CHANGE_ADDR_DATE : - type: string - APPMT_DATE: - type: string - NATIONALITY : - type: string - LIST_CAPITAL: - type: array - items: - properties: - CAPITAL: - type: object - properties: - CAPITAL_CATEGORY: - type: string - CAPITAL_TYPE: - type: string - CURRENCY: - type: string - CAPITAL_AMT : - type: string - NO_OF_SHARES : - type: string - LIST_NAME_CHANGE: - type: array - items: - properties: - NAME_CHANGE: - type: object - properties: - PREV_NAME: - type: string - EFFECT_DATE: - type: string - unauthorized: - type: array - items: - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: array - items: - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: array - items: - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: array - items: - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: array - items: - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file diff --git a/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml b/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml deleted file mode 100644 index d2822200e..000000000 --- a/yaml/BusinessCheckPlusDun&Bradstreet(SG).yaml +++ /dev/null @@ -1,535 +0,0 @@ -openapi: 3.0.1 -info: - title: Business Check Plus Dun & Bradstreet (SG) - description: The Data microservice provides key business information, litigation information (High and Subordinate Courts) and Winding Up Trace of a company including the Business name, registration number, registered address and date of change, company status, registered activities, shareholders details (i.e. date of commencement, residing address) capital amount and shares allocated to each shareholder, litigation information. Updated daily.

Authentication:

Authentication is done using the x-api-key in the request header. - version: '0.1' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1" - description: "Published Date - Jul 23, 2019" -paths: - /dnb/prod/sbcp: - post: - tags: - - v0.1 - summary: Adds a new user - requestBody: - content: - application/xml: - schema: - type: string - examples: - xml: - summary: A sample XML response - value: ' -1199707714C - GPS INDUSTRIES PTE LTD' - responses: - '200': - description: success response - content: - application/xml: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - REPORT: - type: object - properties: - META_INFO: - type: object - properties: - SERVICE: - type: string - SYSTEM_ID : - type: string - CREATION_DATE: - type: string - USER_ID : - type: string - CLASS type: - type: string - REGISTRY_DETAIL : - type: object - properties: - RENEWAL_DATE: - type: string - ADDRESS1: - type: string - ADDRESS2: - type: string - ADDRESS3: - type: string - ADDRESS4: - type: string - COMP_TYPE_CODE: - type: string - REG_DATE: - type: string - REG_ACTIVITY1: - type: string - REG_ACTIVITY2: - type: string - ACC_DATE: - type: string - STATUS_EFFECT_DATE: - type: string - NAME_EFFECT_DATE: - type: string - EXPIRY_DATE: - type: string - COMP_TYPE: - type: string - CHANGE_ADDR_DATE: - type: string - COMP_STATUS: - type: string - REG_ACTIVITY_DESC1: - type: string - REG_ACTIVITY_DESC2: - type: string - AUDITOR: - type: string - AUDITOR_APPMT_DATE: - type: string - LAST_AR_DATE: - type: string - LAST_AGM_DATE: - type: string - COUNTRY_INCORP: - type: string - REQ_SEARCH_INFO : - type: object - properties: - COMP_NAME: - type: string - REG_NO: - type: string - REQ_DATE: - type: string - REQ_REG_NO: - type: string - REQ_NAME: - type: string - REQ_DATE_STR: - type: string - EMPLOYEE_SIZE : - type: object - properties: - ELEMENTS: - type: string - AMOUNT: - type: string - LIST_BIZ_BRANCH : - type: object - properties: - BIZ_BRANCH : - type: object - properties: - REQADDR_BUILDING: - type: string - ADDR_POSTCODE: - type: string - ADDR_ADDRESS1: - type: string - LIST_REG_CHARGES: - type: array - items: - properties: - REG_CHARGES : - type: object - properties: - CHARGE_NO : - type: string - CHARGE_DATE: - type: string - CHARGEE_COMP: - type: string - CURRENCY: - type: string - AMT_SECURED: - type: string - STATUS_SATISFACTION: - type: string - LIST_LIQUIDATOR: - type: array - items: - properties: - LIQUIDATOR : - type: object - properties: - LIQ_NAME : - type: string - LIQ_ID: - type: string - LIQ_POSITION: - type: string - LIQ_COMP: - type: string - LIQ_ADDRESS1: - type: string - LIQ_ADDRESS2: - type: string - LIQ_ADDRESS3: - type: string - LIQ_ADDRESS4: - type: string - LIQ_APPOINTMENT_DATE: - type: string - LIST_WINDING_UP : - type: array - items: - properties: - WINDING_UP : - type: object - properties: - CASE_CODE : - type: string - CASE_YEAR : - type: string - PLAINTIFF : - type: string - PLA_SOLICITOR_ID : - type: string - PLA_FILE_REF : - type: string - COURT_CODE : - type: string - CASE_TYPE : - type: string - CURRENCY1 : - type: string - CURRENCY2 : - type: string - AMOUNT2 : - type: string - CURRENCY3 : - type: string - AMOUNT3 : - type: string - BANKRUPTCY_ACT : - type: string - HEARING_DATE : - type: string - ACTION_DATE : - type: string - SUBJECT_NAME : - type: string - PLA_SOLICITOR : - type: string - PLA_LAW_FIRM : - type: string - LIST_LITIGATION : - type: array - items: - properties: - LITIGATION : - type: object - properties: - SUBJECT_NAME : - type: string - NATURE_OF_CLAIM : - type: string - STATUS_DATE : - type: string - CASE_NO : - type: string - DOC_REMARKS : - type: string - CURRENCY1 : - type: string - CURRENCY2 : - type: string - CURRENCY3 : - type: string - CURRENCY4 : - type: string - CURRENCY5 : - type: string - DEF_SOLICITOR : - type: string - DEF_SOLICITOR_ID : - type: string - DEF_LAW_FIRM : - type: string - DEF_FILE_REF : - type: string - DATE_OF_WRIT : - type: string - STATUS : - type: string - AMOUNT1 : - type: string - AMOUNT2 : - type: string - AMOUNT3 : - type: string - AMOUNT4 : - type: string - AMOUNT5 : - type: string - PLAINTIFF : - type: string - PLA_SOLICITOR: - type: string - PLA_SOLICITOR_ID: - type: string - PLA_LAW_FIRM : - type: string - PLA_FILE_REF : - type: string - PLA_ID: - type: string - PLA_STATUS: - type: string - PLA_STATUS_DATE : - type: string - LIST_SHARE_INTEREST_COMP : - type: array - items: - properties: - SHARE_INTEREST_COMP: - type: object - properties: - COMP_NAME: - type: string - SHARE_OWNED_UNIT: - type: string - SHARE_OWNED_PERCENT: - type: string - STATUS: - type: string - LIST_NAME_CHANGE: - type: array - items: - properties: - NAME_CHANGE: - type: object - properties: - PREV_NAME: - type: string - EFFECT_DATE: - type: string - LIST_SHAREHOLDER: - type: array - items: - properties: - SHAREHOLDER: - type: object - properties: - ADDRESS: - type: string - COMP_ID: - type: string - NO_OF_SHARE: - type: string - CURRENCY: - type: string - SHAREHOLDER_TYPE: - type: string - SHARE_TYPE: - type: string - SHAREHOLDER_NAME: - type: string - CHANGE_ADDR_DATE: - type: string - ADDR_TYPE: - type: string - NATIONALITY: - type: string - LIST_CAPITAL: - type: array - items: - properties: - CAPITAL: - type: object - properties: - CAPITAL_CATEGORY: - type: string - CAPITAL_TYPE: - type: string - CURRENCY: - type: string - CAPITAL_AMT : - type: string - NO_OF_SHARES : - type: string - LIST_OFFICER_OWNER : - type: array - items: - properties: - OFFICER_OWNER: - type: object - properties: - ADDRESS : - type: string - IDENTITY_ID : - type: string - POSITION : - type: string - ADDR_TYPE: - type: string - CESSATION_DATE : - type: string - OFFICER_NAME : - type: string - CHANGE_ADDR_DATE : - type: string - APPMT_DATE: - type: string - NATIONALITY : - type: string - LIST_SALES_REVENUE_AMOUNT : - type: array - items: - properties: - SALES_REVENUE_AMOUNT: - type: object - properties: - ELEMENTS : - type: string - YEAR : - type: string - CURRENCY : - type: string - AMOUNT: - type: number - CESSATION_DATE : - type: string - unauthorized: - type: array - items: - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: array - items: - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: array - items: - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: array - items: - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: array - items: - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file diff --git a/yaml/HDBFlatOwnership(SG).yaml b/yaml/HDBFlatOwnership(SG).yaml deleted file mode 100644 index 41412b1ce..000000000 --- a/yaml/HDBFlatOwnership(SG).yaml +++ /dev/null @@ -1,292 +0,0 @@ -openapi: 3.0.1 -info: - title: Flat Ownership HDB (SG) - description: This Data microservice returns information on flat ownership within Housing Development Board of Singapore (HDB) estates that includes location address, postal code, length of ownership and their quantity in units.

Authentication:

Authentication is done using the x-api-key in the request header.

Search Types


*All values have to be URL encoded

Keyword search

      Keyword search; search for all searchable fields

      Using querystring:

ang mo kio

      Filter search

      Example 1: Get all results except ang mo kio

      Using fiterdata:

{"must_not":[{"match_phrase":{"street":"ang mo kio"}}]}

      Or

      Using querystring:

      name:"ang mo kio"

      Example 2: Filter results with len_of_ownership t <= 10

      Using fiterdata:

{"filter":[{"match":{"len_of_ownership":"t <= 10"}}]}

Geo search

      Example 1: Geo search; distance in km and lat/lon.

      Using fiterdata:

{"filter":[{"geo_distance":{"distance":"1km","location":"1.3492463819999998,103.7511959"}}]}

      Example 2: Geo search; distance in km and lat/lon and trade type supermarket

      Using fiterdata:

{"filter":[{"geo_distance":{"distance":"1km","location":"1.3492463819999998,103.7511959"}},{"match":{"street":"bukit batok"}}]}

Supported Filter Types:


      must - All of these clauses must match. The equivalent of AND.

      must_not - All of these clauses must not match. The equivalent of NOT.

      should - At least one of these clauses must match. The equivalent of OR.

      filter - Clauses that must match, but are run in non-scoring, filtering mode.

Supported Match Types:


      match - is to search within a full-text field for a single word

      { "match":{"street":"bishan"}}

      match_phrase - is to search a full text field

      { "match_phrase":{ "street":bishan street 24"}}

      match_phrase_prefix - is to search a full text field with prefix

      {"match_phrase_prefix":{"street":"bishan"}}

      term - returns documents that contain one or more exact terms in a provided field.

      {"term":{"street":"bishan"}}

      terms - The terms query is the same as the term query, except you can search for multiple values.

      {"terms":{"street":["bishan","and mo kio"]}}

Sample filterdata JSON:


      {
      "must":[{"match_phrase":{"street":"ang+mo+kio+street+21"}}],
      "filter":[{"match":{"tags.type":"source"}}] ,
      "should":[{"match":{"source":"hdb"}}],
      "must_not":[{"match":{"len_of_ownership":"30 < t <= 40"}}
      } - - version: '0.1' -servers: - - url: 'https://api.sentient.io' -tags: -- name: "v0.1" - description: "Published Date - Apr 24, 2020" -paths: - /DaaS/prod/hdb/ownership: - get: - tags: - - v0.1 - parameters: - - in: query - name: querystring - schema: - type: string - description: keyword match to all searchable fields - required: true - - in: query - name: offset - schema: - type: integer - example: "0" - description: The offset of the record list ie the starting index - required: false - - in: query - name: limit - schema: - type: integer - example: 10 - description: The max records to return for the request - required: false - - in: query - name: filterdata - schema: - type: string - description: Additional filter {"must":[ ],"should":[ ],"must_not":[ ],"filter":[ ]} - required: false - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] -components: - schemas: - success: - type: object - properties: - results: - type: object - properties: - total: - type: number - example: 986 - description: Total number of records - max_score: - type: number - example: 17.995623 - description: The highest score value - hits: - type: array - items: - type: object - properties: - _index: - type: string - description: Index group of the document - example: "sentient_durationofownership_hdb_index" - _type: - type: string - description: Content type of the document - example: "dir_doc" - _id: - type: number - description: Document ID - example: "050533/40- - "This Voice microservice takes in an audio file (in WAV format at 16kHz) and transcribes English speech content within the input file into text.

The Automatic Speech Recognition (ASR) AI model is employed to understand the mapping of sound features to actual words in English.

Use this microservice if the audio file consists of mostly speech with no long pauses in between.

Use this microservice if the audio file consists of mostly speech with no long pauses in between.

Authentication:

Authentication is done using the x-api-key in the request header. - version: '0.1' -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v0.1" - description: "Published Date - Jun 18, 2018" -paths: - /microservices/voice/asreng/v0.1/getpredictions: - post: - tags: - - v0.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - description: Input parameters

FieldTypeDescription
audioStringRequired. Input file in base64 format and needs to be prefixed by the data type and encoding.
E.g. "data:audio/wav;base64,<wav in base64 string>"

Audio file should be:
Channel Type mono
Sample Rate 16kHz


- content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - message: - type: string - example: Hi there - description: Converted Text - status: - type: string - example: success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - properties: - audio: - type: string - example: - required: true - example: data:audio/wav;base64,UklGRkbiBABXQVZFZm10IBAAAAABA... - description: Required. Input file in base64 format and needs to be prefixed by the data type and encoding.
E.g. "data:audio/wav;base64," - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom diff --git a/yaml/index.yaml b/yaml/index.yaml deleted file mode 100644 index 9679e18a1..000000000 --- a/yaml/index.yaml +++ /dev/null @@ -1,202 +0,0 @@ -Voice: - Automatic Speech Recognition ENG (SG): - title: Automatic Speech Recognition ENG (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_eng_sg.yaml" - Automatic Speech Recognition CHI (SG): - title: Automatic Speech Recognition CHI (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/automatic_speech_recognition_chi_sg.yaml" - Online Automatic Speech Recognition ENG (SG): - title: Online Automatic Speech Recognition ENG (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/online_automatic_speech_recognition_eng_sg.yaml" - Online Command Automatic Speech Recognition ENG (SG): - title: Online Command Automatic Speech Recognition ENG (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/online_command_automatic_speech_recognition_eng_sg.yaml" - Text-To-Speech ENG: - title: Text-To-Speech ENG - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/text-to-speech_eng.yaml" - Text-To-Speech CHI: - title: Text-To-Speech CHI - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/text-to-speech_chi.yaml" - ASR with Voice Activity Detection ENG (SG): - title: ASR with Voice Activity Detection ENG (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/asr_with_vad_eng_sg.yaml" - Voice Activity Detection ENG: - title: Voice Activity Detection ENG - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/voice_activity_detection_eng.yaml" -NLP: - Inverse Text Normalisation ENG: - title: Inverse Text Normalisation ENG - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/inverse_text_normalisation_eng.yaml" - Named-Entity Recognition ENG: - title: Named-Entity Recognition ENG - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_eng.yaml" - Page Profiler ENG: - title: Page Profiler ENG - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/page_profiler_eng.yaml" - Taxonomy Matcher ENG: - title: Taxonomy Matcher ENG - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/taxonomy_matcher_eng.yaml" - Word Sense Disambiguation ENG: - title: Word Sense Disambiguation ENG - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/word_sense_disambiguation_eng.yaml" - Named-Entity Recognition JAP: - title: Named-Entity Recognition JAP - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_jap.yaml" - Named Entity Recognition THAI: - title: Named Entity Recognition THAI - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/named-entity_recognition_thai.yaml" - Script Alignment: - title: Script Alignment - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/script_alignment.yaml" -Computer Vision: - Object Detection: - title: Object Detection - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/object_detection.yaml" - Face Recognition Politicians (SG): - title: Face Recognition Politicians (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/face_recognition_politicians_sg.yaml" - People Counting: - title: People Counting - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/people_counting.yaml" - Landmark Detection (SG): - title: Landmark Detection (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_sg.yaml" - Landmark Detection (JP): - title: Landmark Detection (JP) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/landmark_detection_jp.yaml" -Utility: - Youtube Video Downloader: - title: Youtube Video Downloader - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/youtube_video_downloader.yaml" - Video-To-Audio Convertor: - title: Video-To-Audio Convertor - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/video-to-audio_convertor.yaml" - Web Scraper: - title: Web Scraper - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/web_scraper.yaml" - Document Convertor ENG: - title: Document Convertor ENG - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/document_convertor_eng.yaml" - PDF Extractor: - title: PDF Extractor - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/pdf_extractor.yaml" - PKI Key Generator: - title: PKI Key Generator - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/pki_key_generator.yaml" - Encryption using PKI Key: - title: Encryption using PKI Key - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/encryption_using_pki_key.yaml" - Decryption using PKI Key: - title: Decryption using PKI Key - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/decryption_using_pki_key.yaml" - Wikipedia Retrieval ENG: - title: Wikipedia Retrieval ENG - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/wikipedia_retrieval_eng.yaml" - JSON-CSV Convertor: - title: JSON-CSV Convertor - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/json-csv_convertor.yaml" - CSV-JSON Convertor: - title: CSV-JSON Convertor - versions: - v1.0: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/csv-json_convertor.yaml" - Audio Format Convertor: - title: Audio Format Convertor - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/audio_format_convertor.yaml" - Video-to-Image Convertor: - title: Video-to-Image Convertor - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/video-to-image_convertor.yaml" - Newspaper Article Scraper: - title: Newspaper Article Scraper - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/newspaper_article_scraper.yaml" - URLs Retrieval: - title: URLs Retrieval - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/urls_retrieval.yaml" -Data: - HDB Commercial Directories (SG): - title: HDB Commercial Directories (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/commercial_directories_hdb_sg.yaml" - HDB Block Coordinates (SG): - title: HDB Block Coordinates (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/building_addresses_hdb_sg.yaml" - HDB Residential Occupancy Status (SG): - title: HDB Residential Occupancy Status (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/residential_sales_and_rental_hdb_sg.yaml" - HDB Carpark Locations (SG): - title: HDB Carpark Locations (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/carpark_hdb_sg.yaml" - HDB Demographics (SG): - title: HDB Demographics (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/demographics_hdb_sg.yaml" - HDB Flat Ownership Duration (SG): - title: HDB Flat Ownership Duration (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/flat_ownership_hdb_sg.yaml" - HDB Season Parking Availability (SG): - title: HDB Season Parking Availability (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/season_parking_availability_hdb_sg.yaml" - Directory of Singapore Startups: - title: Directory of Singapore Startups - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/directory_of_singapore_startups.yaml" - HDB Fitness Stations and Playgrounds (SG): - title: HDB Fitness Stations and Playgrounds (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/fitness_stations_and_playgrounds_hdb_sg.yaml" - HDB Lamp Posts Locations (SG): - title: HDB Lamp Posts Locations (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_lamp_posts_hdb_sg.yaml" - HDB Hardcourts Locations (SG): - title: HDB Hardcourts Locations (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_hardcourts_hdb_sg.yaml" - HDB Shelters Locations (SG): - title: HDB Shelters Locations (SG) - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/amenities_shelters_hdb_sg.yaml" -Data Alliance: - Download Dataset API: - title: Download Dataset API - versions: - v0.1: "https://raw.githubusercontent.com/sentient-io/microservice-docs/master/yaml/download_dataset.yaml" diff --git a/yaml/sentiment-analysis-aws.yaml b/yaml/sentiment-analysis-aws.yaml deleted file mode 100644 index abcf2de1c..000000000 --- a/yaml/sentiment-analysis-aws.yaml +++ /dev/null @@ -1,171 +0,0 @@ -openapi: 3.0.1 -info: - title: Sentiment Analysis AWS - description: >- - The sentiment analysis will help to determine the expressed emotional state of person by using natural language processing to analyse a range of parameters, including tone of voice, choice of words.

This is a passthrough to AWS’s sentiment analyser. - version: '1.0' -servers: - - url: 'https://api.sentient.io' -paths: - /sentimentanalysis/prod/awssa: - post: - tags: - - v0.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - Sentiment: - type: string - example: NEUTRAL - SentimentScore: - items: - type: string - example: 'Positive: 0.05698205158114433, Negative: 0.030973462387919426, Neutral: 0.912034809589386, Mixed: 0.00000966900734056253' - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - properties: - key: - type: string - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file diff --git a/yaml/sentiment-analysis-google.yaml b/yaml/sentiment-analysis-google.yaml deleted file mode 100644 index cb66b4eb2..000000000 --- a/yaml/sentiment-analysis-google.yaml +++ /dev/null @@ -1,176 +0,0 @@ -openapi: 3.0.1 -info: - title: Sentiment Analysis Google - description: >- - The sentiment analysis will help to determine the expressed emotional state of person by using natural language processing to analyse a range of parameters, including tone of voice, choice of words.

This is a passthrough to Google’s sentiment analyser. - version: '1.0' -servers: - - url: 'https://api.sentient.io' -paths: - /sentimentanalysis/prod/googlesa: - post: - tags: - - v0.1 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - documentSentiment: - items: - type: string - example: 'magnitude: 0.1,score: 0.1' - language: - type: string - example: en - sentences: - items: - type: string - example: 'text: {content: hi there, - beginOffset: 0},sentiment:{magnitude: 0.1,score: 0.1}' - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request URL - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - input: - type: object - properties: - key: - type: string - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom \ No newline at end of file diff --git a/yaml/web_scraper.yaml b/yaml/web_scraper.yaml deleted file mode 100644 index 0a82c02db..000000000 --- a/yaml/web_scraper.yaml +++ /dev/null @@ -1,335 +0,0 @@ -openapi: 3.0.1 -info: - title: Web Scraper - description: |+ - This API is used to extract content or specific HTML elements from web pages. Supports both HTML and Text output. The web scraper can be instructed to extract HTML elements that match the criteria given in the queryList HTTP request parameter, it can even do navigate down the html tree like get all p tag inside a div class "class":"class_name p" - x-description2: |+ - Examples: - - To get article content, as text - {"url":<URL>} - - Returns all element text matches the tag name: - {"url":<URL>, queryList:[{"title":,"findType":"find_all","tag":"h1"}]}

Few queryList Examples: - - Returns all Html matches the tag name: - queryList:[{"title":,"findType":"find_all","tag":"h1", "returnType":"html"}] - - Returns all Image Links: - queryList:[{"title":,"findType":"find_all","tag":"img", "attribute":"src"}] - - Returns all Links(URL's): - queryList:[{"title":,"findType":"find_all","tag":"a", "attribute":"href"}] - - Returns all links/text/html/images matches the class name: - queryList:[{"findType":"find_all", "class":,"tag":"a", "attribute":"href"}],{"findType":"find_all", "class":, "tag":"a"},{"findType":"find_all", "class":, "tag":"a", "returnType":"html"},{"findType":"find_all", "class":, "tag":"img", "attribute":"src"}] - - Using select in findType, either class/tag/id/nestedclassid is mandatory: - queryList:[{"findType":"select", "class_":, "tag":}] - queryList:[{"findType":"select", "class_":}] - queryList:[{"findType":"select", "tag":}] - queryList:[{"findType":"select", "id":, "tag":}] - queryList:[{"findType":"select", "id":}] - queryList:[{"findType":"select", "tag":}] - queryList:[{"findType":"select", "nestedclassid":}] - queryList:[{"findType":"select", "nestedclassid":, "returnType":"html"}] - queryList:[{"findType":"select", "nestedclassid":, "attribute":"href"}] - Example using nestedclassid:
<div>
   <h1>This is heading</h1>>
   <p class="strikeout">This is paragraph 1</h1>>
   <p class="strikeout">This is paragraph 2</h1>>
   <p class="strikeout">This is paragraph 3</h1>>
</div>
<div id="div2" class="divclass2">
   <h1>This is another heading 2</h1>>
   <p class="strikeout">This is paragraph 4</p>
   <p class="strikeout">This is paragraph 5</p>
   <p class="strikeout">This is paragraph 6</p>
   <ul>
      <li><a href="      <li class="class3"><a href="      <li><a href="   </ul>
</div>

To get tags that match one or more class names
   "queryList":[{"findType":"select", "nestedclassid":"p.strikeout"}] - To get h1 tags that match one or more class names -    "queryList":[{"findType":"select", "nestedclassid":"h1"}] - To get all p tags that matches element id -    "queryList":[{"findType":"select", "nestedclassid":"div#div2 p"}] - To get all litags that matches the element id
   "queryList":[{"findType":"select", "nestedclassid":"div#div2 ul li"}]
To get links from ul list -    "queryList":[{"findType":"select", "nestedclassid":"ul li a"}] - To get links from ul list that matches one or more class names
   "queryList":[{"findType":"select", "nestedclassid":"ul li.class3 a"}] - To get links a element that matches the element id and class name
   "queryList":[{"findType":"select", "nestedclassid":"div#div2 ul li.class3 a"}] - - Notes: - title - is an optional parameter, if title is empty the return json key is "values"
findType - find/find_all/select -    • find - returns first matching possibility
   • find_all - returns all matching possibilities -    • select - If you want to search for tags that match two or more CSS classes. either class/tag/id/nestedclassid is mandatory - **return type is not supported alone with attribute. - - The results are returned in JSON format and allow for developers to rapidly retrieve website elements like tables, images, etc. from URL - version: '1.0' -servers: - - url: 'https://apis.sentient.io' -tags: -- name: "v1.0" - description: "Published Date - Feb 10, 2020" -paths: - /microservices/utility/webscraping/v1.0/getresults: - post: - tags: - - v1.0 - responses: - '200': - description: success response - content: - application/json: - schema: - $ref: '#/components/schemas/success' - example: - url: string - queryList: - - findType: string - tag: string - id: string - class: string - nestedclassid: string - attribute: string - title: string - returnType: string - '400': - description: Restricted - content: - application/json: - schema: - $ref: '#/components/schemas/restricted' - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/unauthorized' - '402': - description: Payment Required - content: - application/json: - schema: - $ref: '#/components/schemas/paymentrequired' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/forbidden' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/notfound' - '419': - description: Input Field Missing - content: - application/json: - schema: - $ref: '#/components/schemas/inputfieldmissing' - '420': - description: Input Limit Exceeded - content: - application/json: - schema: - $ref: '#/components/schemas/inputlimitexceeded' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/servererror' - '504': - description: Gateway Timeout - content: - application/json: - schema: - $ref: '#/components/schemas/gatewaytimeout' - security: - - APIAuthorizer: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/input' - required: true -components: - schemas: - success: - type: object - properties: - results: - type: array - example: [{"title":"imagelinks", "findType":"find_all","tag":"img","attribute":"src"}] - description: The result of the API call - items: - properties: - links: - type: array - items: - oneOf: - - type: string - example: https://www.bbc.co.uk - - type: string - example: https://www.bbc.co.uk/accessibility/ - - type: string - example: https://www.bbc.co.uk/news - - type: string - example: https://www.bbc.co.uk/news - - type: string - example: https://www.bbc.co.uk/news - - type: string - example: https://www.bbc.co.uk/weather - values: - type: array - items: - oneOf: - - type: object - properties: - value: - type: string - example: Home - - type: object - properties: - value: - type: string - example: News - - type: object - properties: - value: - type: string - example: Sport - images: - type: array - items: - oneOf: - - type: string - example: https://ichef.bbci.co.uk/news/320/cpsprodpb/0DDC/production/_112984530_gettyimages-1227286994.jpg - - type: string - example: https://ichef.bbci.co.uk/images/ic/720x405/p08dwhp8.jpg - message: - type: string - example: successfully processed - description: Detail description on the API status - status: - type: string - example: success - description: The status of the API call success/failure - unauthorized: - type: object - properties: - message: - type: string - example: Missing Authentication Token - status: - type: string - example: Failure - restricted: - type: object - properties: - message: - type: string - example: The content is restricted - status: - type: string - example: Failure - forbidden: - type: object - properties: - message: - type: string - example: Access Denied Unauthorized User - status: - type: string - example: Failure - paymentrequired: - type: object - properties: - message: - type: string - example: Insufficient Credits Kindly Top Up - status: - type: string - example: Failure - notfound: - type: object - properties: - message: - type: string - example: Invalid Request - status: - type: string - example: Failure - servererror: - type: object - properties: - message: - type: string - example: Internal Server Error - status: - type: string - example: Failure - gatewaytimeout: - type: object - properties: - message: - type: string - example: Request Timeout - status: - type: string - example: Failure - inputfieldmissing: - type: object - properties: - message: - type: string - example: Input Field Missing - status: - type: string - example: Failure - inputlimitexceeded: - type: object - properties: - message: - type: string - example: Input Limit Exceeded - status: - type: string - example: Failure - versions: - type: object - properties: - v0.1: - type: array - items: - oneOf: - - type: string - example: Published Date - Feb 10, 2020 - description: Initial version release - input: - type: object - properties: - url: - type: string - default: true - example: https://www.bbc.co.uk - description: Web page URL - queryList: - type: array - default: false - example: [{"title":,"findType":"find_all","tag":"h1", "returnType":"html"}] - description: Array object - items: - properties: - findType: - type: string - tag: - type: string - id: - type: string - class: - type: string - nestedclassid: - type: string - attribute: - type: string - title: - type: string - returnType: - type: string - securitySchemes: - APIAuthorizer: - type: apiKey - name: x-api-key - in: header - x-amazon-apigateway-authtype: custom - description: Authentication is done using the x-api-key in the request header