{"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 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 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":1}}},"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":2}}},"CountyResponse":{"type":"object","properties":{"status":{"type":"string","example":"Success"},"code":{"type":"integer","example":200},"stateId":{"type":"integer","example":2},"countyList":{"type":"array","items":{"$ref":"#/definitions/stateList"}}}},"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"},"county":{"type":"integer","format":"int64"}}},"DocumentTypeResponse":{"type":"object","properties":{"status":{"type":"string","example":"Success"},"code":{"type":"integer","example":200},"document_questions":{"type":"object","properties":{"documents":{"type":"object","properties":{"type":{"type":"array","items":{"$ref":"#/definitions/documentTypes"}},"0":{"type":"object","properties":{"type":{"$ref":"#/definitions/types"},"questions_answers":{"type":"array","items":{"$ref":"#/definitions/questions_answers"}}}}}}}}}},"types":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"documentTypeId":{"type":"integer","format":"int64"},"documentname":{"type":"string"},"doctype_input_field_name":{"type":"string"},"doctype_input_field_value":{"type":"integer","format":"int64"}}},"documentTypes":{"type":"object","properties":{"id":{"type":"integer"},"documentTypeId":{"type":"integer"},"documentname":{"type":"string"}}},"questions_answers":{"type":"object","properties":{"questions":{"$ref":"#/definitions/questions"},"answers":{"$ref":"#/definitions/answers"}}},"questions":{"type":"object","properties":{"question_text":{"type":"string"},"question_hidden_input_field_name":{"type":"string"},"question_hidden_input_field_value":{"type":"string"}}},"answers":{"type":"object","properties":{"answer_input_field_name":{"type":"string"},"is_textbox_selectbox":{"type":"boolean"},"is_currency":{"type":"boolean"},"is_multiselect":{"type":"boolean"},"selectbox_options":{"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":["calculation_doc_types","state_id","county_id"],"properties":{"calculation_doc_types":{"type":"array","items":{"type":"string","example":"1,15"}},"state_id":{"type":"integer"},"county_id":{"type":"integer"},"user_input_values_1":{"type":"array","items":{"type":"string","example":"1,2"}},"user_input_values_15":{"type":"array","items":{"type":"string","example":"1,2"}},"user_input_codes_1":{"type":"array","items":{"type":"string","example":"ip1,ip82"}},"user_input_codes_15":{"type":"array","items":{"type":"string","example":"ip161,ip168"}}}},"FeeCalculationResult":{"type":"object","properties":{"status":{"type":"string","example":"Success"},"code":{"type":"integer","example":200},"results":{"$ref":"#/definitions/Results"}}},"Results":{"type":"object","properties":{"fee-details":{"$ref":"#/definitions/fee_details"},"government-taxes":{"$ref":"#/definitions/government_taxes"},"Standard HUD-1 Annotation":{"$ref":"#/definitions/Standard_HUD_Annotation"},"Forms_details":{"$ref":"#/definitions/Forms_details"},"Jurisdiction_details":{"$ref":"#/definitions/Jurisdiction_details"}}},"fee_details":{"type":"object","properties":{"Deed":{"$ref":"#/definitions/Document_definition"},"Mortgage":{"$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":{"Document Type":{"type":"object","properties":{"Deed":{"$ref":"#/definitions/document_type_definition"},"Mortgage":{"$ref":"#/definitions/document_type_definition"}}},"Total":{"type":"object","properties":{"Recording Fee":{"type":"string","example":452},"Total Taxes":{"type":"string","example":0.02},"Total Other Fee":{"type":"string","example":452},"Total Recording Fee":{"type":"string","example":452.02},"Potential Non Standard Fee":{"type":"string","example":0}}}}},"document_type_definition":{"type":"object","properties":{"Recording Fee":{"type":"string","example":226},"Total Taxes":{"type":"string","example":0.02},"Total Other Fee":{"type":"string","example":200},"Total Recording Fee":{"type":"string","example":200.02},"Potential Non Standard Fee":{"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":""},"Buyer":{"type":"string","example":""},"Seller":{"type":"string","example":""}}},"Forms_details":{"type":"object","properties":{"notes":{"$ref":"#/definitions/Notes"},"files":{"$ref":"#/definitions/Files"},"hyperlink":{"$ref":"#/definitions/Hyperlink"}}},"Notes":{"type":"object","properties":{"id":{"type":"integer","example":150},"formTitle":{"type":"string","example":"Form title"},"notes":{"type":"string","example":"notes"}}},"Files":{"type":"array","items":{"type":"object","properties":{"file_title":{"type":"string","example":"CA Coverpage.pdf"}}}},"Hyperlink":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","example":"CA Notary Acknowledgement"},"hyperlink":{"type":"string","example":"http://notary.cdn.sos.ca.gov/forms/notary-ack.pdf"}}}},"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},"mortageState":{"type":"string","example":false},"blanketAssignments":{"type":"string","example":"Accepted"},"blanketReleases":{"type":"string","example":"Accepted"},"avgTurntimeRecInfoReceived":{"type":"string","example":33}}}}}}