| POST | /stock/orderDetail |
|---|
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 OrderDetailResponse extends ApiServiceResponse implements IConvertible
{
int? orderId;
String? operatorName;
String? driverName;
String? companyName;
String? licensePlate;
String? orderNumber;
String? destinationDepot;
bool? canClose;
bool? canScan;
int? estimatedSeals;
int? scannedSeals;
String? status;
OrderDetailResponse({this.orderId,this.operatorName,this.driverName,this.companyName,this.licensePlate,this.orderNumber,this.destinationDepot,this.canClose,this.canScan,this.estimatedSeals,this.scannedSeals,this.status});
OrderDetailResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
orderId = json['orderId'];
operatorName = json['operatorName'];
driverName = json['driverName'];
companyName = json['companyName'];
licensePlate = json['licensePlate'];
orderNumber = json['orderNumber'];
destinationDepot = json['destinationDepot'];
canClose = json['canClose'];
canScan = json['canScan'];
estimatedSeals = json['estimatedSeals'];
scannedSeals = json['scannedSeals'];
status = json['status'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'orderId': orderId,
'operatorName': operatorName,
'driverName': driverName,
'companyName': companyName,
'licensePlate': licensePlate,
'orderNumber': orderNumber,
'destinationDepot': destinationDepot,
'canClose': canClose,
'canScan': canScan,
'estimatedSeals': estimatedSeals,
'scannedSeals': scannedSeals,
'status': status
});
getTypeName() => "OrderDetailResponse";
TypeContext? context = _ctx;
}
class OrderDetail extends ApiServiceRequest implements IConvertible
{
String? orderNumber;
bool? forOperator;
OrderDetail({this.orderNumber,this.forOperator});
OrderDetail.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
orderNumber = json['orderNumber'];
forOperator = json['forOperator'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'orderNumber': orderNumber,
'forOperator': forOperator
});
getTypeName() => "OrderDetail";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'antel.api.dev.86degrees.com', types: <String, TypeInfo> {
'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
'OrderDetailResponse': TypeInfo(TypeOf.Class, create:() => OrderDetailResponse()),
'OrderDetail': TypeInfo(TypeOf.Class, create:() => OrderDetail()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /stock/orderDetail HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<OrderDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
<Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
<Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
<ForOperator>false</ForOperator>
<OrderNumber>String</OrderNumber>
</OrderDetail>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<OrderDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
<Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Heading>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">false</WasSuccessful>
<CanClose>false</CanClose>
<CanScan>false</CanScan>
<CompanyName>String</CompanyName>
<DestinationDepot>String</DestinationDepot>
<DriverName>String</DriverName>
<EstimatedSeals>0</EstimatedSeals>
<LicensePlate>String</LicensePlate>
<OperatorName>String</OperatorName>
<OrderId>0</OrderId>
<OrderNumber>String</OrderNumber>
<ScannedSeals>0</ScannedSeals>
<Status>String</Status>
</OrderDetailResponse>