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}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports APIbackgroundchecklatam.ServiceModel

Namespace Global

    Namespace APIbackgroundchecklatam.ServiceModel

        Public Partial Class BackgroundchekReport
            Public Sub New()
                Errors = New List(Of BackgroundchekReport.Error)
                Groups = New List(Of BackgroundchekReport.DataGroup)
                Resume = New List(Of String)
            End Sub

            Public Overridable Property AlertsCounter As Integer
            Public Overridable Property ShowRiskMeter As Boolean
            Public Overridable Property FullName As String
            Public Overridable Property DocumentNumber As String
            Public Overridable Property ReportDate As Date
            Public Overridable Property SearchData As BackgroundchekSeach
            Public Overridable Property SearchStatus As BackgroundchekReport.QueryStatus
            Public Overridable Property ReportID As String
            Public Overridable Property Errors As List(Of BackgroundchekReport.Error)
            Public Overridable Property Groups As List(Of BackgroundchekReport.DataGroup)
            Public Overridable Property baseName As String
            Public Overridable Property Resume As List(Of String)
            Public Overridable Property MaxRiskPoints As Integer

            Public Enum QueryStatus
                ok
                fail
            End Enum

            Public Partial Class Error
                Public Overridable Property Code As Integer
                Public Overridable Property Message As String
                Public Overridable Property Source As String
                Public Overridable Property ErrorSeverity As BackgroundchekReport.Severity
            End Class

            Public Enum Severity
                Success
                Info
                Warning
                [Error]
            End Enum

            Public Partial Class DataGroup
                Public Sub New()
                    SubGroups = New List(Of BackgroundchekReport.DataGroup)
                    Records = New List(Of BackgroundchekReport.Record)
                    Errors = New List(Of BackgroundchekReport.Error)
                End Sub

                Public Overridable Property Id As Integer
                Public Overridable Property Name As String
                Public Overridable Property Description As String
                Public Overridable Property SubGroups As List(Of BackgroundchekReport.DataGroup)
                Public Overridable Property Records As List(Of BackgroundchekReport.Record)
                Public Overridable Property Errors As List(Of BackgroundchekReport.Error)
                Public Overridable Property ParentGroupID As Integer
                Public Overridable Property ValidationGroup As Boolean
                Public Overridable Property RiskPointsFound As Integer
                Public Overridable Property RiskPointsNotFound As Integer
                Public Overridable Property NotFoundMessage As String
                Public Overridable Property ConCoincidencias As Boolean
                Public Overridable Property RealPoints As Integer
            End Class

            Public Partial Class FilterEvaluationResults
                Public Overridable Property Matched As Boolean
                Public Overridable Property MatchedRule As String
                Public Overridable Property MatchedExcerpt As String
            End Class

            Public Partial Class Record
                Public Sub New()
                    Values = New List(Of BackgroundchekReport.DataValue)
                End Sub

                Public Overridable Property Values As List(Of BackgroundchekReport.DataValue)
                Public Overridable Property FilterEvaluationResult As BackgroundchekReport.FilterEvaluationResults
            End Class

            Public Partial Class DataValue
                Public Overridable Property Order As Integer
                Public Overridable Property Name As String
                Public Overridable Property Description As String
                Public Overridable Property Tooltip As String
                Public Overridable Property Value As String
                Public Overridable Property DataType As String
            End Class
        End Class

        Public Partial Class BackgroundchekSeach
            Public Overridable Property ApiCode As String
            Public Overridable Property Country As SearchCountrys
            Public Overridable Property DocumentType As String
            Public Overridable Property Query As String
            Public Overridable Property Version As Integer
            Public Overridable Property NombreTitular As String
        End Class

        Public 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
        End Enum
    End Namespace
End Namespace

VB.NET 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}