Antel Merchandiser App API

<back to all web services

AutoLogin

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class AutoLogin extends ApiServiceRequest
    {
        public Integer SystemUserId = null;
        public String RefreshToken = null;
        public Integer UtcOffset = null;
        
        public Integer getSystemUserId() { return SystemUserId; }
        public AutoLogin setSystemUserId(Integer value) { this.SystemUserId = value; return this; }
        public String getRefreshToken() { return RefreshToken; }
        public AutoLogin setRefreshToken(String value) { this.RefreshToken = value; return this; }
        public Integer getUtcOffset() { return UtcOffset; }
        public AutoLogin setUtcOffset(Integer value) { this.UtcOffset = value; return this; }
    }

    public static class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        /**
        * The API Key required for authentication
        */
        @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        public String ApiKey = null;

        /**
        * Latitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Latitude of the user making this request")
        public Double Latitude = null;

        /**
        * Longitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Longitude of the user making this request")
        public Double Longitude = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiServiceRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Double getLatitude() { return Latitude; }
        public ApiServiceRequest setLatitude(Double value) { this.Latitude = value; return this; }
        public Double getLongitude() { return Longitude; }
        public ApiServiceRequest setLongitude(Double value) { this.Longitude = value; return this; }
    }

    public static class AutoLoginResponse extends ApiServiceResponse
    {
        public LoginData Data = null;
        
        public LoginData getData() { return Data; }
        public AutoLoginResponse setData(LoginData value) { this.Data = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        /**
        * Information about the response.
        */
        @ApiMember(Description="Information about the response.", IsRequired=true)
        public String Description = null;

        /**
        * Heading or summary of the response.
        */
        @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
        public String Heading = null;

        /**
        * Did the intended operation for this response complete successfully?
        */
        @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
        public Boolean WasSuccessful = null;

        public ResponseStatus ResponseStatus = null;
        
        public String getDescription() { return Description; }
        public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
        public String getHeading() { return Heading; }
        public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
        public Boolean isWasSuccessful() { return WasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ApiServiceResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class LoginData
    {
        public Integer SystemUserId = null;
        public Integer ClientId = null;
        public BigDecimal VatValue = null;
        public String RefreshToken = null;
        public String FriendlyName = null;
        public ArrayList<OutletData> Outlets = null;
        public Integer UpliftRequestSyncInterval = null;
        public Boolean EnableReturnOfStock = null;
        public Boolean EnableTimeKeeping = null;
        public Boolean EnableCustomerComplaintForm = null;
        public String ClientLogoUrl = null;
        public String ClientColor = null;
        public String ClientName = null;
        
        public Integer getSystemUserId() { return SystemUserId; }
        public LoginData setSystemUserId(Integer value) { this.SystemUserId = value; return this; }
        public Integer getClientId() { return ClientId; }
        public LoginData setClientId(Integer value) { this.ClientId = value; return this; }
        public BigDecimal getVatValue() { return VatValue; }
        public LoginData setVatValue(BigDecimal value) { this.VatValue = value; return this; }
        public String getRefreshToken() { return RefreshToken; }
        public LoginData setRefreshToken(String value) { this.RefreshToken = value; return this; }
        public String getFriendlyName() { return FriendlyName; }
        public LoginData setFriendlyName(String value) { this.FriendlyName = value; return this; }
        public ArrayList<OutletData> getOutlets() { return Outlets; }
        public LoginData setOutlets(ArrayList<OutletData> value) { this.Outlets = value; return this; }
        public Integer getUpliftRequestSyncInterval() { return UpliftRequestSyncInterval; }
        public LoginData setUpliftRequestSyncInterval(Integer value) { this.UpliftRequestSyncInterval = value; return this; }
        public Boolean isEnableReturnOfStock() { return EnableReturnOfStock; }
        public LoginData setEnableReturnOfStock(Boolean value) { this.EnableReturnOfStock = value; return this; }
        public Boolean isEnableTimeKeeping() { return EnableTimeKeeping; }
        public LoginData setEnableTimeKeeping(Boolean value) { this.EnableTimeKeeping = value; return this; }
        public Boolean isEnableCustomerComplaintForm() { return EnableCustomerComplaintForm; }
        public LoginData setEnableCustomerComplaintForm(Boolean value) { this.EnableCustomerComplaintForm = value; return this; }
        public String getClientLogoUrl() { return ClientLogoUrl; }
        public LoginData setClientLogoUrl(String value) { this.ClientLogoUrl = value; return this; }
        public String getClientColor() { return ClientColor; }
        public LoginData setClientColor(String value) { this.ClientColor = value; return this; }
        public String getClientName() { return ClientName; }
        public LoginData setClientName(String value) { this.ClientName = value; return this; }
    }

    public static class OutletData
    {
        public Integer Id = null;
        public String Name = null;
        public String LastRequestedDate = null;
        public Boolean HasGeneralUpliftRequest = null;
        public Integer UpliftRequestCount = null;
        public ArrayList<Integer> AssignedPrincipalIds = null;
        public ArrayList<OutletRegionData> AssignedRegions = null;
        public String Channel = null;
        public String NextScheduledDate = null;
        
        public Integer getId() { return Id; }
        public OutletData setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public OutletData setName(String value) { this.Name = value; return this; }
        public String getLastRequestedDate() { return LastRequestedDate; }
        public OutletData setLastRequestedDate(String value) { this.LastRequestedDate = value; return this; }
        public Boolean isHasGeneralUpliftRequest() { return HasGeneralUpliftRequest; }
        public OutletData setHasGeneralUpliftRequest(Boolean value) { this.HasGeneralUpliftRequest = value; return this; }
        public Integer getUpliftRequestCount() { return UpliftRequestCount; }
        public OutletData setUpliftRequestCount(Integer value) { this.UpliftRequestCount = value; return this; }
        public ArrayList<Integer> getAssignedPrincipalIds() { return AssignedPrincipalIds; }
        public OutletData setAssignedPrincipalIds(ArrayList<Integer> value) { this.AssignedPrincipalIds = value; return this; }
        public ArrayList<OutletRegionData> getAssignedRegions() { return AssignedRegions; }
        public OutletData setAssignedRegions(ArrayList<OutletRegionData> value) { this.AssignedRegions = value; return this; }
        public String getChannel() { return Channel; }
        public OutletData setChannel(String value) { this.Channel = value; return this; }
        public String getNextScheduledDate() { return NextScheduledDate; }
        public OutletData setNextScheduledDate(String value) { this.NextScheduledDate = value; return this; }
    }

    public static class OutletRegionData
    {
        public Integer PrincipalId = null;
        public String Region = null;
        
        public Integer getPrincipalId() { return PrincipalId; }
        public OutletRegionData setPrincipalId(Integer value) { this.PrincipalId = value; return this; }
        public String getRegion() { return Region; }
        public OutletRegionData setRegion(String value) { this.Region = value; return this; }
    }

}

Java 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"}}}