Jump to

• Request
• Response

Retrieves the Event by ID

get

/service/lmd/events/{id}

This endpoint is used to get the event by id.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  Maximum Length: 36

  Event Id for which data needs to be fetched

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : LmdTbEventsWrapperServiceDTO

Type: object

Show Source

• data(optional): object LmdTbEventsDTO
  Events DTO

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/LmdTbEventsDTO"
        }
    }
}

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",
                    "maxLength":50
                },
                "eventSource":{
                    "description":"Source for Events",
                    "type":"string",
                    "maxLength":150
                },
                "eventDescription":{
                    "description":"Description for Events",
                    "type":"string",
                    "maxLength":500
                },
                "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",
                    "maxLength":20
                },
                "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",
                    "maxLength":50
                },
                "fromAccountNumber":{
                    "description":"From Account Number for Events",
                    "type":"string",
                    "maxLength":50
                },
                "fromBranchCode":{
                    "description":"From Branch Code for Exceptions",
                    "type":"string",
                    "maxLength":4
                },
                "fromCurrencyCode":{
                    "description":"From Currency Code for Exceptions",
                    "type":"string",
                    "maxLength":3
                },
                "toAccountNumber":{
                    "description":"To Account Number for Events",
                    "type":"string",
                    "maxLength":50
                },
                "toBranchCode":{
                    "description":"To Branch Code for Exceptions",
                    "type":"string",
                    "maxLength":4
                },
                "toCurrencyCode":{
                    "description":"To Currency Code for Exceptions",
                    "type":"string",
                    "maxLength":3
                },
                "structureType":{
                    "description":"Structure Type for Exceptions",
                    "type":"string",
                    "maxLength":20
                },
                "userId":{
                    "description":"User Id for Exceptions",
                    "type":"string",
                    "maxLength":12
                },
                "structureId":{
                    "description":"Structure Id for Events",
                    "type":"string",
                    "pattern":"[A-Z0-9]{1,30}"
                }
            },
            "required":[
                "id",
                "eventCode"
            ]
        }
    ]
}

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(optional): string(date)
  Close Date for Events
• createdBy(optional): string
  Maximum Length: 20

  Created by for Events
• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}

  Customer Id in Events
• eventCode: string
  Maximum Length: 50

  Code for Events
• eventDate(optional): string
  Date of Events
• eventDescription(optional): string
  Maximum Length: 500

  Description for Events
• eventSource(optional): string
  Maximum Length: 150

  Source for Events
• eventType(optional): string
  Type of Events
• fromAccountNumber(optional): string
  Maximum Length: 50

  From Account Number for Events
• fromBranchCode(optional): string
  Maximum Length: 4

  From Branch Code for Exceptions
• fromCurrencyCode(optional): string
  Maximum Length: 3

  From Currency Code for Exceptions
• isActive(optional): string
  Is Active in Events
• startDate(optional): string(date)
  Start Date for Events
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}

  Structure Id for Events
• structureType(optional): string
  Maximum Length: 20

  Structure Type for Exceptions
• toAccountNumber(optional): string
  Maximum Length: 50

  To Account Number for Events
• toBranchCode(optional): string
  Maximum Length: 4

  To Branch Code for Exceptions
• toCurrencyCode(optional): string
  Maximum Length: 3

  To Currency Code for Exceptions
• transactionId(optional): string
  Maximum Length: 50

  Transaction Id for Events
• userId(optional): string
  Maximum Length: 12

  User Id for Exceptions

{
    "type":"object",
    "properties":{
        "eventDate":{
            "description":"Date of Events",
            "type":"string"
        },
        "eventType":{
            "description":"Type of Events",
            "type":"string"
        },
        "eventCode":{
            "description":"Code for Events",
            "type":"string",
            "maxLength":50
        },
        "eventSource":{
            "description":"Source for Events",
            "type":"string",
            "maxLength":150
        },
        "eventDescription":{
            "description":"Description for Events",
            "type":"string",
            "maxLength":500
        },
        "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",
            "maxLength":20
        },
        "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",
            "maxLength":50
        },
        "fromAccountNumber":{
            "description":"From Account Number for Events",
            "type":"string",
            "maxLength":50
        },
        "fromBranchCode":{
            "description":"From Branch Code for Exceptions",
            "type":"string",
            "maxLength":4
        },
        "fromCurrencyCode":{
            "description":"From Currency Code for Exceptions",
            "type":"string",
            "maxLength":3
        },
        "toAccountNumber":{
            "description":"To Account Number for Events",
            "type":"string",
            "maxLength":50
        },
        "toBranchCode":{
            "description":"To Branch Code for Exceptions",
            "type":"string",
            "maxLength":4
        },
        "toCurrencyCode":{
            "description":"To Currency Code for Exceptions",
            "type":"string",
            "maxLength":3
        },
        "structureType":{
            "description":"Structure Type for Exceptions",
            "type":"string",
            "maxLength":20
        },
        "userId":{
            "description":"User Id for Exceptions",
            "type":"string",
            "maxLength":12
        },
        "structureId":{
            "description":"Structure Id for Events",
            "type":"string",
            "pattern":"[A-Z0-9]{1,30}"
        }
    },
    "required":[
        "id",
        "eventCode"
    ]
}

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