Trendsic Platform Service

<back to all web services

AddressRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/getAddress/{AddressID}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Address() = 
        member val ID:Int32 = new Int32() with get,set
        member val AddressTypeID:Byte = new Byte() with get,set
        member val AddressContact:String = null with get,set
        member val AttentionTo:String = null with get,set
        member val AddressLine1:String = null with get,set
        member val AddressLine2:String = null with get,set
        member val AddressLine3:String = null with get,set
        member val AddressCity:String = null with get,set
        member val AddressState:String = null with get,set
        member val AddressZip:String = null with get,set
        member val AddressCountry:String = null with get,set
        member val PhoneNumber:String = null with get,set
        member val FaxNumber:String = null with get,set
        member val UID:Guid = new Guid() with get,set
        member val Name:String = null with get,set

    [<AllowNullLiteral>]
    type AddressResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Address:Address = null with get,set

    [<AllowNullLiteral>]
    type AddressRequest() = 
        member val AddressID:Int32 = new Int32() with get,set

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