Get all valid structured address
get
/structuredaddress
This endpoints will be used to Get all valid structured address maintenance records.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
authStat(optional): string
-
checkerId(optional): string
-
custAccountNo(optional): string
-
includecloseandunauth(optional): boolean
includecloseandunauth need to be set to fetch summary record, defult value is false
-
limit(optional): integer
limit is maximum no of records to be fetched
-
makerId(optional): string
-
modNo(optional): integer
-
offset(optional): integer
offset is starting no of records to be fetched
-
onceAuth(optional): string
-
postcode(optional): string
-
recordStat(optional): string
-
strrCountry(optional): string
-
townName(optional): string
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of succes or failure
Headers
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
object
Discriminator:
resource_type
Nested Schema : StructuredAddressDTO-allOf[1]
Type:
Show Source
object
-
buildingName(optional):
string
Maximum Length:
35
building Name -
buildingNumber(optional):
string
Maximum Length:
16
Building Number -
countrySubDivision(optional):
string
Maximum Length:
35
Country Sub Division -
custAccountNo:
string
Minimum Length:
1
Maximum Length:35
Pattern:[a-zA-Z0-9]+
Account number of the External customer -
department(optional):
string
Maximum Length:
70
Department -
districtName(optional):
string
Maximum Length:
35
District name -
floor(optional):
string
Maximum Length:
70
Floor -
postbox(optional):
string
Maximum Length:
16
postbox -
postcode:
string
Maximum Length:
16
postcode -
room(optional):
string
Maximum Length:
70
Room -
streetName(optional):
string
Maximum Length:
70
Street Name -
strrCountry:
string
Maximum Length:
2
country -
subDepartment(optional):
string
Maximum Length:
70
Sub Department -
townLocationName(optional):
string
Maximum Length:
35
Town Location Name -
townName:
string
Maximum Length:
35
Town Name
400 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