Trendsic Platform Service

<back to all web services

QueueCustomerRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Customers/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/Customers
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 QueueCustomer() = 
        member val Id:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val Zip:String = null with get,set
        member val MobilePhone:String = null with get,set
        member val Email:String = null with get,set
        member val MarketingOptIn:DateTime = new DateTime() with get,set
        member val DoNoContact:DateTime = new DateTime() with get,set
        member val EntDate:DateTime = new DateTime() with get,set
        member val ModDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type QueueCustomersResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Customers:ResizeArray<QueueCustomer> = new ResizeArray<QueueCustomer>() with get,set

    [<AllowNullLiteral>]
    type QueueCustomerRequest() = 
        inherit QueueCustomer()
        member val ApiKey:Guid = new Guid() with get,set

F# QueueCustomerRequest 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.

POST /v1/Customers/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: 00000000000000000000000000000000,
	Id: 00000000000000000000000000000000,
	Name: String,
	Address1: String,
	Address2: String,
	City: String,
	State: String,
	Zip: String,
	MobilePhone: String,
	Email: String,
	MarketingOptIn: 0001-01-01,
	DoNoContact: 0001-01-01,
	EntDate: 0001-01-01,
	ModDate: 0001-01-01
}
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
		}
	},
	Customers: 
	[
		{
			Id: 00000000000000000000000000000000,
			Name: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Zip: String,
			MobilePhone: String,
			Email: String,
			MarketingOptIn: 0001-01-01,
			DoNoContact: 0001-01-01,
			EntDate: 0001-01-01,
			ModDate: 0001-01-01
		}
	]
}