Needio.Services

<back to all web services

QueryShipmentForViewRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Trans/QueryShipmentForView/
QueryShipmentForViewRequest Parameters:
NameParameterData TypeRequiredDescription
TransReturnTypequeryTransReturnTypesNo
CargoKeyquerystringNo
ShippingMethodIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
QueryShipmentForViewResponse Parameters:
NameParameterData TypeRequiredDescription
QueryShipmentformQueryShipmentDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
QueryShipmentDTO Parameters:
NameParameterData TypeRequiredDescription
TransReturnTypeformTransReturnTypesNo
CargoTransactionStatusformlongNo
CargoEventIdformstringNo
CargoReasonExplanationformstringNo
CargoKeyformstringNo
CargoCompanyDocIdformstringNo
ErrCodeformlongNo
ErrMessageformstringNo
TrackingUrlformstringNo
DeliveryDateformDateTime?No
ShippedDateformDateTime?No
RejectFlagformintNo
RejectStatusformstringNo
RejectReasonExplanationformstringNo
SenderCustIdformstringNo
SenderCustNameformstringNo
SenderAddressTxtformstringNo
ReceiverCustIdformstringNo
ReceiverCustNameformstringNo
ReceiverAddressTxtformstringNo
ArrivalUnitIdformstringNo
ArrivalUnitNameformstringNo
DepartureUnitIdformstringNo
DepartureUnitNameformstringNo
DeliveryUnitIdformstringNo
DeliveryUnitNameformstringNo
CargoMovementsformList<CargoMovementDTO>No
ReceiverInfoformstringNo
TotalPriceformdecimalNo
TotalVatformdecimalNo
TotalAmountformdecimalNo
CargoProductformstringNo
TotalDesiformdecimalNo
TotalKgformdecimalNo
TotalDesiKgformdecimalNo
TotalCargoformdecimalNo
ReturnTotalPriceformdecimalNo
ReturnTotalVatformdecimalNo
ReturnTotalAmountformdecimalNo
BarcodeStringValueformstringNo
DeliveryProblemFlgformboolNo
TransReturnTypes Enum:
NameValue
Transaction1
Return2
CargoMovementDTO Parameters:
NameParameterData TypeRequiredDescription
UnitIdformstringNo
UnitNameformstringNo
EventIdformstringNo
EventNameformstringNo
ReasonIdformstringNo
ReasonNameformstringNo
EventDateformDateTime?No
CityNameformstringNo
TownNameformstringNo
QueryShipmentForViewResponse Parameters:
NameParameterData TypeRequiredDescription
QueryShipmentformQueryShipmentDTONo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Trans/QueryShipmentForView/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryShipmentForViewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <DeviceUUID>String</DeviceUUID>
  <CargoKey>String</CargoKey>
  <ShippingMethodId>0</ShippingMethodId>
  <TransReturnType>Transaction</TransReturnType>
</QueryShipmentForViewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryShipmentForViewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <QueryShipment xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:ArrivalUnitId>String</d2p1:ArrivalUnitId>
    <d2p1:ArrivalUnitName>String</d2p1:ArrivalUnitName>
    <d2p1:BarcodeStringValue>String</d2p1:BarcodeStringValue>
    <d2p1:CargoCompanyDocId>String</d2p1:CargoCompanyDocId>
    <d2p1:CargoEventId>String</d2p1:CargoEventId>
    <d2p1:CargoKey>String</d2p1:CargoKey>
    <d2p1:CargoMovements>
      <d2p1:CargoMovementDTO>
        <d2p1:CityName>String</d2p1:CityName>
        <d2p1:EventDate>0001-01-01T00:00:00</d2p1:EventDate>
        <d2p1:EventId>String</d2p1:EventId>
        <d2p1:EventName>String</d2p1:EventName>
        <d2p1:ReasonId>String</d2p1:ReasonId>
        <d2p1:ReasonName>String</d2p1:ReasonName>
        <d2p1:TownName>String</d2p1:TownName>
        <d2p1:UnitId>String</d2p1:UnitId>
        <d2p1:UnitName>String</d2p1:UnitName>
      </d2p1:CargoMovementDTO>
    </d2p1:CargoMovements>
    <d2p1:CargoProduct>String</d2p1:CargoProduct>
    <d2p1:CargoReasonExplanation>String</d2p1:CargoReasonExplanation>
    <d2p1:CargoTransactionStatus>0</d2p1:CargoTransactionStatus>
    <d2p1:DeliveryDate>0001-01-01T00:00:00</d2p1:DeliveryDate>
    <d2p1:DeliveryProblemFlg>false</d2p1:DeliveryProblemFlg>
    <d2p1:DeliveryUnitId>String</d2p1:DeliveryUnitId>
    <d2p1:DeliveryUnitName>String</d2p1:DeliveryUnitName>
    <d2p1:DepartureUnitId>String</d2p1:DepartureUnitId>
    <d2p1:DepartureUnitName>String</d2p1:DepartureUnitName>
    <d2p1:ErrCode>0</d2p1:ErrCode>
    <d2p1:ErrMessage>String</d2p1:ErrMessage>
    <d2p1:ReceiverAddressTxt>String</d2p1:ReceiverAddressTxt>
    <d2p1:ReceiverCustId>String</d2p1:ReceiverCustId>
    <d2p1:ReceiverCustName>String</d2p1:ReceiverCustName>
    <d2p1:ReceiverInfo>String</d2p1:ReceiverInfo>
    <d2p1:RejectFlag>0</d2p1:RejectFlag>
    <d2p1:RejectReasonExplanation>String</d2p1:RejectReasonExplanation>
    <d2p1:RejectStatus>String</d2p1:RejectStatus>
    <d2p1:ReturnTotalAmount>0</d2p1:ReturnTotalAmount>
    <d2p1:ReturnTotalPrice>0</d2p1:ReturnTotalPrice>
    <d2p1:ReturnTotalVat>0</d2p1:ReturnTotalVat>
    <d2p1:SenderAddressTxt>String</d2p1:SenderAddressTxt>
    <d2p1:SenderCustId>String</d2p1:SenderCustId>
    <d2p1:SenderCustName>String</d2p1:SenderCustName>
    <d2p1:ShippedDate>0001-01-01T00:00:00</d2p1:ShippedDate>
    <d2p1:TotalAmount>0</d2p1:TotalAmount>
    <d2p1:TotalCargo>0</d2p1:TotalCargo>
    <d2p1:TotalDesi>0</d2p1:TotalDesi>
    <d2p1:TotalDesiKg>0</d2p1:TotalDesiKg>
    <d2p1:TotalKg>0</d2p1:TotalKg>
    <d2p1:TotalPrice>0</d2p1:TotalPrice>
    <d2p1:TotalVat>0</d2p1:TotalVat>
    <d2p1:TrackingUrl>String</d2p1:TrackingUrl>
    <d2p1:TransReturnType>Transaction</d2p1:TransReturnType>
  </QueryShipment>
</QueryShipmentForViewResponse>