Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagexml
themeRDark
firstline1
titleWeb Service Call Body
linenumberstrue
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:ValidateLocation>
         <!--Optional:-->
         <cha:location>
            <!--Optional:-->
            <cha:LocationID>?</cha:LocationID>
            <!--Optional:-->
            <cha:Locality>?</cha:Locality>
            <!--Optional:-->
            <cha:State>?</cha:State>
            <!--Optional:-->
            <cha:Postcode>?</cha:Postcode>
            <!--Optional:-->
            <cha:CountryCode>?</cha:CountryCode>
            <!--Optional:-->
            <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
         </cha:location>
      </cha:ValidateLocation>
   </soapenv:Body>
</soapenv:Envelope>

Object Property Definition (Table Format)

Address

...

Element

...

Type

...

Optional / Mandatory

...

Length

...

Comments

...

AccountID

...

Int

...

M

...

10

...

This value represents your assigned account id and can be found as a property in your Session object.

...

AddressID

...

Int

...

M

...

10

...

AddressLocation

...

Location

...

M

...

ContactName

...

String

...

O

...

25

...

Email

...

String

...

O

...

50

...

Exception

...

SaveException

...

ExtensionData

...

ExtensionDataObject

...

Fax

...

String

...

O

...

20

...

Line1

...

String

...

M

...

30

...

Line2

...

String

...

O

...

30

...

Line3

...

String

...

O

...

30

...

LocationDetails

...

Location

...

M

...

LocationID

...

Int

...

M

...

10

...

LocationID found in LocationDetails or AddressLocation property.

...

ModifiedBy

...

Int

...

O

...

10

...

Name

...

String

...

O

...

25

...

Phone

...

String

...

O

...

25

...

State

...

String

...

M

...

50

...

State string found in State property of LocationDetails or AddressLocation property.

...

Suburb

...

Suburb string found in Locality property of LocationDetails or AddressLocation property.


BookingNotification

...

Element

...

Type

...

Optional / Mandatory

...

Length

...

Comments

...

Carrier

...

String

...

M

...

20

...

CarrierId

...

Int

...

M

...

10

...

DistributorID int found in DistributorID property of ServiceLookup object. Use GetStandardServices function to get ServiceLookup array.

...

Confirmation

...

String

...

O

...

Do not populate

...

ExtensionData

...

ExtensionDatabject

...

O

...

Do not populate

...

Id

...

Int

...

PickupDate

...

ResponseError

...

SenderName

...

TotalItems

...

TotalVolume

...

TotalWeight

...

TransferMethod

...

Transferred

...

Transfersettingid

Carrier

CarrierId

Confirmation

ExtensionData

Id

PickupDate

ResponseError

SenderName

TotalItems

TotalVolume

TotalWeight

TransferMethod

Transferred

Transfersettingid

Consignment

-          AccountID
-          CloseAt
-          ConsignmentDate
-          ConsignmentID
-          ConsignmentItems
-          ConsignmentNote
-          ConsignmentType
-          ConsignmentSus
-          ContainingConsignment
-          DeliveryInstructions
-          Description
-          DistributorID
-          DownloadID
-          Exception
-          Ext
-          ExtensionData
-          ExtraInfo
-          Hours
-          ModifiedBy
-          NoItems
-          OnForwarder
-          PickupInstructions
-          ReadyAt
-          Receiver
-          Reference
-          References
-          Released
-          Sender
-          Service
-          SessionID
-          SpecialInstructions
-          Volume
-          Weight

ConsignmentExt

-          ConsignmentID
-          CostCentre
-          ExtensionData
-          ThirdPartyAccount
-          UserField1
-          UserField2
-          UserField3
-          UserField4
-          UserField5

ConsignmentItem

-          Barcode
-          ConsignmentID
-          ConsignmentProduct
-          Description
-          ExchangeReturnable
-          ExtensionData
-          Height
-          ItemNo
-          ItemType
-          Length
-          ModifiedBy
-          NoItems
-          ProductID
-          Reference
-          Returnable
-          Volume
-          Weight
-          Width

ConsolidatedConsignment

-          ExtensionData
-          Height
-          Items
-          ItemType
-          Length
-          Volume
-          Weight
-          Width

DangerousGood

-          AggrigateQuantity
-          ConsignmentID
-          DangerousGoodsID
-          DgClass
-          Exception
-          ExtensionData
-          Group
-          ID
-          ItemNo
-          LiquidVolume
-          LiquidWeight
-          Name
-          PSN
-          Quantity
-          Recepticle
-          SubRisk
-          UnCode
-          Units
-          Volume
-          Weight

Fee

-          ExtensionData
-          FeeCode
-          FeeDescriptions
-          FeeID
-          FeeMinimum
-          FeeName
-          FeeRate
-          Selected
-          TaxCodeID
-          TaxRate
-          ValueField

Location

-          CountryCode
-          ExtensionData
-          Locality
-          LocationID
-          Postcode
-          State
-          SuburbStatePostcode

Product

-          AccountID
-          Code
-          DangerousGoods
-          DangerousGoodsID
-          Error
-          ExtensionData
-          Height
-          IsActive
-          Length
-          Name
-          ProductID
-          Volume
-          Weight
-          Width

Reference

-          ConsignmentReference
-          ExtensionData
-          RemoveReference

SaveException

-          ExtensionData
-          Message
-          ModuleName
-          ProcedureName

ServiceLookup

-          BookingCutOffTime
-          CanConsignFreight
-          CanInsure
-          CarrierService
-          DisplayMember
-          DistributorID
-          ExtensionData
-          InsuranceFees
-          MaxItems
-          MaxVolume
-          MaxWeight
-          UseExternalPriceCalculator
-          ValueMember
-          WebDescription

ServicePricing

-          CarrierID
-          CarrierName
-          CarrierService
-          ETA
-          ExtensionData
-          FeesCharge
-          ID
-          NetCharge
-          RateID
-          ServiceName
-          ShipperService
-          TaxCharge
-          TotalCharge
-          WebDescription
-          ZoneFrom
-          ZoneTo

Session

-          AccountID
-          DistributorID
-          Expires
-          ExtensionData
-          Key
-          UserID

...

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@20f86d
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel in ("api","service","soap","web") and type = "page" and space = "FLIP"
labelsAPI SOAP Web Service

...