Class EncodedNoteService
java.lang.Object
overit.geocallapp.utilities.rs.common.PrivateService
overit.geocallapp.wfm.core.rs5.technicalobject.meter.reading.encodednote.EncodedNoteService
@RestController("EncodedNoteService-legacy")
@RequestMapping("core/r5/customers/meters/readings/encodednotes")
@Resource(logging=true)
public class EncodedNoteService
extends PrivateService
Services to manage encoded notes.
- Since:
- 19.0
- GCApi:
- rest
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity<DTOEncodedNote> Retrieves the required encoded note.org.springframework.http.ResponseEntity<PageResponse<DTOEncodedNote>> getCollection(@NotNull @Valid Page page, @Valid @NotNull DTOEncodedNoteSearchFilter filter) Retrieve the all stored encoded notes.org.springframework.http.ResponseEntity<Void> patch(Long id, @Valid DTOEncodedNoteUpdate input) Modifies the required encoded note.org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@Valid DTOEncodedNoteInsert input) Create a new encoded note.
-
Constructor Details
-
EncodedNoteService
public EncodedNoteService()
-
-
Method Details
-
getCollection
@GetMapping(produces="application/json") public org.springframework.http.ResponseEntity<PageResponse<DTOEncodedNote>> getCollection(@RequestParam("page") @NotNull @Valid @NotNull @Valid Page page, @RequestParam("filter") @Valid @NotNull @Valid @NotNull DTOEncodedNoteSearchFilter filter) throws DAValidateException, DAException Retrieve the all stored encoded notes.EncodedNoteSearchEvent- Parameters:
page- the required result pagefilter- the specifiedDTOEncodedNoteSearchFilter- Returns:
- the response containing the current result page
- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
get
@GetMapping(value="{id:[0-9]+}", produces="application/json") public org.springframework.http.ResponseEntity<DTOEncodedNote> get(@PathVariable("id") Long id) throws DAValidateException, DAException Retrieves the required encoded note.EncodedNoteLoadEvent- Parameters:
id- encoded note id- Returns:
- the response containing the required encoded note
- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
post
@PostMapping(consumes="application/json", produces="application/json") public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@Valid @RequestBody @Valid DTOEncodedNoteInsert input) throws DAValidateException, DAException Create a new encoded note.EncodedNoteInsertEvent- Parameters:
input- theDTOEncodedNote- Returns:
- a standard response containing the new encoded note id
- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
patch
@PatchMapping(value="{id:[0-9]+}", consumes="application/json", produces="application/json") public org.springframework.http.ResponseEntity<Void> patch(@PathVariable("id") Long id, @Valid @RequestBody @Valid DTOEncodedNoteUpdate input) throws DAValidateException, DAException Modifies the required encoded note.EncodedNoteUpdateEvent- Parameters:
id- the encoded note idinput- the encoded note updateDTOEncodedNote- Returns:
- a standard response
- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-