Trendsic Platform Service

<back to all web services

StationsRequest

Requires Authentication
Required roles:Administrator, Administrator, AdministratorRequires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Stations/{Id}
GET,OPTIONS/v1/StationsByLocation/{LocationId}
GET,POST,PUT,DELETE,OPTIONS/v1/Stations
import Foundation
import ServiceStack

public class StationsRequest : Codable
{
    public var id:String
    public var locationId:String
    public var stations:[Station] = []

    required public init(){}
}

public class Station : Codable
{
    public var id:String
    public var locationId:String
    public var locationName:String
    public var stationName:String
    public var active:Bool

    required public init(){}
}

public class StationsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var stations:[Station] = []

    required public init(){}
}


Swift StationsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/Stations/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 00000000000000000000000000000000,
	LocationId: 00000000000000000000000000000000,
	Stations: 
	[
		{
			Id: 00000000000000000000000000000000,
			LocationId: 00000000000000000000000000000000,
			LocationName: String,
			StationName: String,
			Active: False
		}
	]
}
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
		}
	},
	Stations: 
	[
		{
			Id: 00000000000000000000000000000000,
			LocationId: 00000000000000000000000000000000,
			LocationName: String,
			StationName: String,
			Active: False
		}
	]
}