ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

Links

API	Description
GET api/Links/GetAllACTLinks	Fetch all ACT links
POST api/Links/UpdateACTLink	Update existing ACT Links
POST api/Links/CreateACTLink	Add new ACT link
GET api/Links/GetAllNSWLinks	Fetch all NSW links
POST api/Links/UpdateNSWLink	Update existing NSW Link
POST api/Links/CreateNSWLink	Add new NSW link
POST api/Links	No documentation available.

Contacts

The contact controller.

API	Description
GET api/Contacts/GetAllAsync?page={page}&per_page={per_page}	The get all contact async.
POST api/Contacts/CreateContact	The create contact.
PATCH api/Contacts/ChangePassword?userId={userId}&password={password}	The change password.
PATCH api/Contacts/AddSystemUserToContact?id={id}	The create system user from existing contact. assigning roles and permission to the user to give him/her right to access to the EMOS system.
PATCH api/Contacts/UpdateSystemUser?id={id}	The update system user.
DELETE api/Contacts/ArchiveUser/{id}	No documentation available.
POST api/Contacts/Notify/{id}	The notify user.
GET api/Contacts/IsUserExistInProvider?email={email}	The is email exist. (check whether user existence with user provider
GET api/Contacts/IsContactEmailExist?email={email}	The is email exist.
GET api/Contacts/GetByUserId?userId={userId}	Get By User Id.
GET api/Contacts/GetContactByEmail?email={email}	No documentation available.
GET api/Contacts/GetByContactIdAsync?id={id}	The get by contact id async.
GET api/Contacts/Search?keyword={keyword}&page={page}&per_page={per_page}	The search contact by keyword.
GET api/Contacts/SearchAsync?keyword={keyword}&page={page}&per_page={per_page}	The search contact by keyword async.
GET api/Contacts/SearchByDefaultRole?defaultRole={defaultRole}&page={page}&per_page={per_page}	The search by default role.
GET api/Contacts/SearchByDefaultRoleAsync?defaultRole={defaultRole}&page={page}&per_page={per_page}	The search by default role async.
GET api/Contacts/GetContactsByEoc?eocId={eocId}	The get EOC address book.
GET api/Contacts/GetUsersByEoc?eocId={eocId}	The get users by EOC.
GET api/Contacts/GetEocsByUser?userId={userId}&typeKey={typeKey}	The get EOCs by user.
GET api/Contacts/GetEocTreeViewByUser?userId={userId}&contactId={contactId}	The Get EOCs tree view by user.
GET api/Contacts/GetUserRoles?userId={userId}	The get user roles.
PATCH api/Contacts/AddToAddressBook?contactId={contactId}	The add contact to address book.
GET api/Contacts/GetContactLEMC?contactId={contactId}	The get contact LEMC.
GET api/Contacts/GetInternetContactTypes	The get Internet Contact types.
GET api/Contacts/GetAccessLevelTypes	The get Access Level Types
GET api/Contacts/GetPhoneTypes	The get Phone types.
GET api/Contacts/GetAddressTypes	The get Address types.
POST api/Contacts	No documentation available.
GET api/Contacts?page={page}&per_page={per_page}	The get all contacts. (excluded deleted ones, )
DELETE api/Contacts/{id}	The delete contact.
PUT api/Contacts	The update.
GET api/Contacts/{id}	The get by contact id.

DistributionList

The distributionlist controller.

API	Description
POST api/distributionList/CreateDistributionList	add distribution list.
POST api/distributionList/UpdateDistributionList	Update distribution list.
GET api/distributionList/GetDistributionListById?distributionListId={distributionListId}	Get Distribution list my Id
GET api/DistributionList	Get Distribution List
DELETE api/DistributionList/{id}	Delete Distribution List
GET api/DistributionList?eocId={eocId}	Check user is Sys admin Or Admin of specific eoc
POST api/DistributionList	No documentation available.

Notifications

API	Description
POST api/notifications/CreateOnDemandNotification	CreateOnDemandNotification - Creates OnDemand Notifications
GET api/notifications/GetOnDemandNotifications	Get list of On Demand notifications
GET api/notifications/GetOnDemandNotificationById?notificationId={notificationId}	Get list of On Demand notifications
GET api/notifications/GetMyNotifications	CreateOnDemandNotification - Creates OnDemand Notifications
GET api/notifications/GetAllNotificationReplies?notificationId={notificationId}	GetOperationTaskComments
POST api/notifications/AddNotificationReplies	The add replies entry.
GET api/notifications/GetNotificationsForReportsToApprove	CreateOnDemandNotification - Creates OnDemand Notifications
GET api/notifications/GetMyUnNoticedNotifications	CreateOnDemandNotification - Creates OnDemand Notifications
GET api/notifications/GetNotification?notificationId={notificationId}	CreateOnDemandNotification - Creates OnDemand Notifications
PUT api/Notifications	CreateOnDemandNotification - Creates OnDemand Notifications
POST api/Notifications	No documentation available.

Eocs

The EOC controller.

API	Description
POST api/Eocs/CreateEOC	The create EOC.
GET api/Eocs/Search?keyword={keyword}	The search.
GET api/Eocs/Search?keyword={keyword}&page={page}&per_page={per_page}	The search by EOC name.
GET api/Eocs/GetSubEocs/{parentEocId}?allLevelDeep={allLevelDeep}	The get sub eocs.
PATCH api/Eocs/ChangeEocName?id={id}&eocName={eocName}	The change EOC name.
PATCH api/Eocs/ChangeEocType?id={id}&eocTypeKey={eocTypeKey}	The change eoc type.
GET api/eocs/GetEocStatusList	The get operation types.
GET api/eocs/GetEocTypeList	The get EOC type list.
GET api/eocs/GetEocDocuments/{eocId}	The get all eoc documents.
POST api/eocs/UploadEocDocuments?eocId={eocId}	The upload eoc documents.
PATCH api/eocs/RemoveEocDocuments	The remove eoc documents.
GET api/Eocs/{id}	The get.
GET api/Eocs?page={page}&per_page={per_page}	The get EOCs.
PUT api/Eocs	The update.
DELETE api/Eocs/{id}	The delete.
POST api/Eocs	No documentation available.

Agencies

The agency controller.

API	Description
POST api/Agencies/CreateAgency	The create agency.
GET api/Agencies/Search?keyword={keyword}&page={page}&per_page={per_page}	The search. (Name and Company)
PATCH api/Agencies/ChangeAgencyName?id={id}&name={name}	The change agency name.
GET api/Agencies/{id}	The get by agency id.
GET api/Agencies?page={page}&per_page={per_page}	The get all.
PUT api/Agencies	The update agency.
DELETE api/Agencies/{id}	The delete agency.
POST api/Agencies	No documentation available.

Audit

The agency controller.

API	Description
POST api/Audit/CreateAuditEntry	The create agency.
GET api/Audit/{id}	The get by agency id.
GET api/Audit?page={page}&per_page={per_page}	The get all.
POST api/Audit	No documentation available.

Permissions

The permissions controller.

API	Description
GET api/permissions/newlog?operationId={operationId}	The new log.
GET api/Permissions	The get.
POST api/Permissions	No documentation available.

OperationRoles

The contact controller.

API	Description
GET api/OperationRoles/{name}	The search operation role by name.
POST api/OperationRoles/Create	The create operation role.
GET api/OperationRoles/GetRoleCategoryTypes	The get Access Level Types
GET api/OperationRoles/GetRolesByCategory?name={name}	GetRolesByCategory
GET api/OperationRoles	The get all operation roles.
GET api/OperationRoles/{id}	The get.
DELETE api/OperationRoles/{id}	The delete operation role.
PUT api/OperationRoles	Update Operational Role
POST api/OperationRoles	No documentation available.

Operations

The contact controller.

API	Description
POST api/operations/CreateOperations	The create operation.
GET api/operations/SetOperationEditModeOld/{opId}	SetOperationEditMode
PATCH api/operations/SetOperationEditMode?opId={opId}&isEditing={isEditing}	Update IsEditing flag value of operation
PUT api/operations/UpdateOperationRoles	The update.
PUT api/operations/DeleteOperationRoles	The update.
POST api/operations/UpdateOperationMap	Update Operation Map Details only
POST api/operations/UpdateOperationLog	The update operation log.
POST api/operations/AppendChildLogEntry	The attach child log entry.
POST api/operations/AddTaskCommentEntry	The add task comment entry.
GET api/operations/GetOperationLogChildByParentReferenceNumber?parentLogEntryReference={parentLogEntryReference}	The get operation log child by parent reference number.
GET api/operations/GetAllTaskComments?taskId={taskId}	GetOperationTaskComments
GET api/operations/GetAllOperationDetails	The get all operation details.
GET api/operations/Search?keyword={keyword}&page={page}&per_page={per_page}	The search.
GET api/operations/SearchByKeyword?keyword={keyword}	Searches keyword in all the non-closed operations
GET api/operations/GetAllActiveOperations?page={page}&per_page={per_page}	The get all active operation.
GET api/operations/GetActiveOperationsForMenu?page={page}&per_page={per_page}	The latest active operations. 3 operations by default
PATCH api/operations/CloseOperation?operationId={operationId}&messageLog={messageLog}	The close operation.
PATCH api/operations/ReopenOperation?operationId={operationId}&messageLog={messageLog}	The reopen operation.
POST api/operations/AddLogEntryOnOperation	The add log entry on operation.
GET api/operations/GetOperationLogByRefNumber?logReferenceNumber={logReferenceNumber}	The get operation log by ref number.
GET api/operations/GetAllActiveOperationsByEOC?eocId={eocId}	The get all active operations by eoc.
GET api/operations/GetAllActiveOperationsForUser/{userId}	The get all active operations for user.
GET api/operations/GetLogEntryTypes	The get log entry types.
GET api/operations/GetPriorityTypes	The get list of priority type
GET api/operations/GetReliabilityTypes	The get reliability types.
GET api/operations/GetCommunicationMethodTypes	The get communication method types.
GET api/operations/GetOperationTypes	The get operation types.
POST api/operations/AddTaskEntryOnOperation	The add Task entry on operation.
GET api/operations/GetTaskStatusTypes	Get Status Types for Tasks
GET api/operations/GetTaskCompletionReasonTypes	Get Task completion reason code types
GET api/operations/GetTaskReassignmentReasonTypes	Get Task Reassignment Reason Types
GET api/operations/GetOperationTaskDetailsById?taskId={taskId}	Get OperationTask by TaskID
GET api/operations/GetOperationRolesByUserId?operationId={operationId}&userId={userId}	Get operation role detail by userId
GET api/operations/GetOperationTaskLogDetailsById?operatioTaskLogId={operatioTaskLogId}	Get operation task Log detail by TaskLogID
POST api/operations/UpdateOperationTask	Update task entry
GET api/operations/GetOperationDetailsByTaskId?taskId={taskId}	Get Operation by TaskID
GET api/operations/GetMyTaskByUserId/{userId}	GetMyTaskByUserId
GET api/operations/GetTasksToApproveByUserId?userId={userId}	GetTasksToApproveByUserId
GET api/operations/IsUserAuthorizedForApprovalOfTask?userId={userId}&taskId={taskId}	IsUserAuthorizedForApprovalOfTask
POST api/operations/CreateSituationReport	Create Situation Report
GET api/operations/GetSituationReportDetailsById/{situationReportId}	GetSituationReportDetailsById
POST api/operations/UpdateSituationReport	UpdateSituationReport
POST api/operations/CreateImpactAssessmentReport	CreateImpactAssessmentReport
GET api/operations/GetIAReportDetailsById/{reportId}	GetIAReportDetailsById
POST api/operations/UpdateImpactAssessmentReport	UpdateImpactAssessmentReport
POST api/operations/CreateEmergencyActionPlanReport	CreateEAPReport
GET api/operations/GetEmergencyActionPlanReportDetailsById/{reportId}	GetEmergencyActionPlanReportDetailsById
POST api/operations/UpdateEmergencyActionPlanReport	Update EAP Report
POST api/operations/CreateAfterActionreviewReport	CreateAfterActionReviewReport
GET api/operations/GetAfterActionReviewReportDetailsById/{reportId}	GetAARReportDetailsById
POST api/operations/UpdateAfterActionReviewReport	UpdateImpactAssessmentReport
GET api/operations/IsUserAuthorizedForApprovalOfReport?userId={userId}&eocId={eocId}	IsUserAuthorizedForApprovalOfReport
GET api/operations/CopMapFetchData	CopMapFetchData
PATCH api/operations/CheckOverdueTasks	Check for the undue tasks for logged in user If Undue tasks are found then change the status of the task and create a notification
GET api/operations/CanArchiveUser?contactFullName={contactFullName}&contactId={contactId}&userId={userId}
PUT api/Operations	The update.
GET api/Operations	The get all.
GET api/Operations/{id}	The get operation by id.
DELETE api/Operations/{id}	Delete OperationTask
POST api/Operations	No documentation available.

Documents

The contact controller.

API	Description
GET api/Documents/{id}	The get.
POST api/Documents	No documentation available.