Trendsic Platform Service

<back to all web services

AddressRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/getAddress/{AddressID}
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 Address:
    id: int = 0
    address_type_i_d: int = 0
    address_contact: Optional[str] = None
    attention_to: Optional[str] = None
    address_line1: Optional[str] = None
    address_line2: Optional[str] = None
    address_line3: Optional[str] = None
    address_city: Optional[str] = None
    address_state: Optional[str] = None
    address_zip: Optional[str] = None
    address_country: Optional[str] = None
    phone_number: Optional[str] = None
    fax_number: Optional[str] = None
    uid: Optional[str] = None
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressResponse:
    response_status: Optional[ResponseStatus] = None
    address: Optional[Address] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressRequest:
    address_i_d: int = 0

Python AddressRequest DTOs

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

HTTP + JSV

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

GET /v1/getAddress/{AddressID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Address: 
	{
		ID: 0,
		AddressTypeID: 0,
		AddressContact: String,
		AttentionTo: String,
		AddressLine1: String,
		AddressLine2: String,
		AddressLine3: String,
		AddressCity: String,
		AddressState: String,
		AddressZip: String,
		AddressCountry: String,
		PhoneNumber: String,
		FaxNumber: String,
		UID: 00000000000000000000000000000000,
		Name: String
	}
}