{"swagger":"2.0","info":{"description":"It consists of Documentations for Listed APIs. Authorization header added to API's except Generate Token & Refresh Token.\n1. Generate Token,\n2. Refresh Token,\n3. States list,\n4. State based Counties list,\n5. Document type and their questions,\n6. Fee calculation results","version":"1.0.0","title":"3HM Api Services"},"host":"uat.enoahprojects.com","basePath":"/3hm_services_v1/public","schemes":["https"],"tags":[{"name":"GetToken","description":"Getting JWT Token from Secret API key"},{"name":"RefreshToken","description":"Refresh JWT Token"},{"name":"State","description":"To work with states"},{"name":"County","description":"To work with counties"},{"name":"DocumentType","description":"Getting input lists"}],"paths":{"/user/getToken":{"post":{"tags":["GetToken"],"summary":"Getting JWT Token from Secret API key","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Send Secret API Key to get the JWT Token","required":true,"schema":{"$ref":"#/definitions/GenerateJWTRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GenerateJWTResponse"}},"404":{"description":"failure operation","schema":{"$ref":"#/definitions/GenerateJWTFailure"}}}}},"/user/refreshToken":{"post":{"tags":["RefreshToken"],"summary":"Refresh JWT Token","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Send Secret API Key & Expired JWT Token to get the New JWT Token","required":true,"schema":{"$ref":"#/definitions/RefreshJWTRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GenerateJWTResponse"}},"404":{"description":"failure operation","schema":{"$ref":"#/definitions/RefreshJWTFailure"}}}}},"/api/stateslist":{"get":{"tags":["State"],"summary":"Getting list of active states","description":"Getting list of active states","produces":["application/json"],"parameters":[{"in":"header","name":"Authorization","description":"Send JWT Token","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StateSuccess"}},"404":{"description":"No results found","schema":{"$ref":"#/definitions/StateFailure"}},"401":{"description":"Authorization failure","schema":{"$ref":"#/definitions/InvalidUser"}}}}},"/api/statecounties":{"post":{"tags":["County"],"summary":"Getting list of active counties Based on State Id","description":"Returns list of counties","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Send stateId to get the counties list","required":true,"schema":{"$ref":"#/definitions/CountyRequest"}},{"in":"header","name":"Authorization","description":"Send JWT Token","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CountyResponse"}},"404":{"description":"No results found","schema":{"$ref":"#/definitions/CountyFailure"}},"401":{"description":"Authorization failure","schema":{"$ref":"#/definitions/InvalidUser"}}}}},"/api/feeCalculationQuestions":{"post":{"tags":["DocumentType"],"summary":"Getting document types and their inputs","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Area details need to be sent for getting Form inputs","required":true,"schema":{"$ref":"#/definitions/DocumentType"}},{"in":"header","name":"Authorization","description":"an authorization header","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentTypeResponse"}},"404":{"description":"No results found","schema":{"$ref":"#/definitions/DocumentFailure"}},"401":{"description":"Authorization failure","schema":{"$ref":"#/definitions/InvalidUser"}}}}},"/api/feeCalculationResults":{"post":{"tags":["FeeCalculationResult"],"summary":"Fee Calculation Result","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Need to send Document questions and their answers - It will consistes dynamic datas","required":true,"schema":{"$ref":"#/definitions/FeeCalculationRequest"}},{"in":"header","name":"Authorization","description":"an authorization header","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FeeCalculationResult"}},"404":{"description":"failure operation","schema":{"$ref":"#/definitions/stateList"}},"400":{"description":"failure operation","schema":{"$ref":"#/definitions/InvalidUser"}}}}}},"definitions":{"StateSuccess":{"type":"object","properties":{"status":{"type":"string","example":"Success"},"code":{"type":"integer","example":200},"stateList":{"type":"array","items":{"$ref":"#/definitions/stateList"}}}},"stateList":{"type":"object","properties":{"stateName":{"type":"string","example":"California"},"stateId":{"type":"integer","format":"int64","example":5}}},"countyList":{"type":"object","properties":{"countyName":{"type":"string","example":"Yolo"},"countyId":{"type":"integer","format":"int64","example":240}}},"StateFailure":{"type":"object","properties":{"status":{"type":"string","example":"No states found OR States list are not assigned to this User"},"code":{"type":"integer","example":404}}},"InvalidUser":{"type":"object","properties":{"status":{"type":"string","example":"Token not found"},"code":{"type":"integer","example":404}}},"CountyRequest":{"type":"object","required":["stateId"],"properties":{"stateId":{"type":"integer","format":"int64","example":5}}},"CountyResponse":{"type":"object","properties":{"status":{"type":"string","example":"Success"},"code":{"type":"integer","example":200},"stateId":{"type":"integer","example":5},"countyList":{"type":"array","items":{"$ref":"#/definitions/countyList"}}}},"CountyFailure":{"type":"object","properties":{"status":{"type":"string","example":"No counties found under this State"},"code":{"type":"integer","example":404}}},"DocumentType":{"type":"object","required":["state","county"],"properties":{"state":{"type":"integer","format":"int64","example":5},"county":{"type":"integer","format":"int64","example":240}}},"DocumentTypeResponse":{"type":"object","properties":{"status":{"type":"string","example":"Success"},"code":{"type":"integer","example":200},"documentQuestions":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"type":{"$ref":"#/definitions/types"},"questionsAnswers":{"type":"array","items":{"$ref":"#/definitions/questions_answers"}}}}}}}}},"types":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"documentTypeId":{"type":"integer","format":"int64"},"documentName":{"type":"string"},"docTypeInputFieldName":{"type":"string"},"docTypeInputFieldValue":{"type":"integer","format":"int64"}}},"questions_answers":{"type":"object","properties":{"questions":{"$ref":"#/definitions/questions"},"answers":{"$ref":"#/definitions/answers"}}},"questions":{"type":"object","properties":{"questionText":{"type":"string"},"questionHiddenInputFieldName":{"type":"string"},"questionHiddenInputFieldValue":{"type":"string"}}},"answers":{"type":"object","properties":{"answerInputFieldName":{"type":"string"},"isTextboxSelectbox":{"type":"boolean"},"isCurrency":{"type":"boolean"},"isMultiSelect":{"type":"boolean"},"selectboxOptions":{"type":"array","items":{"$ref":"#/definitions/selectbox_options"}}}},"selectbox_options":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"value":{"type":"string"}}},"DocumentFailure":{"type":"object","properties":{"status":{"type":"string","example":"No documents found for given inputs"},"code":{"type":"integer","example":404}}},"GenerateJWTRequest":{"type":"object","required":["secretKey"],"properties":{"secretKey":{"type":"string","example":"secretapikey"}}},"GenerateJWTResponse":{"type":"object","properties":{"status":{"type":"string","example":"Success"},"code":{"type":"integer","example":200},"jwtToken":{"type":"string","example":"jkadssjka.asdsad.sadadsd"}}},"GenerateJWTFailure":{"type":"object","properties":{"status":{"type":"string","example":"Invalid Secret key"},"code":{"type":"integer","example":404}}},"RefreshJWTRequest":{"type":"object","required":["secretKey","jwtToken"],"properties":{"secretKey":{"type":"string","example":"secretapikey"},"jwtToken":{"type":"string","example":"expiredjwttoken"}}},"RefreshJWTFailure":{"type":"object","properties":{"status":{"type":"string","example":"Invalid Secret key or JWT Token Passed"},"code":{"type":"integer","example":404}}},"FeeCalculationRequest":{"type":"object","required":["docTypeInputs","stateId","countyId"],"properties":{"stateId":{"type":"integer"},"countyId":{"type":"integer"},"docTypeInputs":{"type":"array","items":{"$ref":"#/definitions/docTypeInputs"}}},"example":{"stateId":5,"countyId":240,"docTypeInputs":[{"name":"Deed","docId":1,"inputs":[{"Ip1":25000,"Ip82":10,"Ip161":2,"Ip168":1,"Ip286":[1,2,3]}]},{"name":"Montgage","docId":443,"inputs":[{"Ip99":15000,"Ip82":5,"Ip161":4,"Ip286":[1,5,6]}]}]}},"docTypeInputs":{"type":"object","properties":{"name":{"type":"string"},"docId":{"type":"integer"},"inputs":{"type":"array","items":{"type":"object"}}}},"FeeCalculationResult":{"type":"object","properties":{"status":{"type":"string","example":"Success"},"code":{"type":"integer","example":200},"results":{"$ref":"#/definitions/Results"}}},"Results":{"type":"object","properties":{"feeDetails":{"$ref":"#/definitions/fee_details"},"governmentTaxes":{"$ref":"#/definitions/government_taxes"},"standardHUD-1Annotation":{"$ref":"#/definitions/Standard_HUD_Annotation"},"jurisdictionDetails":{"$ref":"#/definitions/Jurisdiction_details"}}},"fee_details":{"type":"array","items":{"$ref":"#/definitions/Document_definition"}},"Document_definition":{"type":"object","properties":{"docId":{"type":"integer","example":1},"name":{"type":"string","example":"Deed"},"additionalComments":{"type":"string","example":"Notes"},"input":{"$ref":"#/definitions/Input"},"output":{"$ref":"#/definitions/Output"}}},"Input":{"type":"object","properties":{"ip1":{"$ref":"#/definitions/Input_values1"},"ip82":{"$ref":"#/definitions/Input_values2"}}},"Input_values1":{"type":"object","properties":{"name":{"type":"string","example":"Consideration"},"code":{"type":"string","example":"ip1"},"value":{"type":"string","example":16.5},"symbol":{"type":"boolean","example":true},"isHighlight":{"type":"integer","example":1}}},"Input_values2":{"type":"object","properties":{"name":{"type":"string","example":"Number of Pages"},"code":{"type":"string","example":"ip82"},"value":{"type":"string","example":5},"symbol":{"type":"boolean","example":true},"isHighlight":{"type":"integer","example":1}}},"Output":{"type":"object","properties":{"op1":{"type":"object","properties":{"name":{"type":"string","example":"Transfer Tax Amount"},"code":{"type":"string","example":"op1"},"value":{"type":"string","example":0.02},"symbol":{"type":"boolean","example":true},"isRequired":{"type":"boolean","example":true}}},"op82":{"type":"object","properties":{"name":{"type":"string","example":"Page Fee"},"code":{"type":"string","example":"op82"},"value":{"type":"string","example":15.0},"symbol":{"type":"boolean","example":true},"isRequired":{"type":"boolean","example":true}}}}},"government_taxes":{"type":"object","properties":{"documentType":{"type":"object","properties":{"Deed":{"$ref":"#/definitions/document_type_definition"},"Mortgage":{"$ref":"#/definitions/document_type_definition"}}},"total":{"type":"object","properties":{"recordingFee":{"type":"string","example":452},"totalTaxes":{"type":"string","example":0.02},"totalOtherFee":{"type":"string","example":452},"totalRecordingFee":{"type":"string","example":452.02},"potentialNonStandardFee":{"type":"string","example":0}}}}},"document_type_definition":{"type":"object","properties":{"recordingFee":{"type":"string","example":226},"totalTaxes":{"type":"string","example":0.02},"totalOtherFee":{"type":"string","example":200},"totalRecordingFee":{"type":"string","example":200.02},"potentialNonStandardFee":{"type":"string","example":0}}},"Standard_HUD_Annotation":{"type":"object","properties":{"1201":{"$ref":"#/definitions/HUD_definition"},"1205":{"$ref":"#/definitions/HUD_definition"}}},"HUD_definition":{"type":"object","properties":{"title":{"type":"string"},"deed":{"type":"string","example":0},"mortgage":{"type":"string","example":0},"value":{"type":"string","example":""}}},"Jurisdiction_details":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","example":"Yolo"},"departmentOffice":{"type":"string","example":"Yolo County Clerk/Recorder"},"address1":{"type":"string","example":"625 Court Street Room B01"},"address2":{"type":"string","example":""},"city":{"type":"string","example":"Woodland"},"zip":{"type":"string","example":"95695"},"phone":{"type":"string","example":"(530) 666-8130"},"checksPayableTo":{"type":"string","example":"Yolo County Clerk/Recorder"},"isEfileEnabled":{"type":"string","example":""},"recordingInformationAvailable":{"type":"string","example":"Rec Info Only No Charge"},"link":{"type":"string","example":"http://www.yolorecorder.org/recsearch"},"maritalState":{"type":"string","example":"Community Property"},"trustState":{"type":"string","example":true},"mortgageState":{"type":"string","example":false},"blanketAssignments":{"type":"string","example":"Accepted"},"blanketReleases":{"type":"string","example":"Accepted"},"avgTurnTimeRecInfoReceived":{"type":"string","example":33}}}}}}