{"openapi":"3.0.0","info":{"title":"4see Analytics APIs","version":"1.0.0","description":"4see Analytics APIs data","contact":{"email":"info@annet.com"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://dev-4see.azurewebsites.net/","description":"Production server"},{"url":"http://localhost:8000/api/documentation","description":"Development server"}],"paths":{"/api/getCreditRatings":{"post":{"tags":["Credit Ratings"],"summary":"Get Credit Ratings by Tenant Name","operationId":"getCreditRatings","parameters":[{"name":"AccessToken","in":"header","description":"Access token received from getAuthToken API","required":true,"schema":{"type":"string","example":"Irb74OWsnY7UfxLaZJhSJSexc62Bqx1TDyBZEqb9ud4e1OZ5Yqc8eHEbAPglK3RpsxyuPrVIJbQMpSww"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["tenant_name"],"properties":{"tenant_name":{"description":"Name of the tenant to get credit ratings for","type":"string","example":"Home Depot"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"TenantName":{"type":"string","example":"Home Depot"},"ParentCompany":{"type":"string","example":"Home Depot Inc."},"CreditRating":{"type":"string","example":"A"},"Outlook":{"type":"string","example":"Stable"},"CreditRatingDate":{"type":"string","example":"15 Oct 2013"}},"type":"object"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getPropertyUnits":{"get":{"tags":["Property Management"],"summary":"Get a list of Property Units from a Property Management","operationId":"getPropertyUnits","parameters":[{"name":"AccessToken","in":"header","description":"Access token for authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Successfully fetched","content":{"application/json":{"schema":{"properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"properties":{"PropertyPKID":{"type":"string","example":"25"},"LeaseID":{"type":"string","example":"280"},"LeaseCode":{"type":"string","example":"ota_1f"},"Company Number":{"type":"string","example":"131a"},"PropertyList":{"type":"string","example":".oak"},"Unit Number":{"type":"string","example":"F"},"Company Description":{"type":"string","example":"Heritage Properties"},"Property Status":{"type":"string","example":"Active"},"Property Type":{"type":"string","example":"Commercial"},"Building Square Footage":{"type":"string","example":"20417.0"},"# of Units":{"type":"string","example":"15"},"propertytenant.city":{"type":"string","example":"South Plainfield"},"County":{"type":"string","example":"United States"},"propertytenant.state":{"type":"string","example":"Arizona"},"ZipCode":{"type":"string","example":"7080"},"propertytenant.address":{"type":"string","example":"1310 Churchville Avenue"},"propertytenant.region":{"type":"string","example":"Northeast"},"PropertyManager":{"type":"string","example":"Adams Hoffman"},"AssetMgrport":{"type":"string","example":"Sarah Smith"},"LeasingManager":{"type":"string","example":"XXX"},"Property Acqusition Date":{"type":"string","format":"date","example":"2001-07-01"},"Gross Acquisition Price":{"type":"string","example":"901406.0"},"Lease Status":{"type":"string","example":"Active"},"Lease Type":{"type":"string","example":"offnet"},"Remaining Lease Term Month":{"type":"string","example":"7"},"Remaining Lease Term Year":{"type":"string","example":"1"},"Unit Type":{"type":"string","example":"off"},"Lease Move In Date":{"type":"string","format":"date","example":"2022-03-01"},"Lease Move Out Date":{"type":"string","format":"date","example":null,"nullable":true},"Lease Start Date":{"type":"string","format":"date","example":"2022-03-01"},"Lease Expiration Date":{"type":"string","format":"date","example":"2025-04-30"},"Tenant Number":{"type":"string","example":""},"Trade Name":{"type":"string","example":"Thomas G. Kaylen - ota_1f"},"local tenant":{"type":"string","example":"Sanchez, Mcdaniel and Evans - ota_1f"},"TenantName":{"type":"string","example":"Sanchez, Mcdaniel and Evans - ota_1f"},"TenantNameOnly":{"type":"string","example":"Sanchez, Mcdaniel and Evans"},"ULI Category":{"type":"string","example":null,"nullable":true},"ULI Category2":{"type":"string","example":null,"nullable":true},"Unit Square Feet":{"type":"string","example":"1612.0"},"Currently Monthly Base Rent":{"type":"string","example":"2565.2600000000002"},"Current Annualized Base Rent PSF":{"type":"string","example":"19.096228287841193"},"Parent Name":{"type":"string","example":null,"nullable":true},"SnP Rating":{"type":"string","example":null,"nullable":true},"is financially vacant":{"type":"string","example":"0"},"Total Commercial Financial Occupancy SF":{"type":"string","example":"2565.2600000000002"},"Total commercial Physical Occupancy SF":{"type":"string","example":"2565.2600000000002"},"Count Asset":{"type":"string","example":"15"},"PropertyID":{"type":"string","example":"25"},"Address":{"type":"string","example":"1310 Churchville Avenue"},"City":{"type":"string","example":"South Plainfield"},"geocoding.state":{"type":"string","example":"Arizona"},"Zip":{"type":"string","example":"7080"},"Lat":{"type":"string","example":null,"nullable":true},"Lon":{"type":"string","example":null,"nullable":true},"region.state":{"type":"string","example":"Arizona"},"region.Region":{"type":"string","example":"Northeast"},"Statename":{"type":"string","example":"Arizona"},"StateFullName":{"type":"string","example":"Arizona"},"Current ABR":{"type":"string","example":"30783.120000000003"},"Tenant Total Rent":{"type":"string","example":null,"nullable":true},"Full address":{"type":"string","example":"1310 Churchville Avenue Oak Tree Associates South Plainfield Arizona 7080"},"Property Description":{"type":"string","example":"Heritage Properties"},"PrimaryEngineer":{"type":"string","example":"Lawrence Battle"},"SecondaryEngineer":{"type":"string","example":"Pete Borges"},"CreatedLeaseExpirationDate":{"type":"string","format":"date","example":"2025-04-30"},"IsFinanciallyVacant":{"type":"string","example":"0"},"IsExclude":{"type":"string","example":"0"},"Team":{"type":"string","example":"NJ Office"},"OwnershipType":{"type":"string","example":"Legacy"},"EconomicHealth":{"type":"string","example":"Green"},"PropType":{"type":"string","example":"Commercial"}},"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getReceivableBalances":{"get":{"tags":["Property Management"],"summary":"Get a list of Receivable Balances from a Property Management","operationId":"getReceivableBalances","parameters":[{"name":"AccessToken","in":"header","description":"Access token for authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Successfully fetched","content":{"application/json":{"schema":{"properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"properties":{"PropertyPKId":{"type":"string","example":"1"},"PropertyNumber":{"type":"string","example":"109"},"PropertyList":{"type":"string","example":"Not associated"},"PropertyName":{"type":"string","example":"Estate Flux Properties"},"Property Type":{"type":"string","example":"Commercial"},"Team":{"type":"string","example":"Greater Monmouth"},"OwnershipType":{"type":"string","example":"Legacy"},"EconomicHealth":{"type":"string","example":"Green"},"Fund":{"type":"string","example":null,"nullable":true},"BusinessUnitNumber":{"type":"string","example":"109-Estate Flux Properties"},"BusinessUnitNumberWithName":{"type":"string","example":"109-Estate Flux Properties"},"PropertyStatus":{"type":"string","example":"Active"},"LeaseCode":{"type":"string","example":"t0006048"},"TenantNumber":{"type":"string","example":""},"TenantName":{"type":"string","example":"YCIPTA (License)"},"TradeName":{"type":"string","example":"Jersey Built Hubs"},"BillCode":{"type":"string","example":"CAM"},"BillCodeSub":{"type":"string","example":"Op Exp Reimb."},"AgingSet":{"type":"string","example":"90+"},"AssetManager":{"type":"string","example":"William Ryan"},"SnP Rating":{"type":"string","example":null,"nullable":true},"Prepay":{"type":"string","example":".00"},"AmountOutstanding":{"type":"string","example":"370.67"},"As-Of Date#Calendar Year":{"type":"string","format":"date","example":"2021-11-30"},"CalendarYear":{"type":"string","example":"CY 2021"},"CalendarQuarter":{"type":"string","example":"Q4"},"CalendarMonth":{"type":"string","example":"October"},"CalendarMonthYear":{"type":"string","example":"Sep 2021"},"LeaseStatus":{"type":"string","example":"Expired"},"LegalNotes":{"type":"string","example":"9/26/23-Certification of Proof for Final Judgement filed by Atty."},"CurrentDate":{"type":"string","format":"date-time","example":"2024-09-19 07:53:52.120"}},"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getIncomeStatements":{"get":{"tags":["Property Management"],"summary":"Get a list of Income Statements from a Property Management","operationId":"getIncomeStatements","parameters":[{"name":"AccessToken","in":"header","description":"Access token for authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Successfully fetched","content":{"application/json":{"schema":{"properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"properties":{"IncomeStatementsID":{"type":"string","example":"1"},"PropertyID":{"type":"string","example":"1"},"NetPostingPeriod":{"type":"string","format":"date","example":"2023-08-01"},"NetPostingPeriodDate":{"type":"string","format":"date","example":"2023-08-01"},"Ledger":{"type":"string","example":"AA"},"PropertyNumber":{"type":"string","example":"109"},"PropertyList":{"type":"string","example":"Not associated"},"Property Name":{"type":"string","example":"Estate Flux Properties"},"PropertyStatus":{"type":"string","example":"Active"},"Team":{"type":"string","example":"Greater Monmouth"},"OwnershipType":{"type":"string","example":"Legacy"},"EconomicHealth":{"type":"string","example":"Green"},"Property Type":{"type":"string","example":"Commercial"},"AccountFullCode":{"type":"string","example":"110565"},"ChartOfAccountID":{"type":"string","example":"111"},"Amount":{"type":"string","example":"0.0"},"NodeDescription":{"type":"string","example":"Late Fees Receivable (110565)"},"L1":{"type":"string","example":"NET INCOME"},"L2":{"type":"string","example":"NET OPERATING INCOME"},"L3":{"type":"string","example":"Late Fees Receivable(110565)"},"L4":{"type":"string","example":""},"L5":{"type":"string","example":""},"L6":{"type":"string","example":""},"L7":{"type":"string","example":""},"L8":{"type":"string","example":""},"L9":{"type":"string","example":""}},"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getVacancyAndExpiration":{"get":{"tags":["Property Management"],"summary":"Get a list of Vacancy And Expiration from a Property Management","operationId":"getVacancyAndExpiration","parameters":[{"name":"AccessToken","in":"header","description":"Access token for authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Successfully fetched","content":{"application/json":{"schema":{"properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"properties":{"PropertyPKID":{"type":"string","example":"25"},"PropertyCode":{"type":"string","example":"131a"},"LeaseExpirationDate":{"type":"string","format":"date","example":"2025-04-30"},"vacant unit number":{"type":"string","example":"F"},"LeaseCode":{"type":"string","example":"ota_1f"},"Company Description":{"type":"string","example":"Heritage Properties"},"Property Name":{"type":"string","example":"Heritage Properties"},"PropertyList":{"type":"string","example":".oak"},"Property Status":{"type":"string","example":"Active"},"vacant property type":{"type":"string","example":""},"tenant property type":{"type":"string","example":""},"# of Units":{"type":"string","example":"15"},"vacant state":{"type":"string","example":"Arizona"},"tenant state":{"type":"string","example":"Arizona"},"tenant address":{"type":"string","example":"1310 Churchville Avenue"},"tenant region":{"type":"string","example":"Northeast"},"tenant Property Manager":{"type":"string","example":"Adams Hoffman"},"Asset Manager":{"type":"string","example":"Sarah Smith"},"AssetMgrport":{"type":"string","example":"Sarah Smith"},"vacant Leasing Manager":{"type":"string","example":"XXX"},"tenant Leasing Manager":{"type":"string","example":"XXX"},"vacant Property Acqusition Date":{"type":"string","format":"date","example":"2001-07-01"},"tenant Property Acqusition Date":{"type":"string","format":"date","example":"2001-07-01"},"Gross Acquisition Price":{"type":"string","example":"901406.0"},"vacant Lease Type":{"type":"string","example":"offnet"},"tenant Lease Type":{"type":"string","example":"offnet"},"Remaining Lease Term Month":{"type":"string","example":"0.0"},"Remaining Lease Term Year":{"type":"string","example":"0.0"},"vacant Unit Type":{"type":"string","example":"off"},"Unit Type":{"type":"string","example":"off"},"LeaseMoveInDate":{"type":"string","format":"date","example":"2022-03-01"},"LeaseMoveOutDate":{"type":"string","example":null,"nullable":true},"Lease Start Date":{"type":"string","format":"date","example":"2022-03-01"},"Vacant Lease Expiration Date":{"type":"string","format":"date","example":"2025-04-30"},"tenant Lease Expiration Date":{"type":"string","format":"date","example":"2025-04-30"},"Tenant Number":{"type":"string","example":""},"Trade Name":{"type":"string","example":"Thomas G. Kaylen - ota_1f"},"vacant Local Tenant":{"type":"string","example":"Sanchez, Mcdaniel and Evans - ota_1f"},"TenantName":{"type":"string","example":"Sanchez, Mcdaniel and Evans - ota_1f"},"LastTenant":{"type":"string","example":"Sanchez, Mcdaniel and Evans - ota_1f"},"Last Tenant Vacate Date":{"type":"string","format":"date","example":"2025-04-30"},"Last Tenant Rent PSF":{"type":"string","example":"0.0"},"Trade Market Type":{"type":"string","example":null,"nullable":true},"ULI Category":{"type":"string","example":null,"nullable":true},"ULI Category2":{"type":"string","example":null,"nullable":true},"vacant Unit Square Feet":{"type":"string","example":"1612.0"},"tenant Unit Square Feet":{"type":"string","example":"1612.0"},"Unit Square Feet":{"type":"string","example":"1612.0"},"Monthly Base Rent":{"type":"string","example":"2565.2600000000002"},"Current Tenant Rent PSF":{"type":"string","example":"19.096228287841193"},"Current Annualized Base Rent PSF":{"type":"string","example":"19.096228287841193"},"SnP Rating":{"type":"string","example":null,"nullable":true},"Count Asset":{"type":"string","example":"15"},"PropertyID":{"type":"string","example":"25"},"Address":{"type":"string","example":"1310 Churchville Avenue"},"City":{"type":"string","example":"South Plainfield"},"geocoding.city":{"type":"string","example":"South Plainfield"},"geocoding.state":{"type":"string","example":"Arizona"},"Zip":{"type":"string","example":"7080"},"Lat":{"type":"string","example":null,"nullable":true},"Lon":{"type":"string","example":null,"nullable":true},"region.state":{"type":"string","example":"Arizona"},"region.Region":{"type":"string","example":"Northeast"},"Statename":{"type":"string","example":"Arizona"},"StateFullName":{"type":"string","example":"Arizona"},"Current ABR":{"type":"string","example":"30783.120000000003"},"Tenant Total Rent":{"type":"string","example":null,"nullable":true},"Full address":{"type":"string","example":"1310 Churchville Avenue Oak Tree Associates South Plainfield Arizona 7080"},"CountryId":{"type":"string","example":"5"},"LeaseExpirationYearlyMTMExpiredThereAfter1":{"type":"string","example":null,"nullable":true},"vacant Lease Status":{"type":"string","example":"Active"},"LEASE status":{"type":"string","example":"Active"},"Current Status":{"type":"string","example":"Active"},"UnitStatus":{"type":"string","example":"Active"},"Data Type":{"type":"string","example":"Active"},"PrimaryEngineer":{"type":"string","example":"Lawrence Battle"},"SecondaryEngineer":{"type":"string","example":"Pete Borges"},"CreatedLeaseExpirationDate":{"type":"string","format":"date","example":"2025-04-30"},"IsFinanciallyVacant":{"type":"string","example":"0"},"IsExclude":{"type":"string","example":"0"},"Team":{"type":"string","example":"NJ Office"},"OwnershipType":{"type":"string","example":"Legacy"},"EconomicHealth":{"type":"string","example":"Green"},"PropType":{"type":"string","example":"Commercial"}},"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getProcurements":{"get":{"tags":["Property Management"],"summary":"Get a list of Procurements from a Property Management","operationId":"getProcurements","parameters":[{"name":"AccessToken","in":"header","description":"Access token for authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Successfully fetched","content":{"application/json":{"schema":{"properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"properties":{"ProcurementDate":{"type":"string","format":"date","example":"2000-08-31"},"PropertyId":{"type":"string","example":"109"},"PropertyName":{"type":"string","example":"Estate Flux Properties"},"PropertyStatus":{"type":"string","example":"Active"},"PropertyList":{"type":"string","example":"Not associated"},"PropertyType":{"type":"string","example":"Commercial"},"Team":{"type":"string","example":"Greater Monmouth"},"OwnershipType":{"type":"string","example":"Legacy"},"EconomicHealth":{"type":"string","example":"Green"},"VendorID":{"type":"string","example":"atlan"},"VendorName":{"type":"string","example":"NAI Atlantic Coast Realty Advisory Group In"},"Amount":{"type":"string","example":"2175.0"},"AccountFullCode":{"type":"string","example":"630615"},"Description":{"type":"string","example":"Leasing Commissions"},"SubLedger":{"type":"string","example":""},"SubledgerType":{"type":"string","example":""},"PeriodNumber-GeneralLedger":{"type":"string","example":"8"},"Century":{"type":"string","example":"21"},"FiscalYear":{"type":"string","example":"01"},"PropertyState":{"type":"string","example":"Arizona"},"PropertyCity":{"type":"string","example":"Toms River"},"VendorState":{"type":"string","example":"Arizona"},"VendorCity":{"type":"string","example":"Toms River"},"Building Square Footage":{"type":"string","example":"101353.0"}},"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getMaintenanceTickets":{"get":{"tags":["Property Management"],"summary":"Get a list of Maintenance Tickets from a Property Management","operationId":"getMaintenanceTickets","parameters":[{"name":"AccessToken","in":"header","description":"Access token for authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Successfully fetched","content":{"application/json":{"schema":{"properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"properties":{"PropertyID":{"type":"string","example":"124"},"PropertyNumber":{"type":"string","example":"6102"},"PropertyName":{"type":"string","example":"Blue Properties"},"PropertyUnit":{"type":"string","example":"817"},"IssueType":{"type":"string","example":"Electrical"},"Issue":{"type":"string","example":"Office and Kitchen"},"IssueStatus":{"type":"string","example":"Work Completed"},"CallDate":{"type":"string","format":"date","example":"2024-07-29"}},"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getTenantDetails":{"get":{"tags":["Property Management"],"summary":"Get a list of Tenant Details from a Property Management","operationId":"getTenantDetails","parameters":[{"name":"AccessToken","in":"header","description":"Access token for authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Successfully fetched","content":{"application/json":{"schema":{"properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"properties":{"PropertyID":{"type":"string","example":"1"},"PropertyNumber":{"type":"string","example":"109"},"PropertyStatus":{"type":"string","example":"Active"},"PropertyName":{"type":"string","example":"Estate Flux Properties"},"LeaseType":{"type":"string","example":"Flex Net"},"RemainingLeaseTermMonth":{"type":"string","example":"0.0"},"LeaseExpirationDate":{"type":"string","format":"date","example":null},"UnitSquareFeet":{"type":"string","example":"1600.0"},"TenantName":{"type":"string","example":"Dennis, Baird and Garcia"},"As-OfDate#CalendarYear":{"type":"string","format":"date","example":"2024-02-29"},"SnPRating":{"type":"string","example":null},"CurrentlyMonthlyBaseRent":{"type":"string","example":"1733.333333"},"ABRPSF":{"type":"string","example":"12.9999999975"},"AmountOutStanding":{"type":"string","example":"473.82"},"PropertyType":{"type":"string","example":"Commercial"}},"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getDailyWeather":{"get":{"tags":["Property Management"],"summary":"Get a list of Daily Weather from a Property Management","operationId":"getDailyWeather","parameters":[{"name":"AccessToken","in":"header","description":"Access token for authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Successfully fetched","content":{"application/json":{"schema":{"properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"properties":{"Zipcode":{"type":"string","example":"11546"},"Latitude":{"type":"string","example":"24.67"},"Longitude":{"type":"string","example":"46.62"},"Date":{"type":"string","format":"date","example":"2024-08-07"},"Sunrise":{"type":"string","example":"05:24 AM"},"Sunset":{"type":"string","example":"06:33 PM"},"Temp":{"type":"string","example":"5.000000"},"FeelsLike":{"type":"string","example":"5.000000"},"Pressure":{"type":"string","example":"1000"},"Humidity%":{"type":"string","example":"6"},"DewPoint":{"type":"string","example":"-19.444444"},"WindSpeed":{"type":"string","example":"25"},"WindDirectionDegree":{"type":"string","example":"355"},"WindGust":{"type":"string","example":"29"},"Visibility":{"type":"string","example":"10"},"Weather":{"type":"string","example":"Partly Cloudy"},"Description":{"type":"string","example":"Partly Cloudy"},"Cloudiness%":{"type":"string","example":"57"},"UVIndex":{"type":"string","example":"10"},"CreatedDAte":{"type":"string","format":"datetime","example":"2024-08-07 13:00:10.150"},"RowNum":{"type":"string","example":"1"},"PropertyName":{"type":"string","example":"Towlan"}},"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getForecastWeather":{"get":{"tags":["Property Management"],"summary":"Get a list of Forecast Weather from a Property Management","operationId":"getForecastWeather","parameters":[{"name":"AccessToken","in":"header","description":"Access token for authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Successfully fetched","content":{"application/json":{"schema":{"properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"properties":{"Zipcode":{"type":"string","example":"11546"},"Latitude":{"type":"string","example":"24.67"},"Longitude":{"type":"string","example":"46.62"},"Date":{"type":"string","format":"date","example":"2024-08-22"},"Sunrise":{"type":"string","example":"05:31 AM"},"Sunset":{"type":"string","example":"06:21 PM"},"TempDay":{"type":"string","example":"2.777777"},"TempMin":{"type":"string","example":"-.555555"},"TempMax":{"type":"string","example":"6.111111"},"TempNight":{"type":"string","example":"2.777777"},"TempEvening":{"type":"string","example":"2.777777"},"TempMorning":{"type":"string","example":"2.777777"},"FeelsLikeDay":{"type":"string","example":"2.777777"},"FeelsLikeNight":{"type":"string","example":"2.777777"},"FeelsLikeEvening":{"type":"string","example":"2.777777"},"FeelsLikeMorning":{"type":"string","example":"2.777777"},"Pressure":{"type":"string","example":"null"},"Humidity%":{"type":"string","example":"27"},"DewPoint":{"type":"string","example":"null"},"WindSpeed":{"type":"string","example":"23"},"WindDirectionDegree":{"type":"string","example":"null"},"Weather":{"type":"string","example":"Sunny"},"Description":{"type":"string","example":"Sunny"},"Cloudiness%":{"type":"string","example":"N/A"},"ProbabilityOfPrecipitation":{"type":"string","example":"0"},"Rain":{"type":"string","example":"0"},"UVIndex":{"type":"string","example":"11"},"PropertyName":{"type":"string","example":"Towlan"},"RowNum":{"type":"string","example":"1"}},"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getHistoricalWeather":{"get":{"tags":["Property Management"],"summary":"Get a list of Historical Weather from a Property Management","operationId":"getHistoricalWeather","parameters":[{"name":"AccessToken","in":"header","description":"Access token for authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Successfully fetched","content":{"application/json":{"schema":{"properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"properties":{"PropertyName":{"type":"string","example":"Estate Flux Properties"},"Zipcode":{"type":"string","example":"15205"},"Latitude":{"type":"string","example":"40.436920000"},"Longitude":{"type":"string","example":"-80.063790000"},"Date":{"type":"string","format":"date","example":"2020-01-01"},"Sunrise":{"type":"string","example":"08:43 AM"},"Sunset":{"type":"string","example":"06:04 PM"},"Moonrise":{"type":"string","example":"12:49 PM"},"Moonset":{"type":"string","example":"No moonset"},"MoonPhase":{"type":"string","example":"Waxing Crescent"},"MoonIllumination":{"type":"string","example":"37"},"TempMax":{"type":"string","example":"35"},"TempMin":{"type":"string","example":"25"},"TempAvg":{"type":"string","example":"32"},"SnowInCm":{"type":"string","example":"2"},"SunHour":{"type":"string","example":"7"},"UVIndex":{"type":"string","example":"1"},"HourlyTempInFahrenheit":{"type":"string","example":"35"},"HourlyWindSpeedInKmph":{"type":"string","example":"17"},"HourlyWindDirectionDegree":{"type":"string","example":"257"},"WeatherDescription":{"type":"string","example":"Light snow showers"},"PrecipitationInMm":{"type":"string","example":"2"},"Humidity%":{"type":"string","example":"78"},"VisibilityInKm":{"type":"string","example":"8"},"PressureInMb":{"type":"string","example":"1012"},"Cloudiness%":{"type":"string","example":"69"},"HeatIndexInFahrenheit":{"type":"string","example":"31"},"DewPointInFahrenheit":{"type":"string","example":"25"},"WindGustInKmph":{"type":"string","example":"22"},"FeelsLikeInFahrenheit":{"type":"string","example":"23"},"Event":{"type":"string","example":"null"},"EventStartDate":{"type":"string","example":"null"},"EventEndDate":{"type":"string","example":"null"},"EventDescription":{"type":"string","example":"null"}},"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getWeatherAnomalies":{"get":{"tags":["Property Management"],"summary":"Get a list of Weather Anomalies from a Property Management","operationId":"getWeatherAnomalies","parameters":[{"name":"AccessToken","in":"header","description":"Access token for authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Successfully fetched","content":{"application/json":{"schema":{"properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"properties":{"AnomalyID":{"type":"integer","example":101},"PropertyName":{"type":"string","example":"Estate Flux Properties"},"Date":{"type":"string","format":"date","example":"2020-01-01"},"AnomalyType":{"type":"string","example":"Temperature Spike"},"Value":{"type":"string","example":"38"},"Description":{"type":"string","example":"Unexpected temperature spike recorded."},"Latitude":{"type":"string","example":"40.436920000"},"Longitude":{"type":"string","example":"-80.063790000"}},"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getCurrencyExchangeRates":{"get":{"tags":["Property Management"],"summary":"Get a list of Currency ExchangeRates from a Property Management","operationId":"getCurrencyExchangeRates","parameters":[{"name":"AccessToken","in":"header","description":"Access token for authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data Successfully fetched","content":{"application/json":{"schema":{"properties":{"current_page":{"type":"integer","example":1},"data":{"type":"array","items":{"properties":{"CountryName":{"type":"string","example":"United Arab Emirates (AED)"},"SourceCurrency":{"type":"string","example":"USD"},"TargetCurrencyCode":{"type":"string","example":"AED"},"TargetCurrencyName":{"type":"string","example":"United Arab Emirates Dirham"},"ClosingRate":{"type":"string","example":"3.6730354263759"},"CurrencySymbol":{"type":"string","example":"د.إ"},"CurrencyName":{"type":"string","example":"AED (Dirham)"},"CreatedDate":{"type":"string","format":"date-time","example":"2024-09-19 00:30:02.057"}},"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getAuthToken":{"post":{"tags":["Get Authentication Token"],"summary":"To Get AccessToken required for API calls","description":"Returns a token for authentication","operationId":"getAuthToken","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["email","password"],"properties":{"email":{"type":"string","format":"email","example":"user@example.com"},"password":{"type":"string","format":"password","example":"password123"}},"type":"object"}}}},"responses":{"200":{"description":"Successful login","content":{"application/json":{"schema":{"properties":{"email":{"type":"string","example":"user@example.com"},"password":{"type":"string","example":"password123"}},"type":"object"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Unauthorised."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getHistoricalWeatherData":{"post":{"tags":["Weather APIs"],"summary":"Get Historical Weather Data","operationId":"getHistoricalWeatherData","parameters":[{"name":"AccessToken","in":"header","description":"Access token received from getAuthToken API","required":true,"schema":{"type":"string","example":"Irb74OWsnY7UfxLaZJhSJSexc62Bqx1TDyBZEqb9ud4e1OZ5Yqc8eHEbAPglK3RpsxyuPrVIJbQMpSww"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["zipcode","startdate","enddate"],"properties":{"zipcode":{"description":"Postal code to get historical weather data","type":"string","example":"400051"},"startdate":{"description":"Start date for historical weather data","type":"string","format":"date","example":"2020-12-26"},"enddate":{"description":"End date for historical weather data","type":"string","format":"date","example":"2020-12-27"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"Zipcode":{"type":"string","example":"400051"},"Latitude":{"type":"string","example":"19.060189999999999"},"Longitude":{"type":"string","example":"72.865167999999997"},"Date":{"type":"string","example":"2020-12-26"},"Sunrise":{"type":"string","example":"07:10 AM"},"Sunset":{"type":"string","example":"06:09 PM"},"Moonrise":{"type":"string","example":"03:20 PM"},"Moonset":{"type":"string","example":"03:42 AM"},"MoonPhase":{"type":"string","example":"Waxing Gibbous"},"TempMax":{"type":"string","example":"29"},"TempMin":{"type":"string","example":"26"},"TempAvg":{"type":"string","example":"28"},"WeatherDescription":{"type":"string","example":"Partly cloudy"},"Humidity%":{"type":"string","example":"51"},"PressureInMb":{"type":"string","example":"1012"}},"type":"object"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Bad Request."},"code":{"type":"integer","example":401},"data":{"properties":{"error":{"type":"string","example":"Unauthorised"}},"type":"object"}},"type":"object"}}}}}}},"/api/getForecastWeatherData":{"post":{"tags":["Weather APIs"],"summary":"Get 7 days forecast weather data by postal code","operationId":"getForecastWeatherData","parameters":[{"name":"AccessToken","in":"header","description":"Access token obtained from getAuthToken API","required":true,"schema":{"type":"string","example":"Irb74OWsnY7UfxLaZJhSJSexc62Bqx1TDyBZEqb9ud4e1OZ5Yqc8eHEbAPglK3RpsxyuPrVIJbQMpSww"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["zipcode"],"properties":{"zipcode":{"description":"Postal code to fetch weather data","type":"string","example":"400051"}},"type":"object"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"Zipcode":{"type":"string","example":"400051"},"Latitude":{"type":"string","example":"19.06"},"Longitude":{"type":"string","example":"72.87"},"Date":{"type":"string","example":"2021-01-01"},"Sunrise":{"type":"string","example":"07:11 AM"},"Sunset":{"type":"string","example":"06:11 PM"},"TempDay":{"type":"string","example":"27.777777"},"TempMin":{"type":"string","example":"24.444444"},"TempMax":{"type":"string","example":"28.333333"},"TempNight":{"type":"string","example":"25.555555"},"TempEvening":{"type":"string","example":"27.222222"},"TempMorning":{"type":"string","example":"25.000000"},"FeelsLikeDay":{"type":"string","example":"28.888888"},"FeelsLikeNight":{"type":"string","example":"26.666666"},"Pressure":{"type":"string","example":"1013"},"Humidity%":{"type":"string","example":"48"},"WindSpeed":{"type":"string","example":"5"},"Weather":{"type":"string","example":"Clouds"},"Description":{"type":"string","example":"scattered clouds"},"UVIndex":{"type":"string","example":"7"}},"type":"object"}}}}},"401":{"description":"Unauthorized - Invalid AccessToken","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Invalid AccessToken"},"code":{"type":"integer","example":401}},"type":"object"}}}},"404":{"description":"No data found","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"No data found!"},"code":{"type":"integer","example":404}},"type":"object"}}}}}}},"/api/getCurrentWeatherData":{"post":{"tags":["Weather APIs"],"summary":"Get Current Weather Information by Zipcode","description":"Returns the current weather observation for a given postal code.","operationId":"getCurrentWeatherData","parameters":[{"name":"AccessToken","in":"header","description":"AccessToken obtained from getAuthToken API response","required":true,"schema":{"type":"string","example":"Irb74OWsnY7UfxLaZJhSJSexc62Bqx1TDyBZEqb9ud4e1OZ5Yqc8eHEbAPglK3RpsxyuPrVIJbQMpSww"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["zipcode"],"properties":{"zipcode":{"description":"Postal code to get weather data","type":"string","example":"400051"}},"type":"object"}}}},"responses":{"200":{"description":"Successful weather data retrieval or error response","content":{"application/json":{"schema":{"oneOf":[{"properties":{"success":{"type":"boolean","example":true},"data":{"properties":{"Zipcode":{"type":"string","example":"400051"},"Latitude":{"type":"string","example":"19.06"},"Longitude":{"type":"string","example":"72.87"},"Date":{"type":"string","format":"date","example":"2020-12-31"},"Sunrise":{"type":"string","example":"07:11 AM"},"Sunset":{"type":"string","example":"06:11 PM"},"Temp":{"type":"string","example":"27.777777"},"FeelsLike":{"type":"string","example":"29.444444"},"Pressure":{"type":"string","example":"1010"},"Humidity%":{"type":"string","example":"58"},"DewPoint":{"type":"string","example":"18.888888"},"WindSpeed":{"type":"string","example":"9"},"WindDirectionDegree":{"type":"string","example":"330"},"Visibility":{"type":"string","example":"22"},"Weather":{"type":"string","example":"Smoke"},"Description":{"type":"string","example":"smoke"},"Cloudiness%":{"type":"string","example":"88"},"CreatedDAte":{"type":"string","format":"date-time","example":"2020-12-31 14:00:07.053"},"RowNum":{"type":"string","example":"1"}},"type":"object"},"message":{"type":"string","example":"User login successfully."},"code":{"type":"integer","example":200}},"type":"object"},{"properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"No data found!"},"code":{"type":"integer","example":200},"data":{"properties":{"error":{"type":"string","example":"No data found!"}},"type":"object"}},"type":"object"}]}}}}}}}},"tags":[{"name":"Credit Ratings","description":"Credit Ratings"},{"name":"Property Management","description":"Property Management"},{"name":"Get Authentication Token","description":"Get Authentication Token"},{"name":"Weather APIs","description":"Weather APIs"}]}