Thursday, November 21, 2024

Client - Entity Audit
Action:
GET
Method:
GET
URL: /api/v1/client/entity/audit/get
Description: Fetch an existing Client Entity Audit record based on Client Entity Identifier and Audit Date
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientEntityID Int32 Client Entity Identifier
Params TransactionDate Date Transaction Date (Audit Date)
Params AuditType Byte 1=Add; 2=Update; 3=Delete
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Entity Audit record being fetched
{
 "BusinessUnitID": 10,
 "BusinessUnitName": Jersey Office,
 "ClientEntityID": 1241,
 "InterfaceReference": "AB1234",
 "LastName": "PUTIN",
 "FirstName": "VLADIMIR",
 "MiddleName": "",
 "CriteriaID": 1,
 "CriteriaName": "Default - Person",
 "GenderID": 1,
 "GenderName": "Male",
 "Date": "1962-03-22 00:00:00",
 "Country1ID": 182,
 "Country1Name": "Russia",
 "Country2ID": 0,
 "Country2Name": "Unknown",
 "Country3ID": 0,
 "Country3Name": "Unknown",
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "0"
 "HandledByUserName": ""
 "RiskID": 3,
 "RiskName": "High",
 "StatusID": 1,
 "StatusName": "Active",
 "DateAdded": "2019-09-06 00:00:00",
 "CustomText1": "",
 "CustomText2": ""
 "AdverseMediaFileCriteriaID": 1003,
 "AdverseMediaDateRangeID": 0,
 "AdverseMediaCountryID": 0,
 "AdditionalAndTerms": "",
 "AdditionalOrTerms": "",
 "ExcludeTerms": ""
 "AdverseMediaDateLastScreened": "2024-11-21 00:00:00",
 "AuditTypeID": 2,
 "AuditTranDate": "2019-09-06 17:51:36",
 "DateLastChanged": "2019-09-06 17:51:36",
 "LastChangedByUserID": 101
}
Field Data Type
BusinessUnitID Int 32
BusinessUnitName Test 255
ClientEntityID Int 32
InterfaceReference Text 50
LastName Text 255
FirstName Text 255
MiddleName Text 255
CriteriaID Int 16
CriteriaName Text 150
GenderID Byte
GenderName Text 150
Date Date
Country1ID Int 16
Country1Name Text 255
Country2ID Int 16
Country2Name Text 255
Country3ID Int 16
Country3Name Text 255
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
RiskID Int 16
RiskName Text 150
StatusID Byte
StatusName Text 150
DateAdded Date
CustomText1 Text 255
CustomText2 Text 255
AdverseMediaFileCriteriaID Int 16
AdverseMediaDateRangeID Int 16
AdverseMediaCountryID Int 16
AdditionalAndTerms Text 256
AdditionalOrTerms Text 256
ExcludeTerms Text 256
AdverseMediaDateLastScreened Date
AuditTypeID Int 16
AuditTranDate Date
DateLastChanged Date
LastChangedByUserID Int 16
Action:
GET ALL
Method:
GET
URL: /api/v1/client/entity/audit/getall
Description: Fetch Client Entity Audit records based on User Identifier and Date Range
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params UserID Int16 User Identifier
Params FromDate Date Audit Start Date
Params ToDate Date Audit End Date
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of the Client Entity Audit objects being fetched
{
 "BusinessUnitID": 10,
 "BusinessUnitName": Jersey Office,
 "ClientEntityID": 1241,
 "InterfaceReference": "AB1234",
 "LastName": "PUTIN",
 "FirstName": "VLADIMIR",
 "MiddleName": "",
 "CriteriaID": 1,
 "CriteriaName": "Default - Person",
 "GenderID": 1,
 "GenderName": "Male",
 "Date": "1962-03-22 00:00:00",
 "Country1ID": 182,
 "Country1Name": "Russia",
 "Country2ID": 0,
 "Country2Name": "Unknown",
 "Country3ID": 0,
 "Country3Name": "Unknown",
 "HandledByUserGroupID": "203"
 "HandledByUserGroupName": "Handler Group"
 "HandledByUserID": "0"
 "HandledByUserName": ""
 "RiskID": 3,
 "RiskName": "High",
 "StatusID": 1,
 "StatusName": "Active",
 "DateAdded": "2019-09-06 00:00:00",
 "CustomText1": "",
 "CustomText2": ""
 "AdverseMediaFileCriteriaID": 1003,
 "AdverseMediaDateRangeID": 0,
 "AdverseMediaCountryID": 0,
 "AdditionalAndTerms": "",
 "AdditionalOrTerms": "",
 "ExcludeTerms": ""
 "AdverseMediaDateLastScreened": "2024-11-21 00:00:00",
 "AuditTypeID": 2,
 "AuditTranDate": "2019-09-06 17:51:36",
 "DateLastChanged": "2019-09-06 17:51:36",
 "LastChangedByUserID": 101
}
Field Data Type
Field Data Type
BusinessUnitID Int 32
BusinessUnitName Test 255
ClientEntityID Int 32
InterfaceReference Text 50
LastName Text 255
FirstName Text 255
MiddleName Text 255
CriteriaID Int 16
CriteriaName Text 150
GenderID Byte
GenderName Text 150
Date Date
Country1ID Int 16
Country1Name Text 255
Country2ID Int 16
Country2Name Text 255
Country3ID Int 16
Country3Name Text 255
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
RiskID Int 16
RiskName Text 150
StatusID Byte
StatusName Text 150
DateAdded Date
CustomText1 Text 255
CustomText2 Text 255
AdverseMediaFileCriteriaID Int 16
AdverseMediaDateRangeID Int 16
AdverseMediaCountryID Int 16
AdditionalAndTerms Text 256
AdditionalOrTerms Text 256
ExcludeTerms Text 256
AdverseMediaDateLastScreened Date
AuditTypeID Int 16
AuditTranDate Date
DateLastChanged Date
LastChangedByUserID Int 16
Action:
GET ALL PAGED
Method:
GET
URL: /api/v1/client/entity/audit/getallpaged
Description: Fetch Client Entity Audit records based on User Identifier, Date Range in batches for the given PageIndex and Number of Rows to fetch
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params UserID Int16 User Identifier
Params FromDate Date Audit Start Date
Params ToDate Date Audit End Date
Params SearchString String Search String (optional- leave blank)
Params SearchOn Byte 0=LastName, 1=FirstName, 2=MiddleName, 3=ClientEntityID, 4=InterfaceReference
Params SearchType Byte 0=StartsWith, 1=Contains
Params SearchStatus Byte 2=Both, 1=Active, 0=Disabled
Params CurrentPage Int32 Page Index
Params PageSize Int32 Number of rows to fetch
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of the Client Entity Audit objects being fetched
{
  "TotalRecords": 5,
  "Data": [
  {
   "BusinessUnitID": 10,
   "BusinessUnitName": Jersey Office,
   "ClientEntityID": 1241,
   "InterfaceReference": "AB1234",
   "LastName": "PUTIN",
   "FirstName": "VLADIMIR",
   "MiddleName": "",
   "CriteriaID": 1,
   "CriteriaName": "Default - Person",
   "GenderID": 1,
   "GenderName": "Male",
   "Date": "1962-03-22 00:00:00",
   "Country1ID": 182,
   "Country1Name": "Russia",
   "Country2ID": 0,
   "Country2Name": "Unknown",
   "Country3ID": 0,
   "Country3Name": "Unknown",
   "HandledByUserGroupID": "203"
   "HandledByUserGroupName": "Handler Group"
   "HandledByUserID": "0"
   "HandledByUserName": ""
   "RiskID": 3,
   "RiskName": "High",
   "StatusID": 1,
   "StatusName": "Active",
   "DateAdded": "2019-09-06 00:00:00",
   "CustomText1": "",
   "CustomText2": ""
   "AdverseMediaFileCriteriaID": 1003,
   "AdverseMediaDateRangeID": 0,
   "AdverseMediaCountryID": 0,
   "AdditionalAndTerms": "",
   "AdditionalOrTerms": "",
   "ExcludeTerms": ""
   "AdverseMediaDateLastScreened": "2024-11-21 00:00:00",
   "AuditTypeID": 2,
   "AuditTranDate": "2019-09-06 17:51:36",
   "DateLastChanged": "2019-09-06 17:51:36",
   "LastChangedByUserID": 101
  }
 ]
}
Field Data Type
TotalRecords Int 32
BusinessUnitID Int 32
BusinessUnitName Test 255
ClientEntityID Int 32
InterfaceReference Text 50
LastName Text 255
FirstName Text 255
MiddleName Text 255
CriteriaID Int 16
CriteriaName Text 150
GenderID Byte
GenderName Text 150
Date Date
Country1ID Int 16
Country1Name Text 255
Country2ID Int 16
Country2Name Text 255
Country3ID Int 16
Country3Name Text 255
HandledByUserGroupID Int 16
HandledByUserGroupName Text 150
HandledByUserID Int 16
HandledByUserName Text 150
RiskID Int 16
RiskName Text 150
StatusID Byte
StatusName Text 150
DateAdded Date
CustomText1 Text 255
CustomText2 Text 255
AdverseMediaFileCriteriaID Int 16
AdverseMediaDateRangeID Int 16
AdverseMediaCountryID Int 16
AdditionalAndTerms Text 256
AdditionalOrTerms Text 256
ExcludeTerms Text 256
AdverseMediaDateLastScreened Date
AuditTypeID Int 16
AuditTranDate Date
DateLastChanged Date
LastChangedByUserID Int 16