ULP_BFF.yaml

openapi: 3.0.3
info:
  title: ULP BFF - OpenAPI 3.0
  description: |-
    ULP Ewallet API design for Mobile BFF (Backend for Frontend)

    You can find out more about
    BFF at [https://medium.com/mobilepeople/backend-for-frontend-pattern-why-you-need-to-know-it-46f94ce420b0](https://medium.com/mobilepeople/backend-for-frontend-pattern-why-you-need-to-know-it-46f94ce420b0).

    You can find out more about
    Ewallet Mobile Design at [https://www.figma.com/file/5m2T5UDtkRj6UAkojdzGvJ/ULP?node-id=0%3A1&t=VxI9cvmjVKsfjIkr-0](https://www.figma.com/file/5m2T5UDtkRj6UAkojdzGvJ/ULP?node-id=0%3A1&t=VxI9cvmjVKsfjIkr-0)

    editor.swagger.io
  version: 1.0.11
servers:
  - url: https://ulp.uniteframework.io/ulp-bff/
tags:
  - name: credential
    description: Bulk AAPI to generate credential of student
  - name: student
    description: Student Ewallet Profile Related Operations
  - name: client
    description: Client who uses our bulk registration API with Client ID and Client Secret
paths:
  /credential/upload/{type}:
    parameters:
        - in: path
          name: type
          schema:
            type: string
            default: proofOfEnrollment
          required: true
          description: The number of items to skip before starting to collect the result set.
    post:
      tags:
        - credential
      summary: bulk import student data to generate credetials
      description: process all the student records and generate crdentials of it
      operationId: importCredential
      requestBody:
        description: Create credentials for each student
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Credential'
          application/xml:
            schema:
              $ref: '#/components/schemas/Credential'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Credential'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'          
            application/xml:
              schema:
                $ref: '#/components/schemas/Credential'
        '405':
          description: Invalid input
  /student/register:
    post:
      tags:
        - student
      description: Student Register API. It create student account with username as studentid id in Keycloak and then add student record with generated DID in Sunbird RC 
      requestBody:
        description: post variable aadhaarid, studentname, schoolname, studentid, phoneno
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterStudent'
          application/xml:
            schema:
              $ref: '#/components/schemas/RegisterStudent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RegisterStudent'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterStudentSuccess'          
            application/xml:
              schema:
                $ref: '#/components/schemas/RegisterStudentSuccess'
  /student/login:
    post:
      tags:
        - student
      description: Student Login API. It get access token from provided credentials from Keycloak and then search data of student record in Sunbird RC and sent as response 
      requestBody:
        description: post variable username, password
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginStudent'
          application/xml:
            schema:
              $ref: '#/components/schemas/LoginStudent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/LoginStudent'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginStudentSuccess'          
            application/xml:
              schema:
                $ref: '#/components/schemas/LoginStudentSuccess'
  /student/getdid/{aadhaarid}:
    get:
      tags:
        - student
      description: get student DID from student aadhaar id 
      parameters:
        - name: aadhaarid
          in: path
          description: DID of student to return
          required: true
          schema:
            type: string
            format: test
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDIDSuccess'          
            application/xml:
              schema:
                $ref: '#/components/schemas/GetDIDSuccess'
  /student/credentials:
    get:
      tags:
        - student
      description: get student generated certificate from credentials 
      parameters:
        - name: token
          in: header
          description: student cerificate return from student token
          required: true
          schema:
            type: string
            format: test
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsSuccess'          
            application/xml:
              schema:
                $ref: '#/components/schemas/CredentialsSuccess'
  /client/register:
    post:
      tags:
        - client
      requestBody:
        description: post variable clientName
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterClient'
          application/xml:
            schema:
              $ref: '#/components/schemas/RegisterClient'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RegisterClient'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterClientSuccess'          
            application/xml:
              schema:
                $ref: '#/components/schemas/RegisterClientSuccess'
  /client/search:
    post:
      tags:
        - client
      requestBody:
        description: post variable clientName
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchClient'
          application/xml:
            schema:
              $ref: '#/components/schemas/SearchClient'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SearchClient'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchClientSuccess'          
            application/xml:
              schema:
                $ref: '#/components/schemas/SearchClientSuccess'
  /client/bulk/upload/{type}:
    post:
      tags:
        - client
      description: get student DID from student aadhaar id 
      parameters:
        - name: type
          in: path
          description: type proofOfAssessment, proofOfEnrollment, proofOfBenifits
          required: true
          schema:
            type: string
            format: test
      requestBody:
        description: post variable clientId, clientSecret, issuerDetail, vcData, credentialSubjectCommon, credentialSubject
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientBulkUpload'
          application/xml:
            schema:
              $ref: '#/components/schemas/ClientBulkUpload'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ClientBulkUpload'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientBulkUploadSuccess'          
            application/xml:
              schema:
                $ref: '#/components/schemas/ClientBulkUploadSuccess'
components:
  schemas: 
    Credential:
      required:
        - name
        - photoUrls
      type: object
      properties:
        issuerDetail:
          type: object
          example: {"udise": "123456","schoolName": "Delhi public school"}
        vcData:
          type: object
          example: {"issuanceDate": "2023-02-06T11:56:27.259Z","expirationDate": "2023-02-06T11:56:27.259Z"}
        credentialSubjectCommon:
          type: object
          example: {"grade": "class-1","academicYear": "2022-2023"}
        credentialSubject:
           type: array
           example: [{"studentName":"Khushi Kumari","dob":"09/09/1999","reference_id": "prernaid","aadhar_token":"qwrycvqwtqw3672", "guardianName": "Sita prabhu", "enrolledOn":"2022-02-06"}]
           xml:
            wrapped: true
           items:
             $ref: '#/components/schemas/Credential'
      xml:
        name: credential
    credentialSubject:
      type: object
      properties:
        studentId:
          type: string
          example: 236239
        studentName:
          type: string
          example: ANAMIKA
        fatherName:
          type: string
          example: BASANT
        guardianName:
          type: string
          example: Rakesh
        dob:
          type: string
          example: 14/08/1993
        class:
          type: string
          example: Level - V
        gender:
          type: string
          example: Male
        mobile:
          type: string
          example: 9044904842
        aadhaarId:
          type: string
          example: adhaartest1
        districtId:
          type: string
          example: Lucknow
        blockId:
          type: string
          example: Sarojini Nagar
        villageId:
          type: string
          example: Sarojini Nagar
      xml:
        name: credentialSubject
    RegisterStudent:
      required:
        - aadhaarId
        - studentName
        - schoolName
        - schoolId
        - studentId
        - phoneNo
      type: object
      properties:
        aadhaarId:
          type: string
          format: text
          example: 999999999999
        studentName:
          type: string
          format: text
          example: ABC
        schoolName:
          type: string
          format: text
          example: DEF
        schoolId:
          type: string
          format: text
          example: 123XYZ
        studentId:
          type: string
          format: text
          example: 123ABC
        phoneNo:
          type: string
          format: text
          example: 8888888888
      xml:
        name: RegisterStudent
    RegisterStudentSuccess:
      required:
        - statusCode
        - success
        - status
        - message
      type: object
      properties:
        success:
          type: boolean
          format: boolean
          example: true
        status:
          type: string
          format: text
          example: registered
        message:
          type: string
          format: text
          example: Student Account Created in Keycloak and Registered in Sunbird RC
        result:
          type: string
          format: text
          example: data_obj
      xml:
        name: RegisterStudentSuccess
    LoginStudent:
      required:
        - username
        - password
      type: object
      properties:
        username:
          type: string
          format: text
          example: ABC123
        password:
          type: string
          format: text
          example: qwerty
      xml:
        name: LoginStudent
    LoginStudentSuccess:
      required:
        - success
        - status
        - message
        - result
      type: object
      properties:
        success:
          type: boolean
          format: boolean
          example: true
        status:
          type: string
          format: text
          example: login_success
        message:
          type: string
          format: text
          example: Login Success
        result:
          type: string
          format: text
          example: {
            userData: {},
            token: token
          }
      xml:
        name: LoginStudentSuccess
    GetDIDSuccess:
      required:
        - success
        - status
        - message
        - result
      type: object
      properties:
        success:
          type: boolean
          format: boolean
          example: true
        status:
          type: string
          format: text
          example: did_success
        message:
          type: string
          format: text
          example: DID Found
        result:
          type: string
          format: text
          example: did:ulp:f89d3678-7a1d-41af-87dc-d9d7453894f6
      xml:
        name: GetDIDSuccess
    CredentialsSuccess:
      required:
        - success
        - status
        - message
        - result
      type: object
      properties:
        success:
          type: boolean
          format: boolean
          example: true
        status:
          type: string
          format: text
          example: cred_success
        message:
          type: string
          format: text
          example: Student Credentials Found
        result:
          type: string
          format: text
          example: credential object
      xml:
        name: CredentialsSuccess
    RegisterClient:
      required:
        - clientName
      type: object
      properties:
        clientName:
          type: string
          format: text
          example: Prerana Portal
      xml:
        name: RegisterClient
    RegisterClientSuccess:
      required:
        - success
        - status
        - message
        - result
      type: object
      properties:
        success:
          type: boolean
          format: boolean
          example: true
        status:
          type: string
          format: text
          example: sb_rc_registered
        message:
          type: string
          format: text
          example: Client Found in Subird RC
        result:
          type: string
          format: text
          example: Logs
      xml:
        name: RegisterClientSuccess
    SearchClient:
      required:
        - clientName
      type: object
      properties:
        clientName:
          type: string
          format: text
          example: Prerana Portal
      xml:
        name: SearchClient
    SearchClientSuccess:
      required:
        - success
        - status
        - message
        - result
      type: object
      properties:
        success:
          type: boolean
          format: boolean
          example: true
        status:
          type: string
          format: text
          example: sb_rc_search_found
        message:
          type: string
          format: text
          example: Client Found in Subird RC
        result:
          type: string
          format: text
          example: Client Details
      xml:
        name: SearchClientSuccess
    ClientBulkUpload:
      required:
        - clientId
        - clientSecret
        - issuerDetail
        - vcData
        - credentialSubjectCommon
        - credentialSubject
      type: object
      properties:
        clientId:
          type: string
          format: text
          example: GY1K1412121
        clientSecret:
          type: string
          format: text
          example: 0c3cbdba425f5db1fa47bfa78563
        issuerDetail:
          type: object
          example: {"udise": "123456","schoolName": "Delhi public school"}
        vcData:
          type: object
          example: {"issuanceDate": "2023-02-06T11:56:27.259Z","expirationDate": "2023-02-06T11:56:27.259Z"}
        credentialSubjectCommon:
          type: object
          example: {"grade": "class-1","academicYear": "2022-2023"}
        credentialSubject:
           type: array
           example: [{"studentName":"Khushi Kumari","dob":"09/09/1999","reference_id": "prernaid","aadhar_token":"qwrycvqwtqw3672", "guardianName": "Sita prabhu", "enrolledOn":"2022-02-06"}]
           xml:
            wrapped: true
           items:
             $ref: '#/components/schemas/Credential'
      xml:
        name: ClientBulkUpload
    ClientBulkUploadSuccess:
      required:
        - success
        - status
        - message
        - result
      type: object
      properties:
        success:
          type: boolean
          format: boolean
          example: true
        status:
          type: string
          format: text
          example: upload_success
        message:
          type: string
          format: text
          example: Upload Success
        result:
          type: string
          format: text
          example: Logs
      xml:
        name: ClientBulkUploadSuccess