Tuesday, July 16, 2024

Static - Error Log
Action:
GET
Method:
GET
URL: /api/v1/static/errorlog/get
Description: Fetch Static Error Log records for:
a) Transaction Date (parameters LogLevel and UserID should be blank for this fetch).
b) Transaction Date and Log Level (parameter UserID should be blank for this fetch).
c) Transaction Date, Log Level and User
Type Key DataType Notes
Headers api-key String Your Api-Key
Params LogLevel String Log Level (Parameter value can be blank)
Params UserID String User Identifier (Parameter value can be blank)
Params TransactionDate DateTime Transaction Date (Log Date) (Parameter value cannot be blank)
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of Static Error Log records.
[{
 "TransactionDate": 2019-09-17 10:15:44,
 "Organisation": "ABC Limited",
 "InterfaceReference": "ABC001",
 "ClientEntityID": 0,
 "LogLevel": "",
 "Data": "Login Error",
 "Stack": "ERROR - com.riskscreen.batch.Controllers.ErrorController -
  Exception: System.NullReferenceException: Object reference not set to an instance of an object.
  at AspNetCore.Views_Entity_Potential__Matches.<>c.<ExecuteAsync>
  b__7_0(MatchModel m)
  at System.Linq.EnumerableSorter`2.ComputeKeys(TElement[] elements, Int32 count)
  at System.Linq.EnumerableSorter`1.Sort(TElement[] elements, Int32 count)
 "UserID": "103",
 "UserName": "Jane",
}]
Field Data Type
TransactionDate DateTime
Organisation Text 25
InterfaceReference Text 50
ClientEntityID Int 32
LogLevel Text 15
Data Text 3500
Stack Text 250
UserID Text 20
UserName Text 50
Action:
ADD
Method:
POST
URL: /api/v1/static/errorlog/add
Description: Add a Static Error Log
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body TransactionDate DateTime Transaction Date (Log Date)
Body Organisation String Organisation
Body InterfaceReference String Interface Reference
Body ClientEntityID Int32 Client Entity Identifier
Body LogLevel String Log Level
Body Data String Data
Body Stack String Stack
Body UserID String User Identifier
Body UserName String User Name
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Static Error Log record added.
{
 "TransactionDate": 2019-09-17 10:15:44,
 "Organisation": "ABC Limited",
 "InterfaceReference": "ABC001",
 "ClientEntityID": 0,
 "LogLevel": "",
 "Data": "Login Error",
 "Stack": "ERROR - com.riskscreen.batch.Controllers.ErrorController -
  Exception: System.NullReferenceException: Object reference not set to an instance of an object.
  at AspNetCore.Views_Entity_Potential__Matches.<>c.<ExecuteAsync>
  b__7_0(MatchModel m)
  at System.Linq.EnumerableSorter`2.ComputeKeys(TElement[] elements, Int32 count)
  at System.Linq.EnumerableSorter`1.Sort(TElement[] elements, Int32 count)
 "UserID": "103",
 "UserName": "Jane",
}
Field Data Type
TransactionDate DateTime
Organisation Text 25
InterfaceReference Text 50
ClientEntityID Int 32
LogLevel Text 15
Data Text 3500
Stack Text 250
UserID Text 20
UserName Text 50
Action:
DELETE
Method:
DELETE
URL: /api/v1/static/errorlog/delete
Description: Delete existing Static Error Logs for a date
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body TransactionDate DateTime Transaction Date (Log Date) of the Static Error Logs to delete
Body ReturnFormat String Json or Xml
Return Data: Json or XML collection of Static Error Log records deleted.
[{
 "TransactionDate": 2019-09-17 10:15:44,
 "Organisation": "ABC Limited",
 "InterfaceReference": "ABC001",
 "ClientEntityID": 0,
 "LogLevel": "",
 "Data": "Login Error",
 "Stack": "ERROR - com.riskscreen.batch.Controllers.ErrorController -
  Exception: System.NullReferenceException: Object reference not set to an instance of an object.
  at AspNetCore.Views_Entity_Potential__Matches.<>c.<ExecuteAsync>
  b__7_0(MatchModel m)
  at System.Linq.EnumerableSorter`2.ComputeKeys(TElement[] elements, Int32 count)
  at System.Linq.EnumerableSorter`1.Sort(TElement[] elements, Int32 count)
 "UserID": "103",
 "UserName": "Jane",
}]
Field Data Type
TransactionDate DateTime
Organisation Text 25
InterfaceReference Text 50
ClientEntityID Int 32
LogLevel Text 15
Data Text 3500
Stack Text 250
UserID Text 20
UserName Text 50