| All Verbs | /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version} | ||
|---|---|---|---|
| All Verbs | /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version}/{NombreTitular} |
import java.math.*
import java.util.*
import net.servicestack.client.*
open class BackgroundchekSeach
{
var ApiCode:String? = null
var Country:SearchCountrys? = null
var DocumentType:String? = null
var Query:String? = null
var Version:Int? = null
var NombreTitular:String? = null
}
enum class SearchCountrys
{
Colombia,
Col,
Mexico,
Mex,
Chile,
Chl,
Brasil,
Bra,
Panama,
Pan,
Dominicana,
Dom,
CostaRica,
Cri,
Argentina,
Arg,
Ecuador,
Ecu,
Peru,
Per,
ElSalvador,
Slv,
Guatemala,
Gtm,
Honduras,
Hnd,
Venezuela,
Ven,
All,
Afg,
Alb,
Dza,
And,
Ago,
Atg,
Arm,
Aus,
Aut,
Aze,
Bhs,
Bhr,
Bgd,
Brb,
Blr,
Bel,
Blz,
Ben,
Btn,
Bol,
Bih,
Bwa,
Brn,
Bgr,
Bfa,
Bdi,
Cpv,
Khm,
Cmr,
Can,
Caf,
Tcd,
Chn,
Com,
Cog,
Civ,
Hrv,
Cub,
Cyp,
Cze,
Dnk,
Dji,
Dma,
Tls,
Egy,
Gnq,
Eri,
Est,
Eth,
Fji,
Fin,
Fra,
Gab,
Gmb,
Geo,
Deu,
Gha,
Grc,
Grd,
Gin,
Gnb,
Guy,
Hti,
Hun,
Isl,
Ind,
Idn,
Irn,
Irq,
Irl,
Isr,
Ita,
Jam,
Jpn,
Jor,
Kaz,
Ken,
Kir,
Prk,
Kor,
Kwt,
Kgz,
Lao,
Lva,
Lbn,
Lso,
Lbr,
Lby,
Lie,
Ltu,
Lux,
Mdg,
Mwi,
Mys,
Mdv,
Mli,
Mlt,
Mhl,
Mrt,
Mus,
Fsm,
Mda,
Mco,
Mng,
Mne,
Mar,
Moz,
Mmr,
Nam,
Nru,
Npl,
Nld,
Nzl,
Nic,
Ner,
Nga,
Mkd,
Nor,
Omn,
Pak,
Plw,
Png,
Pry,
Phl,
Pol,
Prt,
Qat,
Rou,
Rus,
Rwa,
Kna,
Lca,
Vct,
Wsm,
Smr,
Stp,
Sau,
Sen,
Srb,
Syc,
Sle,
Sgp,
Svk,
Svn,
Slb,
Som,
Zaf,
Ssd,
Esp,
Lka,
Sdn,
Sur,
Swz,
Swe,
Che,
Syr,
Twn,
Tjk,
Tza,
Tha,
Tgo,
Ton,
Tto,
Tun,
Tur,
Tkm,
Tuv,
Uga,
Ukr,
Are,
Gbr,
Usa,
Ury,
Uzb,
Vut,
Vnm,
Yem,
Zmb,
Zwe,
}
open class BackgroundchekReport
{
var AlertsCounter:Int? = null
var ShowRiskMeter:Boolean? = null
var FullName:String? = null
var DocumentNumber:String? = null
var ReportDate:Date? = null
var SearchData:BackgroundchekSeach? = null
var SearchStatus:QueryStatus? = null
var ReportID:String? = null
var Errors:ArrayList<Error> = ArrayList<Error>()
var Groups:ArrayList<DataGroup> = ArrayList<DataGroup>()
var baseName:String? = null
var Resume:ArrayList<String> = ArrayList<String>()
var MaxRiskPoints:Int? = null
}
enum class QueryStatus
{
Ok,
Fail,
}
open class Error
{
var Code:Int? = null
var Message:String? = null
var Source:String? = null
var ErrorSeverity:Severity? = null
}
enum class Severity
{
Success,
Info,
Warning,
Error,
}
open class DataGroup
{
var Id:Int? = null
var Name:String? = null
var Description:String? = null
var SubGroups:ArrayList<DataGroup> = ArrayList<DataGroup>()
var Records:ArrayList<Record> = ArrayList<Record>()
var Errors:ArrayList<Error> = ArrayList<Error>()
var ParentGroupID:Int? = null
var ValidationGroup:Boolean? = null
var RiskPointsFound:Int? = null
var RiskPointsNotFound:Int? = null
var NotFoundMessage:String? = null
var ConCoincidencias:Boolean? = null
var RealPoints:Int? = null
}
open class Record
{
var Values:ArrayList<DataValue> = ArrayList<DataValue>()
var FilterEvaluationResult:FilterEvaluationResults? = null
}
open class DataValue
{
var Order:Int? = null
var Name:String? = null
var Description:String? = null
var Tooltip:String? = null
var Value:String? = null
var DataType:String? = null
}
open class FilterEvaluationResults
{
var Matched:Boolean? = null
var MatchedRule:String? = null
var MatchedExcerpt:String? = null
}
Kotlin BackgroundchekSeach DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
ApiCode: String,
Country: Colombia,
DocumentType: String,
Query: String,
Version: 0,
NombreTitular: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
AlertsCounter: 0,
ShowRiskMeter: False,
FullName: String,
DocumentNumber: String,
ReportDate: 0001-01-01,
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
}