Server

<back to all web services

GetDeviceList

Devices
Requires Authentication
The following routes are available for this service:
GET/api/v1/devices
import Foundation
import ServiceStack

public class GetDeviceList : IHasBearerToken, Codable
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public var bearerToken:String

    /**
    * Optional! Follow the format : /api/v1/devices?filter[ObjektGuid]=*
    */
    // @DataMember(Name="filter[ObjektGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/devices?filter[ObjektGuid]=*", ParameterType="query")
    public var filter_ObjektGuid_:String

    /**
    * Optional! Follow the format : /api/v1/devices?filter[NutzerGuid]=*
    */
    // @DataMember(Name="filter[NutzerGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/devices?filter[NutzerGuid]=*", ParameterType="query")
    public var filter_NutzerGuid_:String

    required public init(){}
}

public class GetDeviceListResponse : Codable
{
    public var deviceList:[Device] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class Device : Codable
{
    // @DataMember(Name="Guid")
    public var Guid:String

    // @DataMember(Name="Geraetenummer")
    public var Geraetenummer:String

    // @DataMember(Name="Bezeichnung")
    public var Bezeichnung:String

    // @DataMember(Name="Beschreibung")
    public var Beschreibung:String

    // @DataMember(Name="Einbaudatum")
    public var Einbaudatum:Date

    // @DataMember(Name="Ausbaudatum")
    public var Ausbaudatum:Date?

    // @DataMember(Name="Eichdatum")
    public var Eichdatum:Date?

    // @DataMember(Name="Einheit")
    public var Einheit:String

    // @DataMember(Name="Memo")
    public var Memo:String

    // @DataMember(Name="DeviceCatalogGuid")
    public var DeviceCatalogGuid:String

    required public init(){}
}


Swift GetDeviceList 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.

GET /api/v1/devices HTTP/1.1 
Host: korrekt-gera-servdesk.eras-online.de 
Accept: text/jsv
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
		}
	}
}