| POST | /stock/seal/details |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.ServiceModel.Base;
using CommonService.Api.Models.Base;
namespace CommonService.Api.Models.Base
{
public partial class FileDataItem
{
public virtual string FileName { get; set; }
public virtual string FileUrl { get; set; }
public virtual string ThumbnailUrl { get; set; }
public virtual Guid FileId { get; set; }
public virtual Guid ThumbnailId { get; set; }
public virtual int LinkId { get; set; }
public virtual DateTime CreatedDate { get; set; }
}
}
namespace WebService.ServiceModel
{
public partial class SealDetailsRequest
: ApiServiceRequest
{
public virtual int SealId { get; set; }
}
public partial class SealDetailsResponse
: ApiServiceResponse
{
public SealDetailsResponse()
{
ClaimNumbers = new List<string>{};
SealImages = new List<FileDataItem>{};
OrderHistory = new List<SealOrderHistoryItem>{};
MovementHistory = new List<SealMovementHistoryItem>{};
}
public virtual string PrincipalName { get; set; }
public virtual string UpliftNumber { get; set; }
public virtual string OperatorName { get; set; }
public virtual string OutletName { get; set; }
public virtual string UpliftDate { get; set; }
public virtual string SealNumber { get; set; }
public virtual string CurrentWeight { get; set; }
public virtual string TargetWeight { get; set; }
public virtual bool HasWeightIssue { get; set; }
public virtual string BucketName { get; set; }
public virtual List<string> ClaimNumbers { get; set; }
public virtual string JoinedClaimNumbers { get; set; }
public virtual List<FileDataItem> SealImages { get; set; }
public virtual List<SealOrderHistoryItem> OrderHistory { get; set; }
public virtual List<SealMovementHistoryItem> MovementHistory { get; set; }
}
public partial class SealMovementHistoryItem
{
public virtual long Id { get; set; }
public virtual string EventDateTime { get; set; }
public virtual string ActionUserName { get; set; }
public virtual string ScannedDepotName { get; set; }
public virtual string AssignedBucketName { get; set; }
public virtual string AssignedOrderNumber { get; set; }
public virtual string AssignedOperatorName { get; set; }
public virtual string OrderDriverName { get; set; }
public virtual string OrderDriverCompanyName { get; set; }
public virtual string OrderDriverLicensePlate { get; set; }
public virtual double TargetWeight { get; set; }
public virtual double CurrentWeight { get; set; }
public virtual bool HadWeightIssue { get; set; }
public virtual bool HadUnknownUplift { get; set; }
public virtual bool WasPaused { get; set; }
public virtual bool PausedWasAwaitingAuth { get; set; }
}
public partial class SealOrderHistoryItem
{
public virtual string CreatedDate { get; set; }
public virtual int OrderId { get; set; }
public virtual string OrderNumber { get; set; }
public virtual string OrderRequestingOperator { get; set; }
}
}
namespace WebService.ServiceModel.Base
{
public partial class ApiServiceRequest
: IServiceRequest, IHasApiKey, IHasDeviceInfo
{
///<summary>
///The API Key required for authentication
///</summary>
[ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
public virtual string ApiKey { get; set; }
///<summary>
///Latitude of the user making this request
///</summary>
[ApiMember(DataType="double", Description="Latitude of the user making this request")]
public virtual double Latitude { get; set; }
///<summary>
///Longitude of the user making this request
///</summary>
[ApiMember(DataType="double", Description="Longitude of the user making this request")]
public virtual double Longitude { get; set; }
}
public partial class ApiServiceResponse
: IServiceResponse
{
///<summary>
///Information about the response.
///</summary>
[ApiMember(Description="Information about the response.", IsRequired=true)]
public virtual string Description { get; set; }
///<summary>
///Heading or summary of the response.
///</summary>
[ApiMember(Description="Heading or summary of the response.", IsRequired=true)]
public virtual string Heading { get; set; }
///<summary>
///Did the intended operation for this response complete successfully?
///</summary>
[ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)]
public virtual bool WasSuccessful { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
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.
POST /stock/seal/details HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
sealId: 0,
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
principalName: String,
upliftNumber: String,
operatorName: String,
outletName: String,
upliftDate: String,
sealNumber: String,
currentWeight: String,
targetWeight: String,
hasWeightIssue: False,
bucketName: String,
claimNumbers:
[
String
],
joinedClaimNumbers: String,
sealImages:
[
{
fileName: String,
fileUrl: String,
thumbnailUrl: String,
linkId: 0,
createdDate: 0001-01-01
}
],
orderHistory:
[
{
createdDate: String,
orderId: 0,
orderNumber: String,
orderRequestingOperator: String
}
],
movementHistory:
[
{
id: 0,
eventDateTime: String,
actionUserName: String,
scannedDepotName: String,
assignedBucketName: String,
assignedOrderNumber: String,
assignedOperatorName: String,
orderDriverName: String,
orderDriverCompanyName: String,
orderDriverLicensePlate: String,
targetWeight: 0,
currentWeight: 0,
hadWeightIssue: False,
hadUnknownUplift: False,
wasPaused: False,
pausedWasAwaitingAuth: 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
}
}
}