Jump to

• Request
• Response

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: array
  Minimum Number of Items: 1

  Maximum Number of Items: 100

  array of custAccountNos with minimum 1 and maximum 100

  • [0]: string

  {
      "name":"custAccountNos",
      "in":"query",
      "description":"array of custAccountNos with minimum 1 and maximum 100",
      "required":true,
      "type":"array",
      "items":{
          "type":"string"
      },
      "minItems":1,
      "maxItems":100
  }

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the structured addresses based on given accountNos.

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

Show Source

• 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
• department(optional): string
  Maximum Length: 70

  Department
• districtName(optional): string
  Maximum Length: 35

  District name
• floor(optional): string
  Maximum Length: 70

  Floor
• operationType(optional): string
  operation type
• postbox(optional): string
  Maximum Length: 16

  postbox
• postcode: string
  Maximum Length: 16

  postcode
• resourceId(optional): string
  resource id
• resourceName(optional): string
  resource name
• 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
• virtualEntityId: string
  Specify Virtual Entity Identification Number here

{
    "type":"object",
    "properties":{
        "resourceId":{
            "description":"resource id",
            "type":"string"
        },
        "resourceName":{
            "description":"resource name",
            "type":"string"
        },
        "operationType":{
            "description":"operation type",
            "type":"string"
        },
        "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
        },
        "virtualEntityId":{
            "type":"string",
            "description":"Specify Virtual Entity Identification Number here"
        }
    },
    "required":[
        "virtualEntityId",
        "townName",
        "strrCountry",
        "postcode"
    ]
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top