| All Verbs | /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version} | ||
|---|---|---|---|
| All Verbs | /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version}/{NombreTitular} |
import Foundation
import ServiceStack
public class BackgroundchekSeach : Codable
{
public var apiCode:String?
public var country:SearchCountrys?
public var documentType:String?
public var query:String?
public var version:Int?
public var nombreTitular:String?
required public init(){}
}
public enum SearchCountrys : String, Codable
{
case Colombia
case COL
case Mexico
case MEX
case Chile
case CHL
case Brasil
case BRA
case Panama
case PAN
case Dominicana
case DOM
case CostaRica
case CRI
case Argentina
case ARG
case Ecuador
case ECU
case Peru
case PER
case ElSalvador
case SLV
case Guatemala
case GTM
case Honduras
case HND
case Venezuela
case VEN
case ALL
case AFG
case ALB
case DZA
case AND
case AGO
case ATG
case ARM
case AUS
case AUT
case AZE
case BHS
case BHR
case BGD
case BRB
case BLR
case BEL
case BLZ
case BEN
case BTN
case BOL
case BIH
case BWA
case BRN
case BGR
case BFA
case BDI
case CPV
case KHM
case CMR
case CAN
case CAF
case TCD
case CHN
case COM
case COG
case CIV
case HRV
case CUB
case CYP
case CZE
case DNK
case DJI
case DMA
case TLS
case EGY
case GNQ
case ERI
case EST
case ETH
case FJI
case FIN
case FRA
case GAB
case GMB
case GEO
case DEU
case GHA
case GRC
case GRD
case GIN
case GNB
case GUY
case HTI
case HUN
case ISL
case IND
case IDN
case IRN
case IRQ
case IRL
case ISR
case ITA
case JAM
case JPN
case JOR
case KAZ
case KEN
case KIR
case PRK
case KOR
case KWT
case KGZ
case LAO
case LVA
case LBN
case LSO
case LBR
case LBY
case LIE
case LTU
case LUX
case MDG
case MWI
case MYS
case MDV
case MLI
case MLT
case MHL
case MRT
case MUS
case FSM
case MDA
case MCO
case MNG
case MNE
case MAR
case MOZ
case MMR
case NAM
case NRU
case NPL
case NLD
case NZL
case NIC
case NER
case NGA
case MKD
case NOR
case OMN
case PAK
case PLW
case PNG
case PRY
case PHL
case POL
case PRT
case QAT
case ROU
case RUS
case RWA
case KNA
case LCA
case VCT
case WSM
case SMR
case STP
case SAU
case SEN
case SRB
case SYC
case SLE
case SGP
case SVK
case SVN
case SLB
case SOM
case ZAF
case SSD
case ESP
case LKA
case SDN
case SUR
case SWZ
case SWE
case CHE
case SYR
case TWN
case TJK
case TZA
case THA
case TGO
case TON
case TTO
case TUN
case TUR
case TKM
case TUV
case UGA
case UKR
case ARE
case GBR
case USA
case URY
case UZB
case VUT
case VNM
case YEM
case ZMB
case ZWE
}
public class BackgroundchekReport : Codable
{
public var alertsCounter:Int?
public var showRiskMeter:Bool?
public var fullName:String?
public var documentNumber:String?
public var reportDate:Date?
public var searchData:BackgroundchekSeach?
public var searchStatus:QueryStatus?
public var reportID:String?
public var errors:[Error] = []
public var groups:[DataGroup] = []
public var baseName:String?
public var resume:[String] = []
public var maxRiskPoints:Int?
required public init(){}
}
public enum QueryStatus : String, Codable
{
case ok
case fail
}
public class Error : Codable
{
public var code:Int?
public var message:String?
public var source:String?
public var errorSeverity:Severity?
required public init(){}
}
public enum Severity : String, Codable
{
case Success
case Info
case Warning
case Error
}
public class DataGroup : Codable
{
public var id:Int?
public var name:String?
public var Description:String?
public var subGroups:[DataGroup] = []
public var records:[Record] = []
public var errors:[Error] = []
public var parentGroupID:Int?
public var validationGroup:Bool?
public var riskPointsFound:Int?
public var riskPointsNotFound:Int?
public var notFoundMessage:String?
public var conCoincidencias:Bool?
public var realPoints:Int?
required public init(){}
}
public class Record : Codable
{
public var values:[DataValue] = []
public var filterEvaluationResult:FilterEvaluationResults?
required public init(){}
}
public class DataValue : Codable
{
public var order:Int?
public var name:String?
public var Description:String?
public var tooltip:String?
public var value:String?
public var dataType:String?
required public init(){}
}
public class FilterEvaluationResults : Codable
{
public var matched:Bool?
public var matchedRule:String?
public var matchedExcerpt:String?
required public init(){}
}
Swift BackgroundchekSeach DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version} HTTP/1.1
Host: api.backgroundchecklatam.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ApiCode":"String","Country":"Colombia","DocumentType":"String","Query":"String","Version":0,"NombreTitular":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"AlertsCounter":0,"ShowRiskMeter":false,"FullName":"String","DocumentNumber":"String","ReportDate":"\/Date(-62135596800000-0000)\/","SearchData":{"ApiCode":"String","Country":"Colombia","DocumentType":"String","Query":"String","Version":0,"NombreTitular":"String"},"SearchStatus":"ok","ReportID":"String","Errors":[{"Code":0,"Message":"String","Source":"String","ErrorSeverity":"Success"}],"Groups":[{"Id":0,"Name":"String","Description":"String","SubGroups":[{"Id":0,"Name":"String","Description":"String","SubGroups":[{"Id":0,"Name":"String","Description":"String","Records":[{"Values":[{"Order":0,"Name":"String","Description":"String","Tooltip":"String","Value":"String","DataType":"String"}],"FilterEvaluationResult":{"Matched":false,"MatchedRule":"String","MatchedExcerpt":"String"}}],"Errors":[{"Code":0,"Message":"String","Source":"String","ErrorSeverity":"Success"}],"ParentGroupID":0,"ValidationGroup":false,"RiskPointsFound":0,"RiskPointsNotFound":0,"NotFoundMessage":"String","ConCoincidencias":false,"RealPoints":0}],"Records":[{"Values":[{"Order":0,"Name":"String","Description":"String","Tooltip":"String","Value":"String","DataType":"String"}],"FilterEvaluationResult":{"Matched":false,"MatchedRule":"String","MatchedExcerpt":"String"}}],"Errors":[{"Code":0,"Message":"String","Source":"String","ErrorSeverity":"Success"}],"ParentGroupID":0,"ValidationGroup":false,"RiskPointsFound":0,"RiskPointsNotFound":0,"NotFoundMessage":"String","ConCoincidencias":false,"RealPoints":0}],"Records":[{"Values":[{"Order":0,"Name":"String","Description":"String","Tooltip":"String","Value":"String","DataType":"String"}],"FilterEvaluationResult":{"Matched":false,"MatchedRule":"String","MatchedExcerpt":"String"}}],"Errors":[{"Code":0,"Message":"String","Source":"String","ErrorSeverity":"Success"}],"ParentGroupID":0,"ValidationGroup":false,"RiskPointsFound":0,"RiskPointsNotFound":0,"NotFoundMessage":"String","ConCoincidencias":false,"RealPoints":0}],"baseName":"String","Resume":["String"],"MaxRiskPoints":0}