AIM Web Services

<back to all web services

PhysicalInventoryCycleLookupRequest

PhysicalInventoryCycleLookup
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/PhysicalInventoryCycleLookup
import 'package:servicestack/servicestack.dart';

// @DataContract
class BaseRequest implements IConvertible
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    String? ApiKey;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    String? OAuthToken;

    BaseRequest({this.ApiKey,this.OAuthToken});
    BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApiKey = json['ApiKey'];
        OAuthToken = json['OAuthToken'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApiKey': ApiKey,
        'OAuthToken': OAuthToken
    };

    getTypeName() => "BaseRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseSecureRequest extends BaseRequest implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    String? Token;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    String? DeviceId;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    String? AppId;

    BaseSecureRequest({this.Token,this.DeviceId,this.AppId});
    BaseSecureRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Token = json['Token'];
        DeviceId = json['DeviceId'];
        AppId = json['AppId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Token': Token,
        'DeviceId': DeviceId,
        'AppId': AppId
    });

    getTypeName() => "BaseSecureRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseResponseResult implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    String? StatusCode;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    String? Login;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    String? ErrorCode;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    String? ErrorDisplayText;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    String? ErrorMessage;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    String? DomainName;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    String? IpAddress;

    BaseResponseResult({this.StatusCode,this.Login,this.ErrorCode,this.ErrorDisplayText,this.ErrorMessage,this.DomainName,this.IpAddress});
    BaseResponseResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        StatusCode = json['StatusCode'];
        Login = json['Login'];
        ErrorCode = json['ErrorCode'];
        ErrorDisplayText = json['ErrorDisplayText'];
        ErrorMessage = json['ErrorMessage'];
        DomainName = json['DomainName'];
        IpAddress = json['IpAddress'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'StatusCode': StatusCode,
        'Login': Login,
        'ErrorCode': ErrorCode,
        'ErrorDisplayText': ErrorDisplayText,
        'ErrorMessage': ErrorMessage,
        'DomainName': DomainName,
        'IpAddress': IpAddress
    };

    getTypeName() => "BaseResponseResult";
    TypeContext? context = _ctx;
}

// @DataContract
class BaseResponse implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    BaseResponseResult? Status;

    BaseResponse({this.Status});
    BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Status = JsonConverters.fromJson(json['Status'],'BaseResponseResult',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Status': JsonConverters.toJson(Status,'BaseResponseResult',context!)
    };

    getTypeName() => "BaseResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class PhysicalInventoryCycle implements IConvertible
{
    // @DataMember
    int? Id;

    // @DataMember
    String? Description;

    // @DataMember
    String? EmployeeName;

    // @DataMember
    DateTime? CreationDate;

    // @DataMember
    DateTime? LastUpdated;

    PhysicalInventoryCycle({this.Id,this.Description,this.EmployeeName,this.CreationDate,this.LastUpdated});
    PhysicalInventoryCycle.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Description = json['Description'];
        EmployeeName = json['EmployeeName'];
        CreationDate = JsonConverters.fromJson(json['CreationDate'],'DateTime',context!);
        LastUpdated = JsonConverters.fromJson(json['LastUpdated'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Description': Description,
        'EmployeeName': EmployeeName,
        'CreationDate': JsonConverters.toJson(CreationDate,'DateTime',context!),
        'LastUpdated': JsonConverters.toJson(LastUpdated,'DateTime',context!)
    };

    getTypeName() => "PhysicalInventoryCycle";
    TypeContext? context = _ctx;
}

// @DataContract
class PhysicalInventoryCycleLookupResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    String? LookupResult;

    // @DataMember
    PhysicalInventoryCycle? Cycle;

    PhysicalInventoryCycleLookupResponse({this.LookupResult,this.Cycle});
    PhysicalInventoryCycleLookupResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        LookupResult = json['LookupResult'];
        Cycle = JsonConverters.fromJson(json['Cycle'],'PhysicalInventoryCycle',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'LookupResult': LookupResult,
        'Cycle': JsonConverters.toJson(Cycle,'PhysicalInventoryCycle',context!)
    });

    getTypeName() => "PhysicalInventoryCycleLookupResponse";
    TypeContext? context = _ctx;
}

/**
* PhysicalInventoryCycleLookupRequires active-e Inventory Service
*/
// @DataContract
class PhysicalInventoryCycleLookupRequest extends BaseSecureRequest implements IConvertible
{
    /**
    * Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="SkuPk", ParameterType="query")
    int? SkuPk;

    /**
    * Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="LocationId", ParameterType="query")
    int? LocationId;

    /**
    * Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="SaqPk", ParameterType="query")
    int? SaqPk;

    /**
    * Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="SasPk", ParameterType="query")
    int? SasPk;

    PhysicalInventoryCycleLookupRequest({this.SkuPk,this.LocationId,this.SaqPk,this.SasPk});
    PhysicalInventoryCycleLookupRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        SkuPk = json['SkuPk'];
        LocationId = json['LocationId'];
        SaqPk = json['SaqPk'];
        SasPk = json['SasPk'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'SkuPk': SkuPk,
        'LocationId': LocationId,
        'SaqPk': SaqPk,
        'SasPk': SasPk
    });

    getTypeName() => "PhysicalInventoryCycleLookupRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'BaseSecureRequest': TypeInfo(TypeOf.Class, create:() => BaseSecureRequest()),
    'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'PhysicalInventoryCycle': TypeInfo(TypeOf.Class, create:() => PhysicalInventoryCycle()),
    'PhysicalInventoryCycleLookupResponse': TypeInfo(TypeOf.Class, create:() => PhysicalInventoryCycleLookupResponse()),
    'PhysicalInventoryCycleLookupRequest': TypeInfo(TypeOf.Class, create:() => PhysicalInventoryCycleLookupRequest()),
});

Dart PhysicalInventoryCycleLookupRequest DTOs

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

HTTP + XML

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

GET /api/PhysicalInventoryCycleLookup HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PhysicalInventoryCycleLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <Cycle>
    <CreationDate>0001-01-01T00:00:00</CreationDate>
    <Description>String</Description>
    <EmployeeName>String</EmployeeName>
    <Id>0</Id>
    <LastUpdated>0001-01-01T00:00:00</LastUpdated>
  </Cycle>
  <LookupResult>String</LookupResult>
</PhysicalInventoryCycleLookupResponse>