| 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 Foundation
import ServiceStack
public class LocationsRequest : Codable
{
public var id:String
public var locations:[Location] = []
required public init(){}
}
public class Location : Codable
{
public var id:String
public var clientId:String
public var name:String
public var address1:String
public var address2:String
public var city:String
public var state:String
public var zip:String
public var phone:String
public var fax:String
public var timeZone:String
public var active:Bool
public var entDate:Date
public var modDate:Date
required public init(){}
}
public class LocationsResponse : Codable
{
public var responseStatus:ResponseStatus
public var locations:[Location] = []
required public init(){}
}
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/Locations/{Id} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Id: 00000000000000000000000000000000,
Locations:
[
{
Id: 00000000000000000000000000000000,
ClientId: 00000000000000000000000000000000,
Name: String,
Address1: String,
Address2: String,
City: String,
State: String,
Zip: String,
Phone: String,
Fax: String,
TimeZone: String,
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
}
},
Locations:
[
{
Id: 00000000000000000000000000000000,
ClientId: 00000000000000000000000000000000,
Name: String,
Address1: String,
Address2: String,
City: String,
State: String,
Zip: String,
Phone: String,
Fax: String,
TimeZone: String,
Active: False,
EntDate: 0001-01-01,
ModDate: 0001-01-01
}
]
}