| POST | /stock/seal/details |
|---|
export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
/** @description The API Key required for authentication */
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public apiKey: string;
/** @description Latitude of the user making this request */
// @ApiMember(DataType="double", Description="Latitude of the user making this request")
public latitude: number;
/** @description Longitude of the user making this request */
// @ApiMember(DataType="double", Description="Longitude of the user making this request")
public longitude: number;
public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}
export class ApiServiceResponse implements IServiceResponse
{
/** @description Information about the response. */
// @ApiMember(Description="Information about the response.", IsRequired=true)
public description: string;
/** @description Heading or summary of the response. */
// @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
public heading: string;
/** @description Did the intended operation for this response complete successfully? */
// @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
public wasSuccessful: boolean;
public responseStatus: ResponseStatus;
public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}
export class FileDataItem
{
public fileName: string;
public fileUrl: string;
public thumbnailUrl: string;
public fileId: string;
public thumbnailId: string;
public linkId: number;
public createdDate: string;
public constructor(init?: Partial<FileDataItem>) { (Object as any).assign(this, init); }
}
export class SealOrderHistoryItem
{
public createdDate: string;
public orderId: number;
public orderNumber: string;
public orderRequestingOperator: string;
public constructor(init?: Partial<SealOrderHistoryItem>) { (Object as any).assign(this, init); }
}
export class SealMovementHistoryItem
{
public id: number;
public eventDateTime: string;
public actionUserName: string;
public scannedDepotName: string;
public assignedBucketName: string;
public assignedOrderNumber: string;
public assignedOperatorName: string;
public orderDriverName: string;
public orderDriverCompanyName: string;
public orderDriverLicensePlate: string;
public targetWeight: number;
public currentWeight: number;
public hadWeightIssue: boolean;
public hadUnknownUplift: boolean;
public wasPaused: boolean;
public pausedWasAwaitingAuth: boolean;
public constructor(init?: Partial<SealMovementHistoryItem>) { (Object as any).assign(this, init); }
}
export class SealDetailsResponse extends ApiServiceResponse
{
public principalName: string;
public upliftNumber: string;
public operatorName: string;
public outletName: string;
public upliftDate: string;
public sealNumber: string;
public currentWeight: string;
public targetWeight: string;
public hasWeightIssue: boolean;
public bucketName: string;
public claimNumbers: string[];
public joinedClaimNumbers: string;
public sealImages: FileDataItem[];
public orderHistory: SealOrderHistoryItem[];
public movementHistory: SealMovementHistoryItem[];
public constructor(init?: Partial<SealDetailsResponse>) { super(init); (Object as any).assign(this, init); }
}
export class SealDetailsRequest extends ApiServiceRequest
{
public sealId: number;
public constructor(init?: Partial<SealDetailsRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript SealDetailsRequest DTOs
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/seal/details HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SealDetailsRequest 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>
<SealId>0</SealId>
</SealDetailsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SealDetailsResponse 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>
<BucketName>String</BucketName>
<ClaimNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ClaimNumbers>
<CurrentWeight>String</CurrentWeight>
<HasWeightIssue>false</HasWeightIssue>
<MovementHistory>
<SealMovementHistoryItem>
<ActionUserName>String</ActionUserName>
<AssignedBucketName>String</AssignedBucketName>
<AssignedOperatorName>String</AssignedOperatorName>
<AssignedOrderNumber>String</AssignedOrderNumber>
<CurrentWeight>0</CurrentWeight>
<EventDateTime>String</EventDateTime>
<HadUnknownUplift>false</HadUnknownUplift>
<HadWeightIssue>false</HadWeightIssue>
<Id>0</Id>
<OrderDriverCompanyName>String</OrderDriverCompanyName>
<OrderDriverLicensePlate>String</OrderDriverLicensePlate>
<OrderDriverName>String</OrderDriverName>
<PausedWasAwaitingAuth>false</PausedWasAwaitingAuth>
<ScannedDepotName>String</ScannedDepotName>
<TargetWeight>0</TargetWeight>
<WasPaused>false</WasPaused>
</SealMovementHistoryItem>
</MovementHistory>
<OperatorName>String</OperatorName>
<OrderHistory>
<SealOrderHistoryItem>
<CreatedDate>String</CreatedDate>
<OrderId>0</OrderId>
<OrderNumber>String</OrderNumber>
<OrderRequestingOperator>String</OrderRequestingOperator>
</SealOrderHistoryItem>
</OrderHistory>
<OutletName>String</OutletName>
<PrincipalName>String</PrincipalName>
<SealImages xmlns:d2p1="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">
<d2p1:FileDataItem>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:FileId>00000000-0000-0000-0000-000000000000</d2p1:FileId>
<d2p1:FileName>String</d2p1:FileName>
<d2p1:FileUrl>String</d2p1:FileUrl>
<d2p1:LinkId>0</d2p1:LinkId>
<d2p1:ThumbnailId>00000000-0000-0000-0000-000000000000</d2p1:ThumbnailId>
<d2p1:ThumbnailUrl>String</d2p1:ThumbnailUrl>
</d2p1:FileDataItem>
</SealImages>
<SealNumber>String</SealNumber>
<TargetWeight>String</TargetWeight>
<UpliftDate>String</UpliftDate>
<UpliftNumber>String</UpliftNumber>
</SealDetailsResponse>