Antel API

UserLogin

The following routes are available for this service:
POST	/user/login

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.ServiceModel.Base;

namespace WebService.ServiceModel
{
    public partial class ClaimNumberRule
    {
        public virtual int PrincipalId { get; set; }
        public virtual string ChannelName { get; set; }
        public virtual string RulePattern { get; set; }
    }

    public partial class LoginData
    {
        public LoginData()
        {
            StockOperators = new List<StockOperatorData>{};
            ClaimNumberRules = new List<ClaimNumberRule>{};
            PauseUpliftReasons = new List<string>{};
            NoGoodsToUpliftReasons = new List<string>{};
        }

        public virtual int SystemUserId { get; set; }
        public virtual string RefreshToken { get; set; }
        public virtual string FriendlyName { get; set; }
        public virtual decimal VatValue { get; set; }
        public virtual bool CanUplift { get; set; }
        public virtual bool StockCanDropOff { get; set; }
        public virtual bool StockCanCloseArrival { get; set; }
        public virtual bool BlockUpliftIfLineCountDoesNotMatch { get; set; }
        public virtual bool BlockUpliftIfQuantityDoesNotMatch { get; set; }
        public virtual bool CanRipTip { get; set; }
        public virtual bool CanDeleteUplifts { get; set; }
        public virtual List<StockOperatorData> StockOperators { get; set; }
        public virtual List<ClaimNumberRule> ClaimNumberRules { get; set; }
        public virtual int UpliftSyncInterval { get; set; }
        public virtual int LateUpliftThreshold { get; set; }
        public virtual List<string> PauseUpliftReasons { get; set; }
        public virtual List<string> NoGoodsToUpliftReasons { get; set; }
        public virtual decimal BlurryImageErrorScore { get; set; }
        public virtual decimal BlurryImageWarningScore { get; set; }
        public virtual bool BlurryImageDetectionEnabled { get; set; }
        public virtual string ProfileImageUrl { get; set; }
        public virtual double ClaimValueWarningVariance { get; set; }
        public virtual bool StockCanVehicleAssignment { get; set; }
        public virtual bool StockCanOperatorAssignment { get; set; }
        public virtual bool StockCanStockEnd { get; set; }
        public virtual bool StockCanCheckSealDetails { get; set; }
        public virtual bool StockManualEnabled { get; set; }
    }

    public partial class StockOperatorData
    {
        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
    }

    public partial class UserLogin
        : ApiServiceRequest
    {
        public virtual string EmailAddress { get; set; }
        public virtual string Password { get; set; }
        public virtual int UtcOffset { get; set; }
        ///<summary>
        ///The user's push token - used for push messages.
        ///</summary>
        [ApiMember(Description="The user's push token - used for push messages.")]
        public virtual string PushPlayerId { get; set; }

        ///<summary>
        ///Refresh token used to auto login the user.
        ///</summary>
        [ApiMember(Description="Refresh token used to auto login the user.")]
        public virtual string RefreshToken { get; set; }
    }

    public partial class UserLoginResponse
        : ApiServiceResponse
    {
        public virtual LoginData Data { get; set; }
    }

}

namespace WebService.ServiceModel.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Latitude of the user making this request")]
        public virtual double Latitude { get; set; }

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Longitude of the user making this request")]
        public virtual double Longitude { get; set; }
    }

    public partial class ApiServiceResponse
        : IServiceResponse
    {
        ///<summary>
        ///Information about the response.
        ///</summary>
        [ApiMember(Description="Information about the response.", IsRequired=true)]
        public virtual string Description { get; set; }

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [ApiMember(Description="Heading or summary of the response.", IsRequired=true)]
        public virtual string Heading { 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)]
        public virtual bool WasSuccessful { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# UserLogin DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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"}}}