| GET | /api/orderResponse | Get un-acknowledged OrderResponse, oldest first |
|---|
namespace DX.Framework.Core.Querying
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
///<summary>
///Order Response
///</summary>
[<Api(Description="Order Response")>]
[<ApiResponse(Description="OrderResponse message", IsDefaultResponse=true, StatusCode=200)>]
[<ApiResponse(Description="No Content", ResponseType=typeof<IReturnVoid>, StatusCode=204)>]
[<AllowNullLiteral>]
type GetOrderResponse() =
class end
[<DataContract>]
[<AllowNullLiteral>]
type DocumentIdentification() =
[<DataMember(Name="identifier")>]
member val Identifier:String = null with get,set
[<DataMember(Name="type")>]
member val Type:String = null with get,set
[<DataMember(Name="creationDateAndTime")>]
member val CreationDateAndTime:DateTime = new DateTime() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type Identifier() =
[<DataMember(Name="authority")>]
member val Authority:String = null with get,set
[<DataMember(Name="text")>]
member val Text:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type ContactInformation() =
class end
[<DataContract>]
[<AllowNullLiteral>]
type Partner() =
[<DataMember(Name="identifier")>]
member val Identifier:Identifier = null with get,set
[<DataMember(Name="contactInformation")>]
member val ContactInformation:ResizeArray<ContactInformation> = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type Header() =
[<DataMember(Name="documentIdentification")>]
member val DocumentIdentification:DocumentIdentification = null with get,set
[<DataMember(Name="sender")>]
member val Sender:Partner = null with get,set
[<DataMember(Name="receiver")>]
member val Receiver:Partner = null with get,set
type DocumentAction =
| ADD = 0
| CHANGE_BY_REFRESH = 1
| DELETE = 2
| REJECTED = 3
type DocumentStatus =
| ADDITIONAL_TRANSMISSION = 0
| COPY = 1
| ORIGINAL = 2
[<AllowNullLiteral>]
type AvpList() =
member val Code:String = null with get,set
member val Value:String = null with get,set
[<AllowNullLiteral>]
type BaseDocument() =
member val CurrencyCode:String = null with get,set
member val CreationDateTime:DateTime = new DateTime() with get,set
member val DocumentActionCode:DocumentAction = new DocumentAction() with get,set
member val DocumentStatusCode:DocumentStatus = new DocumentStatus() with get,set
member val DocumentStructureVersion:String = null with get,set
member val LastUpdateDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val RevisionNumber:Nullable<Int64> = new Nullable<Int64>() with get,set
member val AvpList:ResizeArray<AvpList> = null with get,set
[<AllowNullLiteral>]
type Ecom_PartyIdentificationType() =
member val Gln:String = null with get,set
member val Name:String = null with get,set
member val AdditionalPartyIdentification:ResizeArray<AvpList> = null with get,set
[<AllowNullLiteral>]
type CommunicationChannel() =
member val CommunicationChannelCode:String = null with get,set
member val CommunicationChannelName:String = null with get,set
member val CommunicationValue:String = null with get,set
[<AllowNullLiteral>]
type Contact() =
member val ContactTypeCode:String = null with get,set
member val PersonName:String = null with get,set
member val DepartmentName:String = null with get,set
member val JobTitle:String = null with get,set
member val Responsibility:String = null with get,set
member val CommunicationChannel:ResizeArray<CommunicationChannel> = null with get,set
[<AllowNullLiteral>]
type Address() =
member val StreetAddressOne:String = null with get,set
member val StreetAddressTwo:String = null with get,set
member val StreetAddressThree:String = null with get,set
member val City:String = null with get,set
member val PostalCode:String = null with get,set
member val ProvinceCode:String = null with get,set
member val CountryCode:String = null with get,set
[<AllowNullLiteral>]
type FinancialRoutingNumber() =
member val Number:String = null with get,set
member val NumberTypeCode:String = null with get,set
[<AllowNullLiteral>]
type FinancialAccount() =
member val Number:String = null with get,set
member val NumberTypeCode:String = null with get,set
member val Name:String = null with get,set
[<AllowNullLiteral>]
type FinancialInstitutionInformation() =
member val FinancialInstitutionBranchName:String = null with get,set
member val FinancialInstitutionName:String = null with get,set
member val FinancialRoutingNumber:FinancialRoutingNumber = null with get,set
member val FinancialAccount:FinancialAccount = null with get,set
member val SwiftCode:String = null with get,set
member val ExportersCode:String = null with get,set
[<AllowNullLiteral>]
type TransactionalParty() =
inherit Ecom_PartyIdentificationType()
member val Contact:ResizeArray<Contact> = null with get,set
member val Address:Address = null with get,set
member val CommunicationChannel:ResizeArray<AvpList> = null with get,set
member val FinancialInstitutionInformation:FinancialInstitutionInformation = null with get,set
member val DutyFeeTaxRegistration:String = null with get,set
member val EntityIdentification:String = null with get,set
[<AllowNullLiteral>]
type BillOfLading() =
member val CreationDate:DateTimeOffset = new DateTimeOffset() with get,set
member val RevisionNumber:Int64 = new Int64() with get,set
member val EntityIdentification:String = null with get,set
member val TagNumbers:ResizeArray<String> = null with get,set
member val TotalBags:Int64 = new Int64() with get,set
[<AllowNullLiteral>]
type DocumentReference() =
member val CreationDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val RevisionNumber:Nullable<Int64> = new Nullable<Int64>() with get,set
member val LineItemNumber:Nullable<Int64> = new Nullable<Int64>() with get,set
member val EntityIdentification:String = null with get,set
[<AllowNullLiteral>]
type Quantity() =
member val Value:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val MeasurementUnitCode:String = null with get,set
member val CodeListVersion:String = null with get,set
[<AllowNullLiteral>]
type TransactionalItem() =
member val MeasurementUnitCode:String = null with get,set
member val MeasurementType:String = null with get,set
member val MeasurementValue:String = null with get,set
[<AllowNullLiteral>]
type SerialNumberRange() =
member val MaximumValue:String = null with get,set
member val MinimumValue:String = null with get,set
[<AllowNullLiteral>]
type TransactionalItemDimension() =
member val MeasurementUnitCode:String = null with get,set
member val Depth:String = null with get,set
member val Height:String = null with get,set
member val Width:String = null with get,set
[<AllowNullLiteral>]
type TransactionalItemLogisticUnitInformation() =
member val NumberOfLayers:Nullable<Int64> = new Nullable<Int64>() with get,set
member val NumberOfUnitsPerLayer:Nullable<Int64> = new Nullable<Int64>() with get,set
member val NumberOfUnitsPerPallet:Nullable<Int64> = new Nullable<Int64>() with get,set
member val PackagingTerms:String = null with get,set
member val PackageTypeCode:String = null with get,set
member val MaximumStackingFactor:Nullable<Int64> = new Nullable<Int64>() with get,set
member val ReturnablePackageTransportCostPayment:String = null with get,set
member val DimensionsOfLogisticUnit:ResizeArray<TransactionalItemDimension> = null with get,set
[<AllowNullLiteral>]
type TransactionalItemDataCarrierAndIdentification() =
member val Gs1TransactionalItemIdentificationKey:String = null with get,set
member val DataCarrier:String = null with get,set
[<AllowNullLiteral>]
type TradeItemWaste() =
member val WasteIdentification:String = null with get,set
member val TypeOfWaste:ResizeArray<AvpList> = null with get,set
[<AllowNullLiteral>]
type TransactionalItemOrganicInformation() =
member val IsTradeItemOrganic:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val OrganicCertification:String = null with get,set
[<AllowNullLiteral>]
type TransactionalItemData() =
member val AvailableForSaleDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val BatchNumber:String = null with get,set
member val BestBeforeDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CountryOfOrigin:String = null with get,set
member val ItemExpirationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val LotNumber:String = null with get,set
member val PackagingDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ProductionDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ProductQualityIndication:String = null with get,set
member val SellByDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val SerialNumber:ResizeArray<String> = null with get,set
member val ShelfLife:String = null with get,set
member val TradeItemQuantity:Nullable<Int64> = new Nullable<Int64>() with get,set
member val ItemInContactWithFoodProduct:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val TransactionalItemWeight:ResizeArray<TransactionalItem> = null with get,set
member val TransactionalItemVolume:ResizeArray<TransactionalItem> = null with get,set
member val SerialNumberRange:ResizeArray<SerialNumberRange> = null with get,set
member val TransactionalItemDimensions:ResizeArray<TransactionalItemDimension> = null with get,set
member val TransactionalItemLogisticUnitInformation:TransactionalItemLogisticUnitInformation = null with get,set
member val TransactionalItemDataCarrierAndIdentification:TransactionalItemDataCarrierAndIdentification = null with get,set
member val TradeItemWaste:ResizeArray<TradeItemWaste> = null with get,set
member val TransactionalItemOrganicInformation:TransactionalItemOrganicInformation = null with get,set
member val AvpList:ResizeArray<AvpList> = null with get,set
[<AllowNullLiteral>]
type Colour() =
member val ColourCode:String = null with get,set
member val ColourDescription:String = null with get,set
[<AllowNullLiteral>]
type Size() =
member val DescriptiveSize:String = null with get,set
member val SizeCode:String = null with get,set
[<AllowNullLiteral>]
type TradeItemClassification() =
member val GpcCategoryCode:String = null with get,set
member val AdditionalTradeItemClassificationCode:ResizeArray<AvpList> = null with get,set
member val GpcCategoryName:String = null with get,set
member val GpcAttribute:ResizeArray<AvpList> = null with get,set
[<AllowNullLiteral>]
type TransactionalTradeItem() =
member val Gtin:String = null with get,set
member val AdditionalTradeItemIdentification:ResizeArray<AvpList> = null with get,set
member val TradeItemQuantity:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val TradeItemDescription:String = null with get,set
member val ProductVariantIdentifier:String = null with get,set
member val ItemTypeCode:String = null with get,set
member val TradeItemDataOwner:String = null with get,set
member val ButterFatReference:String = null with get,set
member val TransactionalItemData:ResizeArray<TransactionalItemData> = null with get,set
member val Colour:ResizeArray<Colour> = null with get,set
member val Size:Size = null with get,set
member val TradeItemClassification:TradeItemClassification = null with get,set
member val AvpList:ResizeArray<AvpList> = null with get,set
[<AllowNullLiteral>]
type ClaimsNotificationItemDiscrepancy() =
member val Price:Decimal = new Decimal() with get,set
member val Quantity:Quantity = null with get,set
member val TransactionalTradeItem:TransactionalTradeItem = null with get,set
[<AllowNullLiteral>]
type ClaimsNotificationDiscrepancyInformation() =
member val ClaimAmount:Decimal = new Decimal() with get,set
member val ClaimReasonCode:String = null with get,set
member val DiscrepancyDescription:String = null with get,set
member val ActualReceived:ClaimsNotificationItemDiscrepancy = null with get,set
member val ExpectedToReceive:ClaimsNotificationItemDiscrepancy = null with get,set
member val AvpList:ResizeArray<AvpList> = null with get,set
[<AllowNullLiteral>]
type ClaimTotals() =
member val BaseAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val TotalTaxAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val TotalClaimAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<AllowNullLiteral>]
type ClaimExtension() =
member val ClaimTotals:ClaimTotals = null with get,set
member val ShipFrom:TransactionalParty = null with get,set
member val ShipTo:TransactionalParty = null with get,set
[<AllowNullLiteral>]
type ClaimNotification() =
inherit BaseDocument()
member val ClaimsNotificationTypeCode:String = null with get,set
member val IsManualProcessNeededForClaimsResolution:Boolean = new Boolean() with get,set
member val IsSupplementalMessageBeingSent:Boolean = new Boolean() with get,set
member val SupplementalMessageDescription:String = null with get,set
member val ClaimsNotificationIdentification:String = null with get,set
member val Buyer:TransactionalParty = null with get,set
member val RemitTo:TransactionalParty = null with get,set
member val Seller:TransactionalParty = null with get,set
member val BillOfLading:BillOfLading = null with get,set
member val ClaimsNotification:DocumentReference = null with get,set
member val DispatchAdvice:DocumentReference = null with get,set
member val PurchaseOrder:DocumentReference = null with get,set
member val Invoice:DocumentReference = null with get,set
member val ClaimsNotificationDiscrepancyInformation:ResizeArray<ClaimsNotificationDiscrepancyInformation> = null with get,set
member val Extension:ClaimExtension = null with get,set
[<AllowNullLiteral>]
type ClaimMessage() =
member val Header:Header = null with get,set
member val ClaimNotification:ClaimNotification = null with get,set
[<AllowNullLiteral>]
type ResultItem<T>() =
member val Token:Guid = new Guid() with get,set
member val Item:ClaimMessage = null with 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.
GET /api/orderResponse HTTP/1.1 Host: stf-api-uat.data-xchange.co.za Accept: text/jsv