| GET | /sync/incompleteupliftrequests |
|---|
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 IncompleteUpliftRequestData:
system_user_id: Optional[int] = None
incomplete_uplift_request_id: Optional[str] = None
uplift_request_on_device_id: Optional[str] = None
outlet_id: Optional[int] = None
last_synced: Optional[datetime.datetime] = None
is_submitted: Optional[bool] = None
delete_from_device: Optional[bool] = None
created_by_merchandiser_name: Optional[str] = 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 IncompleteUpliftRequestListResponse(ApiServiceResponse):
incomplete_uplift_requests: Optional[List[IncompleteUpliftRequestData]] = None
allow_login: Optional[bool] = None
assigned_outlets: Optional[List[OutletData]] = None
archived: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IncompleteUpliftRequestList(ApiServiceRequest):
pass
Python IncompleteUpliftRequestList DTOs
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.
GET /sync/incompleteupliftrequests HTTP/1.1 Host: returnit-api-dev.happen.zone Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
IncompleteUpliftRequests:
[
{
}
],
AllowLogin: False,
AssignedOutlets:
[
{
}
],
Archived: False,
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
}
}
}