| Required roles: | Administrator, Administrator, Administrator | Requires any of the roles: | Worker, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/Locations/{Id} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Locations |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class LocationsRequest
{
public UUID Id = null;
public ArrayList<Location> Locations = new ArrayList<Location>();
public UUID getId() { return Id; }
public LocationsRequest setId(UUID value) { this.Id = value; return this; }
public ArrayList<Location> getLocations() { return Locations; }
public LocationsRequest setLocations(ArrayList<Location> value) { this.Locations = value; return this; }
}
public static class Location
{
public UUID Id = null;
public UUID ClientId = 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 String Phone = null;
public String Fax = null;
public String TimeZone = null;
public Boolean Active = null;
public Date EntDate = null;
public Date ModDate = null;
public UUID getId() { return Id; }
public Location setId(UUID value) { this.Id = value; return this; }
public UUID getClientId() { return ClientId; }
public Location setClientId(UUID value) { this.ClientId = value; return this; }
public String getName() { return Name; }
public Location setName(String value) { this.Name = value; return this; }
public String getAddress1() { return Address1; }
public Location setAddress1(String value) { this.Address1 = value; return this; }
public String getAddress2() { return Address2; }
public Location setAddress2(String value) { this.Address2 = value; return this; }
public String getCity() { return City; }
public Location setCity(String value) { this.City = value; return this; }
public String getState() { return State; }
public Location setState(String value) { this.State = value; return this; }
public String getZip() { return Zip; }
public Location setZip(String value) { this.Zip = value; return this; }
public String getPhone() { return Phone; }
public Location setPhone(String value) { this.Phone = value; return this; }
public String getFax() { return Fax; }
public Location setFax(String value) { this.Fax = value; return this; }
public String getTimeZone() { return TimeZone; }
public Location setTimeZone(String value) { this.TimeZone = value; return this; }
public Boolean isActive() { return Active; }
public Location setActive(Boolean value) { this.Active = value; return this; }
public Date getEntDate() { return EntDate; }
public Location setEntDate(Date value) { this.EntDate = value; return this; }
public Date getModDate() { return ModDate; }
public Location setModDate(Date value) { this.ModDate = value; return this; }
}
public static class LocationsResponse
{
public ResponseStatus ResponseStatus = null;
public ArrayList<Location> Locations = new ArrayList<Location>();
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public LocationsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
public ArrayList<Location> getLocations() { return Locations; }
public LocationsResponse setLocations(ArrayList<Location> value) { this.Locations = 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/Locations/{Id} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<LocationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Id>00000000-0000-0000-0000-000000000000</Id>
<Locations>
<Location>
<Active>false</Active>
<Address1>String</Address1>
<Address2>String</Address2>
<City>String</City>
<ClientId>00000000-0000-0000-0000-000000000000</ClientId>
<EntDate>0001-01-01T00:00:00</EntDate>
<Fax>String</Fax>
<Id>00000000-0000-0000-0000-000000000000</Id>
<ModDate>0001-01-01T00:00:00</ModDate>
<Name>String</Name>
<Phone>String</Phone>
<State>String</State>
<TimeZone>String</TimeZone>
<Zip>String</Zip>
</Location>
</Locations>
</LocationsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<LocationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Locations>
<Location>
<Active>false</Active>
<Address1>String</Address1>
<Address2>String</Address2>
<City>String</City>
<ClientId>00000000-0000-0000-0000-000000000000</ClientId>
<EntDate>0001-01-01T00:00:00</EntDate>
<Fax>String</Fax>
<Id>00000000-0000-0000-0000-000000000000</Id>
<ModDate>0001-01-01T00:00:00</ModDate>
<Name>String</Name>
<Phone>String</Phone>
<State>String</State>
<TimeZone>String</TimeZone>
<Zip>String</Zip>
</Location>
</Locations>
<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>
</LocationsResponse>