| 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 |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class Clients : ClientObject()
{
open var ApiKey:UUID? = null
}
open class ClientObject
{
open var Id:UUID? = null
open var Name:String? = null
open var Address1:String? = null
open var Address2:String? = null
open var City:String? = null
open var State:String? = null
open var Zip:String? = null
open var SubscriptionId:UUID? = null
open var Active:Boolean? = null
open var EntDate:Date? = null
open var ModDate:Date? = null
}
open class ClientsResponse
{
open var ResponseStatus:ResponseStatus? = null
open var Clients:ArrayList<ClientObject> = ArrayList<ClientObject>()
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<Clients xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Active>false</Active>
<Address1>String</Address1>
<Address2>String</Address2>
<City>String</City>
<EntDate>0001-01-01T00:00:00</EntDate>
<Id>00000000-0000-0000-0000-000000000000</Id>
<ModDate>0001-01-01T00:00:00</ModDate>
<Name>String</Name>
<State>String</State>
<SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
<Zip>String</Zip>
<ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
</Clients>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ClientsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Clients>
<ClientObject>
<Active>false</Active>
<Address1>String</Address1>
<Address2>String</Address2>
<City>String</City>
<EntDate>0001-01-01T00:00:00</EntDate>
<Id>00000000-0000-0000-0000-000000000000</Id>
<ModDate>0001-01-01T00:00:00</ModDate>
<Name>String</Name>
<State>String</State>
<SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
<Zip>String</Zip>
</ClientObject>
</Clients>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</ClientsResponse>