CDD Engine Web Service v2.14.0.0

<back to all web services

AddressRequest

iNASA
Requires Authentication
The following routes are available for this service:
GET, POST/Address
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Capture_Interactive_Retrieve_v1_00_Results:
    id: Optional[str] = None
    domestic_id: Optional[str] = None
    language: Optional[str] = None
    language_alternatives: Optional[str] = None
    department: Optional[str] = None
    company: Optional[str] = None
    sub_building: Optional[str] = None
    building_number: Optional[str] = None
    building_name: Optional[str] = None
    secondary_street: Optional[str] = None
    street: Optional[str] = None
    block: Optional[str] = None
    neighbourhood: Optional[str] = None
    district: Optional[str] = None
    city: Optional[str] = None
    line1: Optional[str] = None
    line2: Optional[str] = None
    line3: Optional[str] = None
    line4: Optional[str] = None
    line5: Optional[str] = None
    admin_area_name: Optional[str] = None
    admin_area_code: Optional[str] = None
    province: Optional[str] = None
    province_name: Optional[str] = None
    province_code: Optional[str] = None
    postal_code: Optional[str] = None
    country_name: Optional[str] = None
    country_iso2: Optional[str] = None
    country_iso3: Optional[str] = None
    country_iso_number: Optional[int] = None
    sorting_number1: Optional[str] = None
    sorting_number2: Optional[str] = None
    barcode: Optional[str] = None
    po_box_number: Optional[str] = None
    label: Optional[str] = None
    type: Optional[str] = None
    data_level: Optional[str] = None
    field1: Optional[str] = None
    field2: Optional[str] = None
    field3: Optional[str] = None
    field4: Optional[str] = None
    field5: Optional[str] = None
    field6: Optional[str] = None
    field7: Optional[str] = None
    field8: Optional[str] = None
    field9: Optional[str] = None
    field10: Optional[str] = None
    field11: Optional[str] = None
    field12: Optional[str] = None
    field13: Optional[str] = None
    field14: Optional[str] = None
    field15: Optional[str] = None
    field16: Optional[str] = None
    field17: Optional[str] = None
    field18: Optional[str] = None
    field19: Optional[str] = None
    field20: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Capture_Interactive_Find_v1_00_Results:
    id: Optional[str] = None
    type: Optional[str] = None
    text: Optional[str] = None
    highlight: Optional[str] = None
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdderessResponse:
    successful: Optional[bool] = None
    """
    Contains response status, details and errors.
    """

    csr: Optional[str] = None
    """
    The Csr of the application (if available).
    """

    retrieve_result: Optional[List[Capture_Interactive_Retrieve_v1_00_Results]] = None
    """
    Contains the Adderess lookup Retrieve result when successful.
    """

    find_results: Optional[List[Capture_Interactive_Find_v1_00_Results]] = None
    """
    Contains the Adderess lookup Find result when successful.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressRequest:
    # @Required()
    text: Optional[str] = None
    """
    The Text is address code.
    """


    # @Required()
    container: Optional[str] = None
    """
    The Container is address Id.
    """


    # @Required()
    type: Optional[str] = None
    """
    The Type is type of addresss.
    """


    csr: Optional[str] = None
    """
    The Csr of the application (if available).
    """

    source_code: Optional[str] = None
    """
    The SourceCode of the Adderess.
    """

Python AddressRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Address HTTP/1.1 
Host: wpcdd-featuretest-ws.worldpay.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Text":"String","Container":"String","Type":"String","CSR":"String","SourceCode":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Successful":false,"Csr":"String"}