Class SalesDimensionsV2026_2Controller

Dziedziczenie
object
ApiController
AdvancedApiController
SalesDimensionsController
SalesDimensionsV2026_1Controller
SalesDimensionsV2026_2Controller
Implementuje
Odziedziczone składowe
Namespace: Sage.PL.WebAPI.Module.Sales.Controllers.V2026_2
Assembly: Sage.PL.WebAPI.Module.Sales.dll
Składnia
[ApiVersion(2026.2, null)]
[AuthorizeSession]
[ExceptionLogHandling]
[ControllerName("SalesDimensions")]
public class SalesDimensionsV2026_2Controller : SalesDimensionsV2026_1Controller, ISalesDimensionsController

Konstruktory

SalesDimensionsV2026_2Controller(IMessageBus, ILogService, ISalesDimensionService, ISalesAspectService)

Deklaracja
public SalesDimensionsV2026_2Controller(IMessageBus messageBus, ILogService logService, ISalesDimensionService salesDimensionService, ISalesAspectService salesAspectService)
Parametry
Typ Nazwa Opis
IMessageBus messageBus
ILogService logService
ISalesDimensionService salesDimensionService
ISalesAspectService salesAspectService

Metody

Get(DocumentSourceEnum, string)

Metoda umożliwia pobranie listy pól własnych dokumentu sprzedaży o podanym numerze dokumentu.

[GET] /api/SalesDimensions?documentNumber=numer_dokumentu

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

[FromUri] Numer dokumentu sprzedaży.
Zwraca
Typ Opis
IHttpActionResult

Zwraca kolekcję obiektów Dimension.

Get(string, bool)

Metoda umożliwia pobranie listy pól własnych dokumentu sprzedaży o podanym numerze dokumentu.

[GET] /api/SalesDimensions?documentNumber=numer_dokumentu

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

[FromUri] Numer dokumentu sprzedaży.
bool buffer

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

Zwraca kolekcję obiektów Dimension.
Nadpisuje

GetAspects(DocumentSourceEnum, string)

Metoda umożliwia pobranie wymiarów pozycji dokumentu sprzedaży o podanym numerze dokumentu.

[GET] /api/SalesDimensions/Aspects?documentNumber=numer_dokumentu

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

[FromUri] Id dokumentu sprzedaży.
Zwraca
Typ Opis
IHttpActionResult

Zwraca obiekt AspectDocument.

GetAspects(string, bool)

Metoda umożliwia pobranie wymiarów pozycji dokumentu sprzedaży o podanym numerze dokumentu.

[GET] /api/SalesDimensions/Aspects?documentNumber=numer_dokumentu

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

[FromUri] Id dokumentu sprzedaży.
bool buffer

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

Zwraca obiekt AspectDocument.
Nadpisuje

GetPositionsByDocumentNumber(DocumentSourceEnum, string)

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

[GET] /api/SalesDimensions/Positions?documentNumber=numer_dokumentu

Deklaracja
[HttpGet]
[WebApiRoute("Positions/{source:regex((?i)^(Issued|FromBuffer)$)}/{*documentNumber}", true, true)]
[SwaggerResponse(HttpStatusCode.OK, null, typeof(List<PositionDimension>))]
[SwaggerResponse(HttpStatusCode.NotFound, "W przypadku gdy nie odnaleziono żądanego dokumentu sprzedaży", typeof(string))]
[ActionNotAvailable(WorkMode.H50)]
public virtual IHttpActionResult GetPositionsByDocumentNumber(DocumentSourceEnum source, string documentNumber)
Parametry
Typ Nazwa Opis
DocumentSourceEnum source
string documentNumber

[FromUri] Numer dokumentu sprzedaży.
Zwraca
Typ Opis
IHttpActionResult

Zwraca kolekcję obiektów PositionDimension.

GetPositionsByDocumentNumber(string, bool)

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

[GET] /api/SalesDimensions/Positions?documentNumber=numer_dokumentu

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

[FromUri] Numer dokumentu sprzedaży.
bool buffer

[FromUri] Czy dokument znajduje się w buforze. W przypadku, gdy parametr nie zostanie podany zostanie pobrana lista pól własnych pozycji dokumentu sprzedaży 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)

Metoda umożliwia aktualizacje pola własnego dokumentu sprzedaży o podanym kodzie dla dokumentu sprzedaży o podanym numerze dokumentu.

[PUT] /api/SalesDimensions/Update?documentNumber=numer_dokumentu

Deklaracja
[HttpPut]
[ValidateModelState]
[WebApiRoute("Update/{source:regex((?i)^(Issued|FromBuffer)$)}/{*documentNumber}", true, true)]
[SwaggerResponse(HttpStatusCode.Created, null, typeof(ResponseMessageResult))]
[SwaggerResponse(HttpStatusCode.NotFound, "W przypadku gdy nie odnaleziono żądanego dokumentu sprzedaży", typeof(string))]
[SwaggerResponse(HttpStatusCode.BadRequest, "W przypadku gdy model jest niepoprawny.", typeof(string))]
[SwaggerResponse(HttpStatusCode.BadRequest, "W przypadku błędu wykonania procedury SQL", typeof(string))]
public virtual IHttpActionResult Update(DocumentSourceEnum source, string documentNumber, Dimension documentDimension)
Parametry
Typ Nazwa Opis
DocumentSourceEnum source
string documentNumber

[FromUri] Numer dokumentu sprzedaży.
Dimension documentDimension

[FromBody] Obiekt pola własnego dokumentu sprzedaży do aktualizacji.
Zwraca
Typ Opis
IHttpActionResult

Metoda nie zwraca żadnej zawartości.

Update(DocumentSourceEnum, string, List<Dimension>)

Metoda umożliwia aktualizacje pól własnych dokumentu sprzedaży o podanych kodach dla dokumentu sprzedaży o podanym num`erze dokumentu.

[PUT] /api/SalesDimensions/UpdateList?documentNumber=numer_dokumentu

Deklaracja
[HttpPut]
[ValidateModelState]
[WebApiRoute("UpdateList/{source:regex((?i)^(Issued|FromBuffer)$)}/{*documentNumber}", true, true)]
[SwaggerResponse(HttpStatusCode.Created, null, typeof(ResponseMessageResult))]
[SwaggerResponse(HttpStatusCode.NotFound, "W przypadku gdy nie odnaleziono żądanego dokumentu sprzedaży", typeof(string))]
[SwaggerResponse(HttpStatusCode.BadRequest, "W przypadku gdy model jest niepoprawny.", typeof(string))]
[SwaggerResponse(HttpStatusCode.BadRequest, "W przypadku błędu wykonania procedury SQL", typeof(string))]
public virtual IHttpActionResult Update(DocumentSourceEnum source, string documentNumber, List<Dimension> documentDimensions)
Parametry
Typ Nazwa Opis
DocumentSourceEnum source
string documentNumber

[FromUri] Numer dokumentu sprzedaży.
List<Dimension> documentDimensions

[FromBody] Lista obiektów pól własnych dokumentu sprzedaży do aktualizacji.
Zwraca
Typ Opis
IHttpActionResult

Metoda nie zwraca żadnej zawartości.

Update(string, Dimension, bool)

Metoda umożliwia aktualizacje pola własnego dokumentu sprzedaży o podanym kodzie dla dokumentu sprzedaży o podanym numerze dokumentu.

[PUT] /api/SalesDimensions/Update?documentNumber=numer_dokumentu

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

[FromUri] Numer dokumentu sprzedaży.
Dimension documentDimension

[FromBody] Obiekt pola własnego dokumentu sprzedaży do aktualizacji.
bool buffer

[FromUri] Czy dokument znajduje się w buforze. W przypadku, gdy parametr nie zostanie podany zostanie zaktualizowane pole własne dokumentu sprzedaży 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 dokumentu sprzedaży o podanych kodach dla dokumentu sprzedaży o podanym num`erze dokumentu.

[PUT] /api/SalesDimensions/UpdateList?documentNumber=numer_dokumentu

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

[FromUri] Numer dokumentu sprzedaży.
List<Dimension> documentDimensions

[FromBody] Lista obiektów pól własnych dokumentu sprzedaży do aktualizacji.
bool buffer

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

Metoda nie zwraca żadnej zawartości.
Nadpisuje

Implementuje