Antel API

<back to all web services

AutoLogin

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ServiceModel
Imports WebService.ServiceModel.Base

Namespace Global

    Namespace WebService.ServiceModel

        Public Partial Class AutoLogin
            Inherits ApiServiceRequest
            Public Overridable Property SystemUserId As Integer
            Public Overridable Property RefreshToken As String
            Public Overridable Property UtcOffset As Integer
        End Class

        Public Partial Class AutoLoginResponse
            Inherits ApiServiceResponse
            Public Overridable Property Data As LoginData
        End Class

        Public Partial Class ClaimNumberRule
            Public Overridable Property PrincipalId As Integer
            Public Overridable Property ChannelName As String
            Public Overridable Property RulePattern As String
        End Class

        Public Partial Class LoginData
            Public Sub New()
                StockOperators = New List(Of StockOperatorData)
                ClaimNumberRules = New List(Of ClaimNumberRule)
                PauseUpliftReasons = New List(Of String)
                NoGoodsToUpliftReasons = New List(Of String)
            End Sub

            Public Overridable Property SystemUserId As Integer
            Public Overridable Property RefreshToken As String
            Public Overridable Property FriendlyName As String
            Public Overridable Property VatValue As Decimal
            Public Overridable Property CanUplift As Boolean
            Public Overridable Property StockCanDropOff As Boolean
            Public Overridable Property StockCanCloseArrival As Boolean
            Public Overridable Property BlockUpliftIfLineCountDoesNotMatch As Boolean
            Public Overridable Property BlockUpliftIfQuantityDoesNotMatch As Boolean
            Public Overridable Property CanRipTip As Boolean
            Public Overridable Property CanDeleteUplifts As Boolean
            Public Overridable Property StockOperators As List(Of StockOperatorData)
            Public Overridable Property ClaimNumberRules As List(Of ClaimNumberRule)
            Public Overridable Property UpliftSyncInterval As Integer
            Public Overridable Property LateUpliftThreshold As Integer
            Public Overridable Property PauseUpliftReasons As List(Of String)
            Public Overridable Property NoGoodsToUpliftReasons As List(Of String)
            Public Overridable Property BlurryImageErrorScore As Decimal
            Public Overridable Property BlurryImageWarningScore As Decimal
            Public Overridable Property BlurryImageDetectionEnabled As Boolean
            Public Overridable Property ProfileImageUrl As String
            Public Overridable Property ClaimValueWarningVariance As Double
            Public Overridable Property StockCanVehicleAssignment As Boolean
            Public Overridable Property StockCanOperatorAssignment As Boolean
            Public Overridable Property StockCanStockEnd As Boolean
            Public Overridable Property StockCanCheckSealDetails As Boolean
            Public Overridable Property StockManualEnabled As Boolean
        End Class

        Public Partial Class StockOperatorData
            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
        End Class
    End Namespace

    Namespace WebService.ServiceModel.Base

        Public Partial Class ApiServiceRequest
            Implements IServiceRequest
            Implements IHasApiKey
            Implements IHasDeviceInfo
            '''<Summary>
            '''The API Key required for authentication
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''Latitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Latitude of the user making this request")>
            Public Overridable Property Latitude As Double

            '''<Summary>
            '''Longitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Longitude of the user making this request")>
            Public Overridable Property Longitude As Double
        End Class

        Public Partial Class ApiServiceResponse
            Implements IServiceResponse
            '''<Summary>
            '''Information about the response.
            '''</Summary>
            <ApiMember(Description:="Information about the response.", IsRequired:=true)>
            Public Overridable Property Description As String

            '''<Summary>
            '''Heading or summary of the response.
            '''</Summary>
            <ApiMember(Description:="Heading or summary of the response.", IsRequired:=true)>
            Public Overridable Property Heading As String

            '''<Summary>
            '''Did the intended operation for this response complete successfully?
            '''</Summary>
            <ApiMember(DataType:="boolean", Description:="Did the intended operation for this response complete successfully?", IsRequired:=true)>
            Public Overridable Property WasSuccessful As Boolean

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET AutoLogin 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 /jsv/reply/AutoLogin HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	systemUserId: 0,
	refreshToken: String,
	utcOffset: 0,
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	data: 
	{
		systemUserId: 0,
		refreshToken: String,
		friendlyName: String,
		vatValue: 0,
		canUplift: False,
		stockCanDropOff: False,
		stockCanCloseArrival: False,
		blockUpliftIfLineCountDoesNotMatch: False,
		blockUpliftIfQuantityDoesNotMatch: False,
		canRipTip: False,
		canDeleteUplifts: False,
		stockOperators: 
		[
			{
				
			}
		],
		claimNumberRules: 
		[
			{
				
			}
		],
		upliftSyncInterval: 0,
		lateUpliftThreshold: 0,
		pauseUpliftReasons: 
		[
			String
		],
		noGoodsToUpliftReasons: 
		[
			String
		],
		blurryImageErrorScore: 0,
		blurryImageWarningScore: 0,
		blurryImageDetectionEnabled: False,
		profileImageUrl: String,
		claimValueWarningVariance: 0,
		stockCanVehicleAssignment: False,
		stockCanOperatorAssignment: False,
		stockCanStockEnd: False,
		stockCanCheckSealDetails: False,
		stockManualEnabled: False
	},
	description: String,
	heading: String,
	wasSuccessful: False,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}