Jump to

• Request
• Response

Add New Note

post

/notes-service/saveNotes

This endpoint is used to add or save a new note.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  The ID of the application making the request.
• branchCode: string
  The branch code for the request.
• contentType(optional): string
  The content type of the request.
• tenantId(optional): string
  The ID of the tenant.
• userId: string
  The ID of the user making the request.

Body ()

Request Body that contains data required for creating a new note.

Root Schema : NotesModel

Type: object

Notes model

Show Source

• accountId(optional): string
  Account Id
• alert(optional): string
  Alert Flag
• capturedBy(optional): string
  Captured By User Id
• createdDate(optional): string
  Created Date
• desc(optional): string
  Notes Description
• notesId(optional): string
  Notes Id
• notesType(optional): string
  Notes Type
• status(optional): string
  Status

{
    "description":"Notes model",
    "type":"object",
    "properties":{
        "notesId":{
            "description":"Notes Id",
            "type":"string"
        },
        "accountId":{
            "description":"Account Id",
            "type":"string"
        },
        "alert":{
            "description":"Alert Flag",
            "type":"string"
        },
        "createdDate":{
            "description":"Created Date",
            "type":"string"
        },
        "capturedBy":{
            "description":"Captured By User Id",
            "type":"string"
        },
        "status":{
            "description":"Status",
            "type":"string"
        },
        "notesType":{
            "description":"Notes Type",
            "type":"string"
        },
        "desc":{
            "description":"Notes Description",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns the ID of the newly created note.

Headers

• Location: string
  URL of newly created note.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input.

500 Response

Internal error.

Back to Top