javascript 地址服务 - 萨斯public.js
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了javascript 地址服务 - 萨斯public.js相关的知识，希望对你有一定的参考价值。
{
"swagger": "2.0",
"info": {
"title": "NBN Structured Address Service API",
"description": "This is the NBN Address Service API that communicated with EAST and gets the address details.",
"version": "1.0.0",
"termsOfService": ""
},
"host": "tapi.telstra.com",
"basePath": "/v1/addresssearch",
"schemes": [
"https"
],
"paths": {
"/addresses": {
"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 'NBNAS'",
"type": "string",
"required": true
},
{
"name": "payload",
"in": "body",
"description": "A JSON payload containing the structured address query",
"required": true,
"schema": {
"$ref": "#/definitions/StructuredAddressRequest"
}
}
],
"responses": {
"200": {
"description": "Success - the address details for a given structured address is returned",
"schema": {
"$ref": "#/definitions/StructuredAddressResponse"
}
},
"400": {
"description": "Invalid or missing request parameters",
"schema": {
"$ref": "#/definitions/Error"
}
},
"401": {
"description": "Invalid or no credentials passed in the request",
"schema": {
"$ref": "#/definitions/Error"
}
},
"422": {
"description": "The request is formed correctly, but due to some condition the request cannot be processed e.g. email is required and it is not provided 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"
}
}
},
"security": []
}
},
"/address-detail": {
"post": {
"operationId": "Get Address By adborId",
"summary": "Get the address details by adborId",
"description": "This API calls EAST to get the address info based on the adborId in the request ",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Authorization header in the format 'Bearer {access_token}' - get the token by using the OAuth API with the scope 'NBNAS'",
"type": "string",
"required": true
},
{
"name": "payload",
"in": "body",
"description": "request data",
"required": true,
"schema": {
"$ref": "#/definitions/AddressDetailsRequest"
}
}
],
"responses": {
"200": {
"description": "Success - the address details for a given adborId is returned",
"schema": {
"$ref": "#/definitions/AddressDetailsResponse"
}
},
"400": {
"description": "Invalid or missing request parameters",
"schema": {
"$ref": "#/definitions/Error"
}
},
"401": {
"description": "Invalid or no credentials passed in the request",
"schema": {
"$ref": "#/definitions/Error"
}
},
"404": {
"description": "Invalid query passed in the request",
"schema": {
"$ref": "#/definitions/Error"
}
},
"422": {
"description": "The request is formed correctly, but due to some condition the request cannot be processed e.g. email is required and it is not provided 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"
}
}
}
}
},
"/addresses/timezones": {
"get": {
"operationId": "Get TimeZone By AdborId",
"summary": "Get TimeZone By AdborId",
"description": "Get TimeZone information from EAST by passing AdborId in the request",
"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 'NBNAS'",
"type": "string",
"required": true
},
{
"name": "addressId",
"in": "query",
"description": "addressId ",
"type": "string",
"required": true
},
{
"name": "dsdate",
"in": "query",
"description": "Date field",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Success - the address details for a given structured address is returned",
"schema": {
"$ref": "#/definitions/TimezoneResponse"
}
},
"400": {
"description": "Invalid or missing request parameters",
"schema": {
"$ref": "#/definitions/Error"
}
},
"401": {
"description": "Invalid or no credentials passed in the request",
"schema": {
"$ref": "#/definitions/Error"
}
},
"422": {
"description": "The request is formed correctly, but due to some condition the request cannot be processed e.g. email is required and it is not provided 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"
}
}
},
"security": []
}
},
"/addresses/nbnLocationId/{nbnLocationId}": {
"get": {
"operationId": "Get address in multiple formats from EAST using LocationId",
"summary": "Get address in multiple formats By NBN LocationId",
"description": "Get address in multiple formats from EAST giving nbnLocationId and reqaddformatout in request",
"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 'NBNAS'",
"type": "string",
"required": true
},
{
"name": "nbnLocationId",
"in": "path",
"description": "NBN LocationId",
"type": "string",
"required": true
},
{
"name": "reqaddformatout",
"in": "query",
"description": "Structured, Unstructured - different address formats, by default both structured and unstructured will be shown",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Success - the address details for a given structured address is returned",
"schema": {
"$ref": "#/definitions/MultipleFormatResponseLocId"
}
},
"400": {
"description": "Invalid or missing request parameters",
"schema": {
"$ref": "#/definitions/SearchMFError"
}
},
"401": {
"description": "Invalid or no credentials passed in the request",
"schema": {
"$ref": "#/definitions/SearchMFError"
}
},
"422": {
"description": "The request is formed correctly, but due to some condition the request cannot be processed e.g. email is required and it is not provided in the request",
"schema": {
"$ref": "#/definitions/SearchMFError"
}
},
"500": {
"description": "An internal error occurred when processing the request",
"schema": {
"$ref": "#/definitions/SearchMFError"
}
},
"503": {
"description": "The service requested is currently unavailable",
"schema": {
"$ref": "#/definitions/SearchMFError"
}
}
},
"security": [
]
}
},
"/addresses/{addressId}": {
"get": {
"operationId": "Get address in multiple formats from EAST",
"summary": "Get address in multiple formats By AdborId",
"description": "Get address in multiple formats from EAST giving AdborId(addressId) and reqaddformatout in request",
"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 'NBNAS'",
"type": "string",
"required": true
},
{
"name": "addressId",
"in": "path",
"description": "AddressId",
"type": "string",
"required": true
},
{
"name": "reqaddformatout",
"in": "query",
"description": "Structured, Unstructured - different address formats and twoLineAUPost - which gives address in two line address, by default both structured and unstructured will be shown",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Success - the address details for a given structured address is returned",
"schema": {
"$ref": "#/definitions/AddressIdResponse"
}
},
"400": {
"description": "Invalid or missing request parameters",
"schema": {
"$ref": "#/definitions/SearchbyIdMFError"
}
},
"401": {
"description": "Invalid or no credentials passed in the request",
"schema": {
"$ref": "#/definitions/SearchbyIdMFError"
}
},
"422": {
"description": "The request is formed correctly, but due to some condition the request cannot be processed e.g. email is required and it is not provided in the request",
"schema": {
"$ref": "#/definitions/SearchbyIdMFError"
}
},
"500": {
"description": "An internal error occurred when processing the request",
"schema": {
"$ref": "#/definitions/SearchbyIdMFError"
}
},
"503": {
"description": "The service requested is currently unavailable",
"schema": {
"$ref": "#/definitions/SearchbyIdMFError"
}
}
},
"security": [
]
}
}
},
"securityDefinitions": {
"OAuth2": {
"type": "oauth2",
"tokenUrl": "tapi.telstra.com/v2/oauth/token",
"flow": "application",
"scopes": {
"NBNAS": "OAuth scope for the Address Service API"
}
}
},
"definitions": {
"StructuredAddressRequest": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"requestParams": {
"type": "object",
"required": [
"streetNumber",
"streetName",
"streetType",
"suburb",
"postcode",
"state"
],
"properties": {
"unitNumber": {
"type": "string",
"maxLength": 10
},
"streetNumber": {
"type": "string",
"maxLength": 7
},
"streetName": {
"type": "string",
"maxLength": 30
},
"streetType": {
"type": "string"
},
"streetSuffix": {
"type": "string"
},
"suburb": {
"type": "string",
"maxLength": 46
},
"state": {
"type": "string"
},
"postcode": {
"type": "string",
"maxLength": 4
},
"addressType": {
"type": "string"
},
"reqaddformatin": {
"type": "string"
},
"reqaddformatout": {
"type": "string"
}
}
}
}
}
},
"example": {
"data": {
"requestParams": {
"streetNumber": "8",
"streetName": "FALABELLA",
"streetType": "St",
"suburb": "BEAUMONT HILLS",
"state": "NSW",
"postcode": "2155",
"reqaddformatin": "0",
"reqaddformatout": "0",
"addressType": "HSE"
}
}
}
},
"StructuredAddressResponse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"addresses": {
"type": "object",
"properties": {
"postcode": {
"type": "integer"
},
"state": {
"type": "string"
},
"locality": {
"type": "string"
},
"streetName": {
"type": "string"
},
"number": {
"type": "integer"
},
"numberTo": {
"type": "integer"
},
"addressId": {
"type": "integer"
},
"addressSummaryType": {
"type": "string"
},
"addressType": {
"type": "string"
},
"streetType": {
"type": "string"
}
}
},
"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-11-28T19:22:14+11:00",
"data": {
"result": {
"status": 0,
"addresses": {
"confirmed": true,
"addressId": "263607749",
"addressSummaryType": "PropertyAddressSummary",
"addressType": "PRNUM",
"postcode": "2155",
"state": "NSW",
"locality": "BEAUMONT HILLS",
"number": 8,
"numberTo": 0,
"streetName": "FALABELLA",
"streetType": "STREET"
},
"serviceLocation": {
"exchangeServiceArea": "KELL",
"facsRealm": "26",
"latitude": "-33:41:28.7",
"longitude": "150:56:02.8"
},
"matchingresultscount": 1
}
},
"request": {
"params": {},
"data": {
"requestParams": {
"streetNumber": "8",
"streetName": "FALABELLA",
"streetType": "St",
"suburb": "BEAUMONT HILLS",
"state": "NSW",
"postcode": "2155",
"reqaddformatin": "0",
"reqaddformatout": "0",
"addressType": "HSE"
}
},
"path": "/addresses",
"method": "POST",
"requestId": "25747f33-c1b2-4bd2-bcf6-e1bd1459705e",
"correlationId": "02ef9509-3da7-4376-a0ef-257888a8e3bd"
},
"correlationId": "02ef9509-3da7-4376-a0ef-257888a8e3bd"
}
},
"AddressDetailsRequest": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"requestParams": {
"type": "object",
"required": [
"adborId"
],
"properties": {
"adborId": {
"type": "string",
"maxLength": 9,
"minLength": 9
}
}
}
}
}
},
"example": {
"data": {
"requestParams": {
"adborId": "161152457"
}
}
}
},
"AddressDetailsResponse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"addresses": {
"type": "object",
"properties": {
"postcode": {
"type": "integer"
},
"state": {
"type": "string"
},
"locality": {
"type": "string"
},
"streetName": {
"type": "string"
},
"number": {
"type": "integer"
},
"numberTo": {
"type": "integer"
},
"addressId": {
"type": "integer"
},
"addressSummaryType": {
"type": "string"
},
"addressType": {
"type": "string"
},
"streetType": {
"type": "string"
}
}
},
"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-11-28T19:30:51+11:00",
"data": {
"result": {
"status": 0,
"addresses": {
"confirmed": true,
"addressSummaryType": "PropertyAddressSummary",
"addressId": "161152457",
"addressType": "PRNUM",
"postcode": "3030",
"state": "VIC",
"locality": "WERRIBEE SOUTH",
"number": 1,
"numberTo": 0,
"streetName": "FINCH",
"streetType": "ROAD"
},
"serviceLocation": {
"exchangeServiceArea": "WBES",
"facsRealm": "39",
"latitude": "-37:58:16.5",
"longitude": "144:41:16.0",
"readyForServiceDate": "2009-10-11",
"locationId": "LOC160829045445",
"customerServiceAreaId": "CSA200000000199"
},
"matchingresultscount": 1
}
},
"request": {
"params": {},
"data": {
"requestParams": {
"adborId": "161152457"
}
},
"path": "/address-detail",
"method": "POST",
"requestId": "80a5fc6b-e4f5-4a41-9826-42afcf57d669",
"correlationId": "be66fb03-c34e-4e4d-a859-8f1345d25db9"
},
"correlationId": "be66fb03-c34e-4e4d-a859-8f1345d25db9"
}
},
"TimezoneResponse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"locationTimeZones": {
"type": "object"
}
}
},
"status": {
"type": "string"
}
}
}
},
"example": {
"code": 200,
"status": 200,
"time": "2017-03-24T18:22:33+11:00",
"data": {
"result": {
"status": {
"statusCode": "SUCCESS"
},
"locationTimeZones": [
{
"tzLabel": "AEST",
"tzOffset": "+10:00",
"locale": "(GMT+10:00) CANBERRA,MELBOURNE, SYDNEY",
"daylightSavingsInfo": {
"observanceDateCurrent": "2016-04-02T15:00:00.000Z",
"observanceDateNext": "2016-10-01T16:00:00.000Z",
"dsLabel": "AEDT",
"dsOffset": "+01:00",
"dsInEffect": false
}
}
]
}
},
"request": {
"params": {
"addressId": "427212987",
"dsdate": "2016-07-15T04:25:10.897Z"
},
"data": {},
"path": "/addresses/timezones",
"method": "GET",
"requestId": "836beb97-75fb-45cd-a22f-d0624b37225a",
"correlationId": "abf47512-c28c-4da0-9665-c257ed59533b"
},
"correlationId": "abf47512-c28c-4da0-9665-c257ed59533b"
}
},
"MultipleFormatResponseLocId": {
"description": "The default length value is 100",
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "response code for the message"
},
"time": {
"type": "string",
"format": "date-time",
"description": "The date and time when the message was received by recipient."
},
"data": {
"type": "object",
"properties": {
"transactionStatus": {
"type": "string"
},
"matchingresultscount": {
"type": "integer"
},
"structured": {
"type": "object",
"properties": {
"addresses": {
"type": "object",
"properties": {
"addressSummaryType": {
"type": "string",
"maxLength": 100
},
"addressId": {
"type": "integer",
"maxLength": 9
},
"addressType": {
"type": "string",
"maxLength": 100
},
"confirmed": {
"type": "boolean"
},
"subAddressType": {
"type": "string",
"maxLength": 100
},
"planNumber": {
"type": "string",
"maxLength": 100
},
"parceltype1": {
"type": "string",
"maxLength": 100
},
"parceldescriptiontype1": {
"type": "string",
"maxLength": 100
},
"parcelDescriptor1": {
"type": "integer",
"maxLength": 5
},
"parceltype2": {
"type": "string",
"maxLength": 100
},
"parceldescriptiontype2": {
"type": "string",
"maxLength": 100
},
"parcelDescriptor2": {
"type": "string",
"maxLength": 5
},
"name": {
"type": "string",
"maxLength": 100
},
"ruralmailNumber": {
"type": "string",
"maxLength": 100
},
"ruralmailType": {
"type": "string",
"maxLength": 100
},
"fsam": {
"type": "string",
"maxLength": 7
},
"condorCode": {
"type": "string",
"maxLength": 100
},
"reqaddformatout": {
"type": "string",
"maxLength": 100
},
"postcode": {
"type": "integer",
"maxLength": 4
},
"state": {
"type": "string",
"maxLength": 3
},
"localityName": {
"type": "string",
"maxLength": 23
},
"streetName": {
"type": "string",
"maxLength": 30
},
"streetType": {
"type": "string",
"maxLength": 17
},
"streetSuffix": {
"type": "string",
"maxLength": 100
},
"numSubaddresses": {
"type": "integer",
"maxLength": 100
},
"subaddresses": {
"type": "object",
"maxLength": 100
},
"propertyName": {
"type": "string",
"maxLength": 100
},
"propertyNumberFrom": {
"type": "integer",
"maxLength": 5
},
"propertyNumberTo": {
"type": "integer",
"maxLength": 5
},
"propertyNumberSuffixFrom": {
"type": "string",
"maxLength": 100
},
"propertyNumberSuffixTo": {
"type": "string",
"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": "object",
"properties": {
"addresses": {
"type": "object",
"properties": {
"addressSummaryType": {
"type": "string",
"maxLength": 100
},
"addressId": {
"type": "integer",
"maxLength": 9
},
"addressType": {
"type": "string",
"maxLength": 100
},
"confirmed": {
"type": "boolean"
},
"subAddressType": {
"type": "string",
"maxLength": 100
},
"planNumber": {
"type": "string",
"maxLength": 100
},
"parceltype1": {
"type": "string",
"maxLength": 100
},
"parceldescriptiontype1": {
"type": "string",
"maxLength": 100
},
"parcelDescriptor1": {
"type": "integer",
"maxLength": 100
},
"parceltype2": {
"type": "string",
"maxLength": 100
},
"parceldescriptiontype2": {
"type": "string",
"maxLength": 100
},
"parcelDescriptor2": {
"type": "string",
"maxLength": 100
},
"name": {
"type": "string",
"maxLength": 100
},
"ruralmailNumber": {
"type": "string",
"maxLength": 100
},
"ruralmailType": {
"type": "string",
"maxLength": 100
},
"fsam": {
"type": "string",
"maxLength": 7
},
"condorCode": {
"type": "string",
"maxLength": 100
},
"reqaddformatout": {
"type": "string",
"maxLength": 100
},
"postcode": {
"type": "integer",
"maxLength": 4
},
"state": {
"type": "string",
"maxLength": 3
},
"localityName": {
"type": "string",
"maxLength": 23
},
"addressline1": {
"type": "string",
"maxLength": 100
},
"addressline2": {
"type": "string",
"maxLength": 100
},
"addressline3": {
"type": "string",
"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
}
}
}
}
}
}
}
},
"example": {
"code": 200,
"status": 200,
"time": "2017-03-24T18:33:16+11:00",
"data": {
"transactionStatus": "Success",
"matchingresultscount": 1,
"structured": {
"addresses": {
"addressSummaryType": "PropertyAddressSummary",
"addressId": "65328200",
"addressType": "Property with Number",
"confirmed": true,
"reqaddformatout": "structured",
"condorCode": "ACTN",
"numSubaddresses": 0,
"postcode": "2601",
"state": "ACT",
"localityName": "ACTON",
"propertyNumberFrom": 55,
"propertyNumberTo": "",
"streetName": "BALMAIN",
"streetType": "CRESCENT",
"propertyNumberSuffixFrom": "E"
},
"serviceLocation": {
"latitude": "-35:17:05.7",
"longitude": "149:07:03.7",
"exchangeServiceArea": "CVIC",
"facsRealm": "73"
}
},
"unstructuredAUPost": {
"addresses": {
"addressSummaryType": "FormattedAddressSummary",
"addressId": "65328200",
"addressType": "Property with Number",
"reqaddformatout": "unstructuredAUPost",
"confirmed": true,
"postcode": "2601",
"state": "ACT",
"localityName": "ACTON",
"condorCode": "ACTN",
"addressline1": "55E BALMAIN CRES,"
},
"serviceLocation": {
"latitude": "-35:17:05.7",
"longitude": "149:07:03.7"
}
}
},
"request": {
"params": {
"addressId": "65328200",
"reqaddformatout": "unstructuredAUPost,structured"
},
"data": {},
"path": "/addresses/:addressId",
"method": "GET",
"requestId": "4c22b144-6b24-4e23-bc33-55b227d8392f",
"correlationId": "5a5c4678-309b-4042-88da-194a92930815"
},
"correlationId": "5a5c4678-309b-4042-88da-194a92930815"
}
},
"Error": {
"description": "This error scenario is applicable for the '/addresses' [POST], '/address-detail' [POST] and '/addresses/timezones' [GET] entry points. ",
"type": "object",
"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"
}
},
"request": {
"type": "object",
"description": "The error request metadata received by the client"
},
"correlationId": {
"type": "string",
"description": "Correlation Id received by the client"
}
},
"example": {
"code": 422,
"status": 422,
"time": "2017-12-01T14:53:28+05:30",
"errors": [
{
"field": "adborId",
"message": "The Maximum Length Of AdborId should not Exceed than 9",
"code": 1000
}
],
"request": {
"params": {},
"data": {
"requestParams": {
"adborId": "16115245711"
}
},
"path": "/address-detail",
"method": "POST",
"requestId": "12ab5279-22db-4f27-9006-76177b5165af",
"correlationId": "c7cf2568-6040-4f93-952e-d42364cf1066"
},
"correlationId": "c7cf2568-6040-4f93-952e-d42364cf1066"
}
},
"SearchbyIdMFError": {
"description": "This error scenario is applicable for the '/addresses/{addressId}' [GET] entry point.",
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "The error 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",
"description": "Error message description."
},
"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": 3002,
"status": 500,
"time": "2017-12-01T14:55:45+05:30",
"message": "Address search is incomplete, cannot retrieve detailed record",
"request": {
"params": {
"addressId": "1611524"
},
"data": {},
"path": "/addresses/:addressId",
"method": "GET",
"requestId": "71848e92-5e3b-4461-9810-a25f35d737a4",
"correlationId": "0b5f7065-7023-4e0d-ade5-5997b83b265d"
},
"correlationId": "0b5f7065-7023-4e0d-ade5-5997b83b265d"
}
},
"SearchMFError": {
"description": "This error scenario is applicable for the '/addresses/{addressId}' [GET] entry point.",
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "The error 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",
"description": "Error message description."
},
"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": 3006,
"status": 422,
"time": "2018-01-18T12:22:44+11:00",
"message": "Unable to process the request",
"request": {
"params": {
"nbnLocationId": "",
"reqaddformatout": "unstructuredAUPost,structured"
},
"data": {},
"path": "/addresses/nbnLocationId/:nbnLocationId",
"method": "GET",
"requestId": "bb62fb82-da35-490a-9cee-67bcdc873921",
"correlationId": "b1a82121-c820-4255-b151-591e97efb777"
},
"correlationId": "b1a82121-c820-4255-b151-591e97efb777"
}
},
"AddressIdResponse": {
"description": "The default length value is 100",
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "response code for the message"
},
"time": {
"type": "string",
"format": "date-time",
"description": "The date and time when the message was received by recipient."
},
"data": {
"type": "object",
"properties": {
"transactionStatus": {
"type": "string"
},
"matchingresultscount": {
"type": "integer"
},
"structured": {
"type": "object",
"properties": {
"addresses": {
"type": "object",
"properties": {
"addressSummaryType": {
"type": "string",
"maxLength": 100
},
"addressId": {
"type": "integer",
"maxLength": 9
},
"addressType": {
"type": "string",
"maxLength": 100
},
"confirmed": {
"type": "boolean"
},
"subAddressType": {
"type": "string",
"maxLength": 100
},
"planNumber": {
"type": "string",
"maxLength": 100
},
"parceltype1": {
"type": "string",
"maxLength": 100
},
"parceldescriptiontype1": {
"type": "string",
"maxLength": 100
},
"parcelDescriptor1": {
"type": "integer",
"maxLength": 5
},
"parceltype2": {
"type": "string",
"maxLength": 100
},
"parceldescriptiontype2": {
"type": "string",
"maxLength": 100
},
"parcelDescriptor2": {
"type": "string",
"maxLength": 5
},
"name": {
"type": "string",
"maxLength": 100
},
"ruralmailNumber": {
"type": "string",
"maxLength": 100
},
"ruralmailType": {
"type": "string",
"maxLength": 100
},
"fsam": {
"type": "string",
"maxLength": 7
},
"condorCode": {
"type": "string",
"maxLength": 100
},
"reqaddformatout": {
"type": "string",
"maxLength": 100
},
"postcode": {
"type": "integer",
"maxLength": 4
},
"state": {
"type": "string",
"maxLength": 3
},
"localityName": {
"type": "string",
"maxLength": 23
},
"streetName": {
"type": "string",
"maxLength": 30
},
"streetType": {
"type": "string",
"maxLength": 17
},
"streetSuffix": {
"type": "string",
"maxLength": 100
},
"numSubaddresses": {
"type": "integer",
"maxLength": 100
},
"subaddresses": {
"type": "object",
"maxLength": 100
},
"propertyName": {
"type": "string",
"maxLength": 100
},
"propertyNumberFrom": {
"type": "integer",
"maxLength": 5
},
"propertyNumberTo": {
"type": "integer",
"maxLength": 5
},
"propertyNumberSuffixFrom": {
"type": "string",
"maxLength": 100
},
"propertyNumberSuffixTo": {
"type": "string",
"maxLength": 100
}
}
},
"serviceLocation": {
"type": "object",
"properties": {
"latitude": {
"type": "string",
"maxLength": 11
},
"longitude": {
"type": "string",
"maxLength": 11
},
"exchangeServiceArea": {
"type": "string",
"maxLength": 100
},
"facsRealm": {
"type": "string",
"maxLength": 2
}
}
}
}
},
"unstructuredAUPost": {
"type": "object",
"properties": {
"addresses": {
"type": "object",
"properties": {
"addressSummaryType": {
"type": "string",
"maxLength": 100
},
"addressId": {
"type": "integer",
"maxLength": 9
},
"addressType": {
"type": "string",
"maxLength": 100
},
"confirmed": {
"type": "boolean"
},
"subAddressType": {
"type": "string",
"maxLength": 100
},
"planNumber": {
"type": "string",
"maxLength": 100
},
"parceltype1": {
"type": "string",
"maxLength": 100
},
"parceldescriptiontype1": {
"type": "string",
"maxLength": 100
},
"parcelDescriptor1": {
"type": "integer",
"maxLength": 100
},
"parceltype2": {
"type": "string",
"maxLength": 100
},
"parceldescriptiontype2": {
"type": "string",
"maxLength": 100
},
"parcelDescriptor2": {
"type": "string",
"maxLength": 100
},
"name": {
"type": "string",
"maxLength": 100
},
"ruralmailNumber": {
"type": "string",
"maxLength": 100
},
"ruralmailType": {
"type": "string",
"maxLength": 100
},
"fsam": {
"type": "string",
"maxLength": 7
},
"condorCode": {
"type": "string",
"maxLength": 100
},
"reqaddformatout": {
"type": "string",
"maxLength": 100
},
"postcode": {
"type": "integer",
"maxLength": 4
},
"state": {
"type": "string",
"maxLength": 3
},
"localityName": {
"type": "string",
"maxLength": 23
},
"addressline1": {
"type": "string",
"maxLength": 100
},
"addressline2": {
"type": "string",
"maxLength": 100
},
"addressline3": {
"type": "string",
"maxLength": 100
}
}
},
"serviceLocation": {
"type": "object",
"properties": {
"latitude": {
"type": "string",
"maxLength": 11
},
"longitude": {
"type": "string",
"maxLength": 11
},
"exchangeServiceArea": {
"type": "string",
"maxLength": 100
},
"facsRealm": {
"type": "string",
"maxLength": 2
}
}
}
}
},
"twoLineAUPost": {
"type": "object",
"properties": {
"addressId": {
"type": "string",
"maxLength": 9
},
"localityName": {
"type": "string",
"maxLength": 23
},
"postcode": {
"type": "integer",
"maxLength": 4
},
"state": {
"type": "string",
"maxLength": 3
},
"addressline1": {
"type": "string"
},
"addressline2": {
"type": "string"
}
}
}
}
}
},
"example": {
"code": 200,
"status": 200,
"time": "2017-03-24T18:33:16+11:00",
"data": {
"transactionStatus": "Success",
"matchingresultscount": 1,
"structured": {
"addresses": {
"addressSummaryType": "PropertyAddressSummary",
"addressId": "65328200",
"addressType": "Property with Number",
"confirmed": true,
"reqaddformatout": "structured",
"condorCode": "ACTN",
"numSubaddresses": 0,
"postcode": "2601",
"state": "ACT",
"localityName": "ACTON",
"propertyNumberFrom": 55,
"propertyNumberTo": "",
"streetName": "BALMAIN",
"streetType": "CRESCENT",
"propertyNumberSuffixFrom": "E"
},
"serviceLocation": {
"latitude": "-35:17:05.7",
"longitude": "149:07:03.7",
"exchangeServiceArea": "CVIC",
"facsRealm": "73"
}
},
"unstructuredAUPost": {
"addresses": {
"addressSummaryType": "FormattedAddressSummary",
"addressId": "65328200",
"addressType": "Property with Number",
"reqaddformatout": "unstructuredAUPost",
"confirmed": true,
"postcode": "2601",
"state": "ACT",
"localityName": "ACTON",
"condorCode": "ACTN",
"addressline1": "55E BALMAIN CRES,"
},
"serviceLocation": {
"latitude": "-35:17:05.7",
"longitude": "149:07:03.7"
}
},
"twoLineAUPost": {
"addressId": "426997755",
"localityName": "ACTON",
"postcode": "2601",
"state": "ACT",
"addressline1": "SOUTH",
"addressline2": "CSIRO, 16 CLUNIES ROSS STREET"
}
},
"request": {
"params": {
"addressId": "65328200",
"reqaddformatout": "unstructuredAUPost,structured,twoLineAUPost"
},
"data": {
},
"path": "/addresses/:addressId",
"method": "GET",
"requestId": "4c22b144-6b24-4e23-bc33-55b227d8392f",
"correlationId": "5a5c4678-309b-4042-88da-194a92930815"
},
"correlationId": "5a5c4678-309b-4042-88da-194a92930815"
}
}
}
}以上是关于javascript 地址服务 - 萨斯public.js的主要内容，如果未能解决你的问题，请参考以下文章
Arthas（阿尔萨斯）-java诊断工具-----来源于网络