Package overit.geocallapp.wfm.accounts.rs1.contact

Class AccountContactService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.accounts.rs1.contact.AccountContactService

@RestController
@RequestMapping("assets/accounts/r1/accounts/{accountId}/contacts")
@Resource(logging=true)
public class AccountContactService
extends PrivateService

Services to manage the account contacts.

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
AccountContactService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOAccountContact>	get(Long accountId, Long contactId, Collection<String> fields)	Retrieves the required DTOAccountContact by calling from the AccountContactLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOAccountContact>>	getCollection(Long accountId, @Valid Page page, Collection<String> fields, String order, @Valid DTOAccountContactFilter filter)	Returns the collection of all the stored account contacts by calling the AccountContactSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long accountId, Long contactId, @Valid DTOAccountContactUpdate dto)	Update a contact by calling the AccountContactUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long accountId, @Valid DTOAccountContactInsert input)	Create a new account contact by calling the AccountContactInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

AccountContactService

public AccountContactService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOAccountContact>> getCollection(@PathVariable("accountId")
 Long accountId,
 @RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields,
 @RequestParam(required=false,name="_order")
 String order,
 @Valid
 @Valid DTOAccountContactFilter filter)
                                                                                       throws DAValidateException,
DAException

Returns the collection of all the stored account contacts by calling the AccountContactSearchEvent.

Parameters:

accountId - the account id

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

filter - the filter DTOAccountContactFilter

Returns:

the collection of DTOAccountContact

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOAccountContact by calling from the AccountContactLoadEvent.

Parameters:

accountId - the account id

contactId - the account contact id

fields - the collection of fields the response will contain

Returns:

the DTO response containing the loaded DTOAccountContact

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@PathVariable("accountId")
 Long accountId,
 @Valid @RequestBody
 @Valid DTOAccountContactInsert input)
                                                                  throws DAValidateException,
DAException

Create a new account contact by calling the AccountContactInsertEvent.

Parameters:

accountId - the account id

input - the DTOAccountContactInsert

Returns:

the standard response containing the new contact id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update a contact by calling the AccountContactUpdateEvent.

Parameters:

accountId - the account id

contactId - the contact id

dto - the DTOAccountContactUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception