APIbackgroundchecklatam

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.*


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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<BackgroundchekSeach xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIbackgroundchecklatam.ServiceModel">
  <ApiCode>String</ApiCode>
  <Country>Colombia</Country>
  <DocumentType>String</DocumentType>
  <NombreTitular>String</NombreTitular>
  <Query>String</Query>
  <Version>0</Version>
</BackgroundchekSeach>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BackgroundchekReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIbackgroundchecklatam.ServiceModel">
  <AlertsCounter>0</AlertsCounter>
  <DocumentNumber>String</DocumentNumber>
  <Errors>
    <BackgroundchekReport.Error>
      <Code>0</Code>
      <ErrorSeverity>Success</ErrorSeverity>
      <Message>String</Message>
      <Source>String</Source>
    </BackgroundchekReport.Error>
  </Errors>
  <FullName>String</FullName>
  <Groups>
    <BackgroundchekReport.DataGroup>
      <ConCoincidencias>false</ConCoincidencias>
      <Description>String</Description>
      <Errors>
        <BackgroundchekReport.Error>
          <Code>0</Code>
          <ErrorSeverity>Success</ErrorSeverity>
          <Message>String</Message>
          <Source>String</Source>
        </BackgroundchekReport.Error>
      </Errors>
      <Id>0</Id>
      <Name>String</Name>
      <NotFoundMessage>String</NotFoundMessage>
      <ParentGroupID>0</ParentGroupID>
      <RealPoints>0</RealPoints>
      <Records>
        <BackgroundchekReport.Record>
          <FilterEvaluationResult>
            <Matched>false</Matched>
            <MatchedExcerpt>String</MatchedExcerpt>
            <MatchedRule>String</MatchedRule>
          </FilterEvaluationResult>
          <Values>
            <BackgroundchekReport.DataValue>
              <DataType>String</DataType>
              <Description>String</Description>
              <Name>String</Name>
              <Order>0</Order>
              <Tooltip>String</Tooltip>
              <Value>String</Value>
            </BackgroundchekReport.DataValue>
          </Values>
        </BackgroundchekReport.Record>
      </Records>
      <RiskPointsFound>0</RiskPointsFound>
      <RiskPointsNotFound>0</RiskPointsNotFound>
      <SubGroups>
        <BackgroundchekReport.DataGroup>
          <ConCoincidencias>false</ConCoincidencias>
          <Description>String</Description>
          <Errors>
            <BackgroundchekReport.Error>
              <Code>0</Code>
              <ErrorSeverity>Success</ErrorSeverity>
              <Message>String</Message>
              <Source>String</Source>
            </BackgroundchekReport.Error>
          </Errors>
          <Id>0</Id>
          <Name>String</Name>
          <NotFoundMessage>String</NotFoundMessage>
          <ParentGroupID>0</ParentGroupID>
          <RealPoints>0</RealPoints>
          <Records>
            <BackgroundchekReport.Record>
              <FilterEvaluationResult>
                <Matched>false</Matched>
                <MatchedExcerpt>String</MatchedExcerpt>
                <MatchedRule>String</MatchedRule>
              </FilterEvaluationResult>
              <Values>
                <BackgroundchekReport.DataValue>
                  <DataType>String</DataType>
                  <Description>String</Description>
                  <Name>String</Name>
                  <Order>0</Order>
                  <Tooltip>String</Tooltip>
                  <Value>String</Value>
                </BackgroundchekReport.DataValue>
              </Values>
            </BackgroundchekReport.Record>
          </Records>
          <RiskPointsFound>0</RiskPointsFound>
          <RiskPointsNotFound>0</RiskPointsNotFound>
          <SubGroups>
            <BackgroundchekReport.DataGroup>
              <ConCoincidencias>false</ConCoincidencias>
              <Description>String</Description>
              <Errors>
                <BackgroundchekReport.Error>
                  <Code>0</Code>
                  <ErrorSeverity>Success</ErrorSeverity>
                  <Message>String</Message>
                  <Source>String</Source>
                </BackgroundchekReport.Error>
              </Errors>
              <Id>0</Id>
              <Name>String</Name>
              <NotFoundMessage>String</NotFoundMessage>
              <ParentGroupID>0</ParentGroupID>
              <RealPoints>0</RealPoints>
              <Records>
                <BackgroundchekReport.Record>
                  <FilterEvaluationResult>
                    <Matched>false</Matched>
                    <MatchedExcerpt>String</MatchedExcerpt>
                    <MatchedRule>String</MatchedRule>
                  </FilterEvaluationResult>
                  <Values>
                    <BackgroundchekReport.DataValue>
                      <DataType>String</DataType>
                      <Description>String</Description>
                      <Name>String</Name>
                      <Order>0</Order>
                      <Tooltip>String</Tooltip>
                      <Value>String</Value>
                    </BackgroundchekReport.DataValue>
                  </Values>
                </BackgroundchekReport.Record>
              </Records>
              <RiskPointsFound>0</RiskPointsFound>
              <RiskPointsNotFound>0</RiskPointsNotFound>
              <SubGroups i:nil="true" />
              <ValidationGroup>false</ValidationGroup>
            </BackgroundchekReport.DataGroup>
          </SubGroups>
          <ValidationGroup>false</ValidationGroup>
        </BackgroundchekReport.DataGroup>
      </SubGroups>
      <ValidationGroup>false</ValidationGroup>
    </BackgroundchekReport.DataGroup>
  </Groups>
  <MaxRiskPoints>0</MaxRiskPoints>
  <ReportDate>0001-01-01T00:00:00</ReportDate>
  <ReportID>String</ReportID>
  <Resume xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Resume>
  <SearchData>
    <ApiCode>String</ApiCode>
    <Country>Colombia</Country>
    <DocumentType>String</DocumentType>
    <NombreTitular>String</NombreTitular>
    <Query>String</Query>
    <Version>0</Version>
  </SearchData>
  <SearchStatus>ok</SearchStatus>
  <ShowRiskMeter>false</ShowRiskMeter>
  <baseName>String</baseName>
</BackgroundchekReport>