Antel API

<back to all web services

UserLogin

The following routes are available for this service:
POST/user/login
namespace WebService.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        ///<summary>
        ///Information about the response.
        ///</summary>
        [<ApiMember(Description="Information about the response.", IsRequired=true)>]
        member val Description:String = null with get,set

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
        member val Heading:String = null with get,set

        ///<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)>]
        member val WasSuccessful:Boolean = new Boolean() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type StockOperatorData() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set

    [<AllowNullLiteral>]
    type ClaimNumberRule() = 
        member val PrincipalId:Int32 = new Int32() with get,set
        member val ChannelName:String = null with get,set
        member val RulePattern:String = null with get,set

    [<AllowNullLiteral>]
    type LoginData() = 
        member val SystemUserId:Int32 = new Int32() with get,set
        member val RefreshToken:String = null with get,set
        member val FriendlyName:String = null with get,set
        member val VatValue:Decimal = new Decimal() with get,set
        member val CanUplift:Boolean = new Boolean() with get,set
        member val StockCanDropOff:Boolean = new Boolean() with get,set
        member val StockCanCloseArrival:Boolean = new Boolean() with get,set
        member val BlockUpliftIfLineCountDoesNotMatch:Boolean = new Boolean() with get,set
        member val BlockUpliftIfQuantityDoesNotMatch:Boolean = new Boolean() with get,set
        member val CanRipTip:Boolean = new Boolean() with get,set
        member val CanDeleteUplifts:Boolean = new Boolean() with get,set
        member val StockOperators:ResizeArray<StockOperatorData> = new ResizeArray<StockOperatorData>() with get,set
        member val ClaimNumberRules:ResizeArray<ClaimNumberRule> = new ResizeArray<ClaimNumberRule>() with get,set
        member val UpliftSyncInterval:Int32 = new Int32() with get,set
        member val LateUpliftThreshold:Int32 = new Int32() with get,set
        member val PauseUpliftReasons:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val NoGoodsToUpliftReasons:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val BlurryImageErrorScore:Decimal = new Decimal() with get,set
        member val BlurryImageWarningScore:Decimal = new Decimal() with get,set
        member val BlurryImageDetectionEnabled:Boolean = new Boolean() with get,set
        member val ProfileImageUrl:String = null with get,set
        member val ClaimValueWarningVariance:Double = new Double() with get,set
        member val StockCanVehicleAssignment:Boolean = new Boolean() with get,set
        member val StockCanOperatorAssignment:Boolean = new Boolean() with get,set
        member val StockCanStockEnd:Boolean = new Boolean() with get,set
        member val StockCanCheckSealDetails:Boolean = new Boolean() with get,set
        member val StockManualEnabled:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type UserLoginResponse() = 
        inherit ApiServiceResponse()
        member val Data:LoginData = null with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
        member val Latitude:Double = new Double() with get,set

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
        member val Longitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type UserLogin() = 
        inherit ApiServiceRequest()
        member val EmailAddress:String = null with get,set
        member val Password:String = null with get,set
        member val UtcOffset:Int32 = new Int32() with get,set
        ///<summary>
        ///The user's push token - used for push messages.
        ///</summary>
        [<ApiMember(Description="The user's push token - used for push messages.")>]
        member val PushPlayerId:String = null with get,set

        ///<summary>
        ///Refresh token used to auto login the user.
        ///</summary>
        [<ApiMember(Description="Refresh token used to auto login the user.")>]
        member val RefreshToken:String = null with get,set

F# UserLogin DTOs

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

HTTP + OTHER

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

POST /user/login HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"emailAddress":"String","password":"String","utcOffset":0,"pushPlayerId":"String","refreshToken":"String","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}