Retrieves the structured addresses by providing array of account numbers
get
/service/structuredaddress/getStructuredAddresses
This endpoint is used to retrieve the structured addresses by providing array of account numbers
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
custAccountNos(required): array[string]
Minimum Number of Items:
1Maximum Number of Items:100array of custAccountNos with minimum 1 and maximum 100
Header Parameters
-
sourceCode(required): string
Source from which request is initiated
Response
Supported Media Types
- application/json
- text/csv
- application/xml
200 Response
Returns the structured addresses based on given accountNos.
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
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error