| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/Clients/{Id} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Clients |
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 ClientObject() =
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 SubscriptionId:Guid = new Guid() with get,set
member val Active:Boolean = new Boolean() with get,set
member val EntDate:DateTime = new DateTime() with get,set
member val ModDate:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type ClientsResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val Clients:ResizeArray<ClientObject> = new ResizeArray<ClientObject>() with get,set
[<AllowNullLiteral>]
type Clients() =
inherit ClientObject()
member val ApiKey:Guid = new Guid() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Clients/{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,
SubscriptionId: 00000000000000000000000000000000,
Active: False,
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
}
},
Clients:
[
{
Id: 00000000000000000000000000000000,
Name: String,
Address1: String,
Address2: String,
City: String,
State: String,
Zip: String,
SubscriptionId: 00000000000000000000000000000000,
Active: False,
EntDate: 0001-01-01,
ModDate: 0001-01-01
}
]
}