Appraisal Scope Admin API Document Version 1.5.20200923

Appraisal Scope Admin API Document Version 1.5.20200923.01

1

Document Version History

No. Date 1 12/04/18 2

01/29/19 3 02/12/19 4 02/12/19 5 02/12/19

Revised By Alex Patel Mahavir Jain

Mahavir Jain Hitesh Patel David Ashmon

6 02/12/19

David Ashmon

7 03/31/19 8 06/26/19 9 07/10/19 10 10/28/19

Hitesh Patel David Ashmon David Ashmon Cynthia Burton

11 09/23/2020

Cynthia Burton

Version V1.5.20181204.01 V1.5.20190129.01

V1.5.20190212.01 V1.5.20190212.02 V1.5.20190212.03

V1.5.20190226.01

V1.5.20190331.01 V1.5.20190626.01 V1.5.20190710.01 V1.5.20191028.01

V1.520200923.01

Summary of Changes

Send Invoice Call Description Update Update User Password Add and Remove AMC from Client Company Add and Remove AMC from Client Branch

Add getappraisals Add setmanuallogentry Updated document format, fixed typos Made corrections to 3 documentation issues where the incorrect methods were listed: ? Client on Report Company =

client_company_remove_amc ? Change Appraiser Paid Status =

changeappraiserstatustopaid For Edit Branch (edit_branch), indicated that either the Branch ID or Internal Branch ID is required.

2

Contents

Introduction ................................................................................................................................................ 10 Highlights ................................................................................................................................................ 10 Guidelines to get SSL Certificate file (.crt file): ....................................................................................... 10 Integration .............................................................................................................................................. 11 Error Codes & Messages ......................................................................................................................... 11

Login API [Authentication] .......................................................................................................................... 12 Request Parameters................................................................................................................................ 12 Response Parameters ............................................................................................................................. 12 Example Response Data.......................................................................................................................... 12 Possible Error Codes ............................................................................................................................... 12

Get Appraisals ............................................................................................................................................. 13 Request Parameters................................................................................................................................ 13 Response Parameters ............................................................................................................................. 13 Example Response Data.......................................................................................................................... 14 Possible Error Codes ............................................................................................................................... 14

Get Appraisal Details................................................................................................................................... 15 Request Parameters................................................................................................................................ 15 Response Parameters ............................................................................................................................. 15 Example Response Data.......................................................................................................................... 17 Possible Error Codes ............................................................................................................................... 20

Get Appraisals by Status ............................................................................................................................. 21 Request Parameters................................................................................................................................ 21 Response Parameters ............................................................................................................................. 21 Example Response Data.......................................................................................................................... 22 Possible Error Codes ............................................................................................................................... 22

Get Revisions............................................................................................................................................... 23 Request Parameters................................................................................................................................ 23 Response Parameters ............................................................................................................................. 23 Example Response Data.......................................................................................................................... 23 Possible Error Codes ............................................................................................................................... 23

Save Reviewed Report ................................................................................................................................ 24 Request Parameters................................................................................................................................ 24

3

Response Parameters ............................................................................................................................. 24 Example Response Data.......................................................................................................................... 24 Possible Error Codes ............................................................................................................................... 24 Get Appraisal Document............................................................................................................................. 25 Request Parameters................................................................................................................................ 25 Response Parameters ............................................................................................................................. 25 Example Response Data.......................................................................................................................... 26 Possible Error Codes ............................................................................................................................... 26 Rule Profile Assignment .............................................................................................................................. 27 Request Parameters................................................................................................................................ 27 Response Parameters ............................................................................................................................. 27 Example Response Data.......................................................................................................................... 27 Possible Error Codes ............................................................................................................................... 27 Get Rule Profile ........................................................................................................................................... 28 Request Parameters................................................................................................................................ 28 Response Parameters ............................................................................................................................. 28 Example Response Data.......................................................................................................................... 28 Possible Error Codes ............................................................................................................................... 28 Set Appraisal Details ................................................................................................................................... 29 Request Parameters................................................................................................................................ 29 Response Parameters ............................................................................................................................. 29 Example Response Data.......................................................................................................................... 29 Possible Error Codes ............................................................................................................................... 29 Set Staff Notes ............................................................................................................................................ 30 Request Parameters................................................................................................................................ 30 Response Parameters ............................................................................................................................. 30 Example Response Data.......................................................................................................................... 30 Possible Error Codes ............................................................................................................................... 30 Change Appraiser Paid Status ..................................................................................................................... 31 Request Parameters................................................................................................................................ 31 Response Parameters ............................................................................................................................. 31 Example Response Data.......................................................................................................................... 31 Possible Error Codes ............................................................................................................................... 31

4

Get Loan Types............................................................................................................................................ 32 Request Parameters................................................................................................................................ 32 Response Parameters ............................................................................................................................. 32 Example Response Data.......................................................................................................................... 32 Possible Error Codes ............................................................................................................................... 32

Get Branch List ............................................................................................................................................ 33 Request Parameters................................................................................................................................ 33 Response Parameters ............................................................................................................................. 33 Example Response Data.......................................................................................................................... 34 Possible Error Codes ............................................................................................................................... 34

Create Branch ............................................................................................................................................. 35 Request Parameters................................................................................................................................ 35 Response Parameters ............................................................................................................................. 35 Example Response Data.......................................................................................................................... 36 Possible Error Codes ............................................................................................................................... 36

Edit Branch .................................................................................................................................................. 37 Request Parameters................................................................................................................................ 37 Response Parameters ............................................................................................................................. 37 Example Response Data.......................................................................................................................... 38 Possible Error Codes ............................................................................................................................... 38

Add AMC to Client Branch .......................................................................................................................... 39 Request Parameters................................................................................................................................ 39 Response Parameters ............................................................................................................................. 39 Example Response Data.......................................................................................................................... 40 Possible Error Codes ............................................................................................................................... 40

Remove AMC from Client Branch ............................................................................................................... 41 Request Parameters................................................................................................................................ 41 Response Parameters ............................................................................................................................. 41 Example Response Data.......................................................................................................................... 42 Possible Error Codes ............................................................................................................................... 42

Get Client Company List.............................................................................................................................. 43 Request Parameters................................................................................................................................ 43 Response Parameters ............................................................................................................................. 43

5

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download