| POST | /user/login |
|---|
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 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: returnit-api-dev.happen.zone
Accept: text/jsv
Content-Type: text/jsv
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/jsv
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
}
}
}