Update an existing structured address
put
/service/structuredaddress/{custAccountNo}
This endpoint is used to update an existing structured address.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
custAccountNo(required): string
key of the structuredaddress Maintenance
Header Parameters
-
sourceCode(required): string
Source from which request is initiated
Request Body that contains data required for updating an existing structuredaddress
Root Schema : StructuredAddressDTO
Type:
objectMatch All
Show Source
-
allOf
GenericDto
-
object
StructuredAddressDTO-allOf[1]
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
objectDiscriminator:
resource_typeNested Schema : StructuredAddressDTO-allOf[1]
Type:
Show Source
object-
buildingName:
string
Maximum Length:
35building Name -
buildingNumber:
string
Maximum Length:
16Building Number -
countrySubDivision:
string
Maximum Length:
35Country Sub Division -
custAccountNo(required):
string
Minimum Length:
1Maximum Length:35Pattern:[a-zA-Z0-9]+Account number of the External customer -
department:
string
Maximum Length:
70Department -
districtName:
string
Maximum Length:
35District name -
floor:
string
Maximum Length:
70Floor -
postbox:
string
Maximum Length:
16postbox -
postcode(required):
string
Maximum Length:
16postcode -
room:
string
Maximum Length:
70Room -
streetName:
string
Maximum Length:
70Street Name -
strrCountry(required):
string
Maximum Length:
2country -
subDepartment:
string
Maximum Length:
70Sub Department -
townLocationName:
string
Maximum Length:
35Town Location Name -
townName(required):
string
Maximum Length:
35Town Name
Response
Supported Media Types
- application/json
- text/csv
- application/xml
200 Response
Returns updated structuredaddress
Root Schema : StructuredAddressRSServiceResponseDtoWrapper
Type:
Show Source
object-
data:
object StructuredAddressDTO
-
messages:
object ResponseDto
Nested Schema : StructuredAddressDTO
Type:
objectMatch All
Show Source
-
allOf
GenericDto
-
object
StructuredAddressDTO-allOf[1]
Nested Schema : ResponseDto
Type:
Show Source
object-
codes:
array codes
-
id:
string
-
requestId:
string
-
status:
string
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
objectDiscriminator:
resource_typeNested Schema : StructuredAddressDTO-allOf[1]
Type:
Show Source
object-
buildingName:
string
Maximum Length:
35building Name -
buildingNumber:
string
Maximum Length:
16Building Number -
countrySubDivision:
string
Maximum Length:
35Country Sub Division -
custAccountNo(required):
string
Minimum Length:
1Maximum Length:35Pattern:[a-zA-Z0-9]+Account number of the External customer -
department:
string
Maximum Length:
70Department -
districtName:
string
Maximum Length:
35District name -
floor:
string
Maximum Length:
70Floor -
postbox:
string
Maximum Length:
16postbox -
postcode(required):
string
Maximum Length:
16postcode -
room:
string
Maximum Length:
70Room -
streetName:
string
Maximum Length:
70Street Name -
strrCountry(required):
string
Maximum Length:
2country -
subDepartment:
string
Maximum Length:
70Sub Department -
townLocationName:
string
Maximum Length:
35Town Location Name -
townName(required):
string
Maximum Length:
35Town Name
Nested Schema : ResponseCode
Type:
Show Source
object-
arg:
string
-
args:
array args
-
Code:
string
-
Desc:
string
-
Language:
string
-
Type:
string
Nested Schema : items
Type:
object400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error