Jump to

• Request
• Response

Retrieves the List of Existing Events Based on Log Type

get

/service/lmd/events

This endpoint is used to retrieve the list of existing events based on log type.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• customerId: string
  Pattern: [a-zA-Z0-9]{1,20}

  Customer Id(s) for which data needs to be fetched
• eventType: string
  fetch record according to eventType
• limit: integer
  limit is maximum no of records to be fetched
• offset: integer
  offset is starting no of records to be fetched

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : LmdTbEventsServiceCollection

Type: object

Collection of Events

Show Source

• data: array data
• paging: object PagingDto

{
    "description":"Collection of Events",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmdTbEventsDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object LmdTbEventsDTO
  Events DTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : LmdTbEventsDTO

Type: object

Events DTO

Match All

Show Source

• allOf GenericDto
• object LmdTbEventsDTO-allOf[1]

{
    "description":"Events DTO",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "eventDate":{
                    "description":"Date of Events",
                    "type":"string"
                },
                "eventType":{
                    "description":"Type of Events",
                    "type":"string"
                },
                "eventCode":{
                    "description":"Code for Events",
                    "type":"string"
                },
                "eventSource":{
                    "description":"Source for Events",
                    "type":"string"
                },
                "eventDescription":{
                    "description":"Description for Events",
                    "type":"string"
                },
                "customerId":{
                    "description":"Customer Id in Events",
                    "type":"string",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "isActive":{
                    "description":"Is Active in Events",
                    "type":"string"
                },
                "createdBy":{
                    "description":"Created by for Events",
                    "type":"string"
                },
                "startDate":{
                    "description":"Start Date for Events",
                    "type":"string",
                    "format":"date"
                },
                "closeDate":{
                    "description":"Close Date for Events",
                    "type":"string",
                    "format":"date"
                },
                "transactionId":{
                    "description":"Transaction Id for Events",
                    "type":"string"
                },
                "fromAccountNumber":{
                    "description":"From Account Number for Events",
                    "type":"string"
                },
                "toAccountNumber":{
                    "description":"To Account Number for Events",
                    "type":"string"
                },
                "structureId":{
                    "description":"Structure Id for Events",
                    "type":"string",
                    "pattern":"[0-9a-fA-Z-]{1,36}"
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LmdTbEventsDTO-allOf[1]

Type: object

Show Source

• closeDate: string(date)
  Close Date for Events
• createdBy: string
  Created by for Events
• customerId: string
  Pattern: [a-zA-Z0-9]{1,20}

  Customer Id in Events
• eventCode: string
  Code for Events
• eventDate: string
  Date of Events
• eventDescription: string
  Description for Events
• eventSource: string
  Source for Events
• eventType: string
  Type of Events
• fromAccountNumber: string
  From Account Number for Events
• isActive: string
  Is Active in Events
• startDate: string(date)
  Start Date for Events
• structureId: string
  Pattern: [0-9a-fA-Z-]{1,36}

  Structure Id for Events
• toAccountNumber: string
  To Account Number for Events
• transactionId: string
  Transaction Id for Events

{
    "type":"object",
    "properties":{
        "eventDate":{
            "description":"Date of Events",
            "type":"string"
        },
        "eventType":{
            "description":"Type of Events",
            "type":"string"
        },
        "eventCode":{
            "description":"Code for Events",
            "type":"string"
        },
        "eventSource":{
            "description":"Source for Events",
            "type":"string"
        },
        "eventDescription":{
            "description":"Description for Events",
            "type":"string"
        },
        "customerId":{
            "description":"Customer Id in Events",
            "type":"string",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "isActive":{
            "description":"Is Active in Events",
            "type":"string"
        },
        "createdBy":{
            "description":"Created by for Events",
            "type":"string"
        },
        "startDate":{
            "description":"Start Date for Events",
            "type":"string",
            "format":"date"
        },
        "closeDate":{
            "description":"Close Date for Events",
            "type":"string",
            "format":"date"
        },
        "transactionId":{
            "description":"Transaction Id for Events",
            "type":"string"
        },
        "fromAccountNumber":{
            "description":"From Account Number for Events",
            "type":"string"
        },
        "toAccountNumber":{
            "description":"To Account Number for Events",
            "type":"string"
        },
        "structureId":{
            "description":"Structure Id for Events",
            "type":"string",
            "pattern":"[0-9a-fA-Z-]{1,36}"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top