Jump to

• Request
• Response

Add a 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(required): string
  The ID of the application making the request.
• branchCode(required): string
  The branch code for the request.
• contentType: string
  The content type of the request.
• tenantId: string
  The ID of the tenant.
• userId(required): 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: string
  Account Id
• actionId: string
  action Id linked to the Note
• alert: string
  Alert Flag
• capturedBy: string
  Captured By User Id
• createdDate: string
  Created Date
• desc: string
  Notes Description
• notesId: string
  Notes Id
• notesType: string
  Notes Type
• status: 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"
        },
        "actionId":{
            "description":"action Id linked to the Note",
            "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: object ResponseResourceSupport
• messages: 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: array codes
• id: string
• requestId: string
• status: 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: string
• args: array args
• Code: string
• Desc: string
• Language: string
• Type: 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

The request contains invalid input.

500 Response

An internal server error occurred..

Back to Top