| POST | /user/login |
|---|
import 'package:servicestack/servicestack.dart';
class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo, IConvertible
{
/**
* The API Key required for authentication
*/
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
String? ApiKey;
/**
* Latitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Latitude of the user making this request")
double? Latitude;
/**
* Longitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Longitude of the user making this request")
double? Longitude;
ApiServiceRequest({this.ApiKey,this.Latitude,this.Longitude});
ApiServiceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ApiKey = json['ApiKey'];
Latitude = JsonConverters.toDouble(json['Latitude']);
Longitude = JsonConverters.toDouble(json['Longitude']);
return this;
}
Map<String, dynamic> toJson() => {
'ApiKey': ApiKey,
'Latitude': Latitude,
'Longitude': Longitude
};
getTypeName() => "ApiServiceRequest";
TypeContext? context = _ctx;
}
class ApiServiceResponse implements IServiceResponse, IConvertible
{
/**
* Information about the response.
*/
// @ApiMember(Description="Information about the response.", IsRequired=true)
String? Description;
/**
* Heading or summary of the response.
*/
// @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
String? Heading;
/**
* Did the intended operation for this response complete successfully?
*/
// @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
bool? WasSuccessful;
ResponseStatus? ResponseStatus;
ApiServiceResponse({this.Description,this.Heading,this.WasSuccessful,this.ResponseStatus});
ApiServiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Description = json['Description'];
Heading = json['Heading'];
WasSuccessful = json['WasSuccessful'];
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Description': Description,
'Heading': Heading,
'WasSuccessful': WasSuccessful,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "ApiServiceResponse";
TypeContext? context = _ctx;
}
class OutletRegionData implements IConvertible
{
int? PrincipalId;
String? Region;
OutletRegionData({this.PrincipalId,this.Region});
OutletRegionData.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
PrincipalId = json['PrincipalId'];
Region = json['Region'];
return this;
}
Map<String, dynamic> toJson() => {
'PrincipalId': PrincipalId,
'Region': Region
};
getTypeName() => "OutletRegionData";
TypeContext? context = _ctx;
}
class OutletData implements IConvertible
{
int? Id;
String? Name;
String? LastRequestedDate;
bool? HasGeneralUpliftRequest;
int? UpliftRequestCount;
List<int>? AssignedPrincipalIds;
List<OutletRegionData>? AssignedRegions;
String? Channel;
String? NextScheduledDate;
OutletData({this.Id,this.Name,this.LastRequestedDate,this.HasGeneralUpliftRequest,this.UpliftRequestCount,this.AssignedPrincipalIds,this.AssignedRegions,this.Channel,this.NextScheduledDate});
OutletData.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Name = json['Name'];
LastRequestedDate = json['LastRequestedDate'];
HasGeneralUpliftRequest = json['HasGeneralUpliftRequest'];
UpliftRequestCount = json['UpliftRequestCount'];
AssignedPrincipalIds = JsonConverters.fromJson(json['AssignedPrincipalIds'],'List<int>',context!);
AssignedRegions = JsonConverters.fromJson(json['AssignedRegions'],'List<OutletRegionData>',context!);
Channel = json['Channel'];
NextScheduledDate = json['NextScheduledDate'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Name': Name,
'LastRequestedDate': LastRequestedDate,
'HasGeneralUpliftRequest': HasGeneralUpliftRequest,
'UpliftRequestCount': UpliftRequestCount,
'AssignedPrincipalIds': JsonConverters.toJson(AssignedPrincipalIds,'List<int>',context!),
'AssignedRegions': JsonConverters.toJson(AssignedRegions,'List<OutletRegionData>',context!),
'Channel': Channel,
'NextScheduledDate': NextScheduledDate
};
getTypeName() => "OutletData";
TypeContext? context = _ctx;
}
class LoginData implements IConvertible
{
int? SystemUserId;
int? ClientId;
double? VatValue;
String? RefreshToken;
String? FriendlyName;
List<OutletData>? Outlets;
int? UpliftRequestSyncInterval;
bool? EnableReturnOfStock;
bool? EnableTimeKeeping;
bool? EnableCustomerComplaintForm;
String? ClientLogoUrl;
String? ClientColor;
String? ClientName;
LoginData({this.SystemUserId,this.ClientId,this.VatValue,this.RefreshToken,this.FriendlyName,this.Outlets,this.UpliftRequestSyncInterval,this.EnableReturnOfStock,this.EnableTimeKeeping,this.EnableCustomerComplaintForm,this.ClientLogoUrl,this.ClientColor,this.ClientName});
LoginData.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
SystemUserId = json['SystemUserId'];
ClientId = json['ClientId'];
VatValue = JsonConverters.toDouble(json['VatValue']);
RefreshToken = json['RefreshToken'];
FriendlyName = json['FriendlyName'];
Outlets = JsonConverters.fromJson(json['Outlets'],'List<OutletData>',context!);
UpliftRequestSyncInterval = json['UpliftRequestSyncInterval'];
EnableReturnOfStock = json['EnableReturnOfStock'];
EnableTimeKeeping = json['EnableTimeKeeping'];
EnableCustomerComplaintForm = json['EnableCustomerComplaintForm'];
ClientLogoUrl = json['ClientLogoUrl'];
ClientColor = json['ClientColor'];
ClientName = json['ClientName'];
return this;
}
Map<String, dynamic> toJson() => {
'SystemUserId': SystemUserId,
'ClientId': ClientId,
'VatValue': VatValue,
'RefreshToken': RefreshToken,
'FriendlyName': FriendlyName,
'Outlets': JsonConverters.toJson(Outlets,'List<OutletData>',context!),
'UpliftRequestSyncInterval': UpliftRequestSyncInterval,
'EnableReturnOfStock': EnableReturnOfStock,
'EnableTimeKeeping': EnableTimeKeeping,
'EnableCustomerComplaintForm': EnableCustomerComplaintForm,
'ClientLogoUrl': ClientLogoUrl,
'ClientColor': ClientColor,
'ClientName': ClientName
};
getTypeName() => "LoginData";
TypeContext? context = _ctx;
}
class UserLoginResponse extends ApiServiceResponse implements IConvertible
{
LoginData? Data;
UserLoginResponse({this.Data});
UserLoginResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Data = JsonConverters.fromJson(json['Data'],'LoginData',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Data': JsonConverters.toJson(Data,'LoginData',context!)
});
getTypeName() => "UserLoginResponse";
TypeContext? context = _ctx;
}
class UserLogin extends ApiServiceRequest implements IConvertible
{
String? EmailAddress;
String? Password;
int? UtcOffset;
/**
* The user's push token - used for push messages.
*/
// @ApiMember(Description="The user's push token - used for push messages.")
String? PushPlayerId;
/**
* Refresh token used to auto login the user.
*/
// @ApiMember(Description="Refresh token used to auto login the user.")
String? RefreshToken;
UserLogin({this.EmailAddress,this.Password,this.UtcOffset,this.PushPlayerId,this.RefreshToken});
UserLogin.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
EmailAddress = json['EmailAddress'];
Password = json['Password'];
UtcOffset = json['UtcOffset'];
PushPlayerId = json['PushPlayerId'];
RefreshToken = json['RefreshToken'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'EmailAddress': EmailAddress,
'Password': Password,
'UtcOffset': UtcOffset,
'PushPlayerId': PushPlayerId,
'RefreshToken': RefreshToken
});
getTypeName() => "UserLogin";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'returnit_api_dev.happen.zone', types: <String, TypeInfo> {
'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
'OutletRegionData': TypeInfo(TypeOf.Class, create:() => OutletRegionData()),
'OutletData': TypeInfo(TypeOf.Class, create:() => OutletData()),
'List<OutletRegionData>': TypeInfo(TypeOf.Class, create:() => <OutletRegionData>[]),
'LoginData': TypeInfo(TypeOf.Class, create:() => LoginData()),
'List<OutletData>': TypeInfo(TypeOf.Class, create:() => <OutletData>[]),
'UserLoginResponse': TypeInfo(TypeOf.Class, create:() => UserLoginResponse()),
'UserLogin': TypeInfo(TypeOf.Class, create:() => UserLogin()),
});
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
}
}
}