APIbackgroundchecklatam

<back to all web services

BackgroundchekSeach

The following routes are available for this service:
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.*;

public class dtos
{

    public static class BackgroundchekSeach
    {
        public String ApiCode = null;
        public SearchCountrys Country = null;
        public String DocumentType = null;
        public String Query = null;
        public Integer Version = null;
        public String NombreTitular = null;
        
        public String getApiCode() { return ApiCode; }
        public BackgroundchekSeach setApiCode(String value) { this.ApiCode = value; return this; }
        public SearchCountrys getCountry() { return Country; }
        public BackgroundchekSeach setCountry(SearchCountrys value) { this.Country = value; return this; }
        public String getDocumentType() { return DocumentType; }
        public BackgroundchekSeach setDocumentType(String value) { this.DocumentType = value; return this; }
        public String getQuery() { return Query; }
        public BackgroundchekSeach setQuery(String value) { this.Query = value; return this; }
        public Integer getVersion() { return Version; }
        public BackgroundchekSeach setVersion(Integer value) { this.Version = value; return this; }
        public String getNombreTitular() { return NombreTitular; }
        public BackgroundchekSeach setNombreTitular(String value) { this.NombreTitular = value; return this; }
    }

    public static enum 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;
    }

    public static class BackgroundchekReport
    {
        public Integer AlertsCounter = null;
        public Boolean ShowRiskMeter = null;
        public String FullName = null;
        public String DocumentNumber = null;
        public Date ReportDate = null;
        public BackgroundchekSeach SearchData = null;
        public QueryStatus SearchStatus = null;
        public String ReportID = null;
        public ArrayList<Error> Errors = null;
        public ArrayList<DataGroup> Groups = null;
        public String baseName = null;
        public ArrayList<String> Resume = null;
        public Integer MaxRiskPoints = null;
        
        public Integer getAlertsCounter() { return AlertsCounter; }
        public BackgroundchekReport setAlertsCounter(Integer value) { this.AlertsCounter = value; return this; }
        public Boolean isShowRiskMeter() { return ShowRiskMeter; }
        public BackgroundchekReport setShowRiskMeter(Boolean value) { this.ShowRiskMeter = value; return this; }
        public String getFullName() { return FullName; }
        public BackgroundchekReport setFullName(String value) { this.FullName = value; return this; }
        public String getDocumentNumber() { return DocumentNumber; }
        public BackgroundchekReport setDocumentNumber(String value) { this.DocumentNumber = value; return this; }
        public Date getReportDate() { return ReportDate; }
        public BackgroundchekReport setReportDate(Date value) { this.ReportDate = value; return this; }
        public BackgroundchekSeach getSearchData() { return SearchData; }
        public BackgroundchekReport setSearchData(BackgroundchekSeach value) { this.SearchData = value; return this; }
        public QueryStatus getSearchStatus() { return SearchStatus; }
        public BackgroundchekReport setSearchStatus(QueryStatus value) { this.SearchStatus = value; return this; }
        public String getReportID() { return ReportID; }
        public BackgroundchekReport setReportID(String value) { this.ReportID = value; return this; }
        public ArrayList<Error> getErrors() { return Errors; }
        public BackgroundchekReport setErrors(ArrayList<Error> value) { this.Errors = value; return this; }
        public ArrayList<DataGroup> getGroups() { return Groups; }
        public BackgroundchekReport setGroups(ArrayList<DataGroup> value) { this.Groups = value; return this; }
        public String getBaseName() { return baseName; }
        public BackgroundchekReport setBaseName(String value) { this.baseName = value; return this; }
        public ArrayList<String> getResume() { return Resume; }
        public BackgroundchekReport setResume(ArrayList<String> value) { this.Resume = value; return this; }
        public Integer getMaxRiskPoints() { return MaxRiskPoints; }
        public BackgroundchekReport setMaxRiskPoints(Integer value) { this.MaxRiskPoints = value; return this; }
    }

    public static enum QueryStatus
    {
        Ok,
        Fail;
    }

    public static class Error
    {
        public Integer Code = null;
        public String Message = null;
        public String Source = null;
        public Severity ErrorSeverity = null;
        
        public Integer getCode() { return Code; }
        public Error setCode(Integer value) { this.Code = value; return this; }
        public String getMessage() { return Message; }
        public Error setMessage(String value) { this.Message = value; return this; }
        public String getSource() { return Source; }
        public Error setSource(String value) { this.Source = value; return this; }
        public Severity getErrorSeverity() { return ErrorSeverity; }
        public Error setErrorSeverity(Severity value) { this.ErrorSeverity = value; return this; }
    }

    public static enum Severity
    {
        Success,
        Info,
        Warning,
        Error;
    }

    public static class DataGroup
    {
        public Integer Id = null;
        public String Name = null;
        public String Description = null;
        public ArrayList<DataGroup> SubGroups = null;
        public ArrayList<Record> Records = null;
        public ArrayList<Error> Errors = null;
        public Integer ParentGroupID = null;
        public Boolean ValidationGroup = null;
        public Integer RiskPointsFound = null;
        public Integer RiskPointsNotFound = null;
        public String NotFoundMessage = null;
        public Boolean ConCoincidencias = null;
        public Integer RealPoints = null;
        
        public Integer getId() { return Id; }
        public DataGroup setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public DataGroup setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public DataGroup setDescription(String value) { this.Description = value; return this; }
        public ArrayList<DataGroup> getSubGroups() { return SubGroups; }
        public DataGroup setSubGroups(ArrayList<DataGroup> value) { this.SubGroups = value; return this; }
        public ArrayList<Record> getRecords() { return Records; }
        public DataGroup setRecords(ArrayList<Record> value) { this.Records = value; return this; }
        public ArrayList<Error> getErrors() { return Errors; }
        public DataGroup setErrors(ArrayList<Error> value) { this.Errors = value; return this; }
        public Integer getParentGroupID() { return ParentGroupID; }
        public DataGroup setParentGroupID(Integer value) { this.ParentGroupID = value; return this; }
        public Boolean isValidationGroup() { return ValidationGroup; }
        public DataGroup setValidationGroup(Boolean value) { this.ValidationGroup = value; return this; }
        public Integer getRiskPointsFound() { return RiskPointsFound; }
        public DataGroup setRiskPointsFound(Integer value) { this.RiskPointsFound = value; return this; }
        public Integer getRiskPointsNotFound() { return RiskPointsNotFound; }
        public DataGroup setRiskPointsNotFound(Integer value) { this.RiskPointsNotFound = value; return this; }
        public String getNotFoundMessage() { return NotFoundMessage; }
        public DataGroup setNotFoundMessage(String value) { this.NotFoundMessage = value; return this; }
        public Boolean isConCoincidencias() { return ConCoincidencias; }
        public DataGroup setConCoincidencias(Boolean value) { this.ConCoincidencias = value; return this; }
        public Integer getRealPoints() { return RealPoints; }
        public DataGroup setRealPoints(Integer value) { this.RealPoints = value; return this; }
    }

    public static class Record
    {
        public ArrayList<DataValue> Values = null;
        public FilterEvaluationResults FilterEvaluationResult = null;
        
        public ArrayList<DataValue> getValues() { return Values; }
        public Record setValues(ArrayList<DataValue> value) { this.Values = value; return this; }
        public FilterEvaluationResults getFilterEvaluationResult() { return FilterEvaluationResult; }
        public Record setFilterEvaluationResult(FilterEvaluationResults value) { this.FilterEvaluationResult = value; return this; }
    }

    public static class DataValue
    {
        public Integer Order = null;
        public String Name = null;
        public String Description = null;
        public String Tooltip = null;
        public String Value = null;
        public String DataType = null;
        
        public Integer getOrder() { return Order; }
        public DataValue setOrder(Integer value) { this.Order = value; return this; }
        public String getName() { return Name; }
        public DataValue setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public DataValue setDescription(String value) { this.Description = value; return this; }
        public String getTooltip() { return Tooltip; }
        public DataValue setTooltip(String value) { this.Tooltip = value; return this; }
        public String getValue() { return Value; }
        public DataValue setValue(String value) { this.Value = value; return this; }
        public String getDataType() { return DataType; }
        public DataValue setDataType(String value) { this.DataType = value; return this; }
    }

    public static class FilterEvaluationResults
    {
        public Boolean Matched = null;
        public String MatchedRule = null;
        public String MatchedExcerpt = null;
        
        public Boolean isMatched() { return Matched; }
        public FilterEvaluationResults setMatched(Boolean value) { this.Matched = value; return this; }
        public String getMatchedRule() { return MatchedRule; }
        public FilterEvaluationResults setMatchedRule(String value) { this.MatchedRule = value; return this; }
        public String getMatchedExcerpt() { return MatchedExcerpt; }
        public FilterEvaluationResults setMatchedExcerpt(String value) { this.MatchedExcerpt = value; return this; }
    }

}

Java BackgroundchekSeach DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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}