Jump to

• Request
• Response

Get Notes by Action ID

get

/notes-service/note/{actionId}

This endpoint is used to retrieve notes by action ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• actionId(required): string
  The action ID for which we need the account information.

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns the notes details based on given action ID.

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

Invalid input

500 Response

An internal server error occurred.

Back to Top