| All Verbs | /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version} | ||
|---|---|---|---|
| All Verbs | /BackgroundchekSeach/{ApiCode}/{Country}/{DocumentType}/{Query}/{Version}/{NombreTitular} |
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using APIbackgroundchecklatam.ServiceModel;
namespace APIbackgroundchecklatam.ServiceModel
{
public partial class BackgroundchekReport
{
public BackgroundchekReport()
{
Errors = new List<BackgroundchekReport.Error>{};
Groups = new List<BackgroundchekReport.DataGroup>{};
Resume = new List<string>{};
}
public virtual int AlertsCounter { get; set; }
public virtual bool ShowRiskMeter { get; set; }
public virtual string FullName { get; set; }
public virtual string DocumentNumber { get; set; }
public virtual DateTime ReportDate { get; set; }
public virtual BackgroundchekSeach SearchData { get; set; }
public virtual BackgroundchekReport.QueryStatus SearchStatus { get; set; }
public virtual string ReportID { get; set; }
public virtual List<BackgroundchekReport.Error> Errors { get; set; }
public virtual List<BackgroundchekReport.DataGroup> Groups { get; set; }
public virtual string baseName { get; set; }
public virtual List<string> Resume { get; set; }
public virtual int MaxRiskPoints { get; set; }
public enum QueryStatus
{
ok,
fail,
}
public partial class Error
{
public virtual int Code { get; set; }
public virtual string Message { get; set; }
public virtual string Source { get; set; }
public virtual BackgroundchekReport.Severity ErrorSeverity { get; set; }
}
public enum Severity
{
Success,
Info,
Warning,
Error,
}
public partial class DataGroup
{
public DataGroup()
{
SubGroups = new List<BackgroundchekReport.DataGroup>{};
Records = new List<BackgroundchekReport.Record>{};
Errors = new List<BackgroundchekReport.Error>{};
}
public virtual int Id { get; set; }
public virtual string Name { get; set; }
public virtual string Description { get; set; }
public virtual List<BackgroundchekReport.DataGroup> SubGroups { get; set; }
public virtual List<BackgroundchekReport.Record> Records { get; set; }
public virtual List<BackgroundchekReport.Error> Errors { get; set; }
public virtual int ParentGroupID { get; set; }
public virtual bool ValidationGroup { get; set; }
public virtual int RiskPointsFound { get; set; }
public virtual int RiskPointsNotFound { get; set; }
public virtual string NotFoundMessage { get; set; }
public virtual bool ConCoincidencias { get; set; }
public virtual int RealPoints { get; set; }
}
public partial class FilterEvaluationResults
{
public virtual bool Matched { get; set; }
public virtual string MatchedRule { get; set; }
public virtual string MatchedExcerpt { get; set; }
}
public partial class Record
{
public Record()
{
Values = new List<BackgroundchekReport.DataValue>{};
}
public virtual List<BackgroundchekReport.DataValue> Values { get; set; }
public virtual BackgroundchekReport.FilterEvaluationResults FilterEvaluationResult { get; set; }
}
public partial class DataValue
{
public virtual int Order { get; set; }
public virtual string Name { get; set; }
public virtual string Description { get; set; }
public virtual string Tooltip { get; set; }
public virtual string Value { get; set; }
public virtual string DataType { get; set; }
}
}
public partial class BackgroundchekSeach
{
public virtual string ApiCode { get; set; }
public virtual SearchCountrys Country { get; set; }
public virtual string DocumentType { get; set; }
public virtual string Query { get; set; }
public virtual int Version { get; set; }
public virtual string NombreTitular { get; set; }
}
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,
}
}
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
}