Previous Next JavaScript must be enabled to correctly display this content

## Retrives the structured address by given ID

get

/structuredaddress/{id}/unauthorized

This endpoint is used to retrives the structured address identified by given ID.

### Request

Supported Media Types

- application/json
- application/xml

Path Parameters

- id: string
  Id of the user that needs to be fetched

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Returns the structuredaddress based on given id.
Body ()
Root Schema : StructuredAddressCollection
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/StructuredAddressDTO"
                }
            },
            "paging":{
                "$ref":"#/definitions/PagingDto"
            }
        }
    }

Nested Schema : data
Type: `array`
Show Source

- Array of: object StructuredAddressDTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

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

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

- allOf GenericDto
- object StructuredAddressDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "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
                    },
                    "custAccountNo":{
                        "type":"string",
                        "description":"Account number of the External customer",
                        "minLength":1,
                        "maxLength":35,
                        "pattern":"[a-zA-Z0-9]+"
                    }
                },
                "required":[
                    "custAccountNo",
                    "strrCountry",
                    "postcode",
                    "townName"
                ]
            }
        ]
    }

Nested Schema : GenericDto
Match All
Show Source

- object GenericDto-allOf[0]
  Discriminator: `resource_type`

    {
        "allOf":[
            {
                "type":"object",
                "discriminator":"resource_type"
            }
        ]
    }

Nested Schema : GenericDto-allOf[0]
Type: `object`
Discriminator: `resource_type`
Nested Schema : StructuredAddressDTO-allOf[1]
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
- 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

    {
        "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
            },
            "custAccountNo":{
                "type":"string",
                "description":"Account number of the External customer",
                "minLength":1,
                "maxLength":35,
                "pattern":"[a-zA-Z0-9]+"
            }
        },
        "required":[
            "custAccountNo",
            "strrCountry",
            "postcode",
            "townName"
        ]
    }

#### 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