{"endpoints":[{"name":"Report","description":"
Contains the endpoints to get detailed information and functions about Reports<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/reports","Synopsis":"
Creates a report<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"A report object"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getMaintenanceChecklist","MethodName":"MaintenanceChecklist","HTTPMethod":"GET","URI":"\/reports\/maintenancechecklist","Synopsis":"
Retrieves maintenance checklist from survey.json file<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/reports","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/reports","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/reports","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/reports\/:id","Synopsis":"
Retrieves a report<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/reports\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/reports\/:id","Synopsis":"
Deletes a report<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetPreview","MethodName":"Preview","HTTPMethod":"GET","URI":"\/reports\/:id\/preview","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetReportByType","MethodName":"ReportByType","HTTPMethod":"GET","URI":"\/reports\/:id\/reportbytype","Synopsis":"
Retrieves a report on its proper class object<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostEmail","MethodName":"Email","HTTPMethod":"POST","URI":"\/reports\/:id\/email","Synopsis":"
Sends reports email<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostCorrigo","MethodName":"Corrigo","HTTPMethod":"POST","URI":"\/reports\/:id\/corrigo","Synopsis":"
Sends reports email<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostJlreport","MethodName":"Jlreport","HTTPMethod":"POST","URI":"\/reports\/:id\/jlreport","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\Report","fielddocs":[{"name":"creation_date","type":"int","doc":"\n"},{"name":"report_type","type":"string","doc":"\n"},{"name":"name","type":"string","doc":"\n"},{"name":"state","type":"string","doc":"\n"},{"name":"unit_ids","type":"array","doc":"\n"},{"name":"user_id","type":"string","doc":"\n"},{"name":"user_ini_time","type":"int","doc":"\n"},{"name":"user_end_time","type":"int","doc":"\n"}]}]},{"name":"Unit","description":"
Contains the endpoints to get detailed information and functions about Units<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/units","Synopsis":"
Creates a unit<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"A unit object"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getBleTags","MethodName":"BleTags","HTTPMethod":"GET","URI":"\/units\/bletags","Synopsis":"
Retrieve all the units that have a major and minor id<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getIsUsedQRCode","MethodName":"IsUsedQRCode","HTTPMethod":"GET","URI":"\/units\/isusedqrcode","Synopsis":"
Search for a unit quit a QR code set<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getUnitByQRCode","MethodName":"UnitByQRCode","HTTPMethod":"GET","URI":"\/units\/unitbyqrcode","Synopsis":"
Search for a unit quit a QR code set<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getUnitWarranties","MethodName":"UnitWarranties","HTTPMethod":"GET","URI":"\/units\/unitwarranties","Synopsis":"
Retrieves all the warranties from a given unit id<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getEquipmentInspection","MethodName":"EquipmentInspection","HTTPMethod":"GET","URI":"\/units\/equipmentinspection","Synopsis":"
Search for an unfinished equipment inspection (authorized == FALSE)<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"postVerifyCorrigoWo","MethodName":"VerifyCorrigoWo","HTTPMethod":"POST","URI":"\/units\/verifycorrigowo","Synopsis":"
json should be passed in in the following form<\/p>\n\n
{\n \"wo_number\": string\n}\n<\/code><\/pre>\n","parameters":[{"Name":"wo_number","Type":"string","Location":"body","Required":"Y","Description":"json object containing a corrigo work order number"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/units","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/units","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/units","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/units\/:id","Synopsis":"Retrieves a unit<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/units\/:id","Synopsis":"
Updates a unit<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The unit object to be updated"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/units\/:id","Synopsis":"
Deletes a unit<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostPictures","MethodName":"Pictures","HTTPMethod":"POST","URI":"\/units\/:id\/pictures","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetReports","MethodName":"Reports","HTTPMethod":"GET","URI":"\/units\/:id\/reports","Synopsis":"
Retrieves unit reports<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetUnitArchivedReports","MethodName":"UnitArchivedReports","HTTPMethod":"GET","URI":"\/units\/:id\/unitarchivedreports","Synopsis":"
Retrieves archived unit reports<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetReportsCount","MethodName":"ReportsCount","HTTPMethod":"GET","URI":"\/units\/:id\/reportscount","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetReportsNameCount","MethodName":"ReportsNameCount","HTTPMethod":"GET","URI":"\/units\/:id\/reportsnamecount","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostPhotos","MethodName":"Photos","HTTPMethod":"POST","URI":"\/units\/:id\/photos","Synopsis":"
Saves photos and notes of a unit.<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetPhotos","MethodName":"Photos","HTTPMethod":"GET","URI":"\/units\/:id\/photos","Synopsis":"
Gets the photos and notes of a unit<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetLatestReports","MethodName":"LatestReports","HTTPMethod":"GET","URI":"\/units\/:id\/latestreports","Synopsis":"
Gets the unit latest reports<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostRemoveFromSiteRequest","MethodName":"RemoveFromSiteRequest","HTTPMethod":"POST","URI":"\/units\/:id\/removefromsiterequest","Synopsis":"
Removes the unit from its site's in progress request<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostAddToSiteRequest","MethodName":"AddToSiteRequest","HTTPMethod":"POST","URI":"\/units\/:id\/addtositerequest","Synopsis":"
Adds the unit to its site's in progress request<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetPicturesFe","MethodName":"PicturesFe","HTTPMethod":"GET","URI":"\/units\/:id\/picturesfe","Synopsis":"
Gets pictures of a unit for Fieldequipt<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostPicturesFe","MethodName":"PicturesFe","HTTPMethod":"POST","URI":"\/units\/:id\/picturesfe","Synopsis":"
Save pictures of a unit for field equipt app<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\Unit","fielddocs":[{"name":"capacity","type":"string","doc":"\n"},{"name":"date_created","type":"int","doc":"\n"},{"name":"manufactured_year","type":"int","doc":"\n"},{"name":"in_manufactured_year","type":"int","doc":"\n"},{"name":"out_manufactured_year","type":"int","doc":"\n"},{"name":"model_id","type":"string","doc":"\n"},{"name":"model_description","type":"string","doc":"\n"},{"name":"rated_eer","type":"string","doc":"\n"},{"name":"run_time","type":"string","doc":"\n"},{"name":"serial_number","type":"string","doc":"\n"},{"name":"site_id","type":"string","doc":"\n"},{"name":"status","type":"string","doc":"\n"},{"name":"tag","type":"string","doc":"\n"},{"name":"user_id","type":"string","doc":"\n"},{"name":"unit_type","type":"string","doc":"\n"},{"name":"full_model_number","type":"string","doc":"\n"},{"name":"in_manufacturer","type":"string","doc":"\n"},{"name":"in_model_number","type":"string","doc":"\n"},{"name":"in_serial_number","type":"string","doc":"\n"},{"name":"manufacturer","type":"string","doc":"\n"},{"name":"meter_device","type":"string","doc":"\n"},{"name":"model_number","type":"string","doc":"\n"},{"name":"out_manufacturer","type":"string","doc":"\n"},{"name":"out_model_number","type":"string","doc":"\n"},{"name":"out_serial_number","type":"string","doc":"\n"},{"name":"eva_coil_manufacturer","type":"string","doc":"\n"},{"name":"eva_coil_model_number","type":"string","doc":"\n"},{"name":"eva_coil_serial_number","type":"string","doc":"\n"},{"name":"qr_code_1","type":"string","doc":"\n"},{"name":"qr_code_2","type":"string","doc":"\n"},{"name":"target_sc_value","type":"string","doc":"\n"},{"name":"raw_target_sc_value","type":"string","doc":"\n"},{"name":"target_sh_table","type":"string","doc":"\n"},{"name":"target_sh_value","type":"string","doc":"\n"},{"name":"raw_target_sh_value","type":"string","doc":"\n"},{"name":"cooling","type":"string","doc":"\n"},{"name":"cooling_airflow","type":"string","doc":"\n"},{"name":"heating_airflow","type":"string","doc":"\n"},{"name":"compressors","type":"int","doc":"\n"},{"name":"power_phase","type":"int","doc":"\n"},{"name":"condenser_fans","type":"int","doc":"\n"},{"name":"picture","type":"string","doc":"\n"},{"name":"raw_picture","type":"string","doc":"\n"},{"name":"in_picture","type":"string","doc":"\n"},{"name":"raw_in_picture","type":"string","doc":"\n"},{"name":"out_picture","type":"string","doc":"\n"},{"name":"raw_out_picture","type":"string","doc":"\n"},{"name":"beacon_major_id","type":"string","doc":"\n"},{"name":"beacon_minor_id","type":"string","doc":"\n"},{"name":"beacon_major_id_2","type":"string","doc":"\n"},{"name":"beacon_minor_id_2","type":"string","doc":"\n"},{"name":"heat_type","type":"string","doc":"\n"},{"name":"furnace_type","type":"string","doc":"\n"},{"name":"thermal_heat","type":"string","doc":"\n"},{"name":"electric_heat","type":"string","doc":"\n"},{"name":"decommissioned_date","type":"int","doc":"\n"},{"name":"SC_AreaId","type":"string","doc":"\n"},{"name":"SC_ProblemType","type":"string","doc":"\n"},{"name":"SC_EquipmentType","type":"string","doc":"\n"},{"name":"has_requests","type":"bool","doc":"\n"}]}]},{"name":"ServiceSchedules","description":"
Contains the endpoints to get detailed information and functions about Service schedules<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/serviceschedules","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/serviceschedules","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/serviceschedules","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/serviceschedules","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/serviceschedules\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/serviceschedules\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/serviceschedules\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]}],"models":[{"name":"ad\\decom\\ServiceSchedules","fielddocs":[{"name":"name","type":"string","doc":"\n"}]}]},{"name":"PaymentType","description":"
Contains the endpoints to get detailed information and functions about Payment Types<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/paymenttypes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/paymenttypes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/paymenttypes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/paymenttypes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/paymenttypes\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/paymenttypes\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/paymenttypes\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]}],"models":[{"name":"ad\\decom\\PaymentType","fielddocs":[{"name":"name","type":"string","doc":"\n"}]}]},{"name":"ADModel","description":"
Contains the endpoints to get detailed information and functions about Models<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/models","Synopsis":"
Creates a model<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"A model object"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/models","Synopsis":"
Retrieves all models<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"getSearch","MethodName":"Search","HTTPMethod":"GET","URI":"\/models\/search","Synopsis":"
Retrieves models coincidences according model number and manufacturer id<\/p>\n","parameters":[{"Name":"model_number","Type":"string","Location":"url","Required":"Y","Description":"Model number"},{"Name":"manufacturer_id","Type":"string","Location":"url","Required":"Y","Description":"Manufacturer id"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/models","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/models","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/models\/:id","Synopsis":"
Retrieves a model<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/models\/:id","Synopsis":"
Updates a model<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The model object to be updated"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/models\/:id","Synopsis":"
Deletes a model<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]}],"models":[{"name":"ad\\decom\\ADModel","fielddocs":[{"name":"date_created","type":"int","doc":"\n"},{"name":"is_verified","type":"bool","doc":"\n"},{"name":"manufacturer","type":"string","doc":"\n"},{"name":"manufacturer_id","type":"string","doc":"\n"},{"name":"model_number","type":"string","doc":"\n"},{"name":"requested_by","type":"string","doc":"\n"},{"name":"indirect_air","type":"array","doc":"\n"},{"name":"status","type":"string","doc":"\n"}]}]},{"name":"LiveLookInSession","description":"
Contains the endpoints to get detailed information and functions about Live Look In Sessions<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/livelookin","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getMembersLiveSession","MethodName":"MembersLiveSession","HTTPMethod":"GET","URI":"\/livelookin\/memberslivesession","Synopsis":"
Retrieves all the live look in sessions that the current user can see.\nA user can see a live look in session if the unit is in a site that belongs in a team, and if\nthe user has an account membershipt to that team<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/livelookin","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/livelookin","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/livelookin","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/livelookin\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/livelookin\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/livelookin\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\LiveLookInSession","fielddocs":[{"name":"unit_id","type":"string","doc":"\n"}]}]},{"name":"User","description":"
Manages the endpoints for the User model. This includes creating a new user using a POST to the collection, and\ngetting, updating and deleting the user information.<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/users","Synopsis":"
Creates a new user.\nOverrides the entire post method from the parent class because the password\nlength validation shouldn't be here anymore. Adds an email format validation instead<\/p>\n","parameters":[{"Name":"user","Type":"string","Location":"body","Required":"Y","Description":"A user object to create in the database"},{"Name":"SESSION","Required":"N","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"postForgotPassword","MethodName":"ForgotPassword","HTTPMethod":"POST","URI":"\/users\/forgotpassword","Synopsis":"
json should be passed in in the following form<\/p>\n\n
{\n \"email\": string\n}\n<\/code><\/pre>\n","parameters":[{"Name":"email","Type":"string","Location":"body","Required":"Y","Description":"json object containing a user's email"},{"Name":"SESSION","Required":"N","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getWorkOrderNumber","MethodName":"WorkOrderNumber","HTTPMethod":"GET","URI":"\/users\/workordernumber","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"N","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getInvoiceNumber","MethodName":"InvoiceNumber","HTTPMethod":"GET","URI":"\/users\/invoicenumber","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"N","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getCompanyUsers","MethodName":"CompanyUsers","HTTPMethod":"GET","URI":"\/users\/companyusers","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"N","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"postCheckConnection","MethodName":"CheckConnection","HTTPMethod":"POST","URI":"\/users\/checkconnection","Synopsis":"return random data<\/p>\n","parameters":[{"Name":"SESSION","Required":"N","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getClampMeterTags","MethodName":"ClampMeterTags","HTTPMethod":"GET","URI":"\/users\/clampmetertags","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"N","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"postClampMeterTags","MethodName":"ClampMeterTags","HTTPMethod":"POST","URI":"\/users\/clampmetertags","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"N","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"deleteClampMeterTags","MethodName":"ClampMeterTags","HTTPMethod":"DELETE","URI":"\/users\/clampmetertags","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"N","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getPermissions","MethodName":"Permissions","HTTPMethod":"GET","URI":"\/users\/permissions","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"N","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"postUpgradeAccountEmail","MethodName":"UpgradeAccountEmail","HTTPMethod":"POST","URI":"\/users\/upgradeaccountemail","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"N","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/users\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/users\/:id","Synopsis":"
Updates a user<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"A user object"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/users\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetSites","MethodName":"Sites","HTTPMethod":"GET","URI":"\/users\/:id\/sites","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\User","fielddocs":[{"name":"username","type":"string","doc":"\n"},{"name":"access","type":"array","doc":"\n"},{"name":"reporting_company_id","type":"string","doc":"\n"},{"name":"subinventory","type":"string","doc":"\n"},{"name":"phone","type":"string","doc":"\n"},{"name":"report_email","type":"string","doc":"\n"},{"name":"bt_customer_id","type":"string","doc":"\n"},{"name":"bt_subscription_id","type":"string","doc":"\n"},{"name":"account_id","type":"string","doc":"
Used on FP to identify to which account\nthe user belongs to.<\/p>\n"},{"name":"account_owner","type":"bool","doc":"
Whether the user is owner of the account\nor not.<\/p>\n"},{"name":"confirmpassword","type":"string","doc":"
Used to confirm password on the UI.\nShould NOT be inserted into the database.<\/p>\n"},{"name":"defaultteamid","type":"string","doc":"
Used to get the default team id.\nShould NOT be inserted into the database.<\/p>\n"},{"name":"equipment_category","type":"array","doc":"
The equipment categories the user has access to.<\/p>\n"},{"name":"qbo_config","type":"array","doc":"\n"},{"name":"userId","type":"string","doc":"\n"},{"name":"created","type":"\\DateTime","doc":"
When the user was created<\/p>\n"},{"name":"lastAccessed","type":"\\DateTime","doc":"
When the user was last accessed<\/p>\n"},{"name":"firstName","type":"string","doc":"
First name of the user<\/p>\n"},{"name":"lastName","type":"string","doc":"
Last name of the user<\/p>\n"},{"name":"email","type":"string","doc":"
Email address of the user<\/p>\n"},{"name":"password","type":"string","doc":"
A plaintext transmission of the user's password. Should only be sent when creating or updating the password. Will\nalways be returned as NULL. Passwords must be at least 6 characters long and are stored as secured hashes.<\/p>\n"},{"name":"newSessionId","type":"string","doc":"
A session id that is only filled when creating a new user, so that they may authenticate immediately.<\/p>\n"}]}]},{"name":"ProblemCode","description":"
Manages the endpoints that encompass all elements of the work order details,\nwhich include, but are not limited to, the blanket authorization of location,\ntime record, status, instructions and call to action for a work order.<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/problemcodes","Synopsis":"
Retrieves all the problem codes from an specific unit (sc_equipment_type)<\/p>\n","parameters":[{"Name":"unit_id","Type":"string","Location":"query","Required":"Y","Description":"Unit id"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/problemcodes","Synopsis":"
Deny access to default CRUD endpoints<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/problemcodes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/problemcodes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/problemcodes\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/problemcodes\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/problemcodes\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}]},{"name":"Warranty","description":"
Contains the endpoints to get detailed information and functions about Warranties<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/warranties","Synopsis":"
Creates a warranty<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"A site object"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/warranties","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/warranties","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/warranties","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/warranties\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/warranties\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/warranties\/:id","Synopsis":"
Deletes a warranty. Overrides the default warranty delete functionality, now it will perform a logic delete.<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]}],"models":[{"name":"ad\\decom\\Warranty","fielddocs":[{"name":"unit_id","type":"string","doc":"\n"},{"name":"part_id","type":"string","doc":"\n"},{"name":"warranty_period","type":"int","doc":"\n"},{"name":"labor_period","type":"int","doc":"\n"},{"name":"labor_provider","type":"string","doc":"\n"},{"name":"date_created","type":"int","doc":"\n"},{"name":"service_company","type":"array","doc":"\n"},{"name":"part","type":"array","doc":"\n"}]}]},{"name":"UnitType","description":"
Contains the endpoints to get detailed information and functions about equipment types<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/unittypes","Synopsis":"
Returns equipment types by application and user access<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/unittypes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/unittypes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/unittypes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/unittypes\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/unittypes\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/unittypes\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\UnitType","fielddocs":[{"name":"unit_type","type":"string","doc":"\n"},{"name":"label","type":"string","doc":"\n"},{"name":"category_id","type":"string","doc":"\n"}]}]},{"name":"Time","description":"
Contains the endpoints to get detailed information and functions about Promised Times<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/times","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/times","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/times","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/times","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/times\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/times\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/times\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]}],"models":[{"name":"ad\\decom\\Time","fielddocs":[{"name":"name","type":"string","doc":"\n"}]}]},{"name":"PriorityLevel","description":"
Contains the endpoints to get detailed information and functions about Priority levels<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/prioritylevels","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/prioritylevels","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/prioritylevels","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/prioritylevels","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/prioritylevels\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/prioritylevels\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/prioritylevels\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]}],"models":[{"name":"ad\\decom\\PriorityLevel","fielddocs":[{"name":"name","type":"string","doc":"\n"}]}]},{"name":"Manufacturer","description":"
Contains the endpoints to get detailed information and functions about Manufacturers<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/manufacturers","Synopsis":"
Creates a manufacturer<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"A manufacturer object"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/manufacturers","Synopsis":"
Retrieves all manufacturers<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/manufacturers","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/manufacturers","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/manufacturers\/:id","Synopsis":"
Retrieves a manufacturer<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/manufacturers\/:id","Synopsis":"
Updates a manufacturer<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The manufacturer object to be updated"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/manufacturers\/:id","Synopsis":"
Deletes a manufacturer<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetModels","MethodName":"Models","HTTPMethod":"GET","URI":"\/manufacturers\/:id\/models","Synopsis":"
Retrieves all models which belong to a manufacturer<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\Manufacturer","fielddocs":[{"name":"name","type":"string","doc":"\n"},{"name":"is_verified","type":"bool","doc":"\n"},{"name":"requested_by","type":"string","doc":"\n"},{"name":"date_created","type":"int","doc":"\n"},{"name":"category","type":"unknown","doc":"
var array<\/p>\n"},{"name":"status","type":"unknown","doc":"
var string<\/p>\n"}]}]},{"name":"JobType","description":"
Contains the endpoints to get detailed information and functions about Job Types<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/jobtypes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/jobtypes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/jobtypes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/jobtypes","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/jobtypes\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/jobtypes\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/jobtypes\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]}],"models":[{"name":"ad\\decom\\JobType","fielddocs":[{"name":"name","type":"string","doc":"\n"},{"name":"access","type":"array","doc":"\n"}]}]},{"name":"UnitName","description":"
Contains the endpoints to get detailed information and functions about unit names<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/unitnames","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/unitnames","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/unitnames","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/unitnames","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/unitnames\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/unitnames\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/unitnames\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]}],"models":[{"name":"ad\\decom\\UnitName","fielddocs":[{"name":"name","type":"string","doc":"\n"}]}]},{"name":"TimeCard","description":"
Contains the endpoints to get detailed information and functions about Time Cards<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/timecards","Synopsis":"
Creates a time card entry<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"A time card object"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/timecards","Synopsis":"
Return user time cards<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/timecards","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/timecards","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/timecards\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/timecards\/:id","Synopsis":"
Updates a time card<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The time card object to be updated"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/timecards\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]}],"models":[{"name":"ad\\decom\\TimeCard","fielddocs":[{"name":"date_created","type":"int","doc":"\n"},{"name":"user_id","type":"string","doc":"\n"},{"name":"check_in","type":"int","doc":"\n"},{"name":"check_out","type":"int","doc":"\n"},{"name":"tag","type":"string","doc":"\n"},{"name":"media","type":"string","doc":"
nfc or qr<\/p>\n"}]}]},{"name":"Session","description":"
Manages the endpoints for the maintaining authenticated sessions for Users. These are required for many\ncalls that secure user information or must identify the user. The endpoints include creating a new session\nusing a POST to the collection, and getting, updating and deleting extra session information.\nAuthenticating into the API is analogous to creating a new session, as logging out of the API is analogous to\ndeleting the session.\nThere is no expiration mechanism built into the sessions, but this can be done in a custom implementation.<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/sessions","Synopsis":"
Creates a session. A valid email and password of an existing user must be passed in, and the new session\n(with the session id) will be returned.\n~~~\nGet sessions through email password\n{\n \"email\": string,\n \"password\": string\n}\nor get one time session to reset password\n{\n \"email\": string,\n \"authToken\": string\n}<\/p>\n","parameters":[{"Name":"session","Type":"string","Location":"body","Required":"Y","Description":"A session object (with email & password or email & authToken filled in)"},{"Name":"SESSION","Required":"N","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/sessions\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/sessions\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/sessions\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\Session","fielddocs":[{"name":"access_token","type":"String","doc":"\n"},{"name":"subscriber_access","type":"array","doc":"\n"},{"name":"sessionId","type":"string","doc":"
Identifies the authenticated session. This id is included in the request header for various endpoints\nto identify which session the client is using.<\/p>\n"},{"name":"userId","type":"string","doc":"
The ID of the user which this session is authenticated for<\/p>\n"},{"name":"user","type":"\\MABI\\Identity\\User","doc":"
The full user object which this session is authenticated for. This is only returned when creating a session\nso that an extra request does not need to be made to the User controller. This is most likely wasteful for other\nrequests so only the userId field is filled.<\/p>\n"},{"name":"email","type":"string","doc":"
The email that is used to authenticate the user. This should only be filled for incoming POSTs to create\nnew sessions. Otherwise it will always be NULL.<\/p>\n"},{"name":"password","type":"string","doc":"
The plaintext password that is used to authenticate the user. This should only be filled for incoming POSTs\nto create new sessions. Otherwise it will always be NULL.<\/p>\n"},{"name":"authToken","type":"string","doc":"
The plaintext password that is used to authenticate the user. This should only be filled for incoming POSTs\nto create new sessions. Otherwise it will always be NULL.<\/p>\n"}]}]},{"name":"RepairReport","description":"
Contains the endpoints to get detailed information and functions about Repair Reports (Jobs and Work Orders)<\/p>\n","methods":[{"InternalMethodName":"getWorkOrders","MethodName":"WorkOrders","HTTPMethod":"GET","URI":"\/repairs\/workorders","Synopsis":"
Retrieves work orders based on the user's profile<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/repairs","Synopsis":"
Creates a report<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"A report object"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getMaintenanceChecklist","MethodName":"MaintenanceChecklist","HTTPMethod":"GET","URI":"\/repairs\/maintenancechecklist","Synopsis":"
Retrieves maintenance checklist from survey.json file<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/repairs","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/repairs","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/repairs","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/repairs\/:id","Synopsis":"
Retrieves a report<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/repairs\/:id","Synopsis":"
Updates a repair report<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"A repair report object"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/repairs\/:id","Synopsis":"
Deletes a report<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPutStartService","MethodName":"StartService","HTTPMethod":"PUT","URI":"\/repairs\/:id\/startservice","Synopsis":"
Starts a Service Requests, sets all the necessary states and returns\nthe site the service belongs to<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetPreview","MethodName":"Preview","HTTPMethod":"GET","URI":"\/repairs\/:id\/preview","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetReportByType","MethodName":"ReportByType","HTTPMethod":"GET","URI":"\/repairs\/:id\/reportbytype","Synopsis":"
Retrieves a report on its proper class object<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostEmail","MethodName":"Email","HTTPMethod":"POST","URI":"\/repairs\/:id\/email","Synopsis":"
Sends reports email<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostCorrigo","MethodName":"Corrigo","HTTPMethod":"POST","URI":"\/repairs\/:id\/corrigo","Synopsis":"
Sends reports email<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostJlreport","MethodName":"Jlreport","HTTPMethod":"POST","URI":"\/repairs\/:id\/jlreport","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\RepairReport","fielddocs":[{"name":"raw_invoice_1","type":"string","doc":"\n"},{"name":"data","type":"array","doc":"\n"},{"name":"creation_date","type":"int","doc":"\n"},{"name":"report_type","type":"string","doc":"\n"},{"name":"name","type":"string","doc":"\n"},{"name":"state","type":"string","doc":"\n"},{"name":"unit_ids","type":"array","doc":"\n"},{"name":"user_id","type":"string","doc":"\n"},{"name":"user_ini_time","type":"int","doc":"\n"},{"name":"user_end_time","type":"int","doc":"\n"}]}]},{"name":"Jl2Connection","description":"
Contains the endpoints to get detailed information and functions about Jl2 Connections<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/jl2connections","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/jl2connections","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/jl2connections","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/jl2connections","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/jl2connections\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/jl2connections\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/jl2connections\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]}],"models":[{"name":"ad\\decom\\Jl2Connection","fielddocs":[{"name":"unit_id","type":"string","doc":"\n"},{"name":"user_id","type":"string","doc":"\n"},{"name":"serialNumber","type":"string","doc":"\n"},{"name":"platform","type":"string","doc":"\n"},{"name":"creation_date","type":"int","doc":"\n"}]}]},{"name":"Invoice","description":"
Contains the endpoints to get detailed information and functions about Invoices<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/invoices","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/invoices","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/invoices","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/invoices","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/invoices\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/invoices\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/invoices\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"restPostEmail","MethodName":"Email","HTTPMethod":"POST","URI":"\/invoices\/:id\/email","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]}],"models":[{"name":"ad\\decom\\Invoice","fielddocs":[{"name":"title","type":"string","doc":"\n"},{"name":"number","type":"string","doc":"\n"},{"name":"site_id","type":"string","doc":"\n"},{"name":"user_id","type":"string","doc":"\n"},{"name":"creation_date","type":"int","doc":"\n"},{"name":"state","type":"string","doc":"\n"},{"name":"signature","type":"string","doc":"\n"},{"name":"services","type":"array","doc":"\n"},{"name":"photos","type":"array","doc":"\n"},{"name":"captions","type":"array","doc":"\n"},{"name":"payment_notes","type":"string","doc":"\n"},{"name":"qbo_invoice_id","type":"int","doc":"\n"}]}]},{"name":"Account","description":"
Contains the endpoints to get detailed information and functions about Accounts<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/accounts","Synopsis":"
Retrieves user account information<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getMeasurementunits","MethodName":"Measurementunits","HTTPMethod":"GET","URI":"\/accounts\/measurementunits","Synopsis":"
Retrieves the account's measurement units<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/accounts","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/accounts","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/accounts","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/accounts\/:id","Synopsis":"
Retrieves all the account information<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/accounts\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/accounts\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPutUnits","MethodName":"Units","HTTPMethod":"PUT","URI":"\/accounts\/:id\/units","Synopsis":"
Updates the measurement unit the user will use in the app<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\Account","fielddocs":[{"name":"name","type":"string","doc":"\n"},{"name":"contractor_license","type":"string","doc":"\n"},{"name":"address","type":"string","doc":"\n"},{"name":"phone_number","type":"string","doc":"\n"},{"name":"fax_number","type":"string","doc":"\n"},{"name":"email","type":"string","doc":"\n"},{"name":"website","type":"string","doc":"\n"},{"name":"status","type":"string","doc":"\n"},{"name":"type","type":"string","doc":"
The account type (single or multiple)<\/p>\n"},{"name":"logo","type":"string","doc":"\n"},{"name":"pressure_unit","type":"string","doc":"\n"},{"name":"temperature_unit","type":"string","doc":"\n"},{"name":"altitude","type":"int","doc":"
By default we use sea level value<\/p>\n"},{"name":"raw_altitude","type":"int","doc":"\n"},{"name":"length_unit","type":"string","doc":"\n"},{"name":"enthalpy_unit","type":"string","doc":"\n"},{"name":"capacity_unit","type":"string","doc":"\n"},{"name":"terms_conditions","type":"string","doc":"\n"}]}]},{"name":"Company","description":"
Contains the endpoints to get detailed information and functions about Companies<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/companies","Synopsis":"
Overrides Company creation<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"A Company object"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"getServiceCompanies","MethodName":"ServiceCompanies","HTTPMethod":"GET","URI":"\/companies\/servicecompanies","Synopsis":"
Retrieve all the companies marked as service companies<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/companies","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/companies","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/companies","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/companies\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/companies\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/companies\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"}]}],"models":[{"name":"ad\\decom\\Company","fielddocs":[{"name":"id","type":"string","doc":"\n"},{"name":"name","type":"string","doc":"\n"},{"name":"address","type":"string","doc":"\n"},{"name":"email","type":"string","doc":"\n"},{"name":"phone","type":"string","doc":"\n"},{"name":"is_service_company","type":"bool","doc":"\n"},{"name":"is_verified","type":"bool","doc":"\n"},{"name":"requested_by","type":"string","doc":"\n"},{"name":"service_company_ids","type":"array","doc":"\n"},{"name":"secondary_email","type":"string","doc":"\n"},{"name":"external_token","type":"array","doc":"
Array of token used to authenticate to external services<\/p>\n"}]}]},{"name":"Site","description":"
Contains the endpoints to get detailed information and functions about Sites<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/sites","Synopsis":"
Creates a site<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"A site object"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/sites","Synopsis":"
Retrieves all sites for the authenticated user<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"getCounterUnitsInSites","MethodName":"CounterUnitsInSites","HTTPMethod":"GET","URI":"\/sites\/counterunitsinsites","Synopsis":"
Retrieves the number of units in each site<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/sites","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/sites","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/sites\/:id","Synopsis":"
Retrieves a site<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/sites\/:id","Synopsis":"
Updates a site<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The site object to be updated"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/sites\/:id","Synopsis":"
Deletes a site<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPutChangeStatus","MethodName":"ChangeStatus","HTTPMethod":"PUT","URI":"\/sites\/:id\/changestatus","Synopsis":"
Change the status of a site to opened or completed<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"status","Type":"string","Location":"body","Required":"Y","Description":"New site's status wrapped in json"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetUnits","MethodName":"Units","HTTPMethod":"GET","URI":"\/sites\/:id\/units","Synopsis":"
Retrieves site's units<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetSiteRequests","MethodName":"SiteRequests","HTTPMethod":"GET","URI":"\/sites\/:id\/siterequests","Synopsis":"
Retrieves site's requests<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetInvoices","MethodName":"Invoices","HTTPMethod":"GET","URI":"\/sites\/:id\/invoices","Synopsis":"
Retrieves site's invoices<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostReport","MethodName":"Report","HTTPMethod":"POST","URI":"\/sites\/:id\/report","Synopsis":"
Sends Site report email for FE<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\Site","fielddocs":[{"name":"building_name","type":"string","doc":"\n"},{"name":"date_created","type":"int","doc":"\n"},{"name":"distance_to_coast","type":"string","doc":"\n"},{"name":"status","type":"string","doc":"\n"},{"name":"address","type":"string","doc":"\n"},{"name":"zip_code","type":"string","doc":"\n"},{"name":"owner_ids","type":"array","doc":"\n"},{"name":"invoice_number","type":"string","doc":"\n"},{"name":"customer_name","type":"string","doc":"\n"},{"name":"email","type":"string","doc":"\n"},{"name":"phone_number","type":"string","doc":"\n"},{"name":"requests_count","type":"int","doc":"\n"},{"name":"last_accessed","type":"date","doc":"\n"},{"name":"units_count","type":"int","doc":"\n"},{"name":"team_ids","type":"array","doc":"\n"}]}]},{"name":"FastMeasurementsReport","description":"
Contains the endpoints to get detailed information and functions about Reports<\/p>\n","methods":[{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/fastmeasurementsreports","Synopsis":"
Creates a report<\/p>\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"A report object"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/fastmeasurementsreports","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/fastmeasurementsreports","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/fastmeasurementsreports","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/fastmeasurementsreports\/:id","Synopsis":"
Retrieves a report<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/fastmeasurementsreports\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/fastmeasurementsreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPostEmail","MethodName":"Email","HTTPMethod":"POST","URI":"\/fastmeasurementsreports\/:id\/email","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\FastMeasurementsReport","fielddocs":[{"name":"creation_date","type":"int","doc":"\n"},{"name":"state","type":"string","doc":"\n"},{"name":"user_id","type":"string","doc":"\n"},{"name":"data","type":"array","doc":"\n"},{"name":"thermal_heat","type":"string","doc":"\n"},{"name":"target_sc_value","type":"string","doc":"\n"},{"name":"target_sh_value","type":"string","doc":"\n"},{"name":"meter_device","type":"string","doc":"\n"},{"name":"target_sh_table","type":"string","doc":"\n"},{"name":"cooling_airflow","type":"string","doc":"\n"},{"name":"heating_airflow","type":"string","doc":"\n"},{"name":"rt_refrigerant","type":"string","doc":"\n"}]}]},{"name":"ServiceType","description":"\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/servicetypes","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/servicetypes","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/servicetypes","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/servicetypes","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/servicetypes\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/servicetypes\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/servicetypes\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"Team","description":"
Contains the endpoints to get detailed information and functions about Teams<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/teams","Synopsis":"
Retrieves all teams for current user<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/teams","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/teams","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/teams","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/teams\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/teams\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/teams\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetMembers","MethodName":"Members","HTTPMethod":"GET","URI":"\/teams\/:id\/members","Synopsis":"
Retrieves all members for the current team<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\Team","fielddocs":[{"name":"name","type":"string","doc":"\n"},{"name":"owner_id","type":"string","doc":"\n"},{"name":"default","type":"boolean","doc":"\n"}]}]},{"name":"Survey","description":"
Contains the endpoints to get detailed information and functions about Surveys<\/p>\n","methods":[{"InternalMethodName":"getPmInspections","MethodName":"PmInspections","HTTPMethod":"GET","URI":"\/surveys\/pminspections","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/surveys","Synopsis":"
Returns surveys for the authenticated user by unit type<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/surveys","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/surveys","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/surveys","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/surveys\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/surveys\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/surveys\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\Survey","fielddocs":[{"name":"name","type":"string","doc":"\n"},{"name":"questions","type":"array","doc":"\n"},{"name":"unit_type_id","type":"string","doc":"\n"},{"name":"type","type":"string","doc":"\n"}]}]},{"name":"Notification","description":"
Contains the endpoints to get detailed information and functions about Teams<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/notifications","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/notifications","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/notifications","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/notifications","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/notifications\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/notifications\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/notifications\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restPutRead","MethodName":"Read","HTTPMethod":"PUT","URI":"\/notifications\/:id\/read","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\Notification","fielddocs":[{"name":"user_id","type":"string","doc":"\n"},{"name":"created_by","type":"string","doc":"\n"},{"name":"icon","type":"string","doc":"\n"},{"name":"body","type":"string","doc":"\n"},{"name":"action_text","type":"string","doc":"\n"},{"name":"action_url","type":"string","doc":"\n"},{"name":"read","type":"boolean","doc":"\n"},{"name":"created_at","type":"int","doc":"\n"},{"name":"type","type":"string","doc":"\n"},{"name":"display_date","type":"string","doc":"\n"}]}]},{"name":"EquipmentCategory","description":"
Contains the endpoints to get detailed information and functions about equipment categories<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/equipmentcategories","Synopsis":"
Returns equipment types by application and user access<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/equipmentcategories","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/equipmentcategories","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/equipmentcategories","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/equipmentcategories\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/equipmentcategories\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/equipmentcategories\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"restGetUnitTypes","MethodName":"UnitTypes","HTTPMethod":"GET","URI":"\/equipmentcategories\/:id\/unittypes","Synopsis":"
Retrieves all the unit types from an equipment category<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\EquipmentCategory","fielddocs":[{"name":"label","type":"string","doc":"\n"},{"name":"category_type","type":"string","doc":"\n"},{"name":"equipment_category","type":"string","doc":"\n"},{"name":"access","type":"string","doc":"\n"}]}]},{"name":"Part","description":"
Contains the endpoints to get detailed information and functions about Parts<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/parts","Synopsis":"
Overrides RESTModelController::get<\/p>\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/parts","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/parts","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/parts","Synopsis":"\n","parameters":[{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/parts\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/parts\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/parts\/:id","Synopsis":"
Deletes a part<\/p>\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"},{"Name":"SESSION","Required":"Y","Type":"string","Location":"header","Description":"A guid that identifies the current logged in session (the session id when you create a session)"},{"Name":"shared-secret","Required":"N","Type":"string","Location":"header","Description":"The guid that identifies which application is attempting to access this endpoint. Only\n the application itself and the internal API should be able to see this value, therefore, it should always\n be transmitted over HTTPs."}]}],"models":[{"name":"ad\\decom\\Part","fielddocs":[{"name":"name","type":"string","doc":"\n"},{"name":"number","type":"string","doc":"\n"},{"name":"unit_types","type":"array","doc":"\n"},{"name":"manufacturer","type":"string","doc":"\n"},{"name":"supply_manager_category","type":"string","doc":"\n"},{"name":"requested_by","type":"string","doc":"\n"},{"name":"is_verified","type":"bool","doc":"\n"},{"name":"date_created","type":"int","doc":"\n"},{"name":"status","type":"string","doc":"\n"},{"name":"company_id","type":"int","doc":"\n"},{"name":"first_name","type":"string","doc":"\n"},{"name":"last_name","type":"string","doc":"\n"},{"name":"badge_number","type":"string","doc":"\n"},{"name":"email","type":"string","doc":"\n"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/subscriptions","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/subscriptions","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/subscriptions","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/subscriptions","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/subscriptions\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/subscriptions\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/subscriptions\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/equipmentinspectionreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/equipmentinspectionreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/equipmentinspectionreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/equipmentinspectionreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/equipmentinspectionreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/equipmentinspectionreports\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/equipmentinspectionreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/clampmetertags","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/clampmetertags","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/clampmetertags","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/clampmetertags","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/clampmetertags\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/clampmetertags\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/clampmetertags\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/recommendationreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/recommendationreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/recommendationreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/recommendationreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/recommendationreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/recommendationreports\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/recommendationreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/defaultreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/defaultreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/defaultreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/defaultreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/defaultreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/defaultreports\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/defaultreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/assessmentreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/assessmentreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/assessmentreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/assessmentreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/assessmentreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/assessmentreports\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/assessmentreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/accountmemberships","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/accountmemberships","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/accountmemberships","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/accountmemberships","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/accountmemberships\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/accountmemberships\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/accountmemberships\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/jlreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/jlreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/jlreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/jlreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/jlreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/jlreports\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/jlreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/photos","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/photos","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/photos","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/photos","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/photos\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/photos\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/photos\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/teammemberships","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/teammemberships","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/teammemberships","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/teammemberships","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/teammemberships\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/teammemberships\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/teammemberships\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/measurementreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/measurementreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/measurementreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/measurementreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/measurementreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/measurementreports\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/measurementreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/notereports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/notereports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/notereports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/notereports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/notereports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/notereports\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/notereports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/checklists","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/checklists","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/checklists","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/checklists","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/checklists\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/checklists\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/checklists\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/picturereportves","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/picturereportves","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/picturereportves","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/picturereportves","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/picturereportves\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/picturereportves\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/picturereportves\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/picturereports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/picturereports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/picturereports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/picturereports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/picturereports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/picturereports\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/picturereports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]},{"name":"RESTModel","description":"
todo: docs<\/p>\n","methods":[{"InternalMethodName":"get","MethodName":"Get Full Collection","HTTPMethod":"GET","URI":"\/surveyreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"post","MethodName":"Add to Collection","HTTPMethod":"POST","URI":"\/surveyreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"put","MethodName":"Replace Full Collection","HTTPMethod":"PUT","URI":"\/surveyreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"delete","MethodName":"Delete Full Collection","HTTPMethod":"DELETE","URI":"\/surveyreports","Synopsis":"\n","parameters":[]},{"InternalMethodName":"_restGetResource","MethodName":"Get Resource","HTTPMethod":"GET","URI":"\/surveyreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restPutResource","MethodName":"Update Resource","HTTPMethod":"PUT","URI":"\/surveyreports\/:id","Synopsis":"\n","parameters":[{"Name":"body","Type":"string","Location":"body","Required":"Y","Description":"The object to update in the database"},{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]},{"InternalMethodName":"_restDeleteResource","MethodName":"Delete Resource","HTTPMethod":"DELETE","URI":"\/surveyreports\/:id","Synopsis":"\n","parameters":[{"Name":"id","Required":"Y","Type":"string","Location":"url","Description":"The id of the resource"}]}]}]}