Package de.hybris.platform.partyroletmfwebservices.v1.api

Interface PartyRoleApi

All Known Implementing Classes:

PrPartyRoleController

public interface PartyRoleApi

Interface handling operations for PartyRole.

Since:

2302

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<PartyRole>	createPartyRole(@Valid PartyRole body)
org.springframework.http.ResponseEntity<Void>	deletePartyRole(String id)
org.springframework.http.ResponseEntity<List<PartyRole>>	listPartyRole(@Valid String fields, @Valid Integer offset, @Valid Integer limit, @Valid String name, @Valid String status)
org.springframework.http.ResponseEntity<PartyRole>	patchPartyRole(String id, @Valid PartyRole body)
org.springframework.http.ResponseEntity<PartyRole>	retrievePartyRole(String id, @Valid String fields)

Method Details

createPartyRole

@RequestMapping(value="/partyRole",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=POST)
org.springframework.http.ResponseEntity<PartyRole> createPartyRole(@Valid @RequestBody
 @Valid PartyRole body)

deletePartyRole

@RequestMapping(value="/partyRole/{id}",
                produces="application/json;charset=utf-8",
                method=DELETE)
org.springframework.http.ResponseEntity<Void> deletePartyRole(@PathVariable("id")
 String id)

listPartyRole

@RequestMapping(value="/partyRole",
                produces="application/json;charset=utf-8",
                method=GET)
org.springframework.http.ResponseEntity<List<PartyRole>> listPartyRole(@Valid @RequestParam(value="fields",required=false)
 @Valid String fields,
 @Valid @RequestParam(value="offset",required=false)
 @Valid Integer offset,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit,
 @Valid @RequestParam(value="name",required=false)
 @Valid String name,
 @Valid @RequestParam(value="status",required=false)
 @Valid String status)

patchPartyRole

@RequestMapping(value="/partyRole/{id}",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=PATCH)
org.springframework.http.ResponseEntity<PartyRole> patchPartyRole(@PathVariable("id")
 String id,
 @Valid @RequestBody
 @Valid PartyRole body)

retrievePartyRole

@RequestMapping(value="/partyRole/{id}",
                produces="application/json;charset=utf-8",
                method=GET)
org.springframework.http.ResponseEntity<PartyRole> retrievePartyRole(@PathVariable("id")
 String id,
 @Valid @RequestParam(value="fields",required=false)
 @Valid String fields)