Skip to content

周伟奇 / bmw-ocr

Go to a project
Toggle navigation
Toggle navigation pinning
1a0015c2 by 周伟奇
Options

add swagger file

1 parent fdadf10d
Inline Side-by-side
Showing 1 changed file with 846 additions and 0 deletions
docs/comparison.yaml 0 → 100644
1 swagger: '2.0'
2 info:
3 title: 接口文档
4 description: 宝马ocr/biz_logic接口文档
5 version: 1.0.0
6 host: li19dkocruat01vm.bmwgroup.net
7 basePath: /
8 tags:
9 - name: info
10 description: 比对信息
11 schemes:
12 - https
13 security:
14 - OAuth2: []
15 paths:
16 /api/compare/settlement/v1:
17 post:
18 tags:
19 - info
20 summary: POS上传SE比对信息
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/SEComparison'
31 responses:
32 200:
33 description: ok
34 schema:
35 $ref: '#/definitions/ApiResponse'
36 /api/compare/v1:
37 post:
38 tags:
39 - info
40 summary: POS上传CA比对信息
41 consumes:
42 - application/json
43 produces:
44 - application/json
45 parameters:
46 - in: body
47 name: body
48 required: true
49 schema:
50 $ref: '#/definitions/Comparison'
51 responses:
52 200:
53 description: ok
54 schema:
55 $ref: '#/definitions/ApiResponse'
56 securityDefinitions:
57 OAuth2:
58 type: oauth2
59 flow: application
60 description: 'This API uses OAuth 2 with the application(clientCredentials) grant
61 flow.
62
63 client_id=sMlciTkppsMzARwHpCVarm5q7DP2Vucj3ny8JFhw
64
65 client_secret=WNoOilDx140ZLcenDKfsnikv7S2LIFs60DciYoqnrZaYLqYsKpcmt7mJIL69o9AEf84uQvRnS3K2UioxfjNyImjR4UOyXbDcF6qYgTLC4KDVByKFdVhKfrn2Lc4q4BNW
66
67 scopes=write
68
69 '
70 tokenUrl: https://li19dkocruat01vm.bmwgroup.net/api/oauth/token/
71 scopes:
72 write: Grants write access
73 responses:
74 ErrorResponse:
75 description: 调用异常， 具体情况请参考`HTTP`状态码和`code`字段
76 schema:
77 $ref: '#/definitions/ApiResponse'
78 NoContent:
79 description: 后台接收请求，但是没有响应内容
80 schema:
81 $ref: '#/definitions/ApiResponse'
82 definitions:
83 individualCusInfo:
84 type: object
85 required:
86 - applicantType
87 - idType
88 - customerChineseName
89 - idNum
90 - idExpiryDate
91 - dateOfBirth
92 - companyName
93 - registeredCapital
94 - selfEmployedSubType
95 properties:
96 applicantType:
97 description: applicantType
98 type: string
99 example: COAPP
100 enum:
101 - COAPP
102 - CUSTR
103 - GAUTR1
104 - GAUTR2
105 idType:
106 description: idType
107 type: string
108 example: ITARI
109 enum:
110 - ITARI
111 - ITHKM
112 - ITPRC
113 - ITPSP
114 - ITRES
115 - ITTID
116 - ITUSC
117 - ITCCU
118 secondIdType:
119 description: secondIdType
120 type: string
121 example: ITARI
122 enum:
123 - ITARI
124 - ITHKM
125 - ITPRC
126 - ITPSP
127 - ITRES
128 - ITTID
129 customerChineseName:
130 description: customerChineseName
131 type: string
132 example: 李四
133 idNum:
134 description: idNum
135 type: string
136 example: 111111199404251111
137 secondIdNum:
138 description: secondIdNum
139 type: string
140 example: 111111199404251111
141 idExpiryDate:
142 description: idExpiryDate
143 type: string
144 format: date
145 example: '2027-04-30'
146 dateOfBirth:
147 description: dateOfBirth
148 type: string
149 format: date
150 example: '2027-04-30'
151 companyName:
152 description: companyName
153 type: string
154 example: 北京思图场景数据科技服务有限公司
155 registeredCapital:
156 description: registeredCapital
157 type: number
158 format: float
159 example: 1234.56
160 selfEmployedSubType:
161 description: selfEmployedSubType
162 type: string
163 example: CSIBM
164 enum:
165 - CSIBM
166 - CSOTH
167 - CSSME
168 SEindividualCusInfo:
169 type: object
170 required:
171 - customerType
172 - applicantType
173 - customerName
174 - idType
175 - idNum
176 - dateOfBirth
177 - idExpiryDate
178 - hukouProvince
179 - hukouCity
180 properties:
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 applicantType:
194 description: applicantType
195 type: string
196 example: COAPP
197 enum:
198 - COAPP
199 - CUSTR
200 - GAUTR1
201 - GAUTR2
202 customerName:
203 description: customerName
204 type: string
205 example: 李四
206 idType:
207 description: idType
208 type: string
209 example: ITARI
210 enum:
211 - ITARI
212 - ITHKM
213 - ITPRC
214 - ITPSP
215 - ITRES
216 - ITTID
217 - ITUSC
218 - ITCCU
219 idNum:
220 description: idNum
221 type: string
222 example: 111111199404251111
223 secondIdType:
224 description: secondIdType
225 type: string
226 example: ITARI
227 enum:
228 - ITARI
229 - ITHKM
230 - ITPRC
231 - ITPSP
232 - ITRES
233 - ITTID
234 secondIdNum:
235 description: secondIdNum
236 type: string
237 example: 111111199404251111
238 dateOfBirth:
239 description: dateOfBirth
240 type: string
241 format: date
242 example: '2027-04-30'
243 idExpiryDate:
244 description: idExpiryDate
245 type: string
246 format: date
247 example: '2027-04-30'
248 nationality:
249 description: nationality
250 type: string
251 example: 中国
252 countryregion:
253 description: countryregion
254 type: string
255 example: 中国
256 hukouProvince:
257 description: hukouProvince
258 type: string
259 example: 山东省
260 hukouCity:
261 description: hukouCity
262 type: string
263 example: 日照市
264 residentialProvince:
265 description: residentialProvince
266 type: string
267 example: 江苏省
268 residentialCity:
269 description: residentialCity
270 type: string
271 example: 连云港市
272 companyName:
273 description: companyName
274 type: string
275 example: 北京思图场景数据科技服务有限公司
276 registeredCapital:
277 description: registeredCapital
278 type: number
279 format: float
280 example: 1234.56
281 selfEmployedSubType:
282 description: selfEmployedSubType
283 type: string
284 example: CSIBM
285 enum:
286 - CSIBM
287 - CSOTH
288 - CSSME
289 associatedServiceInfo:
290 type: object
291 required:
292 - service
293 - amount
294 - financedAmount
295 properties:
296 service:
297 description: service
298 type: string
299 example: test_service
300 amount:
301 description: amount
302 type: number
303 format: float
304 example: 1234.56
305 financedAmount:
306 description: financedAmount
307 type: number
308 format: float
309 example: 1234.56
310 monthlyPaymentInfo:
311 type: object
312 required:
313 - term
314 - amount
315 properties:
316 term:
317 description: term
318 type: number
319 example: 12
320 amount:
321 description: amount
322 type: number
323 format: float
324 example: 1234.56
325 SEComparison:
326 type: object
327 required:
328 - content
329 properties:
330 content:
331 description: SE比对内容信息
332 type: object
333 required:
334 - uniqSeq
335 - applicationId
336 - applicationVersion
337 - applicationEntity
338 - customerType
339 - firstSubmmisonDate
340 - individualCusInfo
341 - vehicleInfo
342 - insuranceInfo
343 - bankInfo
344 - quotationtInfo
345 properties:
346 uniqSeq:
347 description: uniqSeq
348 type: string
349 example: 201809301905121000
350 applicationId:
351 description: applicationId
352 type: string
353 example: CH-B100000123
354 applicationVersion:
355 description: applicationVersion
356 type: integer
357 example: 0
358 applicationEntity:
359 description: applicationEntity
360 type: string
361 example: HIL
362 enum:
363 - AFC
364 - HIL
365 customerType:
366 description: customerType
367 type: string
368 example: TCCOR
369 enum:
370 - TCCOR
371 - TCDAS
372 - TCFRE
373 - TCIAS
374 - TCIND
375 - TCSEP
376 - TCURE
377 firstSubmmisonDate:
378 description: firstSubmmisonDate
379 type: string
380 format: date
381 example: '2027-04-30'
382 propertyDocumentPolicy:
383 description: propertyDocumentPolicy
384 type: string
385 example: DOAOB
386 enum:
387 - DOAOB
388 - DOHDP
389 - DOAMP
390 - DOHED
391 - DOAGQ
392 - DOSME
393 - DOLHK
394 - DORET
395 - DOPCQ
396 - DOSNF
397 - DOYES
398 - DOGRC
399 - DOLLR
400 - DOVDL
401 individualCusInfo:
402 description: individualCusInfo
403 type: array
404 items:
405 $ref: '#/definitions/SEindividualCusInfo'
406 corporateCusInfo:
407 description: corporateCusInfo
408 type: object
409 required:
410 - customerType
411 - companyName
412 - firstIdType
413 - firstIdNo
414 - businessLicenseNo
415 - organizationCreditCode
416 - taxRegistrationCertificateNo
417 - establishmentDate
418 - incorporationDate
419 - businessLicenseDueDate
420 - legalRepName
421 - organizationType
422 properties:
423 customerType:
424 description: customerType
425 type: string
426 example: TCCOR
427 enum:
428 - TCCOR
429 - TCDAS
430 - TCFRE
431 - TCIAS
432 - TCIND
433 - TCSEP
434 - TCURE
435 companyName:
436 description: companyName
437 type: string
438 example: 北京思图场景数据科技服务有限公司
439 firstIdType:
440 description: firstIdType
441 type: string
442 example: ITPRC
443 enum:
444 - ITARI
445 - ITHKM
446 - ITPRC
447 - ITPSP
448 - ITRES
449 - ITTID
450 - ITUSC
451 - ITCCU
452 firstIdNo:
453 description: firstIdNo
454 type: string
455 example: MA007438143XJ1P
456 businessLicenseNo:
457 description: businessLicenseNo
458 type: string
459 example: MA007438143XJ1P
460 organizationCreditCode:
461 description: organizationCreditCode
462 type: string
463 example: MA007438143XJ1P
464 taxRegistrationCertificateNo:
465 description: taxRegistrationCertificateNo
466 type: string
467 example: MA007438143XJ1P
468 establishmentDate:
469 description: establishmentDate
470 type: string
471 format: date
472 example: '2027-04-30'
473 incorporationDate:
474 description: incorporationDate
475 type: string
476 format: date
477 example: '2027-04-30'
478 businessLicenseDueDate:
479 description: businessLicenseDueDate
480 type: string
481 format: date
482 example: '2027-04-30'
483 legalRepName:
484 description: legalRepName
485 type: string
486 example: 王五
487 organizationType:
488 description: organizationType
489 type: string
490 example: OTINS
491 enum:
492 - OTINS
493 - OTUNI
494 - OTOTH
495 - OTIND
496 - OTCOR
497 fleetCustomer:
498 description: fleetCustomer
499 type: boolean
500 example: false
501 beneficialOwnerName:
502 description: beneficialOwnerName
503 type: string
504 example: 王五
505 beneficialOwnerIdType:
506 description: beneficialOwnerIdType
507 type: string
508 example: ITPRC
509 enum:
510 - ITARI
511 - ITHKM
512 - ITPRC
513 - ITPSP
514 - ITRES
515 - ITTID
516 - ITUSC
517 - ITCCU
518 beneficialOwnerIdNo:
519 description: beneficialOwnerIdNo
520 type: string
521 example: 324124534534
522 beneficialOwnerIdExpiryDate:
523 description: beneficialOwnerIdExpiryDate
524 type: string
525 format: date
526 example: '2027-04-30'
527 vehicleInfo:
528 description: vehicleInfo
529 type: object
530 required:
531 - vehicleStatus
532 - vehicleTransactionAmount
533 - vinNo
534 - dealer
535 properties:
536 vehicleStatus:
537 description: vehicleStatus
538 type: string
539 example: Usedcar
540 vehicleTransactionAmount:
541 description: vehicleTransactionAmount
542 type: number
543 format: float
544 example: 1234.56
545 vinNo:
546 description: vinNo
547 type: string
548 example: DFS2341JK23
549 dealer:
550 description: dealer
551 type: string
552 example: TestDealer
553 option:
554 description: option
555 type: number
556 format: float
557 example: 1234.56
558 msrp:
559 description: msrp
560 type: number
561 format: float
562 example: 1234.56
563 totalAmount:
564 description: totalAmount
565 type: number
566 format: float
567 example: 1234.56
568 insuranceInfo:
569 description: insuranceInfo
570 type: object
571 required:
572 - insuredAmount
573 - insuranceType
574 - startDate
575 - endDate
576 properties:
577 insuredAmount:
578 description: insuredAmount
579 type: number
580 format: float
581 example: 1234.56
582 insuranceType:
583 description: insuranceType
584 type: string
585 example: ITCOM
586 enum:
587 - ITCOM
588 - ITCOS
589 startDate:
590 description: startDate
591 type: string
592 format: date
593 example: '2027-04-30'
594 endDate:
595 description: endDate
596 type: string
597 format: date
598 example: '2027-04-30'
599 bankInfo:
600 description: bankInfo
601 type: object
602 required:
603 - bankName
604 - branchName
605 - applicantType
606 - accountHolderName
607 - accountNo
608 properties:
609 bankName:
610 description: bankName
611 type: string
612 example: 农业银行
613 branchName:
614 description: branchName
615 type: string
616 example: 回龙观支行
617 applicantType:
618 description: applicantType
619 type: string
620 example: COAPP
621 enum:
622 - COAPP
623 - CUSTR
624 - GAUTR1
625 - GAUTR2
626 accountHolderName:
627 description: accountHolderName
628 type: string
629 example: 张三
630 accountNo:
631 description: accountNo
632 type: string
633 example: 634523426756756
634 bankVerificationStatus:
635 description: bankVerificationStatus
636 type: string
637 example: PASS
638 enum:
639 - PASS
640 - FAIL
641 - N/A
642 isAllDocUploaded:
643 description: isAllDocUploaded
644 type: boolean
645 example: false
646 quotationtInfo:
647 description: quotationtInfo
648 type: object
649 required:
650 - totalLoanAmount
651 - loanTerm
652 - vehiclePrincipal
653 - monthlyPaymentInfo
654 properties:
655 totalLoanAmount:
656 description: totalLoanAmount
657 type: number
658 format: float
659 example: 1234.56
660 loanTerm:
661 description: loanTerm
662 type: number
663 example: 12
664 vehiclePrincipal:
665 description: vehiclePrincipal
666 type: number
667 format: float
668 example: 1234.56
669 associatedServicePrincipal:
670 description: associatedServicePrincipal
671 type: number
672 format: float
673 example: 1234.56
674 associatedServiceInfo:
675 description: associatedServiceInfo
676 type: array
677 items:
678 $ref: '#/definitions/associatedServiceInfo'
679 monthlyPaymentInfo:
680 description: monthlyPaymentInfo
681 type: array
682 items:
683 $ref: '#/definitions/monthlyPaymentInfo'
684 Comparison:
685 type: object
686 required:
687 - content
688 properties:
689 content:
690 description: 比对内容信息
691 type: object
692 required:
693 - uniqSeq
694 - applicationId
695 - applicationEntity
696 - customerType
697 - applicationVersion
698 - vehicleStatus
699 - comments
700 - individualCusInfo
701 properties:
702 uniqSeq:
703 description: uniqSeq
704 type: string
705 example: 201809301905121000
706 applicationId:
707 description: applicationId
708 type: string
709 example: CH-B100000123
710 applicationEntity:
711 description: applicationEntity
712 type: string
713 example: HIL
714 enum:
715 - AFC
716 - HIL
717 customerType:
718 description: customerType
719 type: string
720 example: TCCOR
721 enum:
722 - TCCOR
723 - TCDAS
724 - TCFRE
725 - TCIAS
726 - TCIND
727 - TCSEP
728 - TCURE
729 applicationVersion:
730 description: applicationVersion
731 type: integer
732 example: 0
733 vehicleStatus:
734 description: vehicleStatus
735 type: string
736 example: PCUSD
737 enum:
738 - PCUSD
739 - PCNEW
740 comments:
741 description: comments
742 type: array
743 items:
744 type: string
745 individualCusInfo:
746 description: individualCusInfo
747 type: array
748 items:
749 $ref: '#/definitions/individualCusInfo'
750 usedCarInfo:
751 description: usedCarInfo
752 type: object
753 required:
754 - vinNo
755 - manufactureDate
756 - firstRegistrationDate
757 properties:
758 vinNo:
759 description: vinNo
760 type: string
761 example: LBVSFJSDLFJLSDJF
762 manufactureDate:
763 description: manufactureDate
764 type: string
765 format: date
766 example: '2027-04-30'
767 firstRegistrationDate:
768 description: firstRegistrationDate
769 type: string
770 format: date
771 example: '2027-04-30'
772 corporateCusInfo:
773 description: corporateCusInfo
774 type: object
775 required:
776 - customerChineseName
777 - legalRepName
778 - idNum
779 - businessLicenseNo
780 - taxRegistrationCode
781 - incorporationDate
782 - businessLicenseDueDate
783 - capitalRegAmount
784 properties:
785 customerChineseName:
786 description: customerChineseName
787 type: string
788 example: 北京思图场景数据科技服务有限公司
789 legalRepName:
790 description: legalRepName
791 type: string
792 example: 李六
793 idNum:
794 description: idNum
795 type: string
796 example: MA007438143XJ1P
797 businessLicenseNo:
798 description: businessLicenseNo
799 type: string
800 example: MA007438143XJ1P
801 taxRegistrationCode:
802 description: taxRegistrationCode
803 type: string
804 example: MA007438143XJ1P
805 incorporationDate:
806 description: incorporationDate
807 type: string
808 format: date
809 example: '2027-04-30'
810 businessLicenseDueDate:
811 description: businessLicenseDueDate
812 type: string
813 format: date
814 example: '2027-04-30'
815 capitalRegAmount:
816 description: capitalRegAmount
817 type: number
818 format: float
819 example: 1234.56
820 ApiResponse:
821 description: 响应对象，code字段用于表示响应的状态; data字段用于存放响应内容
822 type: object
823 required:
824 - code
825 - msg
826 properties:
827 code:
828 type: integer
829 format: uint8
830 description: '0: success 1: need login 2: invalid params 3: internal error
831 4: object not exist 5: async wait 6: no permission 7: illegal operation'
832 example: 0
833 enum:
834 - 0
835 - 1
836 - 2
837 - 3
838 - 4
839 - 5
840 - 6
841 - 7
842 msg:
843 type: string
844 example: success
845 data:
846 type: object
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!