Antel Merchandiser App API

<back to all web services

AutoLogin

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey, IHasDeviceInfo):
    # @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    api_key: Optional[str] = None
    """
    The API Key required for authentication
    """


    # @ApiMember(DataType="double", Description="Latitude of the user making this request")
    latitude: Optional[float] = None
    """
    Latitude of the user making this request
    """


    # @ApiMember(DataType="double", Description="Longitude of the user making this request")
    longitude: Optional[float] = None
    """
    Longitude of the user making this request
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
    # @ApiMember(Description="Information about the response.", IsRequired=true)
    description: Optional[str] = None
    """
    Information about the response.
    """


    # @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    heading: Optional[str] = None
    """
    Heading or summary of the response.
    """


    # @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    was_successful: bool = False
    """
    Did the intended operation for this response complete successfully?
    """


    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutletRegionData:
    principal_id: Optional[int] = None
    region: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutletData:
    id: Optional[int] = None
    name: Optional[str] = None
    last_requested_date: Optional[str] = None
    has_general_uplift_request: Optional[bool] = None
    uplift_request_count: Optional[int] = None
    assigned_principal_ids: Optional[List[int]] = None
    assigned_regions: Optional[List[OutletRegionData]] = None
    channel: Optional[str] = None
    next_scheduled_date: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LoginData:
    system_user_id: Optional[int] = None
    client_id: Optional[int] = None
    vat_value: Optional[Decimal] = None
    refresh_token: Optional[str] = None
    friendly_name: Optional[str] = None
    outlets: Optional[List[OutletData]] = None
    uplift_request_sync_interval: Optional[int] = None
    enable_return_of_stock: Optional[bool] = None
    enable_time_keeping: Optional[bool] = None
    enable_customer_complaint_form: Optional[bool] = None
    client_logo_url: Optional[str] = None
    client_color: Optional[str] = None
    client_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AutoLoginResponse(ApiServiceResponse):
    data: Optional[LoginData] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AutoLogin(ApiServiceRequest):
    system_user_id: Optional[int] = None
    refresh_token: Optional[str] = None
    utc_offset: Optional[int] = None

Python AutoLogin DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/AutoLogin HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SystemUserId: 0,
	RefreshToken: String,
	UtcOffset: 0,
	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
		}
	}
}