| GET | /api/itemDataNotification/{Id} | Get specific ItemDataNotification by ItemDataNotification Id |
|---|
namespace DX.STF.Application.ClientApi.Messages.ItemDataNotification
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
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 AdditionalTradeItemIdentification() =
member val Value:String = null with get,set
member val Code:String = null with get,set
[<AllowNullLiteral>]
type Ecom_TradeItemIdentification() =
member val AdditionalTradeItemIdentification:ResizeArray<AdditionalTradeItemIdentification> = null with get,set
member val Gtin:String = null with get,set
[<AllowNullLiteral>]
type IdentifierType() =
member val Value:String = null with get,set
member val IdentificationSchemeAgencyCodeCodeListVersion:String = null with get,set
member val IdentificationSchemeAgencyName:String = null with get,set
member val IdentificationSchemeName:String = null with get,set
[<AllowNullLiteral>]
type AdditionalTradeItemClassificationCode() =
member val Value:String = null with get,set
member val AdditionalTradeItemClassificationCodeListCode:String = null with get,set
member val AdditionalTradeItemClassificationCodeListVersion:String = null with get,set
member val CodeDescription:String = null with get,set
[<AllowNullLiteral>]
type Measurement() =
member val Value:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val CodeListVersion:String = null with get,set
member val MeasurementUnitCode:String = null with get,set
[<AllowNullLiteral>]
type ItemDataWeightAndDimension() =
member val Depth:Measurement = null with get,set
member val Diameter:Measurement = null with get,set
member val GrossWeight:Measurement = null with get,set
member val height:Measurement = null with get,set
member val NetWeight:Measurement = null with get,set
member val Width:Measurement = null with get,set
[<AllowNullLiteral>]
type TemperatureMeasurement() =
member val Value:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val TemperatureMeasurementUnitCode:String = null with get,set
[<AllowNullLiteral>]
type TemperatureRange() =
member val MaximumTemperature:TemperatureMeasurement = null with get,set
member val MinimumTemperature:TemperatureMeasurement = null with get,set
[<AllowNullLiteral>]
type HandlingInstruction() =
member val HandlingInstructionCode:String = null with get,set
member val HandlingInstructionText:String = null with get,set
member val PrintingInstructionCode:ResizeArray<String> = null with get,set
member val storageTemperature:TemperatureRange = null with get,set
member val TransportTemperature:TemperatureRange = null 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
[<AllowNullLiteral>]
type DangerousGoodsInformation() =
member val DangerousGoodsDescription:String = null with get,set
member val DangerousGoodsShippingName:String = null with get,set
member val DangerousGoodsTechnicalName:String = null with get,set
member val dangerousGoodsUNIdentifier:Identifier = null with get,set
member val Contact:ResizeArray<Contact> = null with get,set
[<AllowNullLiteral>]
type AdministrativeUnit() =
member val TypeCode:String = null with get,set
member val Gln:String = null with get,set
member val InternalIdentification:String = null with get,set
[<AllowNullLiteral>]
type ItemDataTradingPartnerNeutral() =
member val CancelledDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DiscontinuedDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val EffectiveDateTime:DateTime = new DateTime() with get,set
member val EndAvailabilityDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val MaximumStackingFactor:Nullable<Int32> = new Nullable<Int32>() with get,set
member val StartAvailabilityDateTime:DateTime = new DateTime() with get,set
member val TradeItemBaseUnitOfMeasure:String = null with get,set
member val TradeItemClassificationCode:ResizeArray<AdditionalTradeItemClassificationCode> = null with get,set
member val WarehouseABCClassificationCode:String = null with get,set
member val ItemDataWeightAndDimension:ItemDataWeightAndDimension = null with get,set
member val HandlingInstruction:ResizeArray<HandlingInstruction> = null with get,set
member val DangerousGoodsInformation:ResizeArray<DangerousGoodsInformation> = null with get,set
member val AdministrativeUnitOfLogisticServiceBuyer:AdministrativeUnit = null with get,set
member val AvpList:ResizeArray<AvpList> = null with get,set
[<AllowNullLiteral>]
type TimeMeasurement() =
member val TimeMeasurementUnitCode:String = null with get,set
member val Value:Nullable<Decimal> = new Nullable<Decimal>() 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 Dimension() =
member val Depth:Measurement = null with get,set
member val Height:Measurement = null with get,set
member val Width:Measurement = null with get,set
[<AllowNullLiteral>]
type ItemDataLogisticUnitInformation() =
member val grossWeight:Measurement = null with get,set
member val MaximumStackingFactor:Nullable<Int64> = new Nullable<Int64>() with get,set
member val NetWeight:Measurement = null with get,set
member val NumberOfLayers:Nullable<Int64> = new Nullable<Int64>() with get,set
member val PackageLevelCode:String = null with get,set
member val PackageTypeCode:String = null with get,set
member val TradeItemQuantity:Quantity = null with get,set
member val TradeItemQuantityPerLayer:Quantity = null with get,set
member val AvpList:AvpList = null with get,set
member val dimensionsOfLogisticUnit:ResizeArray<Dimension> = null with get,set
[<AllowNullLiteral>]
type ItemDataStockRequirements() =
member val requiredStockLevel:Quantity = null with get,set
member val requiredStockLevelValidityDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val StockRequirementTypeCode:String = null with get,set
[<AllowNullLiteral>]
type TransactionalPartyInRole() =
member val PartyRoleCode:String = null with get,set
member val TransactionalParty:TransactionalParty = null with get,set
[<AllowNullLiteral>]
type ItemDataTradingPartnerDependent() =
member val CountryOfOrigin:String = null with get,set
member val MinimumRemainingShelfLifeInbound:TimeMeasurement = null with get,set
member val MinimumRemainingShelfLifeOutbound:TimeMeasurement = null with get,set
member val OrderQuantityMaximum:Quantity = null with get,set
member val OrderQuantityMinimum:Quantity = null with get,set
member val OrderQuantityMultiple:Quantity = null with get,set
member val QualityControlCode:String = null with get,set
member val QuarantinePeriod:TimeMeasurement = null with get,set
member val TradeItemProductionLeadTime:TimeMeasurement = null with get,set
member val TradeItemShipmentLeadTime:TimeMeasurement = null with get,set
member val TradeItemSpecificUnitOfMeasure:String = null with get,set
member val TradeItemSubstitutionDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ItemDataLogisticUnitInformation:ResizeArray<ItemDataLogisticUnitInformation> = null with get,set
member val ItemDataStockRequirements:ResizeArray<ItemDataStockRequirements> = null with get,set
member val AdministrativeUnitOfReceiver:ResizeArray<AdministrativeUnit> = null with get,set
member val AvpList:AvpList = null with get,set
member val originatingParty:ResizeArray<TransactionalPartyInRole> = null with get,set
member val Receiver:TransactionalParty = null with get,set
member val Shipper:TransactionalParty = null with get,set
member val SubstituteItem:Ecom_TradeItemIdentification = null with get,set
[<AllowNullLiteral>]
type LowerLevelTradeItem() =
inherit Ecom_TradeItemIdentification()
member val QuantityOfLowerLevelTradeItem:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<AllowNullLiteral>]
type ItemDataNotificationLineItem() =
inherit Ecom_TradeItemIdentification()
member val BrandName:String = null with get,set
member val GpcCategoryCode:String = null with get,set
member val IsTheProductVariantPreferred:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val LineItemNumber:Nullable<Int64> = new Nullable<Int64>() with get,set
member val ParentLineItemNumber:Nullable<Int64> = new Nullable<Int64>() with get,set
member val ProductVariantIdentifier:IdentifierType = null with get,set
member val QuantityOfItemTypes:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val QuantityOfItemUnits:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val TradeItemDescription:ResizeArray<String> = null with get,set
member val TradeItemUnitDescriptorCode:String = null with get,set
member val ItemDataTradingPartnerNeutral:ItemDataTradingPartnerNeutral = null with get,set
member val ItemDataTradingPartnerDependent:ResizeArray<ItemDataTradingPartnerDependent> = null with get,set
member val LowerLevelTradeItem:ResizeArray<LowerLevelTradeItem> = null with get,set
member val AvpList:ResizeArray<AvpList> = null with get,set
[<AllowNullLiteral>]
type ItemDataNotificationMessage() =
inherit BaseDocument()
member val DataRecipient:TransactionalParty = null with get,set
member val DataSource:TransactionalParty = null with get,set
member val ItemDataNotificationIdentification:String = null with get,set
member val ItemDataNotificationLineItem:ResizeArray<ItemDataNotificationLineItem> = null with get,set
///<summary>
///Item Data Notification
///</summary>
[<Api(Description="Item Data Notification")>]
[<ApiResponse(Description="ItemDataNotification data", IsDefaultResponse=true, StatusCode=200)>]
[<ApiResponse(Description="No Content", ResponseType=typeof<IReturnVoid>, StatusCode=204)>]
[<ApiResponse(Description="Specified argument was out of the range of valid values.", ResponseType=typeof<ArgumentOutOfRangeException>, StatusCode=400)>]
[<AllowNullLiteral>]
type GetItemDataNotificationById() =
///<summary>
///ItemDataNotification ID or Token
///</summary>
[<ApiMember(Description="ItemDataNotification ID or Token", ExcludeInSchema=true, ParameterType="path")>]
member val Id:Guid = new Guid() with get,set
F# GetItemDataNotificationById DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/itemDataNotification/{Id} HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"dataRecipient":{"contact":[{"contactTypeCode":"String","personName":"String","departmentName":"String","jobTitle":"String","responsibility":"String","communicationChannel":[{"communicationChannelCode":"String","communicationChannelName":"String","communicationValue":"String"}]}],"address":{"streetAddressOne":"String","streetAddressTwo":"String","streetAddressThree":"String","city":"String","postalCode":"String","provinceCode":"String","countryCode":"String"},"communicationChannel":[{"code":"String","value":"String"}],"financialInstitutionInformation":{"financialInstitutionBranchName":"String","financialInstitutionName":"String","financialRoutingNumber":{"number":"String","numberTypeCode":"String"},"financialAccount":{"number":"String","numberTypeCode":"String","name":"String"},"swiftCode":"String","exportersCode":"String"},"dutyFeeTaxRegistration":"String","entityIdentification":"String","gln":"String","name":"String","additionalPartyIdentification":[{"code":"String","value":"String"}]},"dataSource":{"contact":[{"contactTypeCode":"String","personName":"String","departmentName":"String","jobTitle":"String","responsibility":"String","communicationChannel":[{"communicationChannelCode":"String","communicationChannelName":"String","communicationValue":"String"}]}],"address":{"streetAddressOne":"String","streetAddressTwo":"String","streetAddressThree":"String","city":"String","postalCode":"String","provinceCode":"String","countryCode":"String"},"communicationChannel":[{"code":"String","value":"String"}],"financialInstitutionInformation":{"financialInstitutionBranchName":"String","financialInstitutionName":"String","financialRoutingNumber":{"number":"String","numberTypeCode":"String"},"financialAccount":{"number":"String","numberTypeCode":"String","name":"String"},"swiftCode":"String","exportersCode":"String"},"dutyFeeTaxRegistration":"String","entityIdentification":"String","gln":"String","name":"String","additionalPartyIdentification":[{"code":"String","value":"String"}]},"itemDataNotificationIdentification":"String","itemDataNotificationLineItem":[{"brandName":"String","gpcCategoryCode":"String","isTheProductVariantPreferred":false,"lineItemNumber":0,"parentLineItemNumber":0,"productVariantIdentifier":{"value":"String","identificationSchemeAgencyCodeCodeListVersion":"String","identificationSchemeAgencyName":"String","identificationSchemeName":"String"},"quantityOfItemTypes":0,"quantityOfItemUnits":0,"tradeItemDescription":["String"],"tradeItemUnitDescriptorCode":"String","itemDataTradingPartnerNeutral":{"cancelledDateTime":"0001-01-01","discontinuedDateTime":"0001-01-01","endAvailabilityDateTime":"0001-01-01","maximumStackingFactor":0,"tradeItemBaseUnitOfMeasure":"String","tradeItemClassificationCode":[{"value":"String","additionalTradeItemClassificationCodeListCode":"String","additionalTradeItemClassificationCodeListVersion":"String","codeDescription":"String"}],"warehouseABCClassificationCode":"String","itemDataWeightAndDimension":{"depth":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"},"diameter":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"},"grossWeight":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"},"height":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"},"netWeight":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"},"width":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"}},"handlingInstruction":[{"handlingInstructionCode":"String","handlingInstructionText":"String","printingInstructionCode":["String"],"storageTemperature":{"maximumTemperature":{"value":0,"temperatureMeasurementUnitCode":"String"},"minimumTemperature":{"value":0,"temperatureMeasurementUnitCode":"String"}},"transportTemperature":{"maximumTemperature":{"value":0,"temperatureMeasurementUnitCode":"String"},"minimumTemperature":{"value":0,"temperatureMeasurementUnitCode":"String"}}}],"dangerousGoodsInformation":[{"dangerousGoodsDescription":"String","dangerousGoodsShippingName":"String","dangerousGoodsTechnicalName":"String","dangerousGoodsUNIdentifier":{"authority":"String","text":"String"},"contact":[{"contactTypeCode":"String","personName":"String","departmentName":"String","jobTitle":"String","responsibility":"String","communicationChannel":[{"communicationChannelCode":"String","communicationChannelName":"String","communicationValue":"String"}]}]}],"administrativeUnitOfLogisticServiceBuyer":{"typeCode":"String","gln":"String","internalIdentification":"String"},"avpList":[{"code":"String","value":"String"}]},"itemDataTradingPartnerDependent":[{"countryOfOrigin":"String","minimumRemainingShelfLifeInbound":{"timeMeasurementUnitCode":"String","value":0},"minimumRemainingShelfLifeOutbound":{"timeMeasurementUnitCode":"String","value":0},"orderQuantityMaximum":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"orderQuantityMinimum":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"orderQuantityMultiple":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"qualityControlCode":"String","quarantinePeriod":{"timeMeasurementUnitCode":"String","value":0},"tradeItemProductionLeadTime":{"timeMeasurementUnitCode":"String","value":0},"tradeItemShipmentLeadTime":{"timeMeasurementUnitCode":"String","value":0},"tradeItemSpecificUnitOfMeasure":"String","tradeItemSubstitutionDateTime":"0001-01-01","itemDataLogisticUnitInformation":[{"grossWeight":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"},"maximumStackingFactor":0,"netWeight":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"},"numberOfLayers":0,"packageLevelCode":"String","packageTypeCode":"String","tradeItemQuantity":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"tradeItemQuantityPerLayer":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"avpList":{"code":"String","value":"String"},"dimensionsOfLogisticUnit":[{"depth":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"},"height":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"},"width":{"value":0,"codeListVersion":"String","measurementUnitCode":"String"}}]}],"itemDataStockRequirements":[{"requiredStockLevel":{"value":0,"measurementUnitCode":"String","codeListVersion":"String"},"requiredStockLevelValidityDateTime":"0001-01-01","stockRequirementTypeCode":"String"}],"administrativeUnitOfReceiver":[{"typeCode":"String","gln":"String","internalIdentification":"String"}],"avpList":{"code":"String","value":"String"},"originatingParty":[{"partyRoleCode":"String","transactionalParty":{"contact":[{"contactTypeCode":"String","personName":"String","departmentName":"String","jobTitle":"String","responsibility":"String","communicationChannel":[{"communicationChannelCode":"String","communicationChannelName":"String","communicationValue":"String"}]}],"address":{"streetAddressOne":"String","streetAddressTwo":"String","streetAddressThree":"String","city":"String","postalCode":"String","provinceCode":"String","countryCode":"String"},"communicationChannel":[{"code":"String","value":"String"}],"financialInstitutionInformation":{"financialInstitutionBranchName":"String","financialInstitutionName":"String","financialRoutingNumber":{"number":"String","numberTypeCode":"String"},"financialAccount":{"number":"String","numberTypeCode":"String","name":"String"},"swiftCode":"String","exportersCode":"String"},"dutyFeeTaxRegistration":"String","entityIdentification":"String","gln":"String","name":"String","additionalPartyIdentification":[{"code":"String","value":"String"}]}}],"receiver":{"contact":[{"contactTypeCode":"String","personName":"String","departmentName":"String","jobTitle":"String","responsibility":"String","communicationChannel":[{"communicationChannelCode":"String","communicationChannelName":"String","communicationValue":"String"}]}],"address":{"streetAddressOne":"String","streetAddressTwo":"String","streetAddressThree":"String","city":"String","postalCode":"String","provinceCode":"String","countryCode":"String"},"communicationChannel":[{"code":"String","value":"String"}],"financialInstitutionInformation":{"financialInstitutionBranchName":"String","financialInstitutionName":"String","financialRoutingNumber":{"number":"String","numberTypeCode":"String"},"financialAccount":{"number":"String","numberTypeCode":"String","name":"String"},"swiftCode":"String","exportersCode":"String"},"dutyFeeTaxRegistration":"String","entityIdentification":"String","gln":"String","name":"String","additionalPartyIdentification":[{"code":"String","value":"String"}]},"shipper":{"contact":[{"contactTypeCode":"String","personName":"String","departmentName":"String","jobTitle":"String","responsibility":"String","communicationChannel":[{"communicationChannelCode":"String","communicationChannelName":"String","communicationValue":"String"}]}],"address":{"streetAddressOne":"String","streetAddressTwo":"String","streetAddressThree":"String","city":"String","postalCode":"String","provinceCode":"String","countryCode":"String"},"communicationChannel":[{"code":"String","value":"String"}],"financialInstitutionInformation":{"financialInstitutionBranchName":"String","financialInstitutionName":"String","financialRoutingNumber":{"number":"String","numberTypeCode":"String"},"financialAccount":{"number":"String","numberTypeCode":"String","name":"String"},"swiftCode":"String","exportersCode":"String"},"dutyFeeTaxRegistration":"String","entityIdentification":"String","gln":"String","name":"String","additionalPartyIdentification":[{"code":"String","value":"String"}]},"substituteItem":{"additionalTradeItemIdentification":[{"value":"String","code":"String"}],"gtin":"String"}}],"lowerLevelTradeItem":[{"quantityOfLowerLevelTradeItem":0,"additionalTradeItemIdentification":[{"value":"String","code":"String"}],"gtin":"String"}],"avpList":[{"code":"String","value":"String"}],"additionalTradeItemIdentification":[{"value":"String","code":"String"}],"gtin":"String"}],"currencyCode":"String","documentActionCode":"ADD","documentStatusCode":"ADDITIONAL_TRANSMISSION","documentStructureVersion":"String","lastUpdateDateTime":"0001-01-01","revisionNumber":0,"avpList":[{"code":"String","value":"String"}]}