Package de.hybris.platform.b2ctelcotmfwebservices.v3.api

Interface GeographicAddressApi

All Known Implementing Classes:

TmaGeographicAddressApiController

public interface GeographicAddressApi

Interface that expose endpoints related to GeographicAddress resource.

Since:

2302

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<List<GeographicAddress>>	listGeographicAddress(@Valid String baseSiteId, @Valid String fields, @Valid Integer offset, @Valid Integer limit, @Valid String relatedPartyId)
org.springframework.http.ResponseEntity<List<GeographicSubAddress>>	listGeographicSubAddress(String geographicAddressId, @Valid String fields, @Valid Integer offset, @Valid Integer limit, @Valid String relatedPartyId)
org.springframework.http.ResponseEntity<GeographicAddress>	retrieveGeographicAddress(String id, @Valid String fields, @Valid String relatedPartyId)
org.springframework.http.ResponseEntity<GeographicSubAddress>	retrieveGeographicSubAddress(String geographicAddressId, String id, @Valid String fields, @Valid String relatedPartyId)

Method Details

listGeographicAddress

@RequestMapping(value="/geographicAddress",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=GET)
org.springframework.http.ResponseEntity<List<GeographicAddress>> listGeographicAddress(@Valid @RequestParam("baseSiteId")
 @Valid String baseSiteId,
 @Valid @RequestParam("fields")
 @Valid String fields,
 @Valid @RequestParam("offset")
 @Valid Integer offset,
 @Valid @RequestParam("limit")
 @Valid Integer limit,
 @Valid @RequestParam("relatedParty.id")
 @Valid String relatedPartyId)

retrieveGeographicAddress

@RequestMapping(value="/geographicAddress/{id}",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=GET)
org.springframework.http.ResponseEntity<GeographicAddress> retrieveGeographicAddress(@PathVariable("id")
 String id,
 @Valid @RequestParam("fields")
 @Valid String fields,
 @Valid @RequestParam("relatedParty.id")
 @Valid String relatedPartyId)

listGeographicSubAddress

@RequestMapping(value="/geographicAddress/{geographicAddressId}/geographicSubAddress",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=GET)
org.springframework.http.ResponseEntity<List<GeographicSubAddress>> listGeographicSubAddress(@PathVariable("geographicAddressId")
 String geographicAddressId,
 @Valid @RequestParam("fields")
 @Valid String fields,
 @Valid @RequestParam("offset")
 @Valid Integer offset,
 @Valid @RequestParam("limit")
 @Valid Integer limit,
 @Valid @RequestParam("relatedParty.id")
 @Valid String relatedPartyId)

retrieveGeographicSubAddress

@RequestMapping(value="/geographicAddress/{geographicAddressId}/geographicSubAddress/{id}",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=GET)
org.springframework.http.ResponseEntity<GeographicSubAddress> retrieveGeographicSubAddress(@PathVariable("geographicAddressId")
 String geographicAddressId,
 @PathVariable("id")
 String id,
 @Valid @RequestParam("fields")
 @Valid String fields,
 @Valid @RequestParam("relatedParty.id")
 @Valid String relatedPartyId)