Previous Next JavaScript must be enabled to correctly display this content

## Get all valid structured address service

get

/service/structuredaddressservice

This endpoint is used to Get all valid structured address service maintenance records.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- authStat(optional): string
- checkerId(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
- virtualAccountNo(optional): string

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of succes or failure
Headers

- Location: string

Body ()
Root Schema : StructuredAddressServiceCollection
Type: `object`
Collection of StructuredAddress.
Show Source

- data(optional): array data
- paging(optional): object PagingDto

    {
        "description":"Collection of StructuredAddress.",
        "type":"object",
        "properties":{
            "data":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/StructuredAddressServiceDTO"
                }
            },
            "paging":{
                "$ref":"#/definitions/PagingDto"
            }
        }
    }

Nested Schema : data
Type: `array`
Show Source

- Array of: object StructuredAddressServiceDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/StructuredAddressServiceDTO"
        }
    }

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

    {
        "type":"object",
        "properties":{
            "totalResults":{
                "type":"integer"
            }
        }
    }

Nested Schema : StructuredAddressServiceDTO
Type: `object`
Match All
Show Source

- object StructuredAddressServiceDTO-allOf[0]

    {
        "type":"object",
        "allOf":[
            {
                "type":"object",
                "properties":{
                    "department":{
                        "type":"string",
                        "description":"Department",
                        "maxLength":70
                    },
                    "subDepartment":{
                        "type":"string",
                        "description":"Sub Department",
                        "maxLength":70
                    },
                    "streetName":{
                        "type":"string",
                        "description":"Street Name",
                        "maxLength":70
                    },
                    "buildingNumber":{
                        "type":"string",
                        "description":"Building Number",
                        "maxLength":16
                    },
                    "buildingName":{
                        "type":"string",
                        "description":"building Name",
                        "maxLength":35
                    },
                    "floor":{
                        "type":"string",
                        "description":"Floor",
                        "maxLength":70
                    },
                    "postbox":{
                        "type":"string",
                        "description":"postbox",
                        "maxLength":16
                    },
                    "room":{
                        "type":"string",
                        "description":"Room",
                        "maxLength":70
                    },
                    "postcode":{
                        "type":"string",
                        "description":"postcode",
                        "maxLength":16
                    },
                    "townName":{
                        "type":"string",
                        "description":"Town Name",
                        "maxLength":35
                    },
                    "townLocationName":{
                        "type":"string",
                        "description":"Town Location Name",
                        "maxLength":35
                    },
                    "districtName":{
                        "type":"string",
                        "description":"District name",
                        "maxLength":35
                    },
                    "countrySubDivision":{
                        "type":"string",
                        "description":"Country Sub Division",
                        "maxLength":35
                    },
                    "strrCountry":{
                        "type":"string",
                        "description":"country",
                        "maxLength":2
                    },
                    "virtualAccountNo":{
                        "type":"string",
                        "description":"Account number of the External customer",
                        "minLength":1,
                        "maxLength":35
                    },
                    "makerId":{
                        "type":"string",
                        "description":"Maker ID of Virtual Account"
                    },
                    "makerDateStamp":{
                        "type":"string",
                        "description":"Date and Time when Virtual Account is created or modified or closed or reopened"
                    },
                    "checkerId":{
                        "type":"string",
                        "description":"Checker ID of Virtual Account"
                    },
                    "checkerDateStamp":{
                        "type":"string",
                        "description":"Date and Time when some action on Virtual Account is authorized"
                    },
                    "modNo":{
                        "type":"integer",
                        "description":"Version number of Virtual Account"
                    },
                    "recordStatus":{
                        "type":"string",
                        "description":"Record Status of Virtual Account"
                    },
                    "authStatus":{
                        "type":"string",
                        "description":"Authorization Status of Virtual Account"
                    },
                    "onceAuth":{
                        "type":"string",
                        "description":"Flag that indicated if Virtual Account is authorized once or not"
                    },
                    "doerRemarks":{
                        "type":"string",
                        "description":"Remarks made by Maker"
                    },
                    "approverRemarks":{
                        "type":"string",
                        "description":"Remarks made by Approver"
                    }
                }
            }
        ]
    }

Nested Schema : StructuredAddressServiceDTO-allOf[0]
Type: `object`
Show Source

- approverRemarks(optional): string
  Remarks made by Approver
- authStatus(optional): string
  Authorization Status of Virtual Account
- buildingName(optional): string
  Maximum Length: `35`
  building Name
- buildingNumber(optional): string
  Maximum Length: `16`
  Building Number
- checkerDateStamp(optional): string
  Date and Time when some action on Virtual Account is authorized
- checkerId(optional): string
  Checker ID of Virtual Account
- countrySubDivision(optional): string
  Maximum Length: `35`
  Country Sub Division
- department(optional): string
  Maximum Length: `70`
  Department
- districtName(optional): string
  Maximum Length: `35`
  District name
- doerRemarks(optional): string
  Remarks made by Maker
- floor(optional): string
  Maximum Length: `70`
  Floor
- makerDateStamp(optional): string
  Date and Time when Virtual Account is created or modified or closed or reopened
- makerId(optional): string
  Maker ID of Virtual Account
- modNo(optional): integer
  Version number of Virtual Account
- onceAuth(optional): string
  Flag that indicated if Virtual Account is authorized once or not
- postbox(optional): string
  Maximum Length: `16`
  postbox
- postcode(optional): string
  Maximum Length: `16`
  postcode
- recordStatus(optional): string
  Record Status of Virtual Account
- room(optional): string
  Maximum Length: `70`
  Room
- streetName(optional): string
  Maximum Length: `70`
  Street Name
- strrCountry(optional): string
  Maximum Length: `2`
  country
- subDepartment(optional): string
  Maximum Length: `70`
  Sub Department
- townLocationName(optional): string
  Maximum Length: `35`
  Town Location Name
- townName(optional): string
  Maximum Length: `35`
  Town Name
- virtualAccountNo(optional): string
  Minimum Length: `1`
  Maximum Length: `35`
  Account number of the External customer

    {
        "type":"object",
        "properties":{
            "department":{
                "type":"string",
                "description":"Department",
                "maxLength":70
            },
            "subDepartment":{
                "type":"string",
                "description":"Sub Department",
                "maxLength":70
            },
            "streetName":{
                "type":"string",
                "description":"Street Name",
                "maxLength":70
            },
            "buildingNumber":{
                "type":"string",
                "description":"Building Number",
                "maxLength":16
            },
            "buildingName":{
                "type":"string",
                "description":"building Name",
                "maxLength":35
            },
            "floor":{
                "type":"string",
                "description":"Floor",
                "maxLength":70
            },
            "postbox":{
                "type":"string",
                "description":"postbox",
                "maxLength":16
            },
            "room":{
                "type":"string",
                "description":"Room",
                "maxLength":70
            },
            "postcode":{
                "type":"string",
                "description":"postcode",
                "maxLength":16
            },
            "townName":{
                "type":"string",
                "description":"Town Name",
                "maxLength":35
            },
            "townLocationName":{
                "type":"string",
                "description":"Town Location Name",
                "maxLength":35
            },
            "districtName":{
                "type":"string",
                "description":"District name",
                "maxLength":35
            },
            "countrySubDivision":{
                "type":"string",
                "description":"Country Sub Division",
                "maxLength":35
            },
            "strrCountry":{
                "type":"string",
                "description":"country",
                "maxLength":2
            },
            "virtualAccountNo":{
                "type":"string",
                "description":"Account number of the External customer",
                "minLength":1,
                "maxLength":35
            },
            "makerId":{
                "type":"string",
                "description":"Maker ID of Virtual Account"
            },
            "makerDateStamp":{
                "type":"string",
                "description":"Date and Time when Virtual Account is created or modified or closed or reopened"
            },
            "checkerId":{
                "type":"string",
                "description":"Checker ID of Virtual Account"
            },
            "checkerDateStamp":{
                "type":"string",
                "description":"Date and Time when some action on Virtual Account is authorized"
            },
            "modNo":{
                "type":"integer",
                "description":"Version number of Virtual Account"
            },
            "recordStatus":{
                "type":"string",
                "description":"Record Status of Virtual Account"
            },
            "authStatus":{
                "type":"string",
                "description":"Authorization Status of Virtual Account"
            },
            "onceAuth":{
                "type":"string",
                "description":"Flag that indicated if Virtual Account is authorized once or not"
            },
            "doerRemarks":{
                "type":"string",
                "description":"Remarks made by Maker"
            },
            "approverRemarks":{
                "type":"string",
                "description":"Remarks made by Approver"
            }
        }
    }

#### 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
Back to Top