Package overit.geocallapp.wfm.resources.rs1.resourceaddress

Class ResourceAddressService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.resources.rs1.resourceaddress.ResourceAddressService

@RestController
@RequestMapping("workforce/resources/r1/resources")
@Resource(logging=true)
public class ResourceAddressService
extends PrivateService

Service to manage resource address

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ResourceAddressService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOResourceAddress>	get(Long resourceId, Long addressId, Collection<String> fields)
org.springframework.http.ResponseEntity<PageResponse<DTOResourceAddress>>	getCollection(Long resourceId, @Valid Page page, Collection<String> fields, @Valid DTOResourceAddressFilter filter)
org.springframework.http.ResponseEntity<Void>	patch(Long resourceId, Long addressId, @Valid DTOResourceAddressUpdate dto)
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long resourceId, @Valid DTOResourceAddressInsert dto)
org.springframework.http.ResponseEntity<Void>	updateStartEndAddresses(Long resourceId, @Valid DTOResourceStartEndAddress input)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ResourceAddressService

public ResourceAddressService()

Method Details

getCollection

@GetMapping(value="/{resourceId:[0-9]+}/addresses",
            produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOResourceAddress>> getCollection(@PathVariable("resourceId")
 Long resourceId,
 @RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,value="_fields")
 Collection<String> fields,
 @Valid
 @Valid DTOResourceAddressFilter filter)
                                                                                        throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

post

@PostMapping(value="/{resourceId:[0-9]+}/addresses",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@PathVariable("resourceId")
 Long resourceId,
 @Valid @RequestBody
 @Valid DTOResourceAddressInsert dto)
                                                                  throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

patch

@PatchMapping(value="/{resourceId:[0-9]+}/addresses/{addressId:[0-9]+}",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patch(@PathVariable("resourceId")
 Long resourceId,
 @PathVariable("addressId")
 Long addressId,
 @Valid @RequestBody
 @Valid DTOResourceAddressUpdate dto)
                                                    throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

get

@GetMapping(value="/{resourceId:[0-9]+}/addresses/{addressId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOResourceAddress> get(@PathVariable("resourceId")
 Long resourceId,
 @PathVariable("addressId")
 Long addressId,
 @RequestParam(required=false,value="_fields")
 Collection<String> fields)
                                                                throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

updateStartEndAddresses

@PostMapping(value="/{resourceId:[0-9]+}/route-addresses",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> updateStartEndAddresses(@PathVariable("resourceId")
 Long resourceId,
 @Valid @RequestBody
 @Valid DTOResourceStartEndAddress input)
                                                                      throws DAValidateException,
DAException

Throws:

DAValidateException

DAException