tdevapigists
11/20/2018 - 7:20 AM

validation-public.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "NBN Multiformat Address Search API",
    "description": "NBN Multiformat Address Search provides API to perform structured, unstructured AUPost query and validation api which provides address Id based on address string provided, and get the address details in multiple formats like structured and unstructured AU Post",
    "version": "1.0.0",
    "termsOfService": ""
  },
  "host": "tapi.telstra.com",
  "basePath": "/v2/address",
  "schemes": [
    "https"
  ],
  "security": [{"APIKeyHeader": []}],
  "paths": {
    "/structured": {
      "post": {
        "operationId": "query by address",
        "summary": "query by address",
        "description": "query by address",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "A header in the format 'Bearer {access_token}' - get the token by using the OAuth API with the scope 'NBNMFAS'",
            "type": "string",
            "required": true
          },
          {
            "name": "payload",
            "in": "body",
            "description": "A JSON payload containing the structured address query",
            "required": true,
            "schema": {
              "$ref": "#/definitions/StructuredAddressSearchRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success - the address details for a given structured address is returned",
            "schema": {
              "$ref": "#/definitions/MultiformatStructuredAddressResponse"
            }
          },
          "400": {
            "description": "Invalid request parameters or Validation Failures",
            "schema": {
              "$ref": "#/definitions/DownstreamError"
            }
          },
          "401": {
            "description": "Invalid or no credentials passed in the request",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "422": {
            "description": "Validation Errors",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "500": {
            "description": "An internal error occurred when processing the request",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "503": {
            "description": "The service requested is currently unavailable",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        }
      }
    },
    "/unstructured": {
      "post": {
        "operationId": "query by unstructured address",
        "summary": "query by unstructured address",
        "description": "query by unstructured address",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "A header in the format 'Bearer {access_token}' - get the token by using the OAuth API with the scope 'NBNMFAS'",
            "type": "string",
            "required": true
          },
          {
            "name": "payload",
            "in": "body",
            "description": "A JSON payload containing the structured address query",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UnStructuredAddressSearchRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success - the address details for a given structured address is returned",
            "schema": {
              "$ref": "#/definitions/MultiformatUnStructuredAddressResponse"
            }
          },
          "400": {
            "description": "Invalid or missing request parameters",
            "schema": {
              "$ref": "#/definitions/DownstreamError"
            }
          },
          "401": {
            "description": "Invalid or no credentials passed in the request",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "500": {
            "description": "An internal error occurred when processing the request",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "503": {
            "description": "The service requested is currently unavailable",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        }
      }
    },
    "/validation/address-validation": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "required": false,
            "schema": {
              "$ref": "#/definitions/ValidationRequest"
            },
            "x-examples": {
              "application/json": "{\n\t\"searchData\": {\n\t\t\"addressLine1\": \"Unit 4 62 Great Western Highway, PARRAMATTA NSW 2150\"\n\t}\n}"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success Response restuted by api",
            "schema": {
              "$ref": "#/definitions/ValidationResponseSuccess"
            }
          },
          "422": {
            "description": "Validation error Response restuted by api",
            "schema": {
              "$ref": "#/definitions/ValidationResponseValidationError"
            }
          },
          "400": {
            "description": "Validation error Response restuted by api",
            "schema": {
              "$ref": "#/definitions/BadRequestErrorResponse"
            }
          },
          "401": {
            "description": "Invalid or no credentials passed in the request",
            "schema": {
              "$ref": "#/definitions/ValidationAuthFailureResponse"
            }
          },
          "411": {
            "description": "Request Metadatas are missing",
            "schema": {
              "$ref": "#/definitions/RequestResponseMetaDataErrorResponse"
            }
          },
          "429": {
            "description": "API quota limit exceeded",
            "schema": {
              "$ref": "#/definitions/QuotaFailureResponse"
            }
          },
          "500": {
            "description": "Error due to downstream errors",
            "schema": {
              "$ref": "#/definitions/ValidationResponseDownstreamError"
            }
          }
        }
      }
    }
  },
  "securityDefinitions": {
    "APIKeyHeader": {
      "type": "apiKey",
      "in": "header",
      "name": "apiKey"
    }
  },
  "definitions": {
    "StructuredAddressSearchRequest": {
      "description": "The default length value is 100",
      "type": "object",
      "properties": {
        "correlationId": {
          "type": "string"
        },
        "data": {
          "type": "object",
          "properties": {
            "searchOptions": {
              "type": "object",
              "properties": {
                "sortType": {
                  "type": "string"
                },
                "addressesToSkip": {
                  "type": "integer"
                },
                "addressesToReturn": {
                  "type": "integer"
                },
                "fuzzyOptions": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "type": "boolean",
                      "enum": [
                        true,
                        false
                      ],
                      "description": "This value represents if fuzzy should be applicable. Default fuzzy is enabled"
                    }
                  }
                },
                "addressType": {
                  "type": "string",
                  "description": "This value represents the address type.",
                  "enum": [
                    "All",
                    "ServiceAddress",
                    "RuralAddress",
                    "PostalAddress",
                    "ParcelAddress"
                  ]
                },
                "responseAddressFormat": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "structured",
                      "unstructuredAUPost"
                    ]
                  }
                }
              }
            },
            "searchData": {
              "type": "object",
              "properties": {
                "addressType": {
                  "type": "string",
                  "description": "This value represents the various address types,applicable for postal and rural address.",
                  "maxLength": 100
                },
                "addressSubType": {
                  "type": "string",
                  "description": "This value represents Address Sub Type.",
                  "maxLength": 100
                },
                "unitNumber": {
                  "type": "string",
                  "description": "-  Unit Number is a conditional mandatory parameter. It is mandatory only when addressType is populated.",
                  "maxLength": 100
                },
                "postalDeliveryNumber": {
                  "type": "string",
                  "description": "-  postalDeliveryNumber is a conditional mandatory parameter,It is mandatory only if the data.searchOptions.addressType is PostalAddress.",
                  "maxLength": 10
                },
                "ruralMailNumber": {
                  "type": "string",
                  "description": "-  ruralMailNumber is a conditional mandatory parameter,It is mandatory only if the data.searchOptions.addressType is RuralAddress.",
                  "maxLength": 10
                },
                "planNumber": {
                  "type": "string",
                  "description": "-  plan number for a parcel address.",
                  "maxLength": 100
                },
                "parcelNumber": {
                  "type": "string",
                  "description": "-  parcel descriptor number.",
                  "maxLength": 100
                },
                "streetNumber": {
                  "type": "string",
                  "maxLength": 100
                },
                "streetName": {
                  "type": "string",
                  "maxLength": 30
                },
                "streetSuffix": {
                  "type": "string",
                  "maxLength": 13
                },
                "streetType": {
                  "type": "string",
                  "description": "This value represents the various street types. Validation fails if any value other than supported is in the request.This field value is ignored in the search, if the request contains other valid field values but an invalid street type. The consumer will get back the closest matches for the requested address, and the original street type will be ignored",
                  "maxLength": 17
                },
                "suburb": {
                  "type": "string",
                  "maxLength": 46
                },
                "state": {
                  "type": "string",
                  "description": "This value represents the various state types. Validation fails if any value other than supported is sent",
                  "maxLength": 3
                },
                "postcode": {
                  "type": "string",
                  "description": "This value represents the various postcode ranges. Validation fails if any value other than supported is sent",
                  "maxLength": 4
                }
              }
            }
          }
        }
      },
      "example": {
        "correlationId": "e36c958d-0adf-4d19-8658-a718c72c55af",
        "data": {
          "searchOptions": {
            "sortType": "0",
            "addressesToSkip": 0,
            "addressesToReturn": 1,
            "fuzzyOptions": {
              "enabled": true
            },
            "addressType": "serviceAddress"
          },
          "searchData": {
            "streetNumber": "3",
            "streetName": "WeLlington",
            "streetType": "roaD",
            "suburb": "aubuRn",
            "state": "NsW",
            "postcode": "2144"
          }
        }
      }
    },
    "UnStructuredAddressSearchRequest": {
      "description": "The default length value is 100",
      "type": "object",
      "properties": {
        "data": {
          "type": "object",
          "properties": {
            "searchOptions": {
              "type": "object",
              "properties": {
                "sortType": {
                  "type": "string"
                },
                "addressestoSkip": {
                  "type": "integer"
                },
                "addressesToReturn": {
                  "type": "integer"
                },
                "fuzzyOptions": {
                  "type": "object",
                  "properties": {
                    "enabled": {
                      "type": "boolean",
                      "enum": [
                        true,
                        false
                      ],
                      "description": "This value represents if fuzzy should be applicable. Default fuzzy is enabled"
                    }
                  }
                },
                "addressType": {
                  "type": "string",
                  "description": "This value represents the address type.",
                  "enum": [
                    "All",
                    "ServiceAddress",
                    "RuralAddress",
                    "PostalAddress",
                    "ParcelAddress"
                  ]
                },
                "responseFormats": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "structured",
                      "unstructuredAUPost"
                    ]
                  }
                }
              }
            },
            "searchData": {
              "type": "object",
              "required": [
                "addressLine1"
              ],
              "properties": {
                "addressLine1": {
                  "type": "string",
                  "description": "First Line of address",
                  "maxLength": 100
                },
                "addressLine2": {
                  "type": "string",
                  "description": "Second Line of address",
                  "maxLength": 100
                },
                "addressLine3": {
                  "type": "string",
                  "description": "Third Line of address",
                  "maxLength": 100
                },
                "streetType": {
                  "type": "string",
                  "description": "This value represents the various street types. Validation fails if any value other than supported is in the request.This field value is ignored in the search, if the request contains other valid field values but an invalid street type. The consumer will get back the closest matches for the requested address, and the original street type will be ignored",
                  "maxLength": 17
                },
                "suburb": {
                  "type": "string",
                  "maxLength": 46
                },
                "state": {
                  "type": "string",
                  "description": "This value represents the various state types. Validation fails if any value other than supported is sent",
                  "maxLength": 3
                },
                "postcode": {
                  "type": "string",
                  "description": "This value represents the various postcode ranges. Validation fails if any value other than supported is sent",
                  "maxLength": 4
                }
              }
            }
          }
        }
      },
      "example": {
        "data": {
          "searchOptions": {
            "addressesToSkip": 0,
            "addressesToReturn": 25,
            "fuzzyOptions": {
              "enabled": true
            },
            "addressType": "serviceAddress",
            "responseFormats": [
              "unstructuredAUPost",
              "structured"
            ]
          },
          "searchData": {
            "addressLine1": "2/284 Casuarina Drive",
            "suburb": "Rapid Creek",
            "state": "nT",
            "postcode": "0810"
          }
        }
      }
    },
    "MultiformatStructuredAddressResponse": {
      "description": "The default length value is 100",
      "type": "object",
      "properties": {
        "data": {
          "type": "object",
          "properties": {
            "resultCount": {
              "type": "integer",
              "description": "Number of addresses that are returned"
            },
            "structured": {
              "type": "array",
              "items": {
                "properties": {
                  "addressSummaryType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "addressId": {
                    "type": "string",
                    "maxLength": 9
                  },
                  "addressType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "confirmed": {
                    "type": "boolean"
                  },
                  "reqaddformatout": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "numSubaddresses": {
                    "type": "integer",
                    "maxLength": 100
                  },
                  "condorCode": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "fsam": {
                    "type": "string",
                    "maxLength": 7
                  },
                  "postcode": {
                    "type": "integer",
                    "maxLength": 4
                  },
                  "state": {
                    "type": "string",
                    "maxLength": 3
                  },
                  "localityName": {
                    "type": "string",
                    "maxLength": 23
                  },
                  "propertyNumberFrom": {
                    "type": "integer",
                    "maxLength": 5
                  },
                  "propertyNumberTo": {
                    "type": "integer",
                    "maxLength": 5
                  },
                  "streetName": {
                    "type": "string",
                    "maxLength": 30
                  },
                  "streetType": {
                    "type": "string",
                    "maxLength": 17
                  },
                  "ruralmailType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "ruralmailNumber": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "postalDeliveryType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "postalDeliveryNumberPrefix": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "postalDeliveryNumber": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "postalDeliveryNumberSuffix": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "planNumber": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelNumber": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptor1Prefix": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptor2": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptionType2": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptor2Prefix": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "subaddresses": {
                    "type": "object",
                    "properties": {
                      "Level1": {
                        "type": "array",
                        "items": {
                          "$ref": "#/definitions/Level1Subaddress"
                        }
                      }
                    },
                    "maxLength": 100
                  },
                  "serviceLocation": {
                    "type": "object",
                    "properties": {
                      "latitude": {
                        "type": "string",
                        "maxLength": 11
                      },
                      "longitude": {
                        "type": "string",
                        "maxLength": 11
                      },
                      "locationId": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "customerServiceAreaId": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "readyForServiceDate": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "exchangeServiceArea": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "facsRealm": {
                        "type": "string",
                        "maxLength": 2
                      }
                    }
                  }
                }
              }
            },
            "unstructuredAUPost": {
              "type": "array",
              "items": {
                "properties": {
                  "addressSummaryType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "addressId": {
                    "type": "string",
                    "maxLength": 9
                  },
                  "addressType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "reqaddformatout": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "confirmed": {
                    "type": "boolean"
                  },
                  "postcode": {
                    "type": "string",
                    "maxLength": 4
                  },
                  "state": {
                    "type": "string",
                    "maxLength": 3
                  },
                  "localityName": {
                    "type": "string",
                    "maxLength": 23
                  },
                  "addressline1": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "condorCode": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "fsam": {
                    "type": "string",
                    "maxLength": 7
                  },
                  "serviceLocation": {
                    "type": "object",
                    "properties": {
                      "latitude": {
                        "type": "string",
                        "maxLength": 11
                      },
                      "longitude": {
                        "type": "string",
                        "maxLength": 11
                      },
                      "locationId": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "customerServiceAreaId": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "readyForServiceDate": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "exchangeServiceArea": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "facsRealm": {
                        "type": "string",
                        "maxLength": 2
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "example": {
        "code": 200,
        "status": 200,
        "time": "2017-12-01T20:37:01+11:00",
        "data": {
          "resultCount": 1,
          "structured": [
            {
              "addressSummaryType": "PropertyAddressSummary",
              "addressId": "240425124",
              "addressType": "Property with Number",
              "confirmed": true,
              "reqaddformatout": "structured",
              "numSubaddresses": 0,
              "condorCode": "AUBN",
              "fsam": "2LID-03",
              "postcode": "2144",
              "localityName": "AUBURN",
              "propertyNumberFrom": 3,
              "propertyNumberTo": "",
              "streetName": "WELLINGTON",
              "streetType": "ROAD",
              "serviceLocation": {
                "latitude": "-33:51:55.9",
                "longitude": "151:01:47.8",
                "locationId": "LOC000082337567",
                "customerServiceAreaId": "CSA200000010503",
                "readyForServiceDate": "2014-01-23",
                "facsRealm": "27",
                "exchangeServiceArea": "LIDC"
              }
            }
          ],
          "unstructuredAUPost": [
            {
              "addressSummaryType": "FormattedAddressSummary",
              "addressId": "240425124",
              "addressType": "Property with Number",
              "reqaddformatout": "unstructuredAUPost",
              "confirmed": true,
              "postcode": "2144",
              "state": "NSW",
              "localityName": "AUBURN",
              "addressline1": "3 WELLINGTON RD,",
              "condorCode": "AUBN",
              "fsam": "2LID-03",
              "serviceLocation": {
                "latitude": "-33:51:55.9",
                "longitude": "151:01:47.8",
                "locationId": "LOC000082337567",
                "customerServiceAreaId": "CSA200000010503",
                "readyForServiceDate": "2014-01-23"
              }
            }
          ]
        },
        "request": {
          "params": {
            "correlationId": "e36c958d-0adf-4d19-8658-a718c72c55af"
          },
          "data": {
            "searchOptions": {
              "sortType": "0",
              "addressesToSkip": 0,
              "addressesToReturn": 1,
              "fuzzyOptions": {
                "enabled": true
              },
              "addressType": "serviceAddress"
            },
            "searchData": {
              "streetNumber": "3",
              "streetName": "WeLlington",
              "streetType": "roaD",
              "suburb": "aubuRn",
              "state": "NsW",
              "postcode": "2144"
            }
          },
          "path": "/structured",
          "method": "POST",
          "requestId": "906c0686-7645-4859-897a-edd3939fb455",
          "correlationId": "e36c958d-0adf-4d19-8658-a718c72c55af"
        },
        "correlationId": "e36c958d-0adf-4d19-8658-a718c72c55af"
      }
    },
    "Level1Subaddress": {
      "description": "The definition for Level 1 Subaddress",
      "type": "object",
      "properties": {
        "AddressType": {
          "type": "string",
          "description": "The address type"
        },
        "SubAddressType": {
          "type": "string",
          "description": "The type of the sub address"
        },
        "ID": {
          "type": "integer",
          "description": "The identifier of this sub address"
        },
        "parentID": {
          "type": "integer",
          "description": "The parent identifier of this sub address"
        },
        "confirmed": {
          "type": "boolean",
          "description": "a flag to indicate if the sub address is a confirmed address"
        },
        "from": {
          "type": "integer",
          "description": "The sub address number"
        },
        "Level2": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Level2Subaddress"
          }
        }
      }
    },
    "Level2Subaddress": {
      "description": "The definition for Level 1 Subaddress",
      "type": "object",
      "properties": {
        "AddressType": {
          "type": "string",
          "description": "The address type"
        },
        "SubAddressType": {
          "type": "string",
          "description": "The type of the sub address"
        },
        "ID": {
          "type": "integer",
          "description": "The identifier of this sub address"
        },
        "parentID": {
          "type": "integer",
          "description": "The parent identifier of this sub address"
        },
        "confirmed": {
          "type": "boolean",
          "description": "a flag to indicate if the sub address is a confirmed address"
        },
        "from": {
          "type": "integer",
          "description": "The sub address number"
        },
        "Level3": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Level3Subaddress"
          }
        }
      }
    },
    "Level3Subaddress": {
      "description": "The definition for Level 1 Subaddress",
      "type": "object",
      "properties": {
        "AddressType": {
          "type": "string",
          "description": "The address type"
        },
        "SubAddressType": {
          "type": "string",
          "description": "The type of the sub address"
        },
        "ID": {
          "type": "integer",
          "description": "The identifier of this sub address"
        },
        "parentID": {
          "type": "integer",
          "description": "The parent identifier of this sub address"
        },
        "confirmed": {
          "type": "boolean",
          "description": "a flag to indicate if the sub address is a confirmed address"
        },
        "from": {
          "type": "integer",
          "description": "The sub address number"
        }
      }
    },
    "MultiformatUnStructuredAddressResponse": {
      "description": "The default length value is 100",
      "type": "object",
      "properties": {
        "data": {
          "type": "object",
          "properties": {
            "resultCount": {
              "type": "integer",
              "description": "Number of addresses that are returned"
            },
            "structured": {
              "type": "array",
              "items": {
                "properties": {
                  "addressSummaryType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "addressId": {
                    "type": "string",
                    "maxLength": 9
                  },
                  "addressType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "confirmed": {
                    "type": "boolean"
                  },
                  "reqaddformatout": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "numSubaddresses": {
                    "type": "integer",
                    "maxLength": 100
                  },
                  "subAddressNumberFrom": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "subAddressCodeset": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptor1": {
                    "type": "string",
                    "maxLength": 7
                  },
                  "condorCode": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "subAddressType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "ruralmailType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "ruralmailNumber": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "postalDeliveryType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "postalDeliveryNumberPrefix": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "postalDeliveryNumber": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "postalDeliveryNumberSuffix": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "planNumber": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelNumber": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptor1Prefix": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptor2": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptionType2": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptor2Prefix": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parent": {
                    "type": "object",
                    "properties": {
                      "addressSummaryType": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "addressId": {
                        "type": "string",
                        "maxLength": 9
                      },
                      "addressType": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "confirmed": {
                        "type": "boolean"
                      },
                      "reqaddformatout": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "numSubaddresses": {
                        "type": "integer",
                        "maxLength": 100
                      },
                      "streetType": {
                        "type": "string",
                        "maxLength": 17
                      },
                      "propertyNumberFrom": {
                        "type": "integer",
                        "maxLength": 5
                      },
                      "propertyNumberTo": {
                        "type": "integer",
                        "maxLength": 5
                      },
                      "postcode": {
                        "type": "string",
                        "maxLength": 4
                      },
                      "state": {
                        "type": "string",
                        "maxLength": 3
                      },
                      "localityName": {
                        "type": "string",
                        "maxLength": 23
                      },
                      "condorCode": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "serviceLocation": {
                        "type": "object",
                        "properties": {
                          "exchangeServiceArea": {
                            "type": "string",
                            "maxLength": 100
                          },
                          "facsRealm": {
                            "type": "string",
                            "maxLength": 2
                          },
                          "latitude": {
                            "type": "string",
                            "maxLength": 11
                          },
                          "longitude": {
                            "type": "string",
                            "maxLength": 11
                          }
                        }
                      }
                    }
                  },
                  "primarySummary": {
                    "type": "object",
                    "properties": {
                      "addressId": {
                        "type": "string",
                        "maxLength": 9
                      },
                      "addressType": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "confirmed": {
                        "type": "boolean"
                      },
                      "reqaddformatout": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "localityName": {
                        "type": "string",
                        "maxLength": 23
                      },
                      "state": {
                        "type": "string",
                        "maxLength": 3
                      },
                      "postcode": {
                        "type": "string",
                        "maxLength": 4
                      },
                      "propertyNumberFrom": {
                        "type": "integer",
                        "maxLength": 5
                      },
                      "propertyNumberTo": {
                        "type": "integer",
                        "maxLength": 5
                      },
                      "numSubaddresses": {
                        "type": "integer",
                        "maxLength": 100
                      },
                      "streetType": {
                        "type": "string",
                        "maxLength": 17
                      },
                      "streetName": {
                        "type": "string",
                        "maxLength": 30
                      },
                      "condorCode": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "serviceLocation": {
                        "type": "object",
                        "properties": {
                          "facsRealm": {
                            "type": "string",
                            "maxLength": 2
                          },
                          "exchangeServiceArea": {
                            "type": "string",
                            "maxLength": 100
                          },
                          "latitude": {
                            "type": "string",
                            "maxLength": 11
                          },
                          "longitude": {
                            "type": "string",
                            "maxLength": 11
                          }
                        }
                      }
                    }
                  },
                  "serviceLocation": {
                    "type": "object",
                    "properties": {
                      "latitude": {
                        "type": "string",
                        "maxLength": 11
                      },
                      "longitude": {
                        "type": "string",
                        "maxLength": 11
                      }
                    }
                  }
                }
              }
            },
            "unstructuredAUPost": {
              "type": "array",
              "items": {
                "properties": {
                  "addressSummaryType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "addressId": {
                    "type": "string",
                    "maxLength": 9
                  },
                  "addressType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "reqaddformatout": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "confirmed": {
                    "type": "boolean"
                  },
                  "postcode": {
                    "type": "string",
                    "maxLength": 4
                  },
                  "state": {
                    "type": "string",
                    "maxLength": 3
                  },
                  "localityName": {
                    "type": "string",
                    "maxLength": 23
                  },
                  "addressline1": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "addressline2": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptor1": {
                    "type": "string",
                    "maxLength": 7
                  },
                  "condorCode": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "subAddressType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "serviceLocation": {
                    "type": "object",
                    "properties": {
                      "latitude": {
                        "type": "string",
                        "maxLength": 11
                      },
                      "longitude": {
                        "type": "string",
                        "maxLength": 11
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "example": {
        "code": 200,
        "status": 200,
        "time": "2018-01-09T17:02:22+11:00",
        "data": {
          "resultCount": 16,
          "structured": [
            {
              "addressSummaryType": "PropertyAddressSummary",
              "addressId": "240427074",
              "addressType": "Property with Number",
              "confirmed": true,
              "reqaddformatout": "structured",
              "numSubaddresses": 17,
              "condorCode": "AUBN",
              "postcode": "2144",
              "state": "NSW",
              "localityName": "AUBURN",
              "propertyNumberFrom": 14,
              "propertyNumberTo": "",
              "streetName": "STATION",
              "streetType": "ROAD",
              "serviceLocation": {
                "latitude": "-33:50:54.7",
                "longitude": "151:02:05.4",
                "facsRealm": "27",
                "exchangeServiceArea": "LIDC"
              },
              "subaddresses": {
                "Level1": [
                  {
                    "AddressType": "Complex - Building with Number",
                    "SubAddressType": "BUILDING",
                    "ID": 265087139,
                    "parentID": 240427074,
                    "Confirmed": true,
                    "from": 1,
                    "Level2": [
                      {
                        "AddressType": "Complex - Floor/Level",
                        "SubAddressType": "FLOOR",
                        "ID": 265087142,
                        "parentID": 265087139,
                        "Confirmed": true,
                        "from": 1
                      },
                      {
                        "AddressType": "Complex - Floor/Level",
                        "SubAddressType": "FLOOR",
                        "ID": 265087141,
                        "parentID": 265087139,
                        "Confirmed": true,
                        "from": 2
                      },
                      {
                        "AddressType": "Complex - Floor/Level",
                        "SubAddressType": "FLOOR",
                        "ID": 265087140,
                        "parentID": 265087139,
                        "Confirmed": true,
                        "from": 3
                      },
                      {
                        "AddressType": "Complex - Floor/Level",
                        "SubAddressType": "GROUND / GROUND FLOOR",
                        "ID": 265087143,
                        "parentID": 265087139,
                        "Confirmed": true,
                        "Level3": [
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400310794,
                            "parentID": 265087143,
                            "Confirmed": true,
                            "from": 1
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400309084,
                            "parentID": 265087143,
                            "Confirmed": true,
                            "from": 10
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 265087154,
                            "parentID": 265087143,
                            "Confirmed": true,
                            "from": 11
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400308768,
                            "parentID": 265087143,
                            "Confirmed": true,
                            "from": 12
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400309081,
                            "parentID": 265087143,
                            "Confirmed": true,
                            "from": 2
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400308834,
                            "parentID": 265087143,
                            "Confirmed": true,
                            "from": 3
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400308518,
                            "parentID": 265087143,
                            "Confirmed": true,
                            "from": 4
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 402288287,
                            "parentID": 265087143,
                            "Confirmed": true,
                            "from": 5
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400308880,
                            "parentID": 265087143,
                            "Confirmed": true,
                            "from": 6
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400308751,
                            "parentID": 265087143,
                            "Confirmed": true,
                            "from": 7
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          ],
          "unstructuredAUPost": [
            {
              "addressSummaryType": "FormattedAddressSummary",
              "addressId": "240427074",
              "addressType": "Property with Number",
              "reqaddformatout": "unstructuredAUPost",
              "confirmed": true,
              "postcode": "2144",
              "state": "NSW",
              "localityName": "AUBURN",
              "addressline1": "14 STATION RD,",
              "condorCode": "AUBN",
              "serviceLocation": {
                "latitude": "-33:50:54.7",
                "longitude": "151:02:05.4"
              }
            }
          ]
        },
        "request": {
          "params": {},
          "data": {
            "searchOptions": {
              "sortType": "Default",
              "addressesToSkip": 0,
              "addressesToReturn": 16,
              "fuzzyOptions": {
                "enabled": false
              },
              "addressType": "serviceAddress"
            },
            "searchData": {
              "buildingName": "Regent",
              "streetNumber": "14",
              "streetName": "station",
              "streetType": "road",
              "suburb": "auburn",
              "state": "nSw",
              "postcode": "2144"
            }
          },
          "path": "/structured",
          "method": "POST",
          "requestId": "36574e24-af3d-4413-b0cd-ad9d37f036a8",
          "correlationId": "72ebbb18-5ef8-4237-b22b-b6f7116ad6b6"
        },
        "correlationId": "72ebbb18-5ef8-4237-b22b-b6f7116ad6b6"
      }
    },
    "Error": {
      "type": "object",
      "description": "The default length value is 100",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32",
          "description": "The error status code received by the client."
        },
        "time": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp of error message received by the client"
        },
        "errors": {
          "type": "array",
          "description": "The error details received by the client",
          "items": {
            "type": "object"
          },
          "properties": {
            "code": {
              "type": "integer"
            },
            "message": {
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "request": {
          "type": "object",
          "description": "The error request metadata received by the client"
        },
        "correlationId": {
          "type": "string",
          "description": "Correlation Id received by the client"
        }
      },
      "example": {
        "status": 422,
        "time": "2018-01-16T13:08:33+11:00",
        "message": "The requested address type A is not valid",
        "request": {
          "params": {},
          "data": {
            "searchOptions": {
              "sortType": "default",
              "addressesToSkip": 0,
              "addressesToReturn": 25,
              "addressType": "A",
              "responseFormats": [
                "structured",
                "unstructuredAUPost"
              ]
            },
            "searchData": {
              "addressSubType": "RSD",
              "suburb": "ARnOLD",
              "state": "VIC",
              "postcode": "3551"
            }
          },
          "path": "/structured",
          "method": "POST",
          "requestId": "76d77d3f-d964-4dcc-b094-2efee807923a",
          "correlationId": "8d55d597-682a-4a40-9c45-a219711d230d"
        },
        "correlationId": "8d55d597-682a-4a40-9c45-a219711d230d"
      }
    },
    "DownstreamError": {
      "description": "The default length value is 100",
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32",
          "description": "The error status code received by the client."
        },
        "status": {
          "type": "integer",
          "format": "int32",
          "description": "The status code received by the client."
        },
        "time": {
          "type": "string",
          "format": "date-time",
          "description": "The time stamp of error message received by the client"
        },
        "message": {
          "type": "string",
          "maxLength": 100
        },
        "request": {
          "type": "object",
          "description": "The error request meta-data received by the client"
        },
        "correlationId": {
          "type": "string",
          "description": "Correlation Id received by the client"
        }
      },
      "example": {
        "code": 3007,
        "status": 400,
        "time": "2017-12-01T20:51:50+11:00",
        "message": "Unable to process the address Request",
        "request": {
          "params": {},
          "data": {
            "searchOptions": {
              "sortType": "Default",
              "addressesToSkip": 5,
              "addressesToReturn": 5,
              "fuzzyOptions": {
                "enabled": true
              },
              "addressType": "serviceAddress",
              "navigators": "disabled",
              "responseFormats": [
                "structured",
                "unstructuredAUPost"
              ]
            },
            "searchData": {
              "unitNumber": "209",
              "addressType": "Unit",
              "streetNumber": "2",
              "streetName": "scotsman",
              "streetType": "street",
              "suburb": "forest lodge",
              "floorNumber": "29",
              "buildingNumber": "2",
              "streetSuffix": "west",
              "state": "VIC1",
              "postcode": "3000"
            }
          },
          "path": "/structured",
          "method": "POST",
          "requestId": "ae977821-6b99-4c80-9b60-681727f36104",
          "correlationId": "b4c8bb9f-8874-48db-88d3-d033221c306d"
        },
        "correlationId": "b4c8bb9f-8874-48db-88d3-d033221c306d"
      }
    },
    "ValidationRequest": {
      "properties": {
        "searchData": {
          "$ref": "#/definitions/SearchData"
        }
      },
      "example": {
        "searchData": {
          "addressLine1": "string"
        }
      }
    },
    "SearchData": {
      "properties": {
        "addressLine1": {
          "type": "string"
        }
      },
      "example": {
        "addressLine1": "addressLine1"
      }
    },
    "ValidationResponseSuccess": {
      "properties": {
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "data": {
          "$ref": "#/definitions/ValidationResponseSuccessData"
        },
        "request": {
          "$ref": "#/definitions/ValidationRequest"
        },
        "requestId": {
          "type": "string"
        },
        "correlationId": {
          "type": "string"
        },
        "time": {
          "type": "string"
        }
      },
      "example": {
        "status": 200,
        "code": 200,
        "data": {
          "resultCount": "1",
          "searchConfidence": "100",
          "structured": [
            {
              "addressSummaryType": "PropertyAddressSummary",
              "addressId": "240150536",
              "addressType": "Property with Number",
              "confirmed": true,
              "reqaddformatout": "structured",
              "numSubaddresses": 34,
              "planNumber": "SP13763",
              "parcelNumber": "1-24",
              "parcelType": "Lot",
              "parcelDescriptor1Prefix": "F",
              "condorCode": "PMTA",
              "fsam": "2PAR-04",
              "subaddresses": {
                "Level1": [
                  {
                    "AddressType": "Complex - Building with Number",
                    "SubAddressType": "BUILDING",
                    "ID": 264821350,
                    "parentID": 240150536,
                    "Confirmed": true,
                    "from": 1,
                    "Level2": [
                      {
                        "AddressType": "Complex - Floor/Level",
                        "SubAddressType": "FLOOR",
                        "ID": 264821353,
                        "parentID": 264821350,
                        "Confirmed": true,
                        "from": 1
                      },
                      {
                        "AddressType": "Complex - Floor/Level",
                        "SubAddressType": "FLOOR",
                        "ID": 264821352,
                        "parentID": 264821350,
                        "Confirmed": true,
                        "from": 2
                      },
                      {
                        "AddressType": "Complex - Floor/Level",
                        "SubAddressType": "FLOOR",
                        "ID": 264821351,
                        "parentID": 264821350,
                        "Confirmed": true,
                        "from": 3
                      },
                      {
                        "AddressType": "Complex - Floor/Level",
                        "SubAddressType": "GROUND / GROUND FLOOR",
                        "ID": 264821354,
                        "parentID": 264821350,
                        "Confirmed": true,
                        "Level3": [
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400106982,
                            "parentID": 264821354,
                            "Confirmed": true,
                            "from": 1
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400107543,
                            "parentID": 264821354,
                            "Confirmed": true,
                            "from": 10
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400108168,
                            "parentID": 264821354,
                            "Confirmed": true,
                            "from": 11
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400107818,
                            "parentID": 264821354,
                            "Confirmed": true,
                            "from": 12
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400105988,
                            "parentID": 264821354,
                            "Confirmed": true,
                            "from": 2
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400107996,
                            "parentID": 264821354,
                            "Confirmed": true,
                            "from": 3
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400106197,
                            "parentID": 264821354,
                            "Confirmed": true,
                            "from": 4
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400106109,
                            "parentID": 264821354,
                            "Confirmed": true,
                            "from": 5
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400106017,
                            "parentID": 264821354,
                            "Confirmed": true,
                            "from": 6
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400107385,
                            "parentID": 264821354,
                            "Confirmed": true,
                            "from": 7
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400106976,
                            "parentID": 264821354,
                            "Confirmed": true,
                            "from": 8
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400107409,
                            "parentID": 264821354,
                            "Confirmed": true,
                            "from": 9
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "AddressType": "Complex - Building with Number",
                    "SubAddressType": "BUILDING",
                    "ID": 264821398,
                    "parentID": 240150536,
                    "Confirmed": true,
                    "from": 2,
                    "Level2": [
                      {
                        "AddressType": "Complex - Floor/Level",
                        "SubAddressType": "FLOOR",
                        "ID": 264821401,
                        "parentID": 264821398,
                        "Confirmed": true,
                        "from": 1
                      },
                      {
                        "AddressType": "Complex - Floor/Level",
                        "SubAddressType": "FLOOR",
                        "ID": 264821400,
                        "parentID": 264821398,
                        "Confirmed": true,
                        "from": 2
                      },
                      {
                        "AddressType": "Complex - Floor/Level",
                        "SubAddressType": "FLOOR",
                        "ID": 264821399,
                        "parentID": 264821398,
                        "Confirmed": true,
                        "from": 3
                      },
                      {
                        "AddressType": "Complex - Floor/Level",
                        "SubAddressType": "GROUND / GROUND FLOOR",
                        "ID": 264821402,
                        "parentID": 264821398,
                        "Confirmed": true,
                        "Level3": [
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400106500,
                            "parentID": 264821402,
                            "Confirmed": true,
                            "from": 13
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400107619,
                            "parentID": 264821402,
                            "Confirmed": true,
                            "from": 14
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400106223,
                            "parentID": 264821402,
                            "Confirmed": true,
                            "from": 15
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400106190,
                            "parentID": 264821402,
                            "Confirmed": true,
                            "from": 16
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400106672,
                            "parentID": 264821402,
                            "Confirmed": true,
                            "from": 17
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400108100,
                            "parentID": 264821402,
                            "Confirmed": true,
                            "from": 18
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 264821409,
                            "parentID": 264821402,
                            "Confirmed": true,
                            "from": 19
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400106039,
                            "parentID": 264821402,
                            "Confirmed": true,
                            "from": 20
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400105904,
                            "parentID": 264821402,
                            "Confirmed": true,
                            "from": 21
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400107959,
                            "parentID": 264821402,
                            "Confirmed": true,
                            "from": 22
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400106759,
                            "parentID": 264821402,
                            "Confirmed": true,
                            "from": 23
                          },
                          {
                            "AddressType": "Complex - Flat/Unit",
                            "SubAddressType": "UNIT",
                            "ID": 400107155,
                            "parentID": 264821402,
                            "Confirmed": true,
                            "from": 24
                          }
                        ]
                      }
                    ]
                  }
                ]
              },
              "postcode": "2150",
              "state": "NSW",
              "localityName": "PARRAMATTA",
              "propertyNumberFrom": 62,
              "propertyNumberTo": "",
              "streetName": "GREAT WESTERN",
              "streetType": "HIGHWAY",
              "serviceLocation": {
                "latitude": "-33:49:04.6",
                "longitude": "150:59:53.8",
                "locationId": "LOC000178188485",
                "customerServiceAreaId": "CSA200000000685",
                "readyForServiceDate": "2019-01-02",
                "facsRealm": "22",
                "exchangeServiceArea": "PARR"
              }
            }
          ],
          "unstructuredAUPost": [
            {
              "addressSummaryType": "FormattedAddressSummary",
              "addressId": "240150536",
              "addressType": "Property with Number",
              "reqaddformatout": "unstructuredAUPost",
              "confirmed": true,
              "postcode": "2150",
              "state": "NSW",
              "localityName": "PARRAMATTA",
              "addressline1": "62 GREAT WESTERN HWY,",
              "planNumber": "SP13763",
              "parcelNumber": "1-24",
              "parcelType": "Lot",
              "parcelDescriptor1Prefix": "F",
              "condorCode": "PMTA",
              "fsam": "2PAR-04",
              "serviceLocation": {
                "latitude": "-33:49:04.6",
                "longitude": "150:59:53.8",
                "locationId": "LOC000178188485",
                "customerServiceAreaId": "CSA200000000685",
                "readyForServiceDate": "2019-01-02",
                "facsRealm": "22",
                "exchangeServiceArea": "PARR"
              }
            }
          ]
        },
        "request": {
          "searchData": {
            "addressLine1": "62 GREAT WESTERN HIGHWAY, PARRAMATTA NSW 2150"
          }
        },
        "requestId": "2264ec36-e445-4c06-b50f-bff7d575b9a0",
        "correlationId": "cda14b80-7f0a-4473-1613-888f6b945c04",
        "time": "2018-10-05T17:50:33+10:00"
      }
    },
    "ValidationResponseSuccessData": {
      "description": "The default length value is 100",
      "type": "object",
      "properties": {
        "data": {
          "type": "object",
          "properties": {
            "resultCount": {
              "type": "integer",
              "description": "Number of addresses that are matched"
            },
            "searchConfidence": {
              "type": "integer",
              "description": "Confidence percentage on address returned"
            },
            "structured": {
              "type": "array",
              "items": {
                "properties": {
                  "addressSummaryType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "addressId": {
                    "type": "string",
                    "maxLength": 9
                  },
                  "addressType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "confirmed": {
                    "type": "boolean"
                  },
                  "reqaddformatout": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "numSubaddresses": {
                    "type": "integer",
                    "maxLength": 100
                  },
                  "condorCode": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "fsam": {
                    "type": "string",
                    "maxLength": 7
                  },
                  "postcode": {
                    "type": "integer",
                    "maxLength": 4
                  },
                  "state": {
                    "type": "string",
                    "maxLength": 3
                  },
                  "localityName": {
                    "type": "string",
                    "maxLength": 23
                  },
                  "propertyNumberFrom": {
                    "type": "integer",
                    "maxLength": 5
                  },
                  "propertyNumberTo": {
                    "type": "integer",
                    "maxLength": 5
                  },
                  "streetName": {
                    "type": "string",
                    "maxLength": 30
                  },
                  "streetType": {
                    "type": "string",
                    "maxLength": 17
                  },
                  "ruralmailType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "ruralmailNumber": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "postalDeliveryType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "postalDeliveryNumberPrefix": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "postalDeliveryNumber": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "postalDeliveryNumberSuffix": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "planNumber": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelNumber": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptor1Prefix": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptor2": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptionType2": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptor2Prefix": {
                    "type": "string",
                    "maxLength": 100
                  },
				  "parent": {
                    "type": "object",
                    "properties": {
                      "addressSummaryType": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "addressId": {
                        "type": "string",
                        "maxLength": 9
                      },
                      "addressType": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "confirmed": {
                        "type": "boolean"
                      },
                      "reqaddformatout": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "numSubaddresses": {
                        "type": "integer",
                        "maxLength": 100
                      },
                      "streetType": {
                        "type": "string",
                        "maxLength": 17
                      },
                      "propertyNumberFrom": {
                        "type": "integer",
                        "maxLength": 5
                      },
                      "propertyNumberTo": {
                        "type": "integer",
                        "maxLength": 5
                      },
                      "postcode": {
                        "type": "string",
                        "maxLength": 4
                      },
                      "state": {
                        "type": "string",
                        "maxLength": 3
                      },
                      "localityName": {
                        "type": "string",
                        "maxLength": 23
                      },
                      "condorCode": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "serviceLocation": {
                        "type": "object",
                        "properties": {
                          "exchangeServiceArea": {
                            "type": "string",
                            "maxLength": 100
                          },
                          "facsRealm": {
                            "type": "string",
                            "maxLength": 2
                          },
                          "latitude": {
                            "type": "string",
                            "maxLength": 11
                          },
                          "longitude": {
                            "type": "string",
                            "maxLength": 11
                          }
                        }
                      }
                    }
                  },
                  "primarySummary": {
                    "type": "object",
                    "properties": {
                      "addressId": {
                        "type": "string",
                        "maxLength": 9
                      },
                      "addressType": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "confirmed": {
                        "type": "boolean"
                      },
                      "reqaddformatout": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "localityName": {
                        "type": "string",
                        "maxLength": 23
                      },
                      "state": {
                        "type": "string",
                        "maxLength": 3
                      },
                      "postcode": {
                        "type": "string",
                        "maxLength": 4
                      },
                      "propertyNumberFrom": {
                        "type": "integer",
                        "maxLength": 5
                      },
                      "propertyNumberTo": {
                        "type": "integer",
                        "maxLength": 5
                      },
                      "numSubaddresses": {
                        "type": "integer",
                        "maxLength": 100
                      },
                      "streetType": {
                        "type": "string",
                        "maxLength": 17
                      },
                      "streetName": {
                        "type": "string",
                        "maxLength": 30
                      },
                      "condorCode": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "serviceLocation": {
                        "type": "object",
                        "properties": {
                          "facsRealm": {
                            "type": "string",
                            "maxLength": 2
                          },
                          "exchangeServiceArea": {
                            "type": "string",
                            "maxLength": 100
                          },
                          "latitude": {
                            "type": "string",
                            "maxLength": 11
                          },
                          "longitude": {
                            "type": "string",
                            "maxLength": 11
                          }
                        }
                      }
                    }
                  },
                  "subaddresses": {
                    "type": "object",
                    "properties": {
                      "Level1": {
                        "type": "array",
                        "items": {
                          "$ref": "#/definitions/Level1Subaddress"
                        }
                      }
                    },
                    "maxLength": 100
                  },
                  "serviceLocation": {
                    "type": "object",
                    "properties": {
                      "latitude": {
                        "type": "string",
                        "maxLength": 11
                      },
                      "longitude": {
                        "type": "string",
                        "maxLength": 11
                      },
                      "locationId": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "customerServiceAreaId": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "readyForServiceDate": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "exchangeServiceArea": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "facsRealm": {
                        "type": "string",
                        "maxLength": 2
                      }
                    }
                  }
                }
              }
            },
            "unstructuredAUPost": {
              "type": "array",
              "items": {
                "properties": {
                  "addressSummaryType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "addressId": {
                    "type": "string",
                    "maxLength": 9
                  },
                  "addressType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "reqaddformatout": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "confirmed": {
                    "type": "boolean"
                  },
                  "postcode": {
                    "type": "string",
                    "maxLength": 4
                  },
                  "state": {
                    "type": "string",
                    "maxLength": 3
                  },
                  "localityName": {
                    "type": "string",
                    "maxLength": 23
                  },
                  "addressline1": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "addressline2": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "parcelDescriptor1": {
                    "type": "string",
                    "maxLength": 7
                  },
                  "condorCode": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "subAddressType": {
                    "type": "string",
                    "maxLength": 100
                  },
                  "serviceLocation": {
                    "type": "object",
                    "properties": {
                      "latitude": {
                        "type": "string",
                        "maxLength": 11
                      },
                      "longitude": {
                        "type": "string",
                        "maxLength": 11
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "ValidationResponseValidationError": {
      "properties": {
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "request": {
          "$ref": "#/definitions/ValidationRequest"
        },
        "requestId": {
          "type": "string"
        },
        "correlationId": {
          "type": "string"
        },
        "time": {
          "type": "string"
        }
      },
      "example": {
        "status": 422,
        "code": 7005,
        "message": "Mandatory Parameter addressLine1 missing in searchData",
        "requestId": "2b1323cf-1223-4776-94c1-a56244f18cb4",
        "correlationId": "f80bd157-0828-4588-8d73-90d070b5a6cf",
        "time": "2018-10-08T10:21:44+10:00",
        "request": {
          "searchData": {}
        }
      }
    },
    "ValidationResponseDownstreamError": {
      "properties": {
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "request": {
          "$ref": "#/definitions/ValidationRequest"
        },
        "requestId": {
          "type": "string"
        },
        "correlationId": {
          "type": "string"
        },
        "time": {
          "type": "string"
        }
      },
      "example": {
        "status": 500,
        "code": 7012,
        "message": "Unable to process request due Address Service connectivity issue.",
        "request": {
          "searchData": {
            "addressLine1": "Unit 4 62 Great Western Highway, PARRAMATTA NSW 2150"
          }
        },
        "requestId": "a18fdae9-f83a-47e0-b03d-1fed516ad52f",
        "correlationId": "a18fdae9-f83a-47e0-b03d-1fed516ad52f",
        "time": "2018-10-08T00:25:54.887Z"
      }
    },
    "ValidationAuthFailureResponse": {
      "properties": {
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "correlationId": {
          "type": "string"
        },
        "timestamp": {
          "type": "string"
        }
      },
      "example": {
        "status": "401",
        "code": "108004",
        "correlationId": "263eb60a-8c6e-4006-e1dc-aa70bfe7bf0c",
        "timestamp": "2018-10-8T0:40:51.720+UTC",
        "message": "Invalid token, authenticaton failed"
      }
    },
    "QuotaFailureResponse": {
      "properties": {
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "correlationId": {
          "type": "string"
        },
        "timestamp": {
          "type": "string"
        }
      },
      "example": {
        "status": "429",
        "code": "108008",
        "correlationId": "263eb60a-8c6e-4006-e1dc-aa70bfe7bf0c",
        "timestamp": "2018-10-8T0:40:51.720+UTC",
        "message": "API quota limit exceeded, unable to process the request. Try later"
      }
    },
    "RequestResponseMetaDataErrorResponse" : {
      "properties": {
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "correlationId": {
          "type": "string"
        },
        "timestamp": {
          "type": "string"
        }
      },
      "example": {
        "status": "411",
        "code": "108009",
        "correlationId": "263eb60a-8c6e-4006-e1dc-aa70bfe7bf0c",
        "timestamp": "2018-10-8T0:40:51.720+UTC",
        "message": "Request received with missing header-ContentLength Missing.Please see API documentation for valid header information"
      }
    },
    "BadRequestErrorResponse": {
      "properties": {
        "status": {
          "type": "integer",
          "format": "int32"
        },
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "correlationId": {
          "type": "string"
        },
        "timestamp": {
          "type": "string"
        }
      },
      "example": {
        "status": "400",
        "code": "108010",
        "correlationId": "263eb60a-8c6e-4006-e1dc-aa70bfe7bf0c",
        "timestamp": "2018-10-8T0:40:51.720+UTC",
        "message": "Response received with missing headers.Please see API documentation for valid header information."
      }
    }
  }
}