Class OwnOrderDimensionsV2026_2Controller

Dziedziczenie
object
ApiController
AdvancedApiController
OwnOrderDimensionsController
OwnOrderDimensionsV2026_1Controller
OwnOrderDimensionsV2026_2Controller
Implementuje
Odziedziczone składowe
Namespace: Sage.PL.WebAPI.Module.OwnOrders.Controllers.V2026_2
Assembly: Sage.PL.WebAPI.Module.OwnOrders.dll
Składnia
[ApiVersion(2026.2, null)]
[AuthorizeSession]
[ExceptionLogHandling]
[ControllerName("OwnOrderDimensions")]
public class OwnOrderDimensionsV2026_2Controller : OwnOrderDimensionsV2026_1Controller, IOwnOrderDimensionsController

Konstruktory

OwnOrderDimensionsV2026_2Controller(IMessageBus, ILogService, IOwnOrderDimensionService, IOwnOrderAspectService)

Deklaracja
public OwnOrderDimensionsV2026_2Controller(IMessageBus messageBus, ILogService logService, IOwnOrderDimensionService ownOrderDimensionService, IOwnOrderAspectService ownOrderAspectService)
Parametry
Typ Nazwa Opis
IMessageBus messageBus
ILogService logService
IOwnOrderDimensionService ownOrderDimensionService
IOwnOrderAspectService ownOrderAspectService

Metody

Get(DocumentSourceEnum, string)

Pobiera wymiary zamówienia własnego po numerze z uwzględnieniem źródła dokumentu.

Deklaracja
[HttpGet]
[WebApiRoute("{source:regex((?i)^(Issued|FromBuffer)$)}/{*orderNumber}", true, true)]
[SwaggerResponse(HttpStatusCode.OK, null, typeof(List<Dimension>))]
[SwaggerResponse(HttpStatusCode.NotFound, Description = "W przypadku gdy nie odnaleziono żądanego zamówienia własnego.")]
public virtual IHttpActionResult Get(DocumentSourceEnum source, string orderNumber)
Parametry
Typ Nazwa Opis
DocumentSourceEnum source

Źródło dokumentu; przyjmowane wartości: Issued lub FromBuffer.
string orderNumber

Numer zamówienia własnego.
Zwraca
Typ Opis
IHttpActionResult

Zwraca listę wymiarów Dimension.

Get(string, bool)

Metoda umożliwia pobranie listy pól własnych zamówienia własnego o podanym numerze dokumentu.

[GET] /api/OwnOrderDimensions?orderNumber=numer_zamówienia

Deklaracja
[NonAction]
[ApiExplorerSettings(IgnoreApi = true)]
public override IHttpActionResult Get(string orderNumber, bool buffer = false)
Parametry
Typ Nazwa Opis
string orderNumber

[FromUri] Numer dokumentu zamówienia własnego.
bool buffer

[FromUri] Czy dokument znajduje się w buforze. W przypadku, gdy parametr nie zostanie podany zostanie pobrana lista pól własnych zamówienia własnego o podanym numerze dokumentu, które nie znajduje się w buforze.
Zwraca
Typ Opis
IHttpActionResult

Zwraca kolekcję obiektów Dimension.
Nadpisuje

GetAspects(DocumentSourceEnum, string)

Pobiera aspekty zamówienia własnego po numerze z uwzględnieniem źródła dokumentu.

Deklaracja
[HttpGet]
[WebApiRoute("Aspects/{source:regex((?i)^(Issued|FromBuffer)$)}/{*orderNumber}", true, true)]
[SwaggerResponse(HttpStatusCode.OK, null, typeof(AspectDocument))]
[SwaggerResponse(HttpStatusCode.NotFound, "W przypadku gdy nie odnaleziono żądanego zamówienia własnego.", null)]
public virtual IHttpActionResult GetAspects(DocumentSourceEnum source, string orderNumber)
Parametry
Typ Nazwa Opis
DocumentSourceEnum source

Źródło dokumentu; przyjmowane wartości: Issued lub FromBuffer.
string orderNumber

Numer zamówienia własnego.
Zwraca
Typ Opis
IHttpActionResult

Zwraca dokument aspektów AspectDocument.

GetAspects(string, bool)

Metoda umożliwia pobranie wymiarów pozycji zamówienia własnego o podanym numerze dokumentu.

[GET] /api/OwnOrderDimensions/Aspects?orderNumber=numer_zamówienia

Deklaracja
[NonAction]
[ApiExplorerSettings(IgnoreApi = true)]
public override IHttpActionResult GetAspects(string orderNumber, bool buffer = false)
Parametry
Typ Nazwa Opis
string orderNumber

[FromUri] Id zamówienia własnego.
bool buffer

[FromUri] Czy dokument znajduje się w buforze. W przypadku, gdy parametr nie zostanie podany zostaną pobrane wymiary pozycji zamówienia własnego o podanym numerze dokumentu, które nie znajduje się w buforze.
Zwraca
Typ Opis
IHttpActionResult

Zwraca obiekt AspectDocument.
Nadpisuje

GetPositionsByOrderNumber(DocumentSourceEnum, string)

Pobiera wymiary pozycji zamówienia własnego po numerze z uwzględnieniem źródła dokumentu.

Deklaracja
[HttpGet]
[WebApiRoute("Positions/{source:regex((?i)^(Issued|FromBuffer)$)}/{*orderNumber}", true, true)]
[SwaggerResponse(HttpStatusCode.OK, null, typeof(List<PositionDimension>))]
[SwaggerResponse(HttpStatusCode.NotFound, Description = "W przypadku gdy nie odnaleziono żądanego zamówienia własnego.")]
public virtual IHttpActionResult GetPositionsByOrderNumber(DocumentSourceEnum source, string orderNumber)
Parametry
Typ Nazwa Opis
DocumentSourceEnum source

Źródło dokumentu; przyjmowane wartości: Issued lub FromBuffer.
string orderNumber

Numer zamówienia własnego.
Zwraca
Typ Opis
IHttpActionResult

Zwraca listę wymiarów pozycji PositionDimension.

GetPositionsByOrderNumber(string, bool)

Metoda umożliwia pobranie listy pól własnych pozycji zamówienia własnego o podanym numerze dokumentu. Metoda niedostępna dla WebAPI H50c.

[GET] /api/OwnOrderDimensions/Positions?orderNumber=numer_zamówienia

Deklaracja
[NonAction]
[ApiExplorerSettings(IgnoreApi = true)]
public override IHttpActionResult GetPositionsByOrderNumber(string orderNumber, bool buffer = false)
Parametry
Typ Nazwa Opis
string orderNumber

[FromUri] Numer dokumentu zamówienia własnego.
bool buffer

[FromUri] Czy dokument znajduje się w buforze. W przypadku, gdy parametr nie zostanie podany zostanie pobrana lista pól własnych pozycji zamówienia własnego o podanym numerze dokumentu, które nie znajduje się w buforze.
Zwraca
Typ Opis
IHttpActionResult

Zwraca kolekcję obiektów PositionDimension.
Nadpisuje

Update(DocumentSourceEnum, string, Dimension)

Aktualizuje wymiar zamówienia własnego po numerze z uwzględnieniem źródła dokumentu.

Deklaracja
[HttpPut]
[WebApiRoute("Update/{source:regex((?i)^(Issued|FromBuffer)$)}/{*orderNumber}", true, true)]
[ValidateModelState]
[SwaggerResponse(HttpStatusCode.Created, null, typeof(ResponseMessageResult))]
[SwaggerResponse(HttpStatusCode.NotFound, "W przypadku gdy nie odnaleziono żądanego zamówienia własnego.", null)]
[SwaggerResponse(HttpStatusCode.BadRequest, "W przypadku gdy model jest niepoprawny. W przypadku gdy nastąpi błąd wykonania procedury SQL", null)]
public virtual IHttpActionResult Update(DocumentSourceEnum source, string orderNumber, Dimension orderDimension)
Parametry
Typ Nazwa Opis
DocumentSourceEnum source

Źródło dokumentu; przyjmowane wartości: Issued lub FromBuffer.
string orderNumber

Numer zamówienia własnego.
Dimension orderDimension

Dane wymiaru do aktualizacji.
Zwraca
Typ Opis
IHttpActionResult

Zwraca HTTP 201 Created w przypadku powodzenia.

Update(DocumentSourceEnum, string, List<Dimension>)

Aktualizuje listę wymiarów zamówienia własnego po numerze z uwzględnieniem źródła dokumentu.

Deklaracja
[HttpPut]
[WebApiRoute("UpdateList/{source:regex((?i)^(Issued|FromBuffer)$)}/{*orderNumber}", true, true)]
[ValidateModelState]
[SwaggerResponse(HttpStatusCode.Created, null, typeof(ResponseMessageResult))]
[SwaggerResponse(HttpStatusCode.NotFound, "W przypadku gdy nie odnaleziono żądanego zamówienia własnego.", null)]
[SwaggerResponse(HttpStatusCode.BadRequest, "W przypadku gdy model jest niepoprawny. W przypadku gdy nastąpi błąd wykonania procedury SQL", null)]
public virtual IHttpActionResult Update(DocumentSourceEnum source, string orderNumber, List<Dimension> orderDimensions)
Parametry
Typ Nazwa Opis
DocumentSourceEnum source

Źródło dokumentu; przyjmowane wartości: Issued lub FromBuffer.
string orderNumber

Numer zamówienia własnego.
List<Dimension> orderDimensions

Lista wymiarów do aktualizacji.
Zwraca
Typ Opis
IHttpActionResult

Zwraca HTTP 201 Created w przypadku powodzenia.

Update(string, Dimension, bool)

Metoda umożliwia aktualizacje pola własnego zamówienia własnego o podanym kodzie dla zamówienia własnego o podanym numerze dokumentu.

[PUT] /api/OwnOrderDimensions/Update?orderNumber=numer_zamówienia

Deklaracja
[NonAction]
[ApiExplorerSettings(IgnoreApi = true)]
public override IHttpActionResult Update(string orderNumber, Dimension orderDimension, bool buffer = false)
Parametry
Typ Nazwa Opis
string orderNumber

[FromUri] Numer zamówienia własnego.
Dimension orderDimension

[FromBody] Obiekt pola własnego zamówienia własnego do aktualizacji.
bool buffer

[FromUri] Czy dokument znajduje się w buforze. W przypadku, gdy parametr nie zostanie podany zostanie zaktualizowane pole własne zamówienia własnego o podanym numerze dokumentu, które nie znajduje się w buforze.
Zwraca
Typ Opis
IHttpActionResult

Metoda nie zwraca żadnej zawartości.
Nadpisuje

Update(string, List<Dimension>, bool)

Metoda umożliwia aktualizacje pól własnych zamówienia własnego o podanych kodach dla zamówienia własnego o podanym numerze dokumentu.

[PUT] /api/OwnOrderDimensions/UpdateList?orderNumber=numer_zamówienia

Deklaracja
[NonAction]
[ApiExplorerSettings(IgnoreApi = true)]
public override IHttpActionResult Update(string orderNumber, List<Dimension> orderDimensions, bool buffer = false)
Parametry
Typ Nazwa Opis
string orderNumber

[FromUri] Numer zamówienia własnego.
List<Dimension> orderDimensions

[FromBody] Lista obiektów pól własnych zamówienia własnego do aktualizacji.
bool buffer

[FromUri] Czy dokument znajduje się w buforze. W przypadku, gdy parametr nie zostanie podany zostaną zaktualizowane pola własne zamówienia własnego o podanym numerze dokumentu, które nie znajduje się w buforze.
Zwraca
Typ Opis
IHttpActionResult

Metoda nie zwraca żadnej zawartości.
Nadpisuje

Implementuje