Skip to content

11 Appendix F - Enotes PTI Web Service Contract

Source: TI_Host_to_Host_Client_User_Manual_v52.pdf Document pages: 178-182 PDF pages: 178-182

Appendix F Appendix E -

Note: Enotes PTI Web Services is for informational purposes for clients migrated to TI from Enotes PTI. New clients must use the TI Third-party Web Services contract.

a) The Web Services protocol sends Notifications real time. Nedbank's preferred standard is to send / push the data to the client's Web Service. A WSDL (Web Service Definition Language) will be provided by Nedbank, which the client will need to conform to. For PTI the 'consume' functionality is not applicable, as data is sent to the client as and when transactions occur. Web Services is offered over either a leased line or the internet. Additional functionality has been built for Web Services to cater for the retrying and resending of transactions within the business day. If you choose the additional functionality, you can specify the following parameters:

  • Retry count It specifies the maximum number of times that Nedbank will retry before permanently marking a message transmission as failed. It is recommended that the retry count must be set to five.

  • Retry Interval The recommended time delay between each retry must be set to a 45 seconds interval.

  • Retry Status Codes - include actual status codes in PTI manual The set of status codes and descriptions eg combinations (1, resend) for which we have to retry.

Note: As a default, only transmission failures and SOAP faults can be retried if no retry status codes are specified.

b) TI third-party Web Service contract

  • Step 1: Extract the four files below to a folder on your machine
  • Step 2: Open you development environment
  • Step 3: Initiate or create a Web Service wizard (Wizard name may be different depending on the development tool you are using)
  • Step 4: Use the TIWebDistribution _2013-11-01.wsdl as your primary file
  • Step 5: Continue implementation as per your development environment

EnterpriseContext_2008-09.wsdl EnterpriseContext_2008-09.xsd

PTITracker_2011-08-17.wsdl

PTITracker_2011-08-17.xsd

c) Describing the Web Service contract

Nedbank initiates a Web Services-ready platform where the enterprise context will already have been populated; you are expected to echo it back on your response message.

Enterprise context headers for all message layouts (request and response) Field name Type (Max Length) Mandatory/ Optional Min occurs Max occurs Description Comment Process context ID String (36) O 0 1 This identifier indicates that the request is part of a bigger process. It is a unique ID for each process request and it must be a globally unique identifier (GUID). Usually populated with a GUID/UUID, used for tracing/tracking. Execution context ID String (36) M 1 1 This identifier is uniquely used to identify the request and it must be a GUID. Usually populated with a GUID/UUID, used for tracing/tracking. Machine IP address String (20) M 1 1 This field contains the IP address of the machine. Source IP Address User principle name String (32) M 1 1 This field contains the username that is used to log on to a machine.

Machine DNS name String (50) M 1 1 This field contains the full qualified domain name of the machine. Source Machine Name Channel ID Long (3) M 1 1 This is the unique identifier for the channel and is used to initiate the request.

Parent instrumentation ID String (36) M 1 1 This is the instrumentation ID of the parent instrumentation entry and it must be a GUID. Usually populated with a GUID/UUID, used for tracing/tracking. Child instrumentation ID String (36) M 1 1 This is the instrumentation ID of the child instrumentation entry and it must Usually populated with a GUID/UUID, used for tracing/tracking.

be a GUID.

Sample Enterprise Context format

<ent:EnterpriseContext>
<ent:ContextInfo>
<ent:ProcessContextId>?</ent:ProcessContextId>
<ent:ExecutionContextId>?</ent:ExecutionContextId>
</ent:ContextInfo>
<ent:RequestOriginator>
<ent:MachineIPAddress>?</ent:MachineIPAddress>
<ent:UserPrincipleName>?</ent:UserPrincipleName>
<ent:MachineDNSName>?</ent:MachineDNSName>
<ent:ChannelId>?</ent:ChannelId>
</ent:RequestOriginator>
<ent:InstrumentationInfo>
<ent:ParentInstrumentationId>?</ent:ParentInstrumentationId>
<ent:ChildInstrumentationId>?</ent:ChildInstrumentationId>
</ent:InstrumentationInfo>
</ent:EnterpriseContext>

Description of the request message Tag name Type (Max Length) Usage Min occurs Max occurs Description Format NC-10 Required 1 1 The format of the data as provided by the TI backend SecurityProxyType NC-10 Required 1 1 A value indicating the security gateway to use. DestinationKey Long(9) Required 1 1 Destination Key TransformedData NC-5000 Required 1 1 The generated data

Sample of request message

1
2
3
4
5
6
7
8
<DistributeMsgRq>
<Content>
<Format>XML</Format>
<SecurityProxyType>SECURE</SecurityProxyType>
<DestinationKey>000</DestinationKey>
<TransformedData>Data</TransformedData>
</Content>
</DistributeMsgRq>

Description of the response message (message generated by you in response to the request message) Tag name Type (Max Length) Usage Min occurs Max occurs Description ResultCode NC-3 Required 1 1 R00 - successful (all other codes will be treated as an error)

Sample of the response message

1
2
3
<DistributeMsgRs>
<ResultCode>R00</ResultCode>
</DistributeMsgRs>

Nedbank Corporate Headoffice 135 Rivonia Road Sandown Sandton 2196 PO Box 1144 Johannesburg 2000 Tel: +27 (0)11 294 4444 Website: www.nedbank.co.za

Disclaimer This communication has been prepared solely for information purposes. It is strongly recommended that appropriate professional advice be sought before acting on any information contained herein. While every care has been taken in preparing this communication, no representation, guarantee, warranty or undertaking, express or implied, is given as to the accuracy or completeness of the information or representations. All information contained herein is subject to change after publication, at any time, without notice. The past performance of any investment product is not an indication of future performance.

Nedbank Limited Reg No 1951/000009/06, VAT Reg No 4320116074, Nedbank 135 Rivonia Campus, 135 Rivonia Road, Sandown, Sandton, 2196, South Africa. We subscribe to the Code of Banking Practice of The Banking Association South Africa and, for unresolved disputes, support resolution through the Ombudsman for Banking Services. We are an authorised financial services provider. We are a registered credit provider in terms of the National Credit Act (NCR Reg No NCRCP16).

Published April 2015