| 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.*;
public class dtos
{
public static class Clients extends ClientObject
{
public UUID ApiKey = null;
public UUID getApiKey() { return ApiKey; }
public Clients setApiKey(UUID value) { this.ApiKey = value; return this; }
}
public static class ClientObject
{
public UUID Id = null;
public String Name = null;
public String Address1 = null;
public String Address2 = null;
public String City = null;
public String State = null;
public String Zip = null;
public UUID SubscriptionId = null;
public Boolean Active = null;
public Date EntDate = null;
public Date ModDate = null;
public UUID getId() { return Id; }
public ClientObject setId(UUID value) { this.Id = value; return this; }
public String getName() { return Name; }
public ClientObject setName(String value) { this.Name = value; return this; }
public String getAddress1() { return Address1; }
public ClientObject setAddress1(String value) { this.Address1 = value; return this; }
public String getAddress2() { return Address2; }
public ClientObject setAddress2(String value) { this.Address2 = value; return this; }
public String getCity() { return City; }
public ClientObject setCity(String value) { this.City = value; return this; }
public String getState() { return State; }
public ClientObject setState(String value) { this.State = value; return this; }
public String getZip() { return Zip; }
public ClientObject setZip(String value) { this.Zip = value; return this; }
public UUID getSubscriptionId() { return SubscriptionId; }
public ClientObject setSubscriptionId(UUID value) { this.SubscriptionId = value; return this; }
public Boolean isActive() { return Active; }
public ClientObject setActive(Boolean value) { this.Active = value; return this; }
public Date getEntDate() { return EntDate; }
public ClientObject setEntDate(Date value) { this.EntDate = value; return this; }
public Date getModDate() { return ModDate; }
public ClientObject setModDate(Date value) { this.ModDate = value; return this; }
}
public static class ClientsResponse
{
public ResponseStatus ResponseStatus = null;
public ArrayList<ClientObject> Clients = new ArrayList<ClientObject>();
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public ClientsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
public ArrayList<ClientObject> getClients() { return Clients; }
public ClientsResponse setClients(ArrayList<ClientObject> value) { this.Clients = value; return this; }
}
}
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>