90 lines
3.4 KiB
C#
90 lines
3.4 KiB
C#
using Microsoft.AspNetCore.Mvc;
|
||
using Persistence.Models;
|
||
|
||
namespace Persistence.API;
|
||
|
||
/// <summary>
|
||
/// Интерфейс для работы с API журнала изменений
|
||
/// </summary>
|
||
public interface IChangeLogApi
|
||
{
|
||
/// <summary>
|
||
/// Получение данных на текущую дату
|
||
/// </summary>
|
||
/// <param name="idDiscriminator"></param>
|
||
/// <param name="token"></param>
|
||
/// <returns></returns>
|
||
Task<ActionResult<IEnumerable<DataWithWellDepthAndSectionDto>>> GetCurrent(Guid idDiscriminator, CancellationToken token);
|
||
|
||
/// <summary>
|
||
/// Получение данных на определенную дату
|
||
/// </summary>
|
||
/// <param name="idDiscriminator"></param>
|
||
/// <param name="moment"></param>
|
||
/// <param name="token"></param>
|
||
/// <returns></returns>
|
||
Task<ActionResult<IEnumerable<DataWithWellDepthAndSectionDto>>> GetByDate(Guid idDiscriminator, DateTimeOffset moment, CancellationToken token);
|
||
|
||
/// <summary>
|
||
/// Получение исторических данных за определенный период времени
|
||
/// </summary>
|
||
/// <param name="idDiscriminator"></param>
|
||
/// <param name="dateBegin"></param>
|
||
/// <param name="dateEnd"></param>
|
||
/// <param name="token"></param>
|
||
/// <returns></returns>
|
||
Task<ActionResult<IEnumerable<ChangeLogDto>>> GetChangeLogForDate(Guid idDiscriminator, DateTimeOffset dateBegin, DateTimeOffset dateEnd, CancellationToken token);
|
||
|
||
/// <summary>
|
||
/// Добавить одну запись
|
||
/// </summary>
|
||
/// <param name="idDiscriminator"></param>
|
||
/// <param name="dto"></param>
|
||
/// <param name="token"></param>
|
||
/// <returns></returns>
|
||
Task<ActionResult<int>> Add(Guid idDiscriminator, DataWithWellDepthAndSectionDto dto, CancellationToken token);
|
||
|
||
/// <summary>
|
||
/// Добавить несколько записей
|
||
/// </summary>
|
||
/// <param name="idDiscriminator"></param>
|
||
/// <param name="dtos"></param>
|
||
/// <param name="token"></param>
|
||
/// <returns></returns>
|
||
Task<ActionResult<int>> AddRange(Guid idDiscriminator, IEnumerable<DataWithWellDepthAndSectionDto> dtos, CancellationToken token);
|
||
|
||
/// <summary>
|
||
/// Обновить одну запись
|
||
/// </summary>
|
||
/// <param name="idDiscriminator"></param>
|
||
/// <param name="dto"></param>
|
||
/// <param name="token"></param>
|
||
/// <returns></returns>
|
||
Task<ActionResult<int>> Update(Guid idDiscriminator, DataWithWellDepthAndSectionDto dto, CancellationToken token);
|
||
|
||
/// <summary>
|
||
/// Обновить несколько записей
|
||
/// </summary>
|
||
/// <param name="idDiscriminator"></param>
|
||
/// <param name="dtos"></param>
|
||
/// <param name="token"></param>
|
||
/// <returns></returns>
|
||
Task<ActionResult<int>> UpdateRange(Guid idDiscriminator, IEnumerable<DataWithWellDepthAndSectionDto> dtos, CancellationToken token);
|
||
|
||
/// <summary>
|
||
/// Удалить одну запись
|
||
/// </summary>
|
||
/// <param name="id"></param>
|
||
/// <param name="token"></param>
|
||
/// <returns></returns>
|
||
Task<ActionResult<int>> Delete(Guid id, CancellationToken token);
|
||
|
||
/// <summary>
|
||
/// Удалить несколько записей
|
||
/// </summary>
|
||
/// <param name="ids"></param>
|
||
/// <param name="token"></param>
|
||
/// <returns></returns>
|
||
Task<ActionResult<int>> DeleteRange(IEnumerable<Guid> ids, CancellationToken token);
|
||
}
|