fdadf10d by 周伟奇

se compare interface

1 parent 23c4a341
1 swagger: '2.0'
2 info:
3 title: 接口文档
4 description: 宝马ocr/biz_logic接口文档
5 version: 1.0.0
6 host: staging-bmw-ocr.situdata.com
7 basePath: /
8 tags:
9 - name: info
10 description: 比对信息
11 schemes:
12 - https
13 security:
14 - OAuth2: []
15 paths:
16 /api/compare/v1:
17 post:
18 tags:
19 - info
20 summary: POS上传比对信息
21 consumes:
22 - application/json
23 produces:
24 - application/json
25 parameters:
26 - in: body
27 name: body
28 required: true
29 schema:
30 $ref: '#/definitions/Comparison'
31 responses:
32 200:
33 description: ok
34 schema:
35 $ref: '#/definitions/ApiResponse'
36 securityDefinitions:
37 OAuth2:
38 type: oauth2
39 flow: application
40 description: 'This API uses OAuth 2 with the application(clientCredentials) grant
41 flow.
42
43 client_id=sMlciTkppsMzARwHpCVarm5q7DP2Vucj3ny8JFhw
44
45 client_secret=WNoOilDx140ZLcenDKfsnikv7S2LIFs60DciYoqnrZaYLqYsKpcmt7mJIL69o9AEf84uQvRnS3K2UioxfjNyImjR4UOyXbDcF6qYgTLC4KDVByKFdVhKfrn2Lc4q4BNW
46
47 scopes=write
48
49 '
50 tokenUrl: https://staging-bmw-ocr.situdata.com/api/oauth/token/
51 scopes:
52 write: Grants write access
53 responses:
54 ErrorResponse:
55 description: 调用异常, 具体情况请参考`HTTP`状态码和`code`字段
56 schema:
57 $ref: '#/definitions/ApiResponse'
58 NoContent:
59 description: 后台接收请求,但是没有响应内容
60 schema:
61 $ref: '#/definitions/ApiResponse'
62 definitions:
63 individualCusInfo:
64 type: object
65 required:
66 - applicantType
67 - idType
68 - customerChineseName
69 - idNum
70 - idExpiryDate
71 - dateOfBirth
72 - companyName
73 - registeredCapital
74 - selfEmployedSubType
75 properties:
76 applicantType:
77 description: applicantType
78 type: string
79 example: COAPP
80 enum:
81 - COAPP
82 - CUSTR
83 - GAUTR1
84 - GAUTR2
85 idType:
86 description: idType
87 type: string
88 example: ITARI
89 enum:
90 - ITARI
91 - ITHKM
92 - ITPRC
93 - ITPSP
94 - ITRES
95 - ITTID
96 - ITUSC
97 - ITCCU
98 secondIdType:
99 description: secondIdType
100 type: string
101 example: ITARI
102 enum:
103 - ITARI
104 - ITHKM
105 - ITPRC
106 - ITPSP
107 - ITRES
108 - ITTID
109 customerChineseName:
110 description: customerChineseName
111 type: string
112 example: 李四
113 idNum:
114 description: idNum
115 type: string
116 example: 111111199404251111
117 secondIdNum:
118 description: secondIdNum
119 type: string
120 example: 111111199404251111
121 idExpiryDate:
122 description: idExpiryDate
123 type: string
124 format: date
125 example: '2027-04-30'
126 dateOfBirth:
127 description: dateOfBirth
128 type: string
129 format: date
130 example: '2027-04-30'
131 companyName:
132 description: companyName
133 type: string
134 example: 北京思图场景数据科技服务有限公司
135 registeredCapital:
136 description: registeredCapital
137 type: number
138 format: float
139 example: 1234.56
140 selfEmployedSubType:
141 description: selfEmployedSubType
142 type: string
143 example: CSIBM
144 enum:
145 - CSIBM
146 - CSOTH
147 - CSSME
148 Comparison:
149 type: object
150 required:
151 - content
152 properties:
153 content:
154 description: 比对内容信息
155 type: object
156 required:
157 - uniqSeq
158 - applicationId
159 - applicationEntity
160 - customerType
161 - applicationVersion
162 - vehicleStatus
163 - comments
164 - individualCusInfo
165 properties:
166 uniqSeq:
167 description: uniqSeq
168 type: string
169 example: 201809301905121000
170 applicationId:
171 description: applicationId
172 type: string
173 example: CH-B100000123
174 applicationEntity:
175 description: applicationEntity
176 type: string
177 example: HIL
178 enum:
179 - AFC
180 - HIL
181 customerType:
182 description: customerType
183 type: string
184 example: TCCOR
185 enum:
186 - TCCOR
187 - TCDAS
188 - TCFRE
189 - TCIAS
190 - TCIND
191 - TCSEP
192 - TCURE
193 applicationVersion:
194 description: applicationVersion
195 type: integer
196 example: 0
197 vehicleStatus:
198 description: vehicleStatus
199 type: string
200 example: PCUSD
201 enum:
202 - PCUSD
203 - PCNEW
204 comments:
205 description: comments
206 type: array
207 items:
208 type: string
209 individualCusInfo:
210 description: individualCusInfo
211 type: array
212 items:
213 $ref: '#/definitions/individualCusInfo'
214 usedCarInfo:
215 description: usedCarInfo
216 type: object
217 required:
218 - vinNo
219 - manufactureDate
220 - firstRegistrationDate
221 properties:
222 vinNo:
223 description: vinNo
224 type: string
225 example: LBVSFJSDLFJLSDJF
226 manufactureDate:
227 description: manufactureDate
228 type: string
229 format: date
230 example: '2027-04-30'
231 firstRegistrationDate:
232 description: firstRegistrationDate
233 type: string
234 format: date
235 example: '2027-04-30'
236 corporateCusInfo:
237 description: corporateCusInfo
238 type: object
239 required:
240 - customerChineseName
241 - legalRepName
242 - idNum
243 - businessLicenseNo
244 - taxRegistrationCode
245 - incorporationDate
246 - businessLicenseDueDate
247 - capitalRegAmount
248 properties:
249 customerChineseName:
250 description: customerChineseName
251 type: string
252 example: 北京思图场景数据科技服务有限公司
253 legalRepName:
254 description: legalRepName
255 type: string
256 example: 李六
257 idNum:
258 description: idNum
259 type: string
260 example: MA007438143XJ1P
261 businessLicenseNo:
262 description: businessLicenseNo
263 type: string
264 example: MA007438143XJ1P
265 taxRegistrationCode:
266 description: taxRegistrationCode
267 type: string
268 example: MA007438143XJ1P
269 incorporationDate:
270 description: incorporationDate
271 type: string
272 format: date
273 example: '2027-04-30'
274 businessLicenseDueDate:
275 description: businessLicenseDueDate
276 type: string
277 format: date
278 example: '2027-04-30'
279 capitalRegAmount:
280 description: capitalRegAmount
281 type: number
282 format: float
283 example: 1234.56
284 ApiResponse:
285 description: 响应对象,code字段用于表示响应的状态; data字段用于存放响应内容
286 type: object
287 required:
288 - code
289 - msg
290 properties:
291 code:
292 type: integer
293 format: uint8
294 description: '0: success 1: need login 2: invalid params 3: internal error
295 4: object not exist 5: async wait 6: no permission 7: illegal operation'
296 example: 0
297 enum:
298 - 0
299 - 1
300 - 2
301 - 3
302 - 4
303 - 5
304 - 6
305 - 7
306 msg:
307 type: string
308 example: success
309 data:
310 type: object
...@@ -52,7 +52,7 @@ se_vehicle_args = { ...@@ -52,7 +52,7 @@ se_vehicle_args = {
52 'vehicleTransactionAmount': CustomDecimal(required=True), 52 'vehicleTransactionAmount': CustomDecimal(required=True),
53 'vinNo': fields.Str(required=True, validate=validate.Length(max=256)), 53 'vinNo': fields.Str(required=True, validate=validate.Length(max=256)),
54 'dealer': fields.Str(required=True, validate=validate.Length(max=256)), 54 'dealer': fields.Str(required=True, validate=validate.Length(max=256)),
55 'option': fields.Str(required=False, validate=validate.Length(max=256)), 55 'option': CustomDecimal(required=False),
56 'msrp': CustomDecimal(required=False), 56 'msrp': CustomDecimal(required=False),
57 'totalAmount': CustomDecimal(required=False), 57 'totalAmount': CustomDecimal(required=False),
58 } 58 }
...@@ -89,7 +89,7 @@ se_quotationt_args = { ...@@ -89,7 +89,7 @@ se_quotationt_args = {
89 'totalLoanAmount': CustomDecimal(required=True), 89 'totalLoanAmount': CustomDecimal(required=True),
90 'loanTerm': fields.Int(required=True), 90 'loanTerm': fields.Int(required=True),
91 'vehiclePrincipal': CustomDecimal(required=True), 91 'vehiclePrincipal': CustomDecimal(required=True),
92 'associatedServicePrincipal': CustomDecimal(required=True), 92 'associatedServicePrincipal': CustomDecimal(required=False),
93 'associatedServiceInfo': fields.List(fields.Nested(se_associated_args), required=False), 93 'associatedServiceInfo': fields.List(fields.Nested(se_associated_args), required=False),
94 'monthlyPaymentInfo': fields.List(fields.Nested(se_payment_args), required=True, validate=validate.Length(min=1)), 94 'monthlyPaymentInfo': fields.List(fields.Nested(se_payment_args), required=True, validate=validate.Length(min=1)),
95 } 95 }
...@@ -158,7 +158,6 @@ se_individual_args = { ...@@ -158,7 +158,6 @@ se_individual_args = {
158 'hukouCity': fields.Str(required=True, validate=validate.Length(max=64)), 158 'hukouCity': fields.Str(required=True, validate=validate.Length(max=64)),
159 'residentialProvince': fields.Str(required=False, validate=validate.Length(max=64)), 159 'residentialProvince': fields.Str(required=False, validate=validate.Length(max=64)),
160 'residentialCity': fields.Str(required=False, validate=validate.Length(max=64)), 160 'residentialCity': fields.Str(required=False, validate=validate.Length(max=64)),
161 'propertyDocumentPolicy': fields.Str(required=False, validate=validate.Length(max=16)),
162 'companyName': fields.Str(required=False, validate=validate.Length(max=256)), 161 'companyName': fields.Str(required=False, validate=validate.Length(max=256)),
163 'registeredCapital': CustomDecimal(required=False), 162 'registeredCapital': CustomDecimal(required=False),
164 'selfEmployedSubType': fields.Str(required=False, validate=validate.Length(max=16)), 163 'selfEmployedSubType': fields.Str(required=False, validate=validate.Length(max=16)),
...@@ -192,6 +191,7 @@ se_compare_content = { ...@@ -192,6 +191,7 @@ se_compare_content = {
192 'applicationEntity': fields.Str(required=True, validate=validate.OneOf(consts.ENTITY)), 191 'applicationEntity': fields.Str(required=True, validate=validate.OneOf(consts.ENTITY)),
193 'customerType': fields.Str(required=True, validate=validate.OneOf(consts.CUSTOMER_TYPE)), 192 'customerType': fields.Str(required=True, validate=validate.OneOf(consts.CUSTOMER_TYPE)),
194 "firstSubmmisonDate": CustomDate(required=True), 193 "firstSubmmisonDate": CustomDate(required=True),
194 'propertyDocumentPolicy': fields.Str(required=False, validate=validate.Length(max=16)),
195 195
196 'individualCusInfo': fields.List(fields.Nested(se_individual_args), 196 'individualCusInfo': fields.List(fields.Nested(se_individual_args),
197 required=True, validate=validate.Length(min=1, max=4)), 197 required=True, validate=validate.Length(min=1, max=4)),
......
...@@ -173,11 +173,6 @@ SEindividualCusInfo: ...@@ -173,11 +173,6 @@ SEindividualCusInfo:
173 description: residentialCity 173 description: residentialCity
174 type: string 174 type: string
175 example: 连云港市 175 example: 连云港市
176 propertyDocumentPolicy:
177 description: propertyDocumentPolicy
178 type: string
179 example: DOAOB
180 enum: [DOAOB, DOHDP, DOAMP, DOHED, DOAGQ, DOSME, DOLHK, DORET, DOPCQ, DOSNF, DOYES, DOGRC, DOLLR, DOVDL]
181 companyName: 176 companyName:
182 description: companyName 177 description: companyName
183 type: string 178 type: string
...@@ -262,6 +257,11 @@ SEComparison: ...@@ -262,6 +257,11 @@ SEComparison:
262 type: string 257 type: string
263 format: date 258 format: date
264 example: "2027-04-30" 259 example: "2027-04-30"
260 propertyDocumentPolicy:
261 description: propertyDocumentPolicy
262 type: string
263 example: DOAOB
264 enum: [DOAOB, DOHDP, DOAMP, DOHED, DOAGQ, DOSME, DOLHK, DORET, DOPCQ, DOSNF, DOYES, DOGRC, DOLLR, DOVDL]
265 265
266 individualCusInfo: 266 individualCusInfo:
267 description: individualCusInfo 267 description: individualCusInfo
...@@ -378,8 +378,9 @@ SEComparison: ...@@ -378,8 +378,9 @@ SEComparison:
378 example: TestDealer 378 example: TestDealer
379 option: 379 option:
380 description: option 380 description: option
381 type: string 381 type: number
382 example: TestOption 382 format: float
383 example: 1234.56
383 msrp: 384 msrp:
384 description: msrp 385 description: msrp
385 type: number 386 type: number
...@@ -456,7 +457,7 @@ SEComparison: ...@@ -456,7 +457,7 @@ SEComparison:
456 quotationtInfo: 457 quotationtInfo:
457 description: quotationtInfo 458 description: quotationtInfo
458 type: object 459 type: object
459 required: [totalLoanAmount, loanTerm, vehiclePrincipal, associatedServicePrincipal, monthlyPaymentInfo] 460 required: [totalLoanAmount, loanTerm, vehiclePrincipal, monthlyPaymentInfo]
460 properties: 461 properties:
461 totalLoanAmount: 462 totalLoanAmount:
462 description: totalLoanAmount 463 description: totalLoanAmount
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!