INFORMATION TECHNOLOGY. Automated Railcar Release, Switch and Resequence XML and WSDL documentation

Size: px

Start display at page:

Download "INFORMATION TECHNOLOGY. Automated Railcar Release, Switch and Resequence XML and WSDL documentation"

Sherilyn Chambers
6 years ago
Views:

1 INFORMATION TECHNOLOGY Automated Railcar Release, Switch and Resequence XML and WSDL documentation Revision Date: December 21, 2017

2 Table of Contents 1 Introduction Purpose of this document Automated Railcar Release Web Service WSDL document Automated Railcar Release Web Service XML Input & Output document Soap Fault Security Diagram Authentication Confidentiality Client configuration References Page 2

3 List of figures Figure 1: Automated Railcar Release Web Service WSDL document in textual format... 5 Figure 2: Automated Railcar Release Web Service WSDL Generated documentation... 6 Figure 3: Automated Railcar Release Web Service Input XML schema (.xsd) document (graphical) 8 Page 3

4 1 Introduction 1.1 Purpose of this document This document describes the WSDL and XML documents related to CN s Automated Railcar Release, Switch and Resequence web service. The name of the webservice is unchanged (SRORelease) but now provides the additional Switch and Resequence functionalities. Page 4

5 2 Web Service WSDL document The WSDL allows a service provider to specify the following characteristics of a Web service, in this case the Railcar Automated Release Web Service: Name of the Web service and addressing information. Protocol and encoding style to be used when accessing the public operations of the Web service. Type information: operations, parameters, and data s comprising the interface of the Web Service, plus a name for this interface. Figure 1: Web Service WSDL document in textual format <wsdl:definitions xmlns:wsdl=" xmlns:wsdlsoap=" xmlns:xsd=" targetnamespace=" xmlns:tns=" xmlns:sro=""> <wsdl:import ="" location=" <wsdl:s> <xsd:schema xmlns:xsd=" elementformdefault="qualified" targetnamespace=" </wsdl:s> <wsdl:message name="sroreleasereply"> <wsdl:part name="sroreleasereplypart" element="sro:sroreleasereply"/> </wsdl:message> <wsdl:message name="sroreleaserequest"> <wsdl:part name="sroreleaserequestpart" element="sro:sroreleaserequest"></wsdl:part> </wsdl:message> <wsdl:porttype name="sroreleaseprovider"> <wsdl:operation name="execute"> <wsdl:input name="sroreleaserequestinput" message="tns:sroreleaserequest"/> <wsdl:output name="sroreleasereplyoutput" message="tns:sroreleasereply"/> </wsdl:operation> </wsdl:porttype> <wsdl:binding name="sroreleaseprovidersoapbinding" ="tns:sroreleaseprovider"> <wsdlsoap:binding style="document" transport=" <wsdl:operation name="execute"> <wsdl:input> <wsdlsoap:body use="literal"/> </wsdl:input> <wsdl:output> <wsdlsoap:body use="literal"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:service name="srorelease"> <wsdl:port name="sroreleaseprovider" binding="tns:sroreleaseprovidersoapbinding"> <wsdlsoap:address location=" </wsdl:port> </wsdl:service> </wsdl:definitions> Many XML editor tools provide the feature of a Documentation generator. The following is the documentation for the AUTOMATED RAILCAR RELEASE Web Service WSDL document. It helps to Page 5

6 identify the main components of the Web service, most notably the Input, Output, and Fault messages which are further described in the next sections as XML documents. Figure 2: Web Service WSDL Generated documentation WSDL SROWebService.wsdl WSDL location: target: services bindings ports messages SRORelease SROReleaseProviderSoapBinding SROReleaseProvider sroreleasereply sroreleaserequest service SRORelease ports SROReleaseProvider binding tns:sroreleaseprovidersoapbinding extensi bility <wsdlsoap:address location=" <wsdl:service name="srorelease"> <wsdl:port name="sroreleaseprovider" binding="tns:sroreleaseprovidersoapbinding"> <wsdlsoap:address location=" </wsdl:port> </wsdl:service> binding SROReleaseProviderSoapBinding tns:sroreleaseprovider extensibility operations Used by <wsdlsoap:binding style="document" transport=" execute extensi bility input <wsdlsoap:body use="literal"/> output <wsdlsoap:body use="literal"/> Service SRORelease in Port SROReleaseProvider <wsdl:binding name="sroreleaseprovidersoapbinding" ="tns:sroreleaseprovider"> <wsdlsoap:binding style="document" transport=" <wsdl:operation name="execute"> <wsdl:input> <wsdlsoap:body use="literal"/> </wsdl:input> <wsdl:output> <wsdlsoap:body use="literal"/> </wsdl:output> </wsdl:operation> </wsdl:binding> Page 6

7 port SROReleaseProvider operations execute input tns:sroreleaserequest Used by output tns:sroreleasereply binding SROReleaseProviderSoapBinding <wsdl:porttype name="sroreleaseprovider"> <wsdl:operation name="execute"> <wsdl:input name="sroreleaserequestinput" message="tns:sroreleaserequest"/> <wsdl:output name="sroreleasereplyoutput" message="tns:sroreleasereply"/> </wsdl:operation> </wsdl:porttype> message sroreleasereply parts sroreleasereplypart element sro:sroreleasereply used by PortType SROReleaseProvider in Operation execute <wsdl:message name="sroreleasereply"> <wsdl:part name="sroreleasereplypart" element="sro:sroreleasereply"/> </wsdl:message> message sroreleaserequest parts sroreleaserequestpart element sro:sroreleaserequest used by PortType SROReleaseProvider in Operation execute <wsdl:message name="sroreleaserequest"> <wsdl:part name="sroreleaserequestpart" element="sro:sroreleaserequest"/> </wsdl:message> 3 Web Service XML Input & Output document The main input to will be an XML document submitted by a SOAP Client. This input XML document is the SROReleaseRequest Input described in the WSDL document. The schema (.xsd file extension) document for the Input XML (.xml file extension) document will define the data elements more precisely (data, number of elements (ex. EquipmentInfo)) to allow for the validation of the input values submitted. The following are graphical and textual representations of the schema document. There are two new elements (Weight and WeightUOM) had been added to EquipmentReleaseDetail. Page 7

8 Figure 3: Automated Railcar Release Web Service Input XML schema (.xsd) document (graphical) Page 8

9 Schema SRORelease.xsd schema location: targetnamespace: Elements SROReleaseReply SROReleaseRequest element SROReleaseReply children ReleaseSummary EquipmentReleaseStatus <xs:element name="sroreleasereply"> <xs:element name="releasesummary"> Page 9

10 <xs:element name="date" nillable="true"> <xs:documentation> The date must conform to the following mask YYYYMMDD</xs:documentation> <xs:pattern value=".{7}."/> <xs:element name="time" nillable="true"> <xs:documentation> The time must conform to the following mask 99:99 in 24 hour format.</xs:documentation> <xs:pattern value=".{1}.:.{1}."/> <xs:element name="location" nillable="true" minoccurs="0"> <xs:documentation>location data entity definition</xs:documentation> <xs:element name="track" nillable="true" minoccurs="0"> <xs:element name="numberofrecords" ="xs:integer"/> <xs:element name="equipmentreleasestatus"> <xs:element name="equipmentinfo"> <xs:element name="equipmentinitials" nillable="false"> <xs:element name="equipmentnumber" nillable="false"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> <xs:element name="releasedtrack" nillable="true" minoccurs="0"> <xs:minlength value="4"/> Page 10

11 <xs:element name="aftercarinitials" nillable="true" minoccurs="0"> <xs:element name="aftercarnumber" nillable="true" minoccurs="0"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> <xs:element name="status" nillable="false"> <xs:enumeration value="accepted"/> <xs:enumeration value="rejected"/> <xs:element name="errorcode" ="xs:string" nillable="true"/> element SROReleaseReply/ReleaseSummary children Date Time Location NumberOfRecords <xs:element name="releasesummary"> <xs:element name="date" nillable="true"> <xs:documentation> The date must conform to the following mask YYYYMMDD</xs:documentation> Page 11

12 <xs:pattern value=".{7}."/> <xs:element name="time" nillable="true"> <xs:documentation> The time must conform to the following mask 99:99 in 24 hour format.</xs:documentation> <xs:pattern value=".{1}.:.{1}."/> <xs:element name="location" nillable="true" minoccurs="0"> <xs:documentation>location data entity definition</xs:documentation> <xs:element name="track" nillable="true" minoccurs="0"> <xs:element name="numberofrecords" ="xs:integer"/> element SROReleaseReply/ReleaseSummary/Date annotation pattern.{7}. documentation The date must conform to the following mask YYYYMMDD <xs:element name="date" nillable="true"> <xs:documentation> The date must conform to the following mask YYYYMMDD</xs:documentation> <xs:pattern value=".{7}."/> Page 12

13 element SROReleaseReply/ReleaseSummary/Time annotation pattern.{1}.:.{1}. documentation The time must conform to the following mask 99:99 in 24 hour format. <xs:element name="time" nillable="true"> <xs:documentation> The time must conform to the following mask 99:99 in 24 hour format.</xs:documentation> <xs:pattern value=".{1}.:.{1}."/> element SROReleaseReply/ReleaseSummary/Location children Track <xs:element name="location" nillable="true" minoccurs="0"> <xs:documentation>location data entity definition</xs:documentation> <xs:element name="track" nillable="true" minoccurs="0"> element SROReleaseReply/ReleaseSummary/Location/Track Page 13

14 minlength 2 maxlength 4 <xs:element name="track" nillable="true" minoccurs="0"> element SROReleaseReply/ReleaseSummary/NumberOfRecords xs:integer <xs:element name="numberofrecords" ="xs:integer"/> element SROReleaseReply/EquipmentReleaseStatus children EquipmentInfo Status ErrorCode <xs:element name="equipmentreleasestatus"> <xs:element name="equipmentinfo"> <xs:element name="equipmentinitials" nillable="false"> <xs:element name="equipmentnumber" nillable="false"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> <xs:element name="releasedtrack" nillable="true" minoccurs="0"> <xs:minlength value="4"/> Page 14

15 <xs:element name="aftercarinitials" nillable="true" minoccurs="0"> <xs:element name="aftercarnumber" nillable="true" minoccurs="0"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> <xs:element name="status" nillable="false"> <xs:enumeration value="accepted"/> <xs:enumeration value="rejected"/> <xs:element name="errorcode" ="xs:string" nillable="true"/> element SROReleaseReply/EquipmentReleaseStatus/EquipmentInfo children EquipmentInitials EquipmentNumber ReleasedTrack AfterCarInitials AfterCarNumber <xs:element name="equipmentinfo"> <xs:element name="equipmentinitials" nillable="false"> <xs:element name="equipmentnumber" nillable="false"> <xs:mininclusive value="000000"/> Page 15

16 <xs:maxinclusive value="999999"/> <xs:element name="releasedtrack" nillable="true" minoccurs="0"> <xs:minlength value="4"/> <xs:element name="aftercarinitials" nillable="true" minoccurs="0"> <xs:element name="aftercarnumber" nillable="true" minoccurs="0"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> element SROReleaseReply/EquipmentReleaseStatus/EquipmentInfo/EquipmentInitials minlength 2 maxlength 4 <xs:element name="equipmentinitials" nillable="false"> element SROReleaseReply/EquipmentReleaseStatus/EquipmentInfo/EquipmentNumber restriction of xs:integer mininclusive maxinclusive <xs:element name="equipmentnumber" nillable="false"> Page 16

17 <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> element SROReleaseReply/EquipmentReleaseStatus/EquipmentInfo/ReleasedTrack minlength 4 maxlength 4 <xs:element name="releasedtrack" nillable="true" minoccurs="0"> <xs:minlength value="4"/> element SROReleaseReply/EquipmentReleaseStatus/EquipmentInfo/AfterCarInitials minlength 2 maxlength 4 <xs:element name="aftercarinitials" nillable="true" minoccurs="0"> element SROReleaseReply/EquipmentReleaseStatus/EquipmentInfo/AfterCarNumber restriction of xs:integer mininclusive maxinclusive <xs:element name="aftercarnumber" nillable="true" minoccurs="0"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> Page 17

18 element SROReleaseReply/EquipmentReleaseStatus/Status enumeration enumeration Accepted Rejected <xs:element name="status" nillable="false"> <xs:enumeration value="accepted"/> <xs:enumeration value="rejected"/> element SROReleaseReply/EquipmentReleaseStatus/ErrorCode xs:string <xs:element name="errorcode" ="xs:string" nillable="true"/> element SROReleaseRequest children UserName Version ReleaseSummary EquipmentReleaseDetail <xs:element name="sroreleaserequest"> <xs:element name="username" ="xs:string"/> <xs:element name="version" nillable="true" minoccurs="0"> <xs:minlength value="1"/> <xs:maxlength value="20"/> <xs:element name="releasesummary"> Page 18

19 <xs:element name="date" nillable="true"> <xs:documentation> The date must conform to the following mask YYYYMMDD</xs:documentation> <xs:pattern value=".{7}."/> <xs:element name="time" nillable="true"> <xs:documentation> The time must conform to the following mask 99:99 in 24 hour format.</xs:documentation> <xs:pattern value=".{1}.:.{1}."/> <xs:element name="location" nillable="true" minoccurs="0"> <xs:documentation>location data entity definition</xs:documentation> <xs:element name="track" nillable="true" minoccurs="0"> <xs:element name="equipmentreleasedetail"> <xs:element name="equipmentinfo"> <xs:element name="equipmentinitials" nillable="false"> <xs:element name="equipmentnumber" nillable="false"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> <xs:element name="releasedtrack" nillable="true" minoccurs="0"> <xs:minlength value="4"/> Page 19

20 <xs:element name="aftercarinitials" nillable="true" minoccurs="0"> <xs:element name="aftercarnumber" nillable="true" minoccurs="0"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> <xs:element name="loadempty" nillable="false"> <xs:enumeration value="load"/> <xs:enumeration value="load"/> <xs:enumeration value="load"/> <xs:enumeration value="empty"/> <xs:enumeration value="empty"/> <xs:enumeration value="empty"/> <xs:element name="lidnumber" nillable="true" minoccurs="0"> <xs:restriction base="xs:string"/> <xs:element name="releasecode" nillable="true" minoccurs="0"> <xs:minlength value="0"/> <xs:maxlength value="2"/> <xs:element name="releasedetail" nillable="true" minoccurs="0"> <xs:minlength value="0"/> <xs:maxlength value="215"/> <xs:element name="residueweight" nillable="true" minoccurs="0"> <xs:element name="weight" nillable="false"> <xs:mininclusive value="0"/> <xs:maxinclusive value=" "/> <xs:element name="weightuom" nillable="false"> <xs:minlength value="0"/> <xs:maxlength value="2"/> Page 20

21 element SROReleaseRequest/UserName xs:string <xs:element name="username" ="xs:string"/> element SROReleaseRequest/Version minlength 1 maxlength 20 <xs:element name="version" nillable="true" minoccurs="0"> <xs:minlength value="1"/> <xs:maxlength value="20"/> element SROReleaseRequest/ReleaseSummary children Date Time Location Page 21

22 <xs:element name="releasesummary"> <xs:element name="date" nillable="true"> <xs:documentation> The date must conform to the following mask YYYYMMDD</xs:documentation> <xs:pattern value=".{7}."/> <xs:element name="time" nillable="true"> <xs:documentation> The time must conform to the following mask 99:99 in 24 hour format.</xs:documentation> <xs:pattern value=".{1}.:.{1}."/> <xs:element name="location" nillable="true" minoccurs="0"> <xs:documentation>location data entity definition</xs:documentation> <xs:element name="track" nillable="true" minoccurs="0"> element SROReleaseRequest/ReleaseSummary/Date annotation pattern.{7}. documentation The date must conform to the following mask YYYYMMDD <xs:element name="date" nillable="true"> <xs:documentation> The date must conform to the following mask YYYYMMDD</xs:documentation> <xs:pattern value=".{7}."/> Page 22

23 element SROReleaseRequest/ReleaseSummary/Time annotation pattern.{1}.:.{1}. documentation The time must conform to the following mask 99:99 in 24 hour format. <xs:element name="time" nillable="true"> <xs:documentation> The time must conform to the following mask 99:99 in 24 hour format.</xs:documentation> <xs:pattern value=".{1}.:.{1}."/> element SROReleaseRequest/ReleaseSummary/Location children Track <xs:element name="location" nillable="true" minoccurs="0"> <xs:documentation>location data entity definition</xs:documentation> <xs:element name="track" nillable="true" minoccurs="0"> element SROReleaseRequest/ReleaseSummary/Location/Track Page 23

24 minlength 2 maxlength 4 <xs:element name="track" nillable="true" minoccurs="0"> element SROReleaseRequest/EquipmentReleaseDetail children EquipmentInfo LoadEmpty LidNumber ReleaseCode ReleaseDetail ResidueWeight <xs:element name="equipmentreleasedetail"> <xs:element name="equipmentinfo"> <xs:element name="equipmentinitials" nillable="false"> <xs:element name="equipmentnumber" nillable="false"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> <xs:element name="releasedtrack" nillable="true" minoccurs="0"> <xs:minlength value="4"/> <xs:element name="aftercarinitials" nillable="true" minoccurs="0"> Page 24

25 <xs:element name="aftercarnumber" nillable="true" minoccurs="0"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> <xs:element name="loadempty" nillable="false"> <xs:enumeration value="load"/> <xs:enumeration value="load"/> <xs:enumeration value="load"/> <xs:enumeration value="empty"/> <xs:enumeration value="empty"/> <xs:enumeration value="empty"/> <xs:element name="lidnumber" nillable="true" minoccurs="0"> <xs:restriction base="xs:string"/> <xs:element name="releasecode" nillable="true" minoccurs="0"> <xs:minlength value="0"/> <xs:maxlength value="2"/> <xs:element name="releasedetail" nillable="true" minoccurs="0"> <xs:minlength value="0"/> <xs:maxlength value="215"/> <xs:element name="residueweight" nillable="true" minoccurs="0"> <xs:element name="weight" nillable="false"> <xs:mininclusive value="0"/> <xs:maxinclusive value=" "/> <xs:element name="weightuom" nillable="false"> <xs:minlength value="0"/> <xs:maxlength value="2"/> Page 25

26 element SROReleaseRequest/EquipmentReleaseDetail/EquipmentInfo children EquipmentInitials EquipmentNumber ReleasedTrack AfterCarInitials AfterCarNumber <xs:element name="equipmentinfo"> <xs:element name="equipmentinitials" nillable="false"> <xs:element name="equipmentnumber" nillable="false"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> <xs:element name="releasedtrack" nillable="true" minoccurs="0"> <xs:minlength value="4"/> <xs:element name="aftercarinitials" nillable="true" minoccurs="0"> <xs:element name="aftercarnumber" nillable="true" minoccurs="0"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> Page 26

27 element SROReleaseRequest/EquipmentReleaseDetail/EquipmentInfo/EquipmentInitials minlength 2 maxlength 4 <xs:element name="equipmentinitials" nillable="false"> element SROReleaseRequest/EquipmentReleaseDetail/EquipmentInfo/EquipmentNumber restriction of xs:integer mininclusive maxinclusive <xs:element name="equipmentnumber" nillable="false"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> element SROReleaseRequest/EquipmentReleaseDetail/EquipmentInfo/ReleasedTrack minlength 4 maxlength 4 <xs:element name="releasedtrack" nillable="true" minoccurs="0"> <xs:minlength value="4"/> Page 27

28 element SROReleaseRequest/EquipmentReleaseDetail/EquipmentInfo/AfterCarInitials minlength 2 maxlength 4 <xs:element name="aftercarinitials" nillable="true" minoccurs="0"> element SROReleaseRequest/EquipmentReleaseDetail/EquipmentInfo/AfterCarNumber restriction of xs:integer mininclusive maxinclusive <xs:element name="aftercarnumber" nillable="true" minoccurs="0"> <xs:mininclusive value="000000"/> <xs:maxinclusive value="999999"/> element SROReleaseRequest/EquipmentReleaseDetail/LoadEmpty enumeration enumeration enumeration enumeration enumeration enumeration LOAD Load load EMPTY Empty empty <xs:element name="loadempty" nillable="false"> <xs:enumeration value="load"/> <xs:enumeration value="load"/> <xs:enumeration value="load"/> <xs:enumeration value="empty"/> <xs:enumeration value="empty"/> <xs:enumeration value="empty"/> Page 28

29 element SROReleaseRequest/EquipmentReleaseDetail/LidNumber <xs:element name="lidnumber" nillable="true" minoccurs="0"> <xs:restriction base="xs:string"/> element SROReleaseRequest/EquipmentReleaseDetail/ReleaseCode minlength 0 maxlength 2 Code BA BC BD BE BG BJ BL BP BS BV BW DE CP BM BN SW Description Release-Side Doors (Box Type Cars) Release-Wood Lining Release-Account Dirty Release-Bulkheads Defective Release-Bad End Gates Release-Floor Defective Release-Hatch Covers Release-Roof Defective Release-Hopper Gates Defective Release-Unloading System Release-Lining Hopper Release-Declared Empty Release-Car has been cleaned/purged Reject-Unloading System-Full Load Reject-Unloading System-Partial Load Switch / Re-sequence Only <xs:element name="releasecode" nillable="true" minoccurs="0"> <xs:minlength value="0"/> <xs:maxlength value="2"/> Page 29

30 element SROReleaseRequest/EquipmentReleaseDetail/ReleaseDetail minlength 0 maxlength 215 <xs:element name="releasedetail" nillable="true" minoccurs="0"> <xs:minlength value="0"/> <xs:maxlength value="215"/> element SROReleaseRequest/EquipmentReleaseDetail/ResidueWeight children Weight WeightUOM <xs:element name="residueweight" nillable="true" minoccurs="0"> <xs:element name="weight" nillable="false"> <xs:mininclusive value="0"/> <xs:maxinclusive value=" "/> <xs:element name="weightuom" nillable="false"> <xs:minlength value="0"/> <xs:maxlength value="2"/> element SROReleaseRequest/EquipmentReleaseDetail/ResidueWeight/Weight restriction of xs:integer Page 30

31 mininclusive 0 maxinclusive <xs:element name="weight" nillable="false"> <xs:mininclusive value="0"/> <xs:maxinclusive value=" "/> Page 31

32 element SROReleaseRequest/EquipmentReleaseDetail/ResidueWeight/WeightUOM minlength 0 maxlength 2 <xs:element name="weightuom" nillable="false"> <xs:minlength value="0"/> <xs:maxlength value="2"/> Page 32

33 4 Soap Fault SOAP Fault errors will be handled via the standard exception handling of web services. Errors will be captured with:. faultcode. faultstring A list of SOAP Fault errors can be found in the /media/files/customer%20centre/customer-centre-documents/automated-railcar-release-error-codesen.pdf document. 5 Security 5.1 Diagram 5.2 Authentication The customers will use the same userid/password as the one they are using for online transaction on the ebusiness site. The client needs to be a registered customer on the ebusiness site. 5.3 Confidentiality Like all ebusiness applications, this service will run under encryption (SSL 128 bits). 5.4 Client configuration Basic Authentication will be used for this service. CN s infrastructure will be doing the Authentication & Authorization. Basically, all WebService clients will have to provide the following information within the HTTP header: AUTH_TYPE = basic USERNAME = joe123 PASSWORD = mypassword Important: The information above is inside the HTTP header, not in the XML document. 6 References Page 33

34 Web services overview and architecture, IBM Corp, Web Services: WSDL: SOAP: Page 34

Automated Railcar Release

Automated Railcar Release How to release railcars through computer-to-computer exchange. This document explains the procedures to provide data from your computer to CN s systems for the purpose of releasing