Antel Merchandiser App API

<back to all web services

AutoLogin

namespace WebService.AppApi.Models

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 OutletRegionData() = 
        member val PrincipalId:Int32 = new Int32() with get,set
        member val Region:String = null with get,set

    [<AllowNullLiteral>]
    type OutletData() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val LastRequestedDate:String = null with get,set
        member val HasGeneralUpliftRequest:Boolean = new Boolean() with get,set
        member val UpliftRequestCount:Int32 = new Int32() with get,set
        member val AssignedPrincipalIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val AssignedRegions:ResizeArray<OutletRegionData> = new ResizeArray<OutletRegionData>() with get,set
        member val Channel:String = null with get,set
        member val NextScheduledDate:String = null with get,set

    [<AllowNullLiteral>]
    type LoginData() = 
        member val SystemUserId:Int32 = new Int32() with get,set
        member val ClientId:Int32 = new Int32() with get,set
        member val VatValue:Decimal = new Decimal() with get,set
        member val RefreshToken:String = null with get,set
        member val FriendlyName:String = null with get,set
        member val Outlets:ResizeArray<OutletData> = new ResizeArray<OutletData>() with get,set
        member val UpliftRequestSyncInterval:Int32 = new Int32() with get,set
        member val EnableReturnOfStock:Boolean = new Boolean() with get,set
        member val EnableTimeKeeping:Boolean = new Boolean() with get,set
        member val EnableCustomerComplaintForm:Boolean = new Boolean() with get,set
        member val ClientLogoUrl:String = null with get,set
        member val ClientColor:String = null with get,set
        member val ClientName:String = null with get,set

    [<AllowNullLiteral>]
    type AutoLoginResponse() = 
        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 AutoLogin() = 
        inherit ApiServiceRequest()
        member val SystemUserId:Int32 = new Int32() with get,set
        member val RefreshToken:String = null with get,set
        member val UtcOffset:Int32 = new Int32() with get,set

F# AutoLogin 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 /json/reply/AutoLogin HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SystemUserId":0,"RefreshToken":"String","UtcOffset":0,"ApiKey":"String","Latitude":0,"Longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Data":{"SystemUserId":0,"ClientId":0,"VatValue":0,"RefreshToken":"String","FriendlyName":"String","Outlets":[{}],"UpliftRequestSyncInterval":0,"EnableReturnOfStock":false,"EnableTimeKeeping":false,"EnableCustomerComplaintForm":false,"ClientLogoUrl":"String","ClientColor":"String","ClientName":"String"},"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"}}}