| All Verbs | /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version} | ||
|---|---|---|---|
| All Verbs | /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version}/{NombreTitular} |
namespace APIbackgroundchecklatam.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type SearchCountrys =
| Colombia = 0
| COL = 1
| Mexico = 2
| MEX = 3
| Chile = 4
| CHL = 5
| Brasil = 6
| BRA = 7
| Panama = 8
| PAN = 9
| Dominicana = 10
| DOM = 11
| CostaRica = 12
| CRI = 13
| Argentina = 14
| ARG = 15
| Ecuador = 16
| ECU = 17
| Peru = 18
| PER = 19
| ElSalvador = 20
| SLV = 21
| Guatemala = 22
| GTM = 23
| Honduras = 24
| HND = 25
| Venezuela = 26
| VEN = 27
| ALL = 28
| AFG = 29
| ALB = 30
| DZA = 31
| AND = 32
| AGO = 33
| ATG = 34
| ARM = 35
| AUS = 36
| AUT = 37
| AZE = 38
| BHS = 39
| BHR = 40
| BGD = 41
| BRB = 42
| BLR = 43
| BEL = 44
| BLZ = 45
| BEN = 46
| BTN = 47
| BOL = 48
| BIH = 49
| BWA = 50
| BRN = 51
| BGR = 52
| BFA = 53
| BDI = 54
| CPV = 55
| KHM = 56
| CMR = 57
| CAN = 58
| CAF = 59
| TCD = 60
| CHN = 61
| COM = 62
| COG = 63
| CIV = 64
| HRV = 65
| CUB = 66
| CYP = 67
| CZE = 68
| DNK = 69
| DJI = 70
| DMA = 71
| TLS = 72
| EGY = 73
| GNQ = 74
| ERI = 75
| EST = 76
| ETH = 77
| FJI = 78
| FIN = 79
| FRA = 80
| GAB = 81
| GMB = 82
| GEO = 83
| DEU = 84
| GHA = 85
| GRC = 86
| GRD = 87
| GIN = 88
| GNB = 89
| GUY = 90
| HTI = 91
| HUN = 92
| ISL = 93
| IND = 94
| IDN = 95
| IRN = 96
| IRQ = 97
| IRL = 98
| ISR = 99
| ITA = 100
| JAM = 101
| JPN = 102
| JOR = 103
| KAZ = 104
| KEN = 105
| KIR = 106
| PRK = 107
| KOR = 108
| KWT = 109
| KGZ = 110
| LAO = 111
| LVA = 112
| LBN = 113
| LSO = 114
| LBR = 115
| LBY = 116
| LIE = 117
| LTU = 118
| LUX = 119
| MDG = 120
| MWI = 121
| MYS = 122
| MDV = 123
| MLI = 124
| MLT = 125
| MHL = 126
| MRT = 127
| MUS = 128
| FSM = 129
| MDA = 130
| MCO = 131
| MNG = 132
| MNE = 133
| MAR = 134
| MOZ = 135
| MMR = 136
| NAM = 137
| NRU = 138
| NPL = 139
| NLD = 140
| NZL = 141
| NIC = 142
| NER = 143
| NGA = 144
| MKD = 145
| NOR = 146
| OMN = 147
| PAK = 148
| PLW = 149
| PNG = 150
| PRY = 151
| PHL = 152
| POL = 153
| PRT = 154
| QAT = 155
| ROU = 156
| RUS = 157
| RWA = 158
| KNA = 159
| LCA = 160
| VCT = 161
| WSM = 162
| SMR = 163
| STP = 164
| SAU = 165
| SEN = 166
| SRB = 167
| SYC = 168
| SLE = 169
| SGP = 170
| SVK = 171
| SVN = 172
| SLB = 173
| SOM = 174
| ZAF = 175
| SSD = 176
| ESP = 177
| LKA = 178
| SDN = 179
| SUR = 180
| SWZ = 181
| SWE = 182
| CHE = 183
| SYR = 184
| TWN = 185
| TJK = 186
| TZA = 187
| THA = 188
| TGO = 189
| TON = 190
| TTO = 191
| TUN = 192
| TUR = 193
| TKM = 194
| TUV = 195
| UGA = 196
| UKR = 197
| ARE = 198
| GBR = 199
| USA = 200
| URY = 201
| UZB = 202
| VUT = 203
| VNM = 204
| YEM = 205
| ZMB = 206
| ZWE = 207
[<AllowNullLiteral>]
type BackgroundchekSeach() =
member val ApiCode:String = null with get,set
member val Country:SearchCountrys = new SearchCountrys() with get,set
member val DocumentType:String = null with get,set
member val Query:String = null with get,set
member val Version:Int32 = new Int32() with get,set
member val NombreTitular:String = null with get,set
type QueryStatus =
| ok = 0
| fail = 1
type Severity =
| Success = 0
| Info = 1
| Warning = 2
| Error = 3
[<AllowNullLiteral>]
type Error() =
member val Code:Int32 = new Int32() with get,set
member val Message:String = null with get,set
member val Source:String = null with get,set
member val ErrorSeverity:Severity = new Severity() with get,set
[<AllowNullLiteral>]
type DataValue() =
member val Order:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Description:String = null with get,set
member val Tooltip:String = null with get,set
member val Value:String = null with get,set
member val DataType:String = null with get,set
[<AllowNullLiteral>]
type FilterEvaluationResults() =
member val Matched:Boolean = new Boolean() with get,set
member val MatchedRule:String = null with get,set
member val MatchedExcerpt:String = null with get,set
[<AllowNullLiteral>]
type Record() =
member val Values:ResizeArray<DataValue> = new ResizeArray<DataValue>() with get,set
member val FilterEvaluationResult:FilterEvaluationResults = null with get,set
[<AllowNullLiteral>]
type DataGroup() =
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Description:String = null with get,set
member val SubGroups:ResizeArray<DataGroup> = new ResizeArray<DataGroup>() with get,set
member val Records:ResizeArray<Record> = new ResizeArray<Record>() with get,set
member val Errors:ResizeArray<Error> = new ResizeArray<Error>() with get,set
member val ParentGroupID:Int32 = new Int32() with get,set
member val ValidationGroup:Boolean = new Boolean() with get,set
member val RiskPointsFound:Int32 = new Int32() with get,set
member val RiskPointsNotFound:Int32 = new Int32() with get,set
member val NotFoundMessage:String = null with get,set
member val ConCoincidencias:Boolean = new Boolean() with get,set
member val RealPoints:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type BackgroundchekReport() =
member val AlertsCounter:Int32 = new Int32() with get,set
member val ShowRiskMeter:Boolean = new Boolean() with get,set
member val FullName:String = null with get,set
member val DocumentNumber:String = null with get,set
member val ReportDate:DateTime = new DateTime() with get,set
member val SearchData:BackgroundchekSeach = null with get,set
member val SearchStatus:QueryStatus = new QueryStatus() with get,set
member val ReportID:String = null with get,set
member val Errors:ResizeArray<Error> = new ResizeArray<Error>() with get,set
member val Groups:ResizeArray<DataGroup> = new ResizeArray<DataGroup>() with get,set
member val baseName:String = null with get,set
member val Resume:ResizeArray<String> = new ResizeArray<String>() with get,set
member val MaxRiskPoints:Int32 = new Int32() with get,set
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
}