Reporting Methods | Sanction Scanner Developer Portal

Get Statistics With Date Range

Required input informations of GetStatisticsWithDateRange Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
https://api.sanctionscanner.com/api/Reports/GetStatisticsWithDateRange?StartDate=startdate&EndDate=enddate

This service is used to view the statistics of searches in the last 1 month. The information required to perform the service call is the name of the person to be interrogated. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This service allows you to view statistics of searches performed by your organization within the date range that you entered. As a result of the service, the number of searches made in the date range and the number of alarms generated in these searches are returned.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
StartDate	DateTime	Yes	Start Date (MM/DD/YYYY)
EndDate	DateTime	Yes	End Date (MM/DD/YYYY)

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
TotalSearchCount	Integer	Count Of All Searches
AlertedSearchCount	Integer	Count Of Alerted Searches
Date	DateTime	Statistic Day Date

https://api.sanctionscanner.com/api/Reports/GetStatisticsWithDateRange?StartDate=startdate&EndDate=enddate

The result of the call is a result and the status of the transaction is returned in response. In successful transactions , this status returns to 200, and in unsuccessful transactions it returns to 400.

Sample Service Response Codes

 

//Request 
GET /api/Reports/GetStatisticsWithDateRange?StartDate=startdate&EndDate=enddate 

//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": [
        {
            "TotalSearchCount": 13,
            "AlertedSearchCount": 10,
            "Date": "01.01.2020"
        }
    ]
}

Get Monitoring Report By Scan Id

Required input informations of GetMonitoringReportByScanId Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
https://api.sanctionscanner.com/api/Reports/GetMonitoringReportByScanId?scanId=ScanId

This service is used to list monitoring reports. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

You can list the monitoring report that you performed. You can follow the process of assigning the user from the "Case Management" screen in the link below.

https://appv2.sanctionscanner.com/CaseManagement/Index

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
ScanId	String	Yes	Memo Id Of Search (Example: "scanId":"D0000000000")

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Class	Result class information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
ApiUsername	String	If an action was taken by the API user, the name of the relevant API user is filled in this field.
UserId	Integer	The Id of the user who made the operation is written in this field.
Username	String	If an action was taken by the WEB user, the name of the relevant WEB user is filled in this field.
SearchedType	String	Searched Type of scan (SearchByName, SearchById, SearchByPassportNo)
QueryString	String	Search Term of scan
CreatedDate	DateTime	Operation Date as Datetime
CreatedDateText	String	Operation Date as Text
ScanId	String	Scan Id of scan
MinMatchRate	Integer	Match Rate of scan
RiskLevelId	Integer	Risk Level Id of scan 0:Unknown 1:Low 2:Medium 3:High 4:Neutral 5:Increased 6:Unacceptable
MonitoringModifiedDate	DateTime	Monitoring Last Modified Date
LastMonitoringDate	DateTime	Last Monitoring Date of scan as Datetime
LastMonitoringDateText	String	Last Monitoring Date as Text
MonitoringDay	Integer	Total Monitoring Day
MonitoringStatus	Boolean	Monitoring is active
Period	String	Period Info 1:Daily 2:Weekly 3:Monthly 4:Quarterly 5:HalfEarly 6:Yearly
Result	String	Result information
NextMonitoringDate	DateTime	Next Monitoring Date

https://api.sanctionscanner.com/api/Reports/GetMonitoringReportByScanId?scanId=ScanId

Sample Service Response Codes

 
                                          
//Request
{
    "scanId":"D0000000000",
}
//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": {
    "ApiUsername": null,
    "UserId": null,
    "Username": null,
    "SearchedType": null,
    "QueryString": null,
    "CreatedDate": null,
    "CreatedDateText": null,
    "Name": null,
    "ScanId": null,
    "MinMatchRate": null,
    "MaxMatchRate": null,
    "RiskLevelId": null,
    "MonitoringModifiedDate": null,
    "LastMonitoringDate": null,
    "LastMonitoringDateText": null,
    "MonitoringDay": null,
    "MonitoringStatus": null,
    "Period": null,
    "Result": null,
    "NextMonitoringDate": null,
    }
}

Get Monitoring History

Required input informations of GetMonitoringHistory Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
https://api.sanctionscanner.com/api/Reports/GetMonitoringHistory

This service is used to list monitoring history. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

You can list the specific monitoring history that you performed. You can follow the process of assigning the user from the "Case Management" screen in the link below.

https://appv2.sanctionscanner.com/CaseManagement/Index

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
ScanId	String	Yes	Memo Id Of Search (Example: "scanId":"D0000000000")

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	String	Result Message
HistoryList	Class	HistoryList Class Information. The following internal table describes the internal parameters.

HistoryList Class Informations

Parameter Name	Data Type	Description
DateTime	String	DateTime Information
Added	Class	Added class information. The following internal table describes the internal parameters.
Updated	Class	Updated class information. The following internal table describes the internal parameters.
Removed	Class	Removed class information. The following internal table describes the internal parameters.

Added Class Informations

Parameter Name	Data Type	Description
Count	Integer	Number of data added
ListNames	String	Names

Updated Class Informations

Parameter Name	Data Type	Description
Count	Integer	Number of data updated
ListNames	String	Names

Removed Class Informations

Parameter Name	Data Type	Description
Count	Integer	Number of data removed
ListNames	String	Names

https://api.sanctionscanner.com/api/Reports/GetMonitoringHistory

Sample Service Response Codes



//Request 
    {
		"Id":"*****"
    }

//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": null,
"HistoryList": [
                "DateTime":null,
                {
                "Added":{
                         "Count":null,
                         "ListNames":
                                     {
                                     "****","****"
                                     }
                        },
                "Updated":{
                           "Count":null,
                           "ListNames":
                                       {
                                       "****","****"
                                       }
                          },
                "Removed":{
                           "Count":null,
                           "ListNames":
                                       {
                                        "****","****"
                                       }
                          }
                }
               ]
}

Get Changed Monitorings By Date

Required input informations of GetChangedMonitoringsByDate Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
https://api.sanctionscanner.com/api/Reports/GetChangedMonitoringsByDate?date=date

This service is used to view the "ScanId" information of the monitors that changed on the sent date. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
date	DateTime	Yes	Monitor Date (YYYY-MM-DD)

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
ScanIdList	String Array	List of Scan Ids of monitors that were modified on the date sent.

https://api.sanctionscanner.com/api/Reports/GetChangedMonitoringsByDate?date=date

Sample Service Response Codes

 

//Request 
GET /api/Reports/GetChangedMonitoringsByDate?date=date 

//Response
{
  "HttpStatusCode": 200,
  "IsSuccess": true,
  "ErrorCode": "string",
  "ErrorMessage": "string",
  "ExtraInfo": "string",
  "Result": {
    "ScanIdList": [
      "string"
    ]
  }
}