BokaMera.API.Host

<back to all web services

CodeLockRcoM5SettingQuery

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ValidateRequest(Validator:="IsAuthenticated")>
        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ApiResponse(Description:="You have too low privileges to call this service", StatusCode:=403)>
        Public Partial Class CodeLockRcoM5SettingQuery
            Implements ICompany
            '''<Summary>
            '''The company id, if empty will use the company id for the user you are logged in with.
            '''</Summary>
            <ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
            Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId
        End Class

        Public Partial Class CodeLockRcoM5SettingResponse
            Public Overridable Property CompanyId As Guid
            '''<Summary>
            '''Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Overrides BokaMera's default M5AdminAPI URL (e.g. https://host/M5AdminAPI/).")>
            Public Overridable Property ApiEndpoint As String

            '''<Summary>
            '''Server id from rcoservers.config of the M5AdminAPI installation.
            '''</Summary>
            <ApiMember(DataType:="int", Description:="Server id from rcoservers.config of the M5AdminAPI installation.")>
            Public Overridable Property ServerId As Integer

            '''<Summary>
            '''System name exactly as in R-CARD M5 Arbetsstation.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="System name exactly as in R-CARD M5 Arbetsstation.")>
            Public Overridable Property SystemName As String

            '''<Summary>
            '''The API operator username to logon to the RCO M5 system.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API operator username to logon to the RCO M5 system.")>
            Public Overridable Property Username As String

            '''<Summary>
            '''The API operator password to logon to the RCO M5 system.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API operator password to logon to the RCO M5 system.")>
            Public Overridable Property Password As String

            '''<Summary>
            '''When settings were created
            '''</Summary>
            <ApiMember(DataType:="datetime", Description:="When settings were created")>
            Public Overridable Property Created As Date

            '''<Summary>
            '''When settings were updated
            '''</Summary>
            <ApiMember(DataType:="datetime", Description:="When settings were updated")>
            Public Overridable Property Updated As Date
        End Class
    End Namespace
End Namespace

VB.NET CodeLockRcoM5SettingQuery DTOs

GET /codelock/rcom5/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ApiEndpoint: String,
	ServerId: 0,
	SystemName: String,
	Username: String,
	Password: String
}