SSDF Segment Manager API
SSDF 2 SOAP
To successfully call the external SOAP feeds, a ws-security token containing the users credentials must be included in the SOAP header. A ws-security token looks like:
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken>
<wsse:Username>…</wsse:Username>
<wsse:Password Type="PasswordText">…</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
There will now be 7 SOAP operations in total, but only 4 operations require some form of parameter to be included in the request. Here are example values:
findJourneyByReference:
<ssd:findJourneyByReference>
<ssd:reference>AKL-SH1-NB-RNM</ssd:reference>
</ssd:findJourneyByReference>
findJourneysByType:
<ssd:findJourneysByType>
<!--Zero or more repetitions:-->
<ssd:typeIds>3</ssd:typeIds>
<ssd:typeIds>4</ssd:typeIds>
<ssd:typeIds>5</ssd:typeIds>
</ssd:findJourneysByType>
findSegmentByReference:
<ssd:findSegmentByReference>
<ssd:reference>0492</ssd:reference>
</ssd:findSegmentByReference>
findSegmentsByType:
<ssd:findSegmentsByType>
<!--Zero or more repetitions:-->
<ssd:type>3</ssd:type>
<ssd:type>2</ssd:type>
</ssd:findSegmentsByType>
The SSDF REST URLs have changed to comply with standards for accessing RESTful web services. Please refer to the SSDF REST URL changes document provided for usage instructions. Note that authentication credentials should still be added as request HEADERS as before.
SSDF2 REST
https://infoconnect1.highwayinfo.govt.nz/ic/jbi/SsdfJourney2/REST/FeedService/(external link) (old way)
The addition of the 6 new methods for SSDF v2 comes with changes to how the REST feeds URL should be accessed. This is in following with industry standards and best practices for providing resources via RESTful web services.
SSDF Resources
The old way of accessing SSDF2 rest was via this URL form:
http://<server_name>:<port>/<context>/jbi/SsdfJourney2/REST/FeedService/
The new URLs will now include resource names and optional parameters following the /FeedService/ portion of the resource path
.../FeedService/journey/xxxx
where xxxx is a journey reference value
.../FeedService/journeys
.../FeedService/journeys?type=xxxx&type=yyyy&type=zzzz
where type is a query parameter which can have multiple values (array). If no type is provided, this URL becomes a call to All Journeys.
.../FeedService/links
.../FeedService/segmentTypes
.../FeedService/segments?type=xxxx&type=yyyy&type=zzzz
where type is a query parameter which can have multiple values (array)
.../FeedService/segments/xxxxx
where xxxx is a segment carriageway segment id value
.../FeedService/segments/134
User-friendly error messages have been added for guidance on correct usage for cases such as invalid URL or missing parameters.
If you any questions or enquiries please refer to the Infoconnect section of the NZTA website.
