tyne and wear open data services platform · 2020-01-15 · 333551 hwy tts 1549540452 g 1549540452...

81
Tyne and Wear Open Data Services Platform API Specification October 2019 Newcastle City Council

Upload: others

Post on 27-Jul-2020

2 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services

Platform

API Specification

October 2019

Newcastle City Council

333551 HWY TTS 1549540452 G

1549540452

18 November 2015

Tyne and WearOpen Data Services Platform

API Specification

Tyne and WearOpen Data ServicesPlatform

API Specification

October 2019

Newcastle City Council

Mott MacDonald 1 Atlantic Quay Broomielaw Glasgow G2 8JB United Kingdom

T +44 (0)141 222 4500 F +44 (0)141 221 2048 W wwwmottmaccom

City of Newcastle upon TyneCivic CentreNewcastle upon TyneNE1 8QH

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Revision Date Originator Checker Approver Description StandardA 15 Jan 2014 S Wheeler C Morrison F Macdonald Initial draft revision for comment

and feedback

B 27 Jan 2014 C Morrison S Wheeler F Macdonald Add additional data feeds No subscription snapshotNotification actions added

C 31 Jan 2014 C Morrison S Wheeler F Macdonald Incorporate comments after review

D 17 Feb 2014 M Watson C Morrison F Macdonald Field updates Minor typo fixes

E 24 Feb 2014 S Sha C Morrison F Macdonald Typo in car park feed URLs

F 21 Oct 2015 C Forbes C Morrison F Macdonald New static and dynamic VMS API

G 18 Nov 2015 C Morrison C Kay C Morrison Updated for API V2

H 25 Oct 2019 T Austen C Kay M Mitchell

C Morrison Changed wording of event incidentand roadworks to indicate the feedwill contain future instances

Issue and revision record

This document is issued for the party which commissioned it andfor specific purposes connected with the above-captioned projectonly It should not be relied upon by any other party or used forany other purpose

We accept no responsibility for the consequences of thisdocument being relied upon by any other party or being usedfor any other purpose or containing any error or omissionwhich is due to an error or omission in data supplied to us byother parties

This document contains confidential information and proprietaryintellectual property It should not be shown to other partieswithout consent from us and from the party whichcommissioned it

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Chapter Title Page

1 Introduction 1

1 1 Overview of the Tyne and Wear Open Data Services Platform ________________________________ 1

12 Types of data available _______________________________________________________________ 1

13 Terms and conditions of use __________________________________________________________ 2

2 Getting started 3

21 Seeing what is available ______________________________________________________________ 3

22 Requesting access __________________________________________________________________ 3

23 Using your access credentials _________________________________________________________ 3

24 Data formats _______________________________________________________________________ 3

3 On demand API 4

31 Data requests ______________________________________________________________________ 4

32 Success responses _________________________________________________________________ 4

33 Error responses ____________________________________________________________________ 5

4 Subscription API 7

41 Overview _________________________________________________________________________ 7

42 Subscribing ________________________________________________________________________ 8

421 Request __________________________________________________________________________ 8

422 Success response __________________________________________________________________ 9

423 Error responses ____________________________________________________________________ 9

43 Handling data notifications ____________________________________________________________ 9

431 Data notification request _____________________________________________________________ 10

432 Expected response _________________________________________________________________ 11

44 Handling other types of notifications ____________________________________________________ 11

441 Delete notification request ___________________________________________________________ 11

442 Refresh notification request __________________________________________________________ 12

443 Expected response _________________________________________________________________ 13

45 Checking subscriptions ______________________________________________________________ 13

451 Request _________________________________________________________________________ 13

46 Removing subscriptions _____________________________________________________________ 14

461 Request _________________________________________________________________________ 14

462 Response ________________________________________________________________________ 14

5 Static car park information 15

51 Overview ________________________________________________________________________ 15

52 On demand request ________________________________________________________________ 15

53 Subscription request ________________________________________________________________ 15

54 Data content ______________________________________________________________________ 15

6 Dynamic car park information 17

Contents

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61 Overview ________________________________________________________________________ 17

62 On demand request ________________________________________________________________ 17

63 Subscription request ________________________________________________________________ 17

64 Data content ______________________________________________________________________ 17

7 Static CCTV information 19

71 Overview ________________________________________________________________________ 19

72 On demand request ________________________________________________________________ 19

73 Subscription request ________________________________________________________________ 19

74 Data content ______________________________________________________________________ 19

8 Dynamic CCTV information 21

81 Overview ________________________________________________________________________ 21

82 On demand request ________________________________________________________________ 21

83 Subscription request ________________________________________________________________ 21

84 Data content ______________________________________________________________________ 21

9 CCTV images 23

91 Overview ________________________________________________________________________ 23

92 On demand request ________________________________________________________________ 23

93 Subscription request ________________________________________________________________ 23

94 Data content ______________________________________________________________________ 23

10 Static SCOOT information 24

101 Overview ________________________________________________________________________ 24

102 On demand request ________________________________________________________________ 24

103 Subscription request ________________________________________________________________ 24

10 4 Data content ______________________________________________________________________ 24

1 1 Dynamic SCOOT information 26

1 1 1 Overview ________________________________________________________________________ 26

1 1 2 On demand request ________________________________________________________________ 26

1 1 3 Subscription request ________________________________________________________________ 26

1 1 4 Data content ______________________________________________________________________ 26

12 Static weather station information 28

121 Overview ________________________________________________________________________ 28

122 On demand request ________________________________________________________________ 28

123 Subscription request ________________________________________________________________ 28

124 Data content ______________________________________________________________________ 28

13 Dynamic weather station information 30

131 Overview ________________________________________________________________________ 30

132 On demand request ________________________________________________________________ 30

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

133 Subscription request ________________________________________________________________ 30

134 Data content ______________________________________________________________________ 30

14 Static air quality information 33

141 Overview ________________________________________________________________________ 33

142 On demand request ________________________________________________________________ 33

143 Subscription request ________________________________________________________________ 33

144 Data content ______________________________________________________________________ 33

15 Daily average air quality information 35

151 Overview ________________________________________________________________________ 35

152 On demand request ________________________________________________________________ 35

153 Subscription request ________________________________________________________________ 35

154 Data content ______________________________________________________________________ 35

16 Dynamic air quality information 37

161 Overview ________________________________________________________________________ 37

162 On demand request ________________________________________________________________ 37

163 Subscription request ________________________________________________________________ 37

164 Data content ______________________________________________________________________ 37

17 Static journey time information 39

171 Overview ________________________________________________________________________ 39

172 On demand request ________________________________________________________________ 39

173 Subscription request ________________________________________________________________ 39

174 Data content ______________________________________________________________________ 39

18 Dynamic journey time information 41

181 Overview ________________________________________________________________________ 41

182 On demand request ________________________________________________________________ 41

183 Subscription request ________________________________________________________________ 41

184 Data content ______________________________________________________________________ 41

19 Incident information 43

191 Overview ________________________________________________________________________ 43

192 On demand request ________________________________________________________________ 43

193 Subscription request ________________________________________________________________ 43

194 Data content ______________________________________________________________________ 43

20 Accident information 46

201 Overview ________________________________________________________________________ 46

202 On demand request ________________________________________________________________ 46

203 Subscription request ________________________________________________________________ 46

204 Data content ______________________________________________________________________ 46

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21 Event information 49

21 1 Overview ________________________________________________________________________ 49

212 On demand request ________________________________________________________________ 49

213 Subscription request ________________________________________________________________ 49

21 4 Data content ______________________________________________________________________ 49

22 Roadwork information 52

221 Overview ________________________________________________________________________ 52

222 On demand request ________________________________________________________________ 52

223 Subscription request ________________________________________________________________ 52

224 Data content ______________________________________________________________________ 52

23 VMS static 55

231 Overview ________________________________________________________________________ 55

232 On Demand request ________________________________________________________________ 55

233 Subscription request ________________________________________________________________ 55

234 Data content ______________________________________________________________________ 55

24 VMS dynamic 57

241 Overview ________________________________________________________________________ 57

242 On demand request ________________________________________________________________ 57

243 Subscription request ________________________________________________________________ 57

244 Data content ______________________________________________________________________ 57

Appendices 59Appendix A Incident Types ____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ___________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types _____________________________________________________________________ 68Appendix I Weather Station types ______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1

11 Overview of the Tyne and Wear Open Data Services Platform

The Tyne and Wear Open Data Service Platform provides an API to deliver a number of data sets currentlycaptured by the Tyne and Wear UTMC (Urban Traffic Management and Control) system to third partyapplications

The Tyne and Wear Open Data Services Platform provides both an on-demand and an asynchronousnotification API API access is over HTTPS with all data sent and received as JSON

The on-demand API will allow a third party application to retrieve the latest set of information as and whenrequired This is the simplest API to use See section 3 for more information

The asynchronous API will allow a third party application to subscribe to any of the available data setsAfter receiving an initial snapshot of the latest state a third party application will then receive further HTTPPOST notifications for each subsequent data update See section 4 for more information

12 Types of data available

The following data sets are available

Table 1 1 List of data types available from the Tyne and Wear Open Data Services Platform

Data set Summary Section

Accidents The latest set of accidents impacting the road network 20

Air Quality daily average information

Various air quality fields averaged for last 24 hours 15

Air quality dynamic information The latest air quality information 16

Air Quality static information The location of the air quality stations 14

Car park dynamic information The latest car park occupancy information 6

Car park static information Describes the car park names locations and capacities 5

CCTV dynamic information The latest update times of the camera images 8

CCTV image The latest captured images from the cameras 9

CCTV static information Describes the CCTV camera locations 7

Events The latest set of events impacting the road network 21

Incidents The latest set of incidents impacting the road network 19

Journey time dynamic information

Journey time readings captured from the HA and bus corridors 18

Journey time static information The location of journey time sites 17

Roadworks The latest set of roadworks impacting the road network 22

SCOOT dynamic information Speed flows and congestion captured from the SCOOT sites 11

SCOOT static information Describes the SCOOT site location 10

Weather station dynamic information

Various weather readings captured by the weather stations 13

1 Introduction

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

2

Data set Summary Section

Weather station static information

The location of weather stations 12

VMS dynamic information This data stream will provide details of variable message signs messages

23

VMS static information This data stream will provide details of variable message signs locations

22

13 Terms and conditions of use

The terms and conditions for use and access to the data feeds are presented to end users whenregistering a new user account on the wwwnetraveldatacouk website The terms and conditions must beaccepted before access is granted to the data feeds

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

3

21 Seeing what is available

The Open Data Service website contains details of the API and other information relating to the use andfuture developments of the Open Data Service

22 Requesting access

During the user account registration process end users will be required to accept the terms and conditionsfor use of the data feeds described in this document Once a user account has been created the end userwill automatically be granted permission to access the data feeds using the username and passwordentered during the registration process

23 Using your access credentials

All data requests are protected by HTTP Basic Authentication You will need to supply a username andpassword that has been registered previously (see section 22) For example

$ curl ndashu usernamepasswordhttps www netraveldata co ukapiv2carparkstatic

24 Data formats

All API access is over HTTPS and is accessed from the wwwnetraveldatacouk domain All data is sentand received as JSON

Blank fields are included as null

All timestamps are returned in ISO 8601 format eg YYYY-MM-DDTHH MM SS SSSZ

2 Getting started

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 2: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

333551 HWY TTS 1549540452 G

1549540452

18 November 2015

Tyne and WearOpen Data Services Platform

API Specification

Tyne and WearOpen Data ServicesPlatform

API Specification

October 2019

Newcastle City Council

Mott MacDonald 1 Atlantic Quay Broomielaw Glasgow G2 8JB United Kingdom

T +44 (0)141 222 4500 F +44 (0)141 221 2048 W wwwmottmaccom

City of Newcastle upon TyneCivic CentreNewcastle upon TyneNE1 8QH

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Revision Date Originator Checker Approver Description StandardA 15 Jan 2014 S Wheeler C Morrison F Macdonald Initial draft revision for comment

and feedback

B 27 Jan 2014 C Morrison S Wheeler F Macdonald Add additional data feeds No subscription snapshotNotification actions added

C 31 Jan 2014 C Morrison S Wheeler F Macdonald Incorporate comments after review

D 17 Feb 2014 M Watson C Morrison F Macdonald Field updates Minor typo fixes

E 24 Feb 2014 S Sha C Morrison F Macdonald Typo in car park feed URLs

F 21 Oct 2015 C Forbes C Morrison F Macdonald New static and dynamic VMS API

G 18 Nov 2015 C Morrison C Kay C Morrison Updated for API V2

H 25 Oct 2019 T Austen C Kay M Mitchell

C Morrison Changed wording of event incidentand roadworks to indicate the feedwill contain future instances

Issue and revision record

This document is issued for the party which commissioned it andfor specific purposes connected with the above-captioned projectonly It should not be relied upon by any other party or used forany other purpose

We accept no responsibility for the consequences of thisdocument being relied upon by any other party or being usedfor any other purpose or containing any error or omissionwhich is due to an error or omission in data supplied to us byother parties

This document contains confidential information and proprietaryintellectual property It should not be shown to other partieswithout consent from us and from the party whichcommissioned it

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Chapter Title Page

1 Introduction 1

1 1 Overview of the Tyne and Wear Open Data Services Platform ________________________________ 1

12 Types of data available _______________________________________________________________ 1

13 Terms and conditions of use __________________________________________________________ 2

2 Getting started 3

21 Seeing what is available ______________________________________________________________ 3

22 Requesting access __________________________________________________________________ 3

23 Using your access credentials _________________________________________________________ 3

24 Data formats _______________________________________________________________________ 3

3 On demand API 4

31 Data requests ______________________________________________________________________ 4

32 Success responses _________________________________________________________________ 4

33 Error responses ____________________________________________________________________ 5

4 Subscription API 7

41 Overview _________________________________________________________________________ 7

42 Subscribing ________________________________________________________________________ 8

421 Request __________________________________________________________________________ 8

422 Success response __________________________________________________________________ 9

423 Error responses ____________________________________________________________________ 9

43 Handling data notifications ____________________________________________________________ 9

431 Data notification request _____________________________________________________________ 10

432 Expected response _________________________________________________________________ 11

44 Handling other types of notifications ____________________________________________________ 11

441 Delete notification request ___________________________________________________________ 11

442 Refresh notification request __________________________________________________________ 12

443 Expected response _________________________________________________________________ 13

45 Checking subscriptions ______________________________________________________________ 13

451 Request _________________________________________________________________________ 13

46 Removing subscriptions _____________________________________________________________ 14

461 Request _________________________________________________________________________ 14

462 Response ________________________________________________________________________ 14

5 Static car park information 15

51 Overview ________________________________________________________________________ 15

52 On demand request ________________________________________________________________ 15

53 Subscription request ________________________________________________________________ 15

54 Data content ______________________________________________________________________ 15

6 Dynamic car park information 17

Contents

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61 Overview ________________________________________________________________________ 17

62 On demand request ________________________________________________________________ 17

63 Subscription request ________________________________________________________________ 17

64 Data content ______________________________________________________________________ 17

7 Static CCTV information 19

71 Overview ________________________________________________________________________ 19

72 On demand request ________________________________________________________________ 19

73 Subscription request ________________________________________________________________ 19

74 Data content ______________________________________________________________________ 19

8 Dynamic CCTV information 21

81 Overview ________________________________________________________________________ 21

82 On demand request ________________________________________________________________ 21

83 Subscription request ________________________________________________________________ 21

84 Data content ______________________________________________________________________ 21

9 CCTV images 23

91 Overview ________________________________________________________________________ 23

92 On demand request ________________________________________________________________ 23

93 Subscription request ________________________________________________________________ 23

94 Data content ______________________________________________________________________ 23

10 Static SCOOT information 24

101 Overview ________________________________________________________________________ 24

102 On demand request ________________________________________________________________ 24

103 Subscription request ________________________________________________________________ 24

10 4 Data content ______________________________________________________________________ 24

1 1 Dynamic SCOOT information 26

1 1 1 Overview ________________________________________________________________________ 26

1 1 2 On demand request ________________________________________________________________ 26

1 1 3 Subscription request ________________________________________________________________ 26

1 1 4 Data content ______________________________________________________________________ 26

12 Static weather station information 28

121 Overview ________________________________________________________________________ 28

122 On demand request ________________________________________________________________ 28

123 Subscription request ________________________________________________________________ 28

124 Data content ______________________________________________________________________ 28

13 Dynamic weather station information 30

131 Overview ________________________________________________________________________ 30

132 On demand request ________________________________________________________________ 30

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

133 Subscription request ________________________________________________________________ 30

134 Data content ______________________________________________________________________ 30

14 Static air quality information 33

141 Overview ________________________________________________________________________ 33

142 On demand request ________________________________________________________________ 33

143 Subscription request ________________________________________________________________ 33

144 Data content ______________________________________________________________________ 33

15 Daily average air quality information 35

151 Overview ________________________________________________________________________ 35

152 On demand request ________________________________________________________________ 35

153 Subscription request ________________________________________________________________ 35

154 Data content ______________________________________________________________________ 35

16 Dynamic air quality information 37

161 Overview ________________________________________________________________________ 37

162 On demand request ________________________________________________________________ 37

163 Subscription request ________________________________________________________________ 37

164 Data content ______________________________________________________________________ 37

17 Static journey time information 39

171 Overview ________________________________________________________________________ 39

172 On demand request ________________________________________________________________ 39

173 Subscription request ________________________________________________________________ 39

174 Data content ______________________________________________________________________ 39

18 Dynamic journey time information 41

181 Overview ________________________________________________________________________ 41

182 On demand request ________________________________________________________________ 41

183 Subscription request ________________________________________________________________ 41

184 Data content ______________________________________________________________________ 41

19 Incident information 43

191 Overview ________________________________________________________________________ 43

192 On demand request ________________________________________________________________ 43

193 Subscription request ________________________________________________________________ 43

194 Data content ______________________________________________________________________ 43

20 Accident information 46

201 Overview ________________________________________________________________________ 46

202 On demand request ________________________________________________________________ 46

203 Subscription request ________________________________________________________________ 46

204 Data content ______________________________________________________________________ 46

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21 Event information 49

21 1 Overview ________________________________________________________________________ 49

212 On demand request ________________________________________________________________ 49

213 Subscription request ________________________________________________________________ 49

21 4 Data content ______________________________________________________________________ 49

22 Roadwork information 52

221 Overview ________________________________________________________________________ 52

222 On demand request ________________________________________________________________ 52

223 Subscription request ________________________________________________________________ 52

224 Data content ______________________________________________________________________ 52

23 VMS static 55

231 Overview ________________________________________________________________________ 55

232 On Demand request ________________________________________________________________ 55

233 Subscription request ________________________________________________________________ 55

234 Data content ______________________________________________________________________ 55

24 VMS dynamic 57

241 Overview ________________________________________________________________________ 57

242 On demand request ________________________________________________________________ 57

243 Subscription request ________________________________________________________________ 57

244 Data content ______________________________________________________________________ 57

Appendices 59Appendix A Incident Types ____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ___________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types _____________________________________________________________________ 68Appendix I Weather Station types ______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1

11 Overview of the Tyne and Wear Open Data Services Platform

The Tyne and Wear Open Data Service Platform provides an API to deliver a number of data sets currentlycaptured by the Tyne and Wear UTMC (Urban Traffic Management and Control) system to third partyapplications

The Tyne and Wear Open Data Services Platform provides both an on-demand and an asynchronousnotification API API access is over HTTPS with all data sent and received as JSON

The on-demand API will allow a third party application to retrieve the latest set of information as and whenrequired This is the simplest API to use See section 3 for more information

The asynchronous API will allow a third party application to subscribe to any of the available data setsAfter receiving an initial snapshot of the latest state a third party application will then receive further HTTPPOST notifications for each subsequent data update See section 4 for more information

12 Types of data available

The following data sets are available

Table 1 1 List of data types available from the Tyne and Wear Open Data Services Platform

Data set Summary Section

Accidents The latest set of accidents impacting the road network 20

Air Quality daily average information

Various air quality fields averaged for last 24 hours 15

Air quality dynamic information The latest air quality information 16

Air Quality static information The location of the air quality stations 14

Car park dynamic information The latest car park occupancy information 6

Car park static information Describes the car park names locations and capacities 5

CCTV dynamic information The latest update times of the camera images 8

CCTV image The latest captured images from the cameras 9

CCTV static information Describes the CCTV camera locations 7

Events The latest set of events impacting the road network 21

Incidents The latest set of incidents impacting the road network 19

Journey time dynamic information

Journey time readings captured from the HA and bus corridors 18

Journey time static information The location of journey time sites 17

Roadworks The latest set of roadworks impacting the road network 22

SCOOT dynamic information Speed flows and congestion captured from the SCOOT sites 11

SCOOT static information Describes the SCOOT site location 10

Weather station dynamic information

Various weather readings captured by the weather stations 13

1 Introduction

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

2

Data set Summary Section

Weather station static information

The location of weather stations 12

VMS dynamic information This data stream will provide details of variable message signs messages

23

VMS static information This data stream will provide details of variable message signs locations

22

13 Terms and conditions of use

The terms and conditions for use and access to the data feeds are presented to end users whenregistering a new user account on the wwwnetraveldatacouk website The terms and conditions must beaccepted before access is granted to the data feeds

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

3

21 Seeing what is available

The Open Data Service website contains details of the API and other information relating to the use andfuture developments of the Open Data Service

22 Requesting access

During the user account registration process end users will be required to accept the terms and conditionsfor use of the data feeds described in this document Once a user account has been created the end userwill automatically be granted permission to access the data feeds using the username and passwordentered during the registration process

23 Using your access credentials

All data requests are protected by HTTP Basic Authentication You will need to supply a username andpassword that has been registered previously (see section 22) For example

$ curl ndashu usernamepasswordhttps www netraveldata co ukapiv2carparkstatic

24 Data formats

All API access is over HTTPS and is accessed from the wwwnetraveldatacouk domain All data is sentand received as JSON

Blank fields are included as null

All timestamps are returned in ISO 8601 format eg YYYY-MM-DDTHH MM SS SSSZ

2 Getting started

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 3: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Revision Date Originator Checker Approver Description StandardA 15 Jan 2014 S Wheeler C Morrison F Macdonald Initial draft revision for comment

and feedback

B 27 Jan 2014 C Morrison S Wheeler F Macdonald Add additional data feeds No subscription snapshotNotification actions added

C 31 Jan 2014 C Morrison S Wheeler F Macdonald Incorporate comments after review

D 17 Feb 2014 M Watson C Morrison F Macdonald Field updates Minor typo fixes

E 24 Feb 2014 S Sha C Morrison F Macdonald Typo in car park feed URLs

F 21 Oct 2015 C Forbes C Morrison F Macdonald New static and dynamic VMS API

G 18 Nov 2015 C Morrison C Kay C Morrison Updated for API V2

H 25 Oct 2019 T Austen C Kay M Mitchell

C Morrison Changed wording of event incidentand roadworks to indicate the feedwill contain future instances

Issue and revision record

This document is issued for the party which commissioned it andfor specific purposes connected with the above-captioned projectonly It should not be relied upon by any other party or used forany other purpose

We accept no responsibility for the consequences of thisdocument being relied upon by any other party or being usedfor any other purpose or containing any error or omissionwhich is due to an error or omission in data supplied to us byother parties

This document contains confidential information and proprietaryintellectual property It should not be shown to other partieswithout consent from us and from the party whichcommissioned it

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Chapter Title Page

1 Introduction 1

1 1 Overview of the Tyne and Wear Open Data Services Platform ________________________________ 1

12 Types of data available _______________________________________________________________ 1

13 Terms and conditions of use __________________________________________________________ 2

2 Getting started 3

21 Seeing what is available ______________________________________________________________ 3

22 Requesting access __________________________________________________________________ 3

23 Using your access credentials _________________________________________________________ 3

24 Data formats _______________________________________________________________________ 3

3 On demand API 4

31 Data requests ______________________________________________________________________ 4

32 Success responses _________________________________________________________________ 4

33 Error responses ____________________________________________________________________ 5

4 Subscription API 7

41 Overview _________________________________________________________________________ 7

42 Subscribing ________________________________________________________________________ 8

421 Request __________________________________________________________________________ 8

422 Success response __________________________________________________________________ 9

423 Error responses ____________________________________________________________________ 9

43 Handling data notifications ____________________________________________________________ 9

431 Data notification request _____________________________________________________________ 10

432 Expected response _________________________________________________________________ 11

44 Handling other types of notifications ____________________________________________________ 11

441 Delete notification request ___________________________________________________________ 11

442 Refresh notification request __________________________________________________________ 12

443 Expected response _________________________________________________________________ 13

45 Checking subscriptions ______________________________________________________________ 13

451 Request _________________________________________________________________________ 13

46 Removing subscriptions _____________________________________________________________ 14

461 Request _________________________________________________________________________ 14

462 Response ________________________________________________________________________ 14

5 Static car park information 15

51 Overview ________________________________________________________________________ 15

52 On demand request ________________________________________________________________ 15

53 Subscription request ________________________________________________________________ 15

54 Data content ______________________________________________________________________ 15

6 Dynamic car park information 17

Contents

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61 Overview ________________________________________________________________________ 17

62 On demand request ________________________________________________________________ 17

63 Subscription request ________________________________________________________________ 17

64 Data content ______________________________________________________________________ 17

7 Static CCTV information 19

71 Overview ________________________________________________________________________ 19

72 On demand request ________________________________________________________________ 19

73 Subscription request ________________________________________________________________ 19

74 Data content ______________________________________________________________________ 19

8 Dynamic CCTV information 21

81 Overview ________________________________________________________________________ 21

82 On demand request ________________________________________________________________ 21

83 Subscription request ________________________________________________________________ 21

84 Data content ______________________________________________________________________ 21

9 CCTV images 23

91 Overview ________________________________________________________________________ 23

92 On demand request ________________________________________________________________ 23

93 Subscription request ________________________________________________________________ 23

94 Data content ______________________________________________________________________ 23

10 Static SCOOT information 24

101 Overview ________________________________________________________________________ 24

102 On demand request ________________________________________________________________ 24

103 Subscription request ________________________________________________________________ 24

10 4 Data content ______________________________________________________________________ 24

1 1 Dynamic SCOOT information 26

1 1 1 Overview ________________________________________________________________________ 26

1 1 2 On demand request ________________________________________________________________ 26

1 1 3 Subscription request ________________________________________________________________ 26

1 1 4 Data content ______________________________________________________________________ 26

12 Static weather station information 28

121 Overview ________________________________________________________________________ 28

122 On demand request ________________________________________________________________ 28

123 Subscription request ________________________________________________________________ 28

124 Data content ______________________________________________________________________ 28

13 Dynamic weather station information 30

131 Overview ________________________________________________________________________ 30

132 On demand request ________________________________________________________________ 30

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

133 Subscription request ________________________________________________________________ 30

134 Data content ______________________________________________________________________ 30

14 Static air quality information 33

141 Overview ________________________________________________________________________ 33

142 On demand request ________________________________________________________________ 33

143 Subscription request ________________________________________________________________ 33

144 Data content ______________________________________________________________________ 33

15 Daily average air quality information 35

151 Overview ________________________________________________________________________ 35

152 On demand request ________________________________________________________________ 35

153 Subscription request ________________________________________________________________ 35

154 Data content ______________________________________________________________________ 35

16 Dynamic air quality information 37

161 Overview ________________________________________________________________________ 37

162 On demand request ________________________________________________________________ 37

163 Subscription request ________________________________________________________________ 37

164 Data content ______________________________________________________________________ 37

17 Static journey time information 39

171 Overview ________________________________________________________________________ 39

172 On demand request ________________________________________________________________ 39

173 Subscription request ________________________________________________________________ 39

174 Data content ______________________________________________________________________ 39

18 Dynamic journey time information 41

181 Overview ________________________________________________________________________ 41

182 On demand request ________________________________________________________________ 41

183 Subscription request ________________________________________________________________ 41

184 Data content ______________________________________________________________________ 41

19 Incident information 43

191 Overview ________________________________________________________________________ 43

192 On demand request ________________________________________________________________ 43

193 Subscription request ________________________________________________________________ 43

194 Data content ______________________________________________________________________ 43

20 Accident information 46

201 Overview ________________________________________________________________________ 46

202 On demand request ________________________________________________________________ 46

203 Subscription request ________________________________________________________________ 46

204 Data content ______________________________________________________________________ 46

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21 Event information 49

21 1 Overview ________________________________________________________________________ 49

212 On demand request ________________________________________________________________ 49

213 Subscription request ________________________________________________________________ 49

21 4 Data content ______________________________________________________________________ 49

22 Roadwork information 52

221 Overview ________________________________________________________________________ 52

222 On demand request ________________________________________________________________ 52

223 Subscription request ________________________________________________________________ 52

224 Data content ______________________________________________________________________ 52

23 VMS static 55

231 Overview ________________________________________________________________________ 55

232 On Demand request ________________________________________________________________ 55

233 Subscription request ________________________________________________________________ 55

234 Data content ______________________________________________________________________ 55

24 VMS dynamic 57

241 Overview ________________________________________________________________________ 57

242 On demand request ________________________________________________________________ 57

243 Subscription request ________________________________________________________________ 57

244 Data content ______________________________________________________________________ 57

Appendices 59Appendix A Incident Types ____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ___________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types _____________________________________________________________________ 68Appendix I Weather Station types ______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1

11 Overview of the Tyne and Wear Open Data Services Platform

The Tyne and Wear Open Data Service Platform provides an API to deliver a number of data sets currentlycaptured by the Tyne and Wear UTMC (Urban Traffic Management and Control) system to third partyapplications

The Tyne and Wear Open Data Services Platform provides both an on-demand and an asynchronousnotification API API access is over HTTPS with all data sent and received as JSON

The on-demand API will allow a third party application to retrieve the latest set of information as and whenrequired This is the simplest API to use See section 3 for more information

The asynchronous API will allow a third party application to subscribe to any of the available data setsAfter receiving an initial snapshot of the latest state a third party application will then receive further HTTPPOST notifications for each subsequent data update See section 4 for more information

12 Types of data available

The following data sets are available

Table 1 1 List of data types available from the Tyne and Wear Open Data Services Platform

Data set Summary Section

Accidents The latest set of accidents impacting the road network 20

Air Quality daily average information

Various air quality fields averaged for last 24 hours 15

Air quality dynamic information The latest air quality information 16

Air Quality static information The location of the air quality stations 14

Car park dynamic information The latest car park occupancy information 6

Car park static information Describes the car park names locations and capacities 5

CCTV dynamic information The latest update times of the camera images 8

CCTV image The latest captured images from the cameras 9

CCTV static information Describes the CCTV camera locations 7

Events The latest set of events impacting the road network 21

Incidents The latest set of incidents impacting the road network 19

Journey time dynamic information

Journey time readings captured from the HA and bus corridors 18

Journey time static information The location of journey time sites 17

Roadworks The latest set of roadworks impacting the road network 22

SCOOT dynamic information Speed flows and congestion captured from the SCOOT sites 11

SCOOT static information Describes the SCOOT site location 10

Weather station dynamic information

Various weather readings captured by the weather stations 13

1 Introduction

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

2

Data set Summary Section

Weather station static information

The location of weather stations 12

VMS dynamic information This data stream will provide details of variable message signs messages

23

VMS static information This data stream will provide details of variable message signs locations

22

13 Terms and conditions of use

The terms and conditions for use and access to the data feeds are presented to end users whenregistering a new user account on the wwwnetraveldatacouk website The terms and conditions must beaccepted before access is granted to the data feeds

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

3

21 Seeing what is available

The Open Data Service website contains details of the API and other information relating to the use andfuture developments of the Open Data Service

22 Requesting access

During the user account registration process end users will be required to accept the terms and conditionsfor use of the data feeds described in this document Once a user account has been created the end userwill automatically be granted permission to access the data feeds using the username and passwordentered during the registration process

23 Using your access credentials

All data requests are protected by HTTP Basic Authentication You will need to supply a username andpassword that has been registered previously (see section 22) For example

$ curl ndashu usernamepasswordhttps www netraveldata co ukapiv2carparkstatic

24 Data formats

All API access is over HTTPS and is accessed from the wwwnetraveldatacouk domain All data is sentand received as JSON

Blank fields are included as null

All timestamps are returned in ISO 8601 format eg YYYY-MM-DDTHH MM SS SSSZ

2 Getting started

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 4: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Chapter Title Page

1 Introduction 1

1 1 Overview of the Tyne and Wear Open Data Services Platform ________________________________ 1

12 Types of data available _______________________________________________________________ 1

13 Terms and conditions of use __________________________________________________________ 2

2 Getting started 3

21 Seeing what is available ______________________________________________________________ 3

22 Requesting access __________________________________________________________________ 3

23 Using your access credentials _________________________________________________________ 3

24 Data formats _______________________________________________________________________ 3

3 On demand API 4

31 Data requests ______________________________________________________________________ 4

32 Success responses _________________________________________________________________ 4

33 Error responses ____________________________________________________________________ 5

4 Subscription API 7

41 Overview _________________________________________________________________________ 7

42 Subscribing ________________________________________________________________________ 8

421 Request __________________________________________________________________________ 8

422 Success response __________________________________________________________________ 9

423 Error responses ____________________________________________________________________ 9

43 Handling data notifications ____________________________________________________________ 9

431 Data notification request _____________________________________________________________ 10

432 Expected response _________________________________________________________________ 11

44 Handling other types of notifications ____________________________________________________ 11

441 Delete notification request ___________________________________________________________ 11

442 Refresh notification request __________________________________________________________ 12

443 Expected response _________________________________________________________________ 13

45 Checking subscriptions ______________________________________________________________ 13

451 Request _________________________________________________________________________ 13

46 Removing subscriptions _____________________________________________________________ 14

461 Request _________________________________________________________________________ 14

462 Response ________________________________________________________________________ 14

5 Static car park information 15

51 Overview ________________________________________________________________________ 15

52 On demand request ________________________________________________________________ 15

53 Subscription request ________________________________________________________________ 15

54 Data content ______________________________________________________________________ 15

6 Dynamic car park information 17

Contents

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61 Overview ________________________________________________________________________ 17

62 On demand request ________________________________________________________________ 17

63 Subscription request ________________________________________________________________ 17

64 Data content ______________________________________________________________________ 17

7 Static CCTV information 19

71 Overview ________________________________________________________________________ 19

72 On demand request ________________________________________________________________ 19

73 Subscription request ________________________________________________________________ 19

74 Data content ______________________________________________________________________ 19

8 Dynamic CCTV information 21

81 Overview ________________________________________________________________________ 21

82 On demand request ________________________________________________________________ 21

83 Subscription request ________________________________________________________________ 21

84 Data content ______________________________________________________________________ 21

9 CCTV images 23

91 Overview ________________________________________________________________________ 23

92 On demand request ________________________________________________________________ 23

93 Subscription request ________________________________________________________________ 23

94 Data content ______________________________________________________________________ 23

10 Static SCOOT information 24

101 Overview ________________________________________________________________________ 24

102 On demand request ________________________________________________________________ 24

103 Subscription request ________________________________________________________________ 24

10 4 Data content ______________________________________________________________________ 24

1 1 Dynamic SCOOT information 26

1 1 1 Overview ________________________________________________________________________ 26

1 1 2 On demand request ________________________________________________________________ 26

1 1 3 Subscription request ________________________________________________________________ 26

1 1 4 Data content ______________________________________________________________________ 26

12 Static weather station information 28

121 Overview ________________________________________________________________________ 28

122 On demand request ________________________________________________________________ 28

123 Subscription request ________________________________________________________________ 28

124 Data content ______________________________________________________________________ 28

13 Dynamic weather station information 30

131 Overview ________________________________________________________________________ 30

132 On demand request ________________________________________________________________ 30

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

133 Subscription request ________________________________________________________________ 30

134 Data content ______________________________________________________________________ 30

14 Static air quality information 33

141 Overview ________________________________________________________________________ 33

142 On demand request ________________________________________________________________ 33

143 Subscription request ________________________________________________________________ 33

144 Data content ______________________________________________________________________ 33

15 Daily average air quality information 35

151 Overview ________________________________________________________________________ 35

152 On demand request ________________________________________________________________ 35

153 Subscription request ________________________________________________________________ 35

154 Data content ______________________________________________________________________ 35

16 Dynamic air quality information 37

161 Overview ________________________________________________________________________ 37

162 On demand request ________________________________________________________________ 37

163 Subscription request ________________________________________________________________ 37

164 Data content ______________________________________________________________________ 37

17 Static journey time information 39

171 Overview ________________________________________________________________________ 39

172 On demand request ________________________________________________________________ 39

173 Subscription request ________________________________________________________________ 39

174 Data content ______________________________________________________________________ 39

18 Dynamic journey time information 41

181 Overview ________________________________________________________________________ 41

182 On demand request ________________________________________________________________ 41

183 Subscription request ________________________________________________________________ 41

184 Data content ______________________________________________________________________ 41

19 Incident information 43

191 Overview ________________________________________________________________________ 43

192 On demand request ________________________________________________________________ 43

193 Subscription request ________________________________________________________________ 43

194 Data content ______________________________________________________________________ 43

20 Accident information 46

201 Overview ________________________________________________________________________ 46

202 On demand request ________________________________________________________________ 46

203 Subscription request ________________________________________________________________ 46

204 Data content ______________________________________________________________________ 46

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21 Event information 49

21 1 Overview ________________________________________________________________________ 49

212 On demand request ________________________________________________________________ 49

213 Subscription request ________________________________________________________________ 49

21 4 Data content ______________________________________________________________________ 49

22 Roadwork information 52

221 Overview ________________________________________________________________________ 52

222 On demand request ________________________________________________________________ 52

223 Subscription request ________________________________________________________________ 52

224 Data content ______________________________________________________________________ 52

23 VMS static 55

231 Overview ________________________________________________________________________ 55

232 On Demand request ________________________________________________________________ 55

233 Subscription request ________________________________________________________________ 55

234 Data content ______________________________________________________________________ 55

24 VMS dynamic 57

241 Overview ________________________________________________________________________ 57

242 On demand request ________________________________________________________________ 57

243 Subscription request ________________________________________________________________ 57

244 Data content ______________________________________________________________________ 57

Appendices 59Appendix A Incident Types ____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ___________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types _____________________________________________________________________ 68Appendix I Weather Station types ______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1

11 Overview of the Tyne and Wear Open Data Services Platform

The Tyne and Wear Open Data Service Platform provides an API to deliver a number of data sets currentlycaptured by the Tyne and Wear UTMC (Urban Traffic Management and Control) system to third partyapplications

The Tyne and Wear Open Data Services Platform provides both an on-demand and an asynchronousnotification API API access is over HTTPS with all data sent and received as JSON

The on-demand API will allow a third party application to retrieve the latest set of information as and whenrequired This is the simplest API to use See section 3 for more information

The asynchronous API will allow a third party application to subscribe to any of the available data setsAfter receiving an initial snapshot of the latest state a third party application will then receive further HTTPPOST notifications for each subsequent data update See section 4 for more information

12 Types of data available

The following data sets are available

Table 1 1 List of data types available from the Tyne and Wear Open Data Services Platform

Data set Summary Section

Accidents The latest set of accidents impacting the road network 20

Air Quality daily average information

Various air quality fields averaged for last 24 hours 15

Air quality dynamic information The latest air quality information 16

Air Quality static information The location of the air quality stations 14

Car park dynamic information The latest car park occupancy information 6

Car park static information Describes the car park names locations and capacities 5

CCTV dynamic information The latest update times of the camera images 8

CCTV image The latest captured images from the cameras 9

CCTV static information Describes the CCTV camera locations 7

Events The latest set of events impacting the road network 21

Incidents The latest set of incidents impacting the road network 19

Journey time dynamic information

Journey time readings captured from the HA and bus corridors 18

Journey time static information The location of journey time sites 17

Roadworks The latest set of roadworks impacting the road network 22

SCOOT dynamic information Speed flows and congestion captured from the SCOOT sites 11

SCOOT static information Describes the SCOOT site location 10

Weather station dynamic information

Various weather readings captured by the weather stations 13

1 Introduction

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

2

Data set Summary Section

Weather station static information

The location of weather stations 12

VMS dynamic information This data stream will provide details of variable message signs messages

23

VMS static information This data stream will provide details of variable message signs locations

22

13 Terms and conditions of use

The terms and conditions for use and access to the data feeds are presented to end users whenregistering a new user account on the wwwnetraveldatacouk website The terms and conditions must beaccepted before access is granted to the data feeds

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

3

21 Seeing what is available

The Open Data Service website contains details of the API and other information relating to the use andfuture developments of the Open Data Service

22 Requesting access

During the user account registration process end users will be required to accept the terms and conditionsfor use of the data feeds described in this document Once a user account has been created the end userwill automatically be granted permission to access the data feeds using the username and passwordentered during the registration process

23 Using your access credentials

All data requests are protected by HTTP Basic Authentication You will need to supply a username andpassword that has been registered previously (see section 22) For example

$ curl ndashu usernamepasswordhttps www netraveldata co ukapiv2carparkstatic

24 Data formats

All API access is over HTTPS and is accessed from the wwwnetraveldatacouk domain All data is sentand received as JSON

Blank fields are included as null

All timestamps are returned in ISO 8601 format eg YYYY-MM-DDTHH MM SS SSSZ

2 Getting started

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 5: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Chapter Title Page

1 Introduction 1

1 1 Overview of the Tyne and Wear Open Data Services Platform ________________________________ 1

12 Types of data available _______________________________________________________________ 1

13 Terms and conditions of use __________________________________________________________ 2

2 Getting started 3

21 Seeing what is available ______________________________________________________________ 3

22 Requesting access __________________________________________________________________ 3

23 Using your access credentials _________________________________________________________ 3

24 Data formats _______________________________________________________________________ 3

3 On demand API 4

31 Data requests ______________________________________________________________________ 4

32 Success responses _________________________________________________________________ 4

33 Error responses ____________________________________________________________________ 5

4 Subscription API 7

41 Overview _________________________________________________________________________ 7

42 Subscribing ________________________________________________________________________ 8

421 Request __________________________________________________________________________ 8

422 Success response __________________________________________________________________ 9

423 Error responses ____________________________________________________________________ 9

43 Handling data notifications ____________________________________________________________ 9

431 Data notification request _____________________________________________________________ 10

432 Expected response _________________________________________________________________ 11

44 Handling other types of notifications ____________________________________________________ 11

441 Delete notification request ___________________________________________________________ 11

442 Refresh notification request __________________________________________________________ 12

443 Expected response _________________________________________________________________ 13

45 Checking subscriptions ______________________________________________________________ 13

451 Request _________________________________________________________________________ 13

46 Removing subscriptions _____________________________________________________________ 14

461 Request _________________________________________________________________________ 14

462 Response ________________________________________________________________________ 14

5 Static car park information 15

51 Overview ________________________________________________________________________ 15

52 On demand request ________________________________________________________________ 15

53 Subscription request ________________________________________________________________ 15

54 Data content ______________________________________________________________________ 15

6 Dynamic car park information 17

Contents

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61 Overview ________________________________________________________________________ 17

62 On demand request ________________________________________________________________ 17

63 Subscription request ________________________________________________________________ 17

64 Data content ______________________________________________________________________ 17

7 Static CCTV information 19

71 Overview ________________________________________________________________________ 19

72 On demand request ________________________________________________________________ 19

73 Subscription request ________________________________________________________________ 19

74 Data content ______________________________________________________________________ 19

8 Dynamic CCTV information 21

81 Overview ________________________________________________________________________ 21

82 On demand request ________________________________________________________________ 21

83 Subscription request ________________________________________________________________ 21

84 Data content ______________________________________________________________________ 21

9 CCTV images 23

91 Overview ________________________________________________________________________ 23

92 On demand request ________________________________________________________________ 23

93 Subscription request ________________________________________________________________ 23

94 Data content ______________________________________________________________________ 23

10 Static SCOOT information 24

101 Overview ________________________________________________________________________ 24

102 On demand request ________________________________________________________________ 24

103 Subscription request ________________________________________________________________ 24

10 4 Data content ______________________________________________________________________ 24

1 1 Dynamic SCOOT information 26

1 1 1 Overview ________________________________________________________________________ 26

1 1 2 On demand request ________________________________________________________________ 26

1 1 3 Subscription request ________________________________________________________________ 26

1 1 4 Data content ______________________________________________________________________ 26

12 Static weather station information 28

121 Overview ________________________________________________________________________ 28

122 On demand request ________________________________________________________________ 28

123 Subscription request ________________________________________________________________ 28

124 Data content ______________________________________________________________________ 28

13 Dynamic weather station information 30

131 Overview ________________________________________________________________________ 30

132 On demand request ________________________________________________________________ 30

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

133 Subscription request ________________________________________________________________ 30

134 Data content ______________________________________________________________________ 30

14 Static air quality information 33

141 Overview ________________________________________________________________________ 33

142 On demand request ________________________________________________________________ 33

143 Subscription request ________________________________________________________________ 33

144 Data content ______________________________________________________________________ 33

15 Daily average air quality information 35

151 Overview ________________________________________________________________________ 35

152 On demand request ________________________________________________________________ 35

153 Subscription request ________________________________________________________________ 35

154 Data content ______________________________________________________________________ 35

16 Dynamic air quality information 37

161 Overview ________________________________________________________________________ 37

162 On demand request ________________________________________________________________ 37

163 Subscription request ________________________________________________________________ 37

164 Data content ______________________________________________________________________ 37

17 Static journey time information 39

171 Overview ________________________________________________________________________ 39

172 On demand request ________________________________________________________________ 39

173 Subscription request ________________________________________________________________ 39

174 Data content ______________________________________________________________________ 39

18 Dynamic journey time information 41

181 Overview ________________________________________________________________________ 41

182 On demand request ________________________________________________________________ 41

183 Subscription request ________________________________________________________________ 41

184 Data content ______________________________________________________________________ 41

19 Incident information 43

191 Overview ________________________________________________________________________ 43

192 On demand request ________________________________________________________________ 43

193 Subscription request ________________________________________________________________ 43

194 Data content ______________________________________________________________________ 43

20 Accident information 46

201 Overview ________________________________________________________________________ 46

202 On demand request ________________________________________________________________ 46

203 Subscription request ________________________________________________________________ 46

204 Data content ______________________________________________________________________ 46

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21 Event information 49

21 1 Overview ________________________________________________________________________ 49

212 On demand request ________________________________________________________________ 49

213 Subscription request ________________________________________________________________ 49

21 4 Data content ______________________________________________________________________ 49

22 Roadwork information 52

221 Overview ________________________________________________________________________ 52

222 On demand request ________________________________________________________________ 52

223 Subscription request ________________________________________________________________ 52

224 Data content ______________________________________________________________________ 52

23 VMS static 55

231 Overview ________________________________________________________________________ 55

232 On Demand request ________________________________________________________________ 55

233 Subscription request ________________________________________________________________ 55

234 Data content ______________________________________________________________________ 55

24 VMS dynamic 57

241 Overview ________________________________________________________________________ 57

242 On demand request ________________________________________________________________ 57

243 Subscription request ________________________________________________________________ 57

244 Data content ______________________________________________________________________ 57

Appendices 59Appendix A Incident Types ____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ___________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types _____________________________________________________________________ 68Appendix I Weather Station types ______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1

11 Overview of the Tyne and Wear Open Data Services Platform

The Tyne and Wear Open Data Service Platform provides an API to deliver a number of data sets currentlycaptured by the Tyne and Wear UTMC (Urban Traffic Management and Control) system to third partyapplications

The Tyne and Wear Open Data Services Platform provides both an on-demand and an asynchronousnotification API API access is over HTTPS with all data sent and received as JSON

The on-demand API will allow a third party application to retrieve the latest set of information as and whenrequired This is the simplest API to use See section 3 for more information

The asynchronous API will allow a third party application to subscribe to any of the available data setsAfter receiving an initial snapshot of the latest state a third party application will then receive further HTTPPOST notifications for each subsequent data update See section 4 for more information

12 Types of data available

The following data sets are available

Table 1 1 List of data types available from the Tyne and Wear Open Data Services Platform

Data set Summary Section

Accidents The latest set of accidents impacting the road network 20

Air Quality daily average information

Various air quality fields averaged for last 24 hours 15

Air quality dynamic information The latest air quality information 16

Air Quality static information The location of the air quality stations 14

Car park dynamic information The latest car park occupancy information 6

Car park static information Describes the car park names locations and capacities 5

CCTV dynamic information The latest update times of the camera images 8

CCTV image The latest captured images from the cameras 9

CCTV static information Describes the CCTV camera locations 7

Events The latest set of events impacting the road network 21

Incidents The latest set of incidents impacting the road network 19

Journey time dynamic information

Journey time readings captured from the HA and bus corridors 18

Journey time static information The location of journey time sites 17

Roadworks The latest set of roadworks impacting the road network 22

SCOOT dynamic information Speed flows and congestion captured from the SCOOT sites 11

SCOOT static information Describes the SCOOT site location 10

Weather station dynamic information

Various weather readings captured by the weather stations 13

1 Introduction

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

2

Data set Summary Section

Weather station static information

The location of weather stations 12

VMS dynamic information This data stream will provide details of variable message signs messages

23

VMS static information This data stream will provide details of variable message signs locations

22

13 Terms and conditions of use

The terms and conditions for use and access to the data feeds are presented to end users whenregistering a new user account on the wwwnetraveldatacouk website The terms and conditions must beaccepted before access is granted to the data feeds

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

3

21 Seeing what is available

The Open Data Service website contains details of the API and other information relating to the use andfuture developments of the Open Data Service

22 Requesting access

During the user account registration process end users will be required to accept the terms and conditionsfor use of the data feeds described in this document Once a user account has been created the end userwill automatically be granted permission to access the data feeds using the username and passwordentered during the registration process

23 Using your access credentials

All data requests are protected by HTTP Basic Authentication You will need to supply a username andpassword that has been registered previously (see section 22) For example

$ curl ndashu usernamepasswordhttps www netraveldata co ukapiv2carparkstatic

24 Data formats

All API access is over HTTPS and is accessed from the wwwnetraveldatacouk domain All data is sentand received as JSON

Blank fields are included as null

All timestamps are returned in ISO 8601 format eg YYYY-MM-DDTHH MM SS SSSZ

2 Getting started

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 6: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61 Overview ________________________________________________________________________ 17

62 On demand request ________________________________________________________________ 17

63 Subscription request ________________________________________________________________ 17

64 Data content ______________________________________________________________________ 17

7 Static CCTV information 19

71 Overview ________________________________________________________________________ 19

72 On demand request ________________________________________________________________ 19

73 Subscription request ________________________________________________________________ 19

74 Data content ______________________________________________________________________ 19

8 Dynamic CCTV information 21

81 Overview ________________________________________________________________________ 21

82 On demand request ________________________________________________________________ 21

83 Subscription request ________________________________________________________________ 21

84 Data content ______________________________________________________________________ 21

9 CCTV images 23

91 Overview ________________________________________________________________________ 23

92 On demand request ________________________________________________________________ 23

93 Subscription request ________________________________________________________________ 23

94 Data content ______________________________________________________________________ 23

10 Static SCOOT information 24

101 Overview ________________________________________________________________________ 24

102 On demand request ________________________________________________________________ 24

103 Subscription request ________________________________________________________________ 24

10 4 Data content ______________________________________________________________________ 24

1 1 Dynamic SCOOT information 26

1 1 1 Overview ________________________________________________________________________ 26

1 1 2 On demand request ________________________________________________________________ 26

1 1 3 Subscription request ________________________________________________________________ 26

1 1 4 Data content ______________________________________________________________________ 26

12 Static weather station information 28

121 Overview ________________________________________________________________________ 28

122 On demand request ________________________________________________________________ 28

123 Subscription request ________________________________________________________________ 28

124 Data content ______________________________________________________________________ 28

13 Dynamic weather station information 30

131 Overview ________________________________________________________________________ 30

132 On demand request ________________________________________________________________ 30

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

133 Subscription request ________________________________________________________________ 30

134 Data content ______________________________________________________________________ 30

14 Static air quality information 33

141 Overview ________________________________________________________________________ 33

142 On demand request ________________________________________________________________ 33

143 Subscription request ________________________________________________________________ 33

144 Data content ______________________________________________________________________ 33

15 Daily average air quality information 35

151 Overview ________________________________________________________________________ 35

152 On demand request ________________________________________________________________ 35

153 Subscription request ________________________________________________________________ 35

154 Data content ______________________________________________________________________ 35

16 Dynamic air quality information 37

161 Overview ________________________________________________________________________ 37

162 On demand request ________________________________________________________________ 37

163 Subscription request ________________________________________________________________ 37

164 Data content ______________________________________________________________________ 37

17 Static journey time information 39

171 Overview ________________________________________________________________________ 39

172 On demand request ________________________________________________________________ 39

173 Subscription request ________________________________________________________________ 39

174 Data content ______________________________________________________________________ 39

18 Dynamic journey time information 41

181 Overview ________________________________________________________________________ 41

182 On demand request ________________________________________________________________ 41

183 Subscription request ________________________________________________________________ 41

184 Data content ______________________________________________________________________ 41

19 Incident information 43

191 Overview ________________________________________________________________________ 43

192 On demand request ________________________________________________________________ 43

193 Subscription request ________________________________________________________________ 43

194 Data content ______________________________________________________________________ 43

20 Accident information 46

201 Overview ________________________________________________________________________ 46

202 On demand request ________________________________________________________________ 46

203 Subscription request ________________________________________________________________ 46

204 Data content ______________________________________________________________________ 46

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21 Event information 49

21 1 Overview ________________________________________________________________________ 49

212 On demand request ________________________________________________________________ 49

213 Subscription request ________________________________________________________________ 49

21 4 Data content ______________________________________________________________________ 49

22 Roadwork information 52

221 Overview ________________________________________________________________________ 52

222 On demand request ________________________________________________________________ 52

223 Subscription request ________________________________________________________________ 52

224 Data content ______________________________________________________________________ 52

23 VMS static 55

231 Overview ________________________________________________________________________ 55

232 On Demand request ________________________________________________________________ 55

233 Subscription request ________________________________________________________________ 55

234 Data content ______________________________________________________________________ 55

24 VMS dynamic 57

241 Overview ________________________________________________________________________ 57

242 On demand request ________________________________________________________________ 57

243 Subscription request ________________________________________________________________ 57

244 Data content ______________________________________________________________________ 57

Appendices 59Appendix A Incident Types ____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ___________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types _____________________________________________________________________ 68Appendix I Weather Station types ______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1

11 Overview of the Tyne and Wear Open Data Services Platform

The Tyne and Wear Open Data Service Platform provides an API to deliver a number of data sets currentlycaptured by the Tyne and Wear UTMC (Urban Traffic Management and Control) system to third partyapplications

The Tyne and Wear Open Data Services Platform provides both an on-demand and an asynchronousnotification API API access is over HTTPS with all data sent and received as JSON

The on-demand API will allow a third party application to retrieve the latest set of information as and whenrequired This is the simplest API to use See section 3 for more information

The asynchronous API will allow a third party application to subscribe to any of the available data setsAfter receiving an initial snapshot of the latest state a third party application will then receive further HTTPPOST notifications for each subsequent data update See section 4 for more information

12 Types of data available

The following data sets are available

Table 1 1 List of data types available from the Tyne and Wear Open Data Services Platform

Data set Summary Section

Accidents The latest set of accidents impacting the road network 20

Air Quality daily average information

Various air quality fields averaged for last 24 hours 15

Air quality dynamic information The latest air quality information 16

Air Quality static information The location of the air quality stations 14

Car park dynamic information The latest car park occupancy information 6

Car park static information Describes the car park names locations and capacities 5

CCTV dynamic information The latest update times of the camera images 8

CCTV image The latest captured images from the cameras 9

CCTV static information Describes the CCTV camera locations 7

Events The latest set of events impacting the road network 21

Incidents The latest set of incidents impacting the road network 19

Journey time dynamic information

Journey time readings captured from the HA and bus corridors 18

Journey time static information The location of journey time sites 17

Roadworks The latest set of roadworks impacting the road network 22

SCOOT dynamic information Speed flows and congestion captured from the SCOOT sites 11

SCOOT static information Describes the SCOOT site location 10

Weather station dynamic information

Various weather readings captured by the weather stations 13

1 Introduction

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

2

Data set Summary Section

Weather station static information

The location of weather stations 12

VMS dynamic information This data stream will provide details of variable message signs messages

23

VMS static information This data stream will provide details of variable message signs locations

22

13 Terms and conditions of use

The terms and conditions for use and access to the data feeds are presented to end users whenregistering a new user account on the wwwnetraveldatacouk website The terms and conditions must beaccepted before access is granted to the data feeds

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

3

21 Seeing what is available

The Open Data Service website contains details of the API and other information relating to the use andfuture developments of the Open Data Service

22 Requesting access

During the user account registration process end users will be required to accept the terms and conditionsfor use of the data feeds described in this document Once a user account has been created the end userwill automatically be granted permission to access the data feeds using the username and passwordentered during the registration process

23 Using your access credentials

All data requests are protected by HTTP Basic Authentication You will need to supply a username andpassword that has been registered previously (see section 22) For example

$ curl ndashu usernamepasswordhttps www netraveldata co ukapiv2carparkstatic

24 Data formats

All API access is over HTTPS and is accessed from the wwwnetraveldatacouk domain All data is sentand received as JSON

Blank fields are included as null

All timestamps are returned in ISO 8601 format eg YYYY-MM-DDTHH MM SS SSSZ

2 Getting started

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 7: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

133 Subscription request ________________________________________________________________ 30

134 Data content ______________________________________________________________________ 30

14 Static air quality information 33

141 Overview ________________________________________________________________________ 33

142 On demand request ________________________________________________________________ 33

143 Subscription request ________________________________________________________________ 33

144 Data content ______________________________________________________________________ 33

15 Daily average air quality information 35

151 Overview ________________________________________________________________________ 35

152 On demand request ________________________________________________________________ 35

153 Subscription request ________________________________________________________________ 35

154 Data content ______________________________________________________________________ 35

16 Dynamic air quality information 37

161 Overview ________________________________________________________________________ 37

162 On demand request ________________________________________________________________ 37

163 Subscription request ________________________________________________________________ 37

164 Data content ______________________________________________________________________ 37

17 Static journey time information 39

171 Overview ________________________________________________________________________ 39

172 On demand request ________________________________________________________________ 39

173 Subscription request ________________________________________________________________ 39

174 Data content ______________________________________________________________________ 39

18 Dynamic journey time information 41

181 Overview ________________________________________________________________________ 41

182 On demand request ________________________________________________________________ 41

183 Subscription request ________________________________________________________________ 41

184 Data content ______________________________________________________________________ 41

19 Incident information 43

191 Overview ________________________________________________________________________ 43

192 On demand request ________________________________________________________________ 43

193 Subscription request ________________________________________________________________ 43

194 Data content ______________________________________________________________________ 43

20 Accident information 46

201 Overview ________________________________________________________________________ 46

202 On demand request ________________________________________________________________ 46

203 Subscription request ________________________________________________________________ 46

204 Data content ______________________________________________________________________ 46

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21 Event information 49

21 1 Overview ________________________________________________________________________ 49

212 On demand request ________________________________________________________________ 49

213 Subscription request ________________________________________________________________ 49

21 4 Data content ______________________________________________________________________ 49

22 Roadwork information 52

221 Overview ________________________________________________________________________ 52

222 On demand request ________________________________________________________________ 52

223 Subscription request ________________________________________________________________ 52

224 Data content ______________________________________________________________________ 52

23 VMS static 55

231 Overview ________________________________________________________________________ 55

232 On Demand request ________________________________________________________________ 55

233 Subscription request ________________________________________________________________ 55

234 Data content ______________________________________________________________________ 55

24 VMS dynamic 57

241 Overview ________________________________________________________________________ 57

242 On demand request ________________________________________________________________ 57

243 Subscription request ________________________________________________________________ 57

244 Data content ______________________________________________________________________ 57

Appendices 59Appendix A Incident Types ____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ___________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types _____________________________________________________________________ 68Appendix I Weather Station types ______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1

11 Overview of the Tyne and Wear Open Data Services Platform

The Tyne and Wear Open Data Service Platform provides an API to deliver a number of data sets currentlycaptured by the Tyne and Wear UTMC (Urban Traffic Management and Control) system to third partyapplications

The Tyne and Wear Open Data Services Platform provides both an on-demand and an asynchronousnotification API API access is over HTTPS with all data sent and received as JSON

The on-demand API will allow a third party application to retrieve the latest set of information as and whenrequired This is the simplest API to use See section 3 for more information

The asynchronous API will allow a third party application to subscribe to any of the available data setsAfter receiving an initial snapshot of the latest state a third party application will then receive further HTTPPOST notifications for each subsequent data update See section 4 for more information

12 Types of data available

The following data sets are available

Table 1 1 List of data types available from the Tyne and Wear Open Data Services Platform

Data set Summary Section

Accidents The latest set of accidents impacting the road network 20

Air Quality daily average information

Various air quality fields averaged for last 24 hours 15

Air quality dynamic information The latest air quality information 16

Air Quality static information The location of the air quality stations 14

Car park dynamic information The latest car park occupancy information 6

Car park static information Describes the car park names locations and capacities 5

CCTV dynamic information The latest update times of the camera images 8

CCTV image The latest captured images from the cameras 9

CCTV static information Describes the CCTV camera locations 7

Events The latest set of events impacting the road network 21

Incidents The latest set of incidents impacting the road network 19

Journey time dynamic information

Journey time readings captured from the HA and bus corridors 18

Journey time static information The location of journey time sites 17

Roadworks The latest set of roadworks impacting the road network 22

SCOOT dynamic information Speed flows and congestion captured from the SCOOT sites 11

SCOOT static information Describes the SCOOT site location 10

Weather station dynamic information

Various weather readings captured by the weather stations 13

1 Introduction

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

2

Data set Summary Section

Weather station static information

The location of weather stations 12

VMS dynamic information This data stream will provide details of variable message signs messages

23

VMS static information This data stream will provide details of variable message signs locations

22

13 Terms and conditions of use

The terms and conditions for use and access to the data feeds are presented to end users whenregistering a new user account on the wwwnetraveldatacouk website The terms and conditions must beaccepted before access is granted to the data feeds

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

3

21 Seeing what is available

The Open Data Service website contains details of the API and other information relating to the use andfuture developments of the Open Data Service

22 Requesting access

During the user account registration process end users will be required to accept the terms and conditionsfor use of the data feeds described in this document Once a user account has been created the end userwill automatically be granted permission to access the data feeds using the username and passwordentered during the registration process

23 Using your access credentials

All data requests are protected by HTTP Basic Authentication You will need to supply a username andpassword that has been registered previously (see section 22) For example

$ curl ndashu usernamepasswordhttps www netraveldata co ukapiv2carparkstatic

24 Data formats

All API access is over HTTPS and is accessed from the wwwnetraveldatacouk domain All data is sentand received as JSON

Blank fields are included as null

All timestamps are returned in ISO 8601 format eg YYYY-MM-DDTHH MM SS SSSZ

2 Getting started

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 8: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21 Event information 49

21 1 Overview ________________________________________________________________________ 49

212 On demand request ________________________________________________________________ 49

213 Subscription request ________________________________________________________________ 49

21 4 Data content ______________________________________________________________________ 49

22 Roadwork information 52

221 Overview ________________________________________________________________________ 52

222 On demand request ________________________________________________________________ 52

223 Subscription request ________________________________________________________________ 52

224 Data content ______________________________________________________________________ 52

23 VMS static 55

231 Overview ________________________________________________________________________ 55

232 On Demand request ________________________________________________________________ 55

233 Subscription request ________________________________________________________________ 55

234 Data content ______________________________________________________________________ 55

24 VMS dynamic 57

241 Overview ________________________________________________________________________ 57

242 On demand request ________________________________________________________________ 57

243 Subscription request ________________________________________________________________ 57

244 Data content ______________________________________________________________________ 57

Appendices 59Appendix A Incident Types ____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ___________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types _____________________________________________________________________ 68Appendix I Weather Station types ______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1

11 Overview of the Tyne and Wear Open Data Services Platform

The Tyne and Wear Open Data Service Platform provides an API to deliver a number of data sets currentlycaptured by the Tyne and Wear UTMC (Urban Traffic Management and Control) system to third partyapplications

The Tyne and Wear Open Data Services Platform provides both an on-demand and an asynchronousnotification API API access is over HTTPS with all data sent and received as JSON

The on-demand API will allow a third party application to retrieve the latest set of information as and whenrequired This is the simplest API to use See section 3 for more information

The asynchronous API will allow a third party application to subscribe to any of the available data setsAfter receiving an initial snapshot of the latest state a third party application will then receive further HTTPPOST notifications for each subsequent data update See section 4 for more information

12 Types of data available

The following data sets are available

Table 1 1 List of data types available from the Tyne and Wear Open Data Services Platform

Data set Summary Section

Accidents The latest set of accidents impacting the road network 20

Air Quality daily average information

Various air quality fields averaged for last 24 hours 15

Air quality dynamic information The latest air quality information 16

Air Quality static information The location of the air quality stations 14

Car park dynamic information The latest car park occupancy information 6

Car park static information Describes the car park names locations and capacities 5

CCTV dynamic information The latest update times of the camera images 8

CCTV image The latest captured images from the cameras 9

CCTV static information Describes the CCTV camera locations 7

Events The latest set of events impacting the road network 21

Incidents The latest set of incidents impacting the road network 19

Journey time dynamic information

Journey time readings captured from the HA and bus corridors 18

Journey time static information The location of journey time sites 17

Roadworks The latest set of roadworks impacting the road network 22

SCOOT dynamic information Speed flows and congestion captured from the SCOOT sites 11

SCOOT static information Describes the SCOOT site location 10

Weather station dynamic information

Various weather readings captured by the weather stations 13

1 Introduction

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

2

Data set Summary Section

Weather station static information

The location of weather stations 12

VMS dynamic information This data stream will provide details of variable message signs messages

23

VMS static information This data stream will provide details of variable message signs locations

22

13 Terms and conditions of use

The terms and conditions for use and access to the data feeds are presented to end users whenregistering a new user account on the wwwnetraveldatacouk website The terms and conditions must beaccepted before access is granted to the data feeds

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

3

21 Seeing what is available

The Open Data Service website contains details of the API and other information relating to the use andfuture developments of the Open Data Service

22 Requesting access

During the user account registration process end users will be required to accept the terms and conditionsfor use of the data feeds described in this document Once a user account has been created the end userwill automatically be granted permission to access the data feeds using the username and passwordentered during the registration process

23 Using your access credentials

All data requests are protected by HTTP Basic Authentication You will need to supply a username andpassword that has been registered previously (see section 22) For example

$ curl ndashu usernamepasswordhttps www netraveldata co ukapiv2carparkstatic

24 Data formats

All API access is over HTTPS and is accessed from the wwwnetraveldatacouk domain All data is sentand received as JSON

Blank fields are included as null

All timestamps are returned in ISO 8601 format eg YYYY-MM-DDTHH MM SS SSSZ

2 Getting started

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 9: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1

11 Overview of the Tyne and Wear Open Data Services Platform

The Tyne and Wear Open Data Service Platform provides an API to deliver a number of data sets currentlycaptured by the Tyne and Wear UTMC (Urban Traffic Management and Control) system to third partyapplications

The Tyne and Wear Open Data Services Platform provides both an on-demand and an asynchronousnotification API API access is over HTTPS with all data sent and received as JSON

The on-demand API will allow a third party application to retrieve the latest set of information as and whenrequired This is the simplest API to use See section 3 for more information

The asynchronous API will allow a third party application to subscribe to any of the available data setsAfter receiving an initial snapshot of the latest state a third party application will then receive further HTTPPOST notifications for each subsequent data update See section 4 for more information

12 Types of data available

The following data sets are available

Table 1 1 List of data types available from the Tyne and Wear Open Data Services Platform

Data set Summary Section

Accidents The latest set of accidents impacting the road network 20

Air Quality daily average information

Various air quality fields averaged for last 24 hours 15

Air quality dynamic information The latest air quality information 16

Air Quality static information The location of the air quality stations 14

Car park dynamic information The latest car park occupancy information 6

Car park static information Describes the car park names locations and capacities 5

CCTV dynamic information The latest update times of the camera images 8

CCTV image The latest captured images from the cameras 9

CCTV static information Describes the CCTV camera locations 7

Events The latest set of events impacting the road network 21

Incidents The latest set of incidents impacting the road network 19

Journey time dynamic information

Journey time readings captured from the HA and bus corridors 18

Journey time static information The location of journey time sites 17

Roadworks The latest set of roadworks impacting the road network 22

SCOOT dynamic information Speed flows and congestion captured from the SCOOT sites 11

SCOOT static information Describes the SCOOT site location 10

Weather station dynamic information

Various weather readings captured by the weather stations 13

1 Introduction

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

2

Data set Summary Section

Weather station static information

The location of weather stations 12

VMS dynamic information This data stream will provide details of variable message signs messages

23

VMS static information This data stream will provide details of variable message signs locations

22

13 Terms and conditions of use

The terms and conditions for use and access to the data feeds are presented to end users whenregistering a new user account on the wwwnetraveldatacouk website The terms and conditions must beaccepted before access is granted to the data feeds

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

3

21 Seeing what is available

The Open Data Service website contains details of the API and other information relating to the use andfuture developments of the Open Data Service

22 Requesting access

During the user account registration process end users will be required to accept the terms and conditionsfor use of the data feeds described in this document Once a user account has been created the end userwill automatically be granted permission to access the data feeds using the username and passwordentered during the registration process

23 Using your access credentials

All data requests are protected by HTTP Basic Authentication You will need to supply a username andpassword that has been registered previously (see section 22) For example

$ curl ndashu usernamepasswordhttps www netraveldata co ukapiv2carparkstatic

24 Data formats

All API access is over HTTPS and is accessed from the wwwnetraveldatacouk domain All data is sentand received as JSON

Blank fields are included as null

All timestamps are returned in ISO 8601 format eg YYYY-MM-DDTHH MM SS SSSZ

2 Getting started

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 10: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1

11 Overview of the Tyne and Wear Open Data Services Platform

The Tyne and Wear Open Data Service Platform provides an API to deliver a number of data sets currentlycaptured by the Tyne and Wear UTMC (Urban Traffic Management and Control) system to third partyapplications

The Tyne and Wear Open Data Services Platform provides both an on-demand and an asynchronousnotification API API access is over HTTPS with all data sent and received as JSON

The on-demand API will allow a third party application to retrieve the latest set of information as and whenrequired This is the simplest API to use See section 3 for more information

The asynchronous API will allow a third party application to subscribe to any of the available data setsAfter receiving an initial snapshot of the latest state a third party application will then receive further HTTPPOST notifications for each subsequent data update See section 4 for more information

12 Types of data available

The following data sets are available

Table 1 1 List of data types available from the Tyne and Wear Open Data Services Platform

Data set Summary Section

Accidents The latest set of accidents impacting the road network 20

Air Quality daily average information

Various air quality fields averaged for last 24 hours 15

Air quality dynamic information The latest air quality information 16

Air Quality static information The location of the air quality stations 14

Car park dynamic information The latest car park occupancy information 6

Car park static information Describes the car park names locations and capacities 5

CCTV dynamic information The latest update times of the camera images 8

CCTV image The latest captured images from the cameras 9

CCTV static information Describes the CCTV camera locations 7

Events The latest set of events impacting the road network 21

Incidents The latest set of incidents impacting the road network 19

Journey time dynamic information

Journey time readings captured from the HA and bus corridors 18

Journey time static information The location of journey time sites 17

Roadworks The latest set of roadworks impacting the road network 22

SCOOT dynamic information Speed flows and congestion captured from the SCOOT sites 11

SCOOT static information Describes the SCOOT site location 10

Weather station dynamic information

Various weather readings captured by the weather stations 13

1 Introduction

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

2

Data set Summary Section

Weather station static information

The location of weather stations 12

VMS dynamic information This data stream will provide details of variable message signs messages

23

VMS static information This data stream will provide details of variable message signs locations

22

13 Terms and conditions of use

The terms and conditions for use and access to the data feeds are presented to end users whenregistering a new user account on the wwwnetraveldatacouk website The terms and conditions must beaccepted before access is granted to the data feeds

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

3

21 Seeing what is available

The Open Data Service website contains details of the API and other information relating to the use andfuture developments of the Open Data Service

22 Requesting access

During the user account registration process end users will be required to accept the terms and conditionsfor use of the data feeds described in this document Once a user account has been created the end userwill automatically be granted permission to access the data feeds using the username and passwordentered during the registration process

23 Using your access credentials

All data requests are protected by HTTP Basic Authentication You will need to supply a username andpassword that has been registered previously (see section 22) For example

$ curl ndashu usernamepasswordhttps www netraveldata co ukapiv2carparkstatic

24 Data formats

All API access is over HTTPS and is accessed from the wwwnetraveldatacouk domain All data is sentand received as JSON

Blank fields are included as null

All timestamps are returned in ISO 8601 format eg YYYY-MM-DDTHH MM SS SSSZ

2 Getting started

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 11: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

2

Data set Summary Section

Weather station static information

The location of weather stations 12

VMS dynamic information This data stream will provide details of variable message signs messages

23

VMS static information This data stream will provide details of variable message signs locations

22

13 Terms and conditions of use

The terms and conditions for use and access to the data feeds are presented to end users whenregistering a new user account on the wwwnetraveldatacouk website The terms and conditions must beaccepted before access is granted to the data feeds

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

3

21 Seeing what is available

The Open Data Service website contains details of the API and other information relating to the use andfuture developments of the Open Data Service

22 Requesting access

During the user account registration process end users will be required to accept the terms and conditionsfor use of the data feeds described in this document Once a user account has been created the end userwill automatically be granted permission to access the data feeds using the username and passwordentered during the registration process

23 Using your access credentials

All data requests are protected by HTTP Basic Authentication You will need to supply a username andpassword that has been registered previously (see section 22) For example

$ curl ndashu usernamepasswordhttps www netraveldata co ukapiv2carparkstatic

24 Data formats

All API access is over HTTPS and is accessed from the wwwnetraveldatacouk domain All data is sentand received as JSON

Blank fields are included as null

All timestamps are returned in ISO 8601 format eg YYYY-MM-DDTHH MM SS SSSZ

2 Getting started

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 12: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

3

21 Seeing what is available

The Open Data Service website contains details of the API and other information relating to the use andfuture developments of the Open Data Service

22 Requesting access

During the user account registration process end users will be required to accept the terms and conditionsfor use of the data feeds described in this document Once a user account has been created the end userwill automatically be granted permission to access the data feeds using the username and passwordentered during the registration process

23 Using your access credentials

All data requests are protected by HTTP Basic Authentication You will need to supply a username andpassword that has been registered previously (see section 22) For example

$ curl ndashu usernamepasswordhttps www netraveldata co ukapiv2carparkstatic

24 Data formats

All API access is over HTTPS and is accessed from the wwwnetraveldatacouk domain All data is sentand received as JSON

Blank fields are included as null

All timestamps are returned in ISO 8601 format eg YYYY-MM-DDTHH MM SS SSSZ

2 Getting started

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 13: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

4

31 Data requests

The latest data can be retrieved using a HTTP GET URL eg

GET https www netraveldata co ukapiv2 dataset

The dataset parameter will be the URL location of the data set For example the following request will

retrieve static information (such as location and capacity) for all car parks

GET https www netraveldata co ukapiv2carparkstatic

32 Success responses

A successful response will return a HTTP 200 status

The JSON body content of the HTTP message will be specific to the requested data set Continuing ourexample of retrieving the latest car park static information the above GET request would return a JSONarray of the form below

Status 200[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

3 On demand API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 14: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

5

ldquocarParkCapacityrdquo 200

]

ldquosystemCodeNumberrdquo ldquoCP2rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoPark and Riderdquo

ldquolongDescriptionrdquo ldquoPark and Ride to north westrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

]

ldquoconfigurationsrdquo [

ldquocarParkCapacityrdquo 620

]

]

33 Error responses

The following HTTP error status can be returned

Table 31 Error response codes

HTTPS status Description

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be returned when the URL path does not reference an available data set

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 15: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

6

HTTPS status Description

50x This error code will be returned if an internal error has occurred

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 16: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

7

41 Overview

The REST subscription API provides a mechanism so that a third party application can register and beasynchronously notified of data updates via HTTP messages Figure 41 illustrates the typical sequence ofevents

Figure 41 Example sequence of HTTP messages for the subscription API

4 Subscription API

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 17: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

8

1 The third party application will subscribe to one or more data sets by submitting a POST to the APIsubscription service specifying the data sets to subscribe to and the URL to send notifications to eghttpltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

2 If successful the response will contain a unique identifier for the subscription At this point the third party application will be registered to receive data update notifications The thirdparty application must provide an HTTP interface where the notifications can be sent This shouldmatch the URL specified in the subscription request It is left up to the 3rd party application to determine if an initial snapshot of the data is required This isachieved using the GET request mechanism detailed in section 3

3 Thereafter any updates will be sent to the HTTP interface of the third party application

The interface will send all data updates for the registered data sets If a third party application is onlyinterested in a subset of data eg a single car park or CCTV camera then it will be the responsibility ofthe third party application to filter the information

4 The third party application DELETEs its subscription

5 The response confirms the deletion No further data pushes are sent to the third party application

42 Subscribing

421 Request

To subscribe to one or more data sets a JSON message of the format below should be posted to thesubscriptions API URL

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 18: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551 HWYTTS1549540452H 25 October 2019 1549540452

9

Table 41 Fields for creating a subscription

Field Description

subscriptions Required - A comma separated list of data sets to subscribe to

notificationURL Required - The URL to send the HTTP notifications to This should be a publically accessible HTTPaddress Notifications will only be sent to an HTTP port (port 80)

422 Success response

Status 201 CreatedLocation https www netraveldata co ukapiv2subscription12345

subscriptionId 12345

Table 42 Response fields for successful subscription creation

Field Description

subscriptionId The unique subscription identifier

Once subscribed to a data set the third party application will receive an initial snapshot of the data via thenotification mechanism (section 43)

423 Error responses

The following HTTP error status can be returned

Table 43 Error response codes

HTTPS status Description

400 This error will be returned if a parameter is missing from the subscription request

401 This error will be returned when no or invalid authentication details have been provided

404 This error will be raised in the subscription URL cannot be found

50x This error will be returned if there is a failure registering the subscription

43 Handling data notifications

Data notifications will be sent via a HTTP POST to a URL specified by the subscription The subscribedthird party application must provide an HTTP interface on port 80 and should process the message in atimely manner returning a valid HTTP status

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 19: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

10

431 Data notification request

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications notificationData portion of this message will vary depending on the

subscription data being pushed and can be an array of one or more data items

An action can be associated with each notification (notifications action) This can have one of the

following values

Table 44 Action field description

Action Description

INSERT A new row of data has been inserted

UPDATE A row of data has been updated

DELETE The data has been deleted Typically only the system code number will be supplied See section441

REFRESH A refresh of all data is required Typically no data will be supplied See section 442

POST http ltMYAPPDOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription CAR PARK DYNAMIC

action INSERT

notificationData [

systemCodeNumber CP1

occupancy 231

lastUpdated 2012-01-13T12 19 32 419+0000rdquo

systemCodeNumber CP2

occupancy 87

lastUpdated 2012-01-13T12 19 40 516+0000rdquo

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 20: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

1 1

]

]

Table 45 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple notifications for different data sets inone message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription Can be one of INSERT UPDATE DELETE orREFRESH

notificationsnotificationData The array of data that has been updated There can be multiple items in a singlenotification The content each object in this array will vary depending on the data set

subscribed to

432 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

44 Handling other types of notifications

441 Delete notification request

Certain types of data will exist only for a finite period of time for example incident and road works Whenthey expire the UTMC system will send a DELETE notification

The following JSON message will be sent This is similar in format to section 431 but the data section willonly contain the system code number

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

notifications [

subscription INCIDENTS

action DELETE

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 21: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

12

ldquonotificationDatardquo [

systemCodeNumber INCIDENT1

]

]

Table 46 Fields in a pushed data notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating thesubscription

notifications The array of notification data There can be multiple notifications for differentdata sets in one message

notificationssubscription The name of the subscription

notificationsaction The action to perform on the subscription This will be DELETE

notificationsnotificationData The array of data that has been deleted

notificationdatasystemCodeNumber The unique identifier of the item being deleted

442 Refresh notification request

If the Open Data Service experiences any communications issues with the UTMC system it will be likelythat UTMC notifications will not have been processed resulting in no data notification requests being sentto third party applications

Upon restoration of communications with the UTMC the Open Data Service will completely refresh itscurrent view of the UTMC data on a feed by feed basis As each feed is refreshed the Open Data Servicewill send a Refresh notification to subscribed third parties This notification indicates that the third partyshould perform a refresh of their data using the on demand API as defined in section 3

The following JSON message will be pushed asynchronously to the subscribed third party application

Note that the notifications portion of this message can be an array of one or more subscriptions

POST http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

subscriptionId 12345

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 22: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

13

notifications [

subscription INCIDENTS

action REFRESH

ldquonotificationDatardquo []

]

Table 47 Fields in a pushed refresh notification request

Field Description

subscriptionId The unique identifier of the subscription returned when creating the subscription

notifications The array of notification data There can be multiple refresh notifications for differentsubscriptions in one message

notificationssubscription The name of the subscription to be refreshed

notificationsaction The action to perform on the subscription This will be REFRESH

notificationsnotificationData For refresh notifications the data tag will be empty

443 Expected response

Third party applications should process the message in a timely manner and return a HTTP 20X status toconfirm that they have accepted the message If a non 20X status is returned then the subscription will bedropped

45 Checking subscriptions

451 Request

To view the list of current subscriptions for a third party application the following HTTP GET requestshould be sent

GET https www netraveldata co ukapiv2subscription

If successful then a HTTP status of 200 with the following JSON will be returned This will contain an arrayof all active subscriptions for the third party application user identifier

Status 200[

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 23: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

14

subscriptionId 12345

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

created 2012-01-13T12 19 32 419+0000

subscriptions [

CAR PARK DYNAMIC

CAR PARK STATIC

]

]

Table 48 Fields in a successful list subscriptions response

Field Subscription

subscriptionId The unique identifier of the subscription returned when creating the subscription

notificationUrl The URL where the subscription notifications will be posted to

created Date and time (in ISO 8601 format) when the subscription was created

subscriptions List of subscriptions

46 Removing subscriptions

461 Request

To remove a subscription a HTTP DELETE should be sent to the following URL

DELETEhttps www netraveldata co ukapiv2subscription subscriptionId

Table 49 Parameters to delete a subscription

Parameter Description

subscriptionId The unique identifier of the subscription This subscription id will have been returned from thesubscription creation

462 Response

Status 204 (No content)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 24: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

15

51 Overview

The static car park information provides details on the car park names locations and capacity

52 On demand request

GET https www netraveldata co ukapiv2carparkstatic

53 Subscription request

To subscribe to this data set specify the subscription CAR PARK STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

54 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static car park information of the format below The example belowillustrates a single car park object

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoTown Centrerdquo

ldquolongDescriptionrdquo ldquoCar park in Newcastle Town Centrerdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

5 Static car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 25: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

16

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

ldquoconfigurationsrdquo [

ldquocapacityrdquo 200

ldquoconfigurationDaterdquo 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 51 Data fields for static car park information

Field Description

systemCodeNumber The unique identifier of the car park

definitions An array of car park definitions ndash typically one

definitionsshortDescription A brief description of the car park usually the car park name

definitionslongDescription A longer description of the car park

definitionspoint The OSNGR location of the car park

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

configurations An array of configuration for the car park ndash typically one

configurationscapacity The capacity of the car park

configurationsconfigurationDate The date and time (in ISO 8601 format) when the configuration was changed

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 26: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

17

61 Overview

The dynamic car park information provides the latest occupancy information for the car parks

62 On demand request

GET https www netraveldata co ukapiv2carparkdynamic

63 Subscription request

To subscribe to this data set specify the subscription CAR PARK DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CAR PARK DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

64 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic car park information of the format below The example belowillustrates a single car park dynamic

[

ldquosystemCodeNumberrdquo ldquoCP1rdquo

ldquodynamicsrdquo [

occupancy 231

ldquostateDescriptionrdquo ldquoSPACESrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

6 Dynamic car park information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 27: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

18

]

Table 61 Data fields for dynamic car park information

Field Description

systemCodeNumber The unique identifier of the car park

dynamics An array of car park dynamics ndash typically one

dynamicsoccupancy The occupancy

dynamicsstateDescription A description of the car park state See Appendix E

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 28: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

19

71 Overview

The static CCTV information provides details on the CCTV camera locations

72 On demand request

GET https www netraveldata co ukapiv2cctvstatic

73 Subscription request

To subscribe to this data set specify the subscription CCTV STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

74 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static CCTV camera information of the format below The examplebelow illustrates a single CCTV camera

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoA167 Durham Roadrdquo

ldquolongDescriptionrdquo ldquoA167 Durham Road - Outside St

George s Churchrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

7 Static CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 29: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

20

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 71 Data fields for static CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

definitions An array of CCTV definitions ndash typically one

definitionsshortDescription A brief description of the CCTV camera

definitionslongDescription A longer description of the CCTV camera

definitionspoint The OSNGR location of the CCTV camera

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 30: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

21

81 Overview

The dynamic CCTV information provides details when the CCTV camera images were updated and thewhere to retrieve CCTV images

82 On demand request

GET https www netraveldata co ukapiv2cctvdynamic

83 Subscription request

To subscribe to this data set specify the subscription CCTV DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

CCTV DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

84 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic CCTV camera information of the format below This exampleillustrates a single CCTV dynamic

[

ldquosystemCodeNumberrdquo ldquoCCTV007rdquo

ldquodynamicsrdquo [

ldquoimagerdquo

ldquohttps www netraveldata co ukapiv2cctvimagesBBC01a jpgrdquo

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

8 Dynamic CCTV information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 31: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

22

]

Table 81 Data fields for dynamic CCTV camera information

Field Description

systemCodeNumber The unique identifier of the CCTV camera

dynamics An array of CCTV dynamics ndash typically one

dynamicsimage A URL to the image

dynamicslastUpdated The date and time (in ISO 8601 foramt) when the image was updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 32: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

23

91 Overview

This API provides the latest CCTV images

92 On demand request

GET https www netraveldata co ukapiv2cctvimages cctvImage

Table 91 Parameters to retrieve a CCTV image

Parameter Description

cctvImage The file name of the CCTV image to retrieve

The actual URL will be specified by the CCTV dynamic (see section 8)

93 Subscription request

This API does not support subscriptions Updates to images will be notified via changes to the CCTVdynamic (see section 8)

94 Data content

The CCTV image will be supplied in JPEG format

9 CCTV images

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 33: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

24

101 Overview

SCOOT coordinates the operation of all traffic signals in an area to give good progression of vehicles Aspart of this it detects vehicles at the start of each approach and gathers various data including averagespeed travel time and flows

The static SCOOT information provides the locations and configuration of various SCOOT sites A SCOOTsite has a start and end location covering a stretch of road

102 On demand request

GET https www netraveldata co ukapiv2scootstatic

103 Subscription request

To subscribe to this data set specify the subscription SCOOT STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

104 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static SCOOT site information of the format below This exampleillustrates a single SCOOT site

[

ldquosystemCodeNumberrdquo ldquoSCOOT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

ldquolongDescriptionrdquo ldquoFELLING BYPASS STONEYGATE SLIPrdquo

10 Static SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 34: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

25

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 10 1 Data fields for static SCOOT site information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

definitions An array of SCOOT definitions ndash typically one

definitionsshortDescription A brief description of the SCOOT site

definitionslongDescription A longer description of the SCOOT site

definitionspoint The starting OSNGR location of the SCOOT site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the SCOOT site

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 35: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

26

111 Overview

The dynamic SCOOT information provides various dynamic data collected by the SCOOT sites includingiexcl Average speediexcl Travel timesiexcl Congestion rates

112 On demand request

GET https www netraveldata co ukapiv2scootdynamic

113 Subscription request

To subscribe to this data set specify the subscription SCOOT DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

SCOOT DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

114 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic SCOOT information of the format below This exampleillustrates a single SCOOT dynamic

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquocongestionPercentrdquo 1

ldquocurrentFlowrdquo 19

ldquoaverageSpeedrdquo 40

ldquolinkStatusrdquo 0

1 1 Dynamic SCOOT information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 36: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

27

ldquolinkTravelTimerdquo 29

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 1 1 1 Data fields for dynamic SCOOT information

Field Description

systemCodeNumber The unique identifier of the SCOOT site

dynamics An array of SCOOT dynamics for the site ndash typically one

dynamicscongestionPercent Congestion percentage

dynamicscurrentFlow Flow of passenger car units (per 5 mins)

dynamicsaverageSpeed Average speed in km per hour

dynamicslinkStatus UTMC standard status of the link Possible value are 0 = NORMAL or 1 =SUSPECT

dynamicslinkTravelTime Travel time in seconds

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 37: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

28

121 Overview

The static Weather Station information provides the locations and configuration of various Weather Stationsites

122 On demand request

GET https www netraveldata co ukapiv2weatherstationstatic

123 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

124 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoB1318rdquo

ldquolongDescriptionrdquo ldquoB1318 Great North Roadrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

12 Static weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 38: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

29

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 12 1 Data fields for static weather site information

Field Description

systemCodeNumber The unique identifier of the weather site

definitions An array of weather site definitions ndash typically one

definitionsshortDescription A brief description of the weather site

definitionslongDescription A longer description of the weather site

definitionspoint The OSNGR location of the weather site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 39: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

30

131 Overview

The weather information provides various dynamic data collected by the Weather sites

132 On demand request

GET https www netraveldata co ukapiv2weatherstationdynamic

133 Subscription request

To subscribe to this data set specify the subscription WEATHER STATION DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

WEATHER STATION DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

134 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic weather information of the format below The example belowillustrates a single dynamic Most fields are optional and their population will depend on the capabilities ofthe weather site gathering the information A null value will be returned when there is no reading isavailable

[

ldquosystemCodeNumberrdquo ldquoMET0001rdquo

ldquodynamicsrdquo [

ldquoairTemperaturerdquo 3 5

ldquodewPointTemperaturerdquo null

ldquoliquidFreezingTemperaturerdquo -0 2

ldquomaxWindDirectionrdquo 306

13 Dynamic weather station information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 40: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

31

ldquomaxWindSpeedrdquo 1 7

ldquoprecipitationTotalrdquo 0 1

ldquorainIntensityrdquo 0

ldquorainOnOffrdquo ldquoRain detector offrdquo

ldquorainStaterdquo ldquoInvalidrdquo

ldquorelativeHumidityrdquo 94 80

ldquosurfaceState1rdquo ldquoInvalidrdquo

ldquosurfaceTemperature1rdquo 10 8

ldquowaterLayerrdquo 0

ldquowaterThicknessrdquo 1 1

ldquowindDirectionrdquo 274

ldquowindSpeedrdquo 1 2

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 13 1 Data fields for dynamic weather station information

Field Description

systemCodeNumber The unique identifier of the Weather site

dynamics An array of weather dynamics for the site ndash typically one

dynamicsairTemperature Air temperature in degC

dynamicsdewPointTemperature Dew point temperature in degC

dynamicsliquidFreezingTemperature Liquid freezing temperature in degC

dynamicsmaxWindDirection Max wind direction in deg

dynamicsmaxWindSpeed Max wind speed in ms

dynamcsprecipitationTotal Total precipitation in mm

dynamicsrainIntensity Rain intensity in mmh

dynamicsrainOnOff Rain on off state value See Appendix I

dynamicsrainState Rain state See Appendix I

dynamicsrelativeHumidity Relative humidity

dynamicssurfaceState1 Surface state See Appendix I

dynamicssurfaceTemperature1 Surface temperature in degC

dynamicswaterLayer Water layer in mm

dynamicswaterThickness Water thickness in mm

dynamicswindDirection Wind direction in deg

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 41: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

32

Field Description

dynamicswindSpeed Wind speed in ms

dynamicslastUpdated Date and time (in ISO 8601 format) when the dynamic was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 42: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

33

141 Overview

The static Air Quality information provides the locations and configuration of various Air Quality sites

142 On demand request

GET https www netraveldata co ukapiv2airqualitystatic

143 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

144 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static weather site information of the format below This exampleillustrates a single air quality site

[

ldquosystemCodeNumberrdquo ldquoAQ0001rdquo

ldquodefinitionsrdquo [

ldquolongDescriptionrdquo ldquoBottle Bankrdquo

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

14 Static air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 43: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

34

ldquolastUpdated 2012-01-13T1 2 19 32 419+0000rdquo

]

]

Table 14 1 Data fields for static Air Quality site information

Field Description

systemCodeNumber The unique identifier of the air quality site

definitions An array of air quality site definitions ndash typically one

definitionslongDescription A longer description of the air quality site

definitionspoint The OSNGR location of the air quality site

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionslastUpdated The date and time (in ISO 8601 format) when the definition was last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 44: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

35

151 Overview

The Daily Average Air Quality information includes various measurements averaged over the last day

152 On demand request

GET https www netraveldata co ukapiv2airqualitydailyaverage

153 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DAILY AVERAGE eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DAILY AVERAGE

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

154 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquodynamicsrdquo [

ldquoavgTemperaturerdquo null

ldquoavgRackrdquo null

ldquoavgFilterrdquo null

ldquoavgPressurerdquo null

ldquoavgNordquo null

15 Daily average air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 45: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

36

ldquoavgNo2 null

ldquoavgNoxrdquo null

ldquoavgPm10rdquo null

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

]

]

Table 15 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of daily average air quality dynamics for the site ndash typically one

dynamicsavgTemperature Average temperature in degC

dynamicsavgRack Average rack temperature in degC

dynamicsavgFilter Average filter

dynamicsavgPressure Average pressure in mBar

dynamicsavgNo Average Nitrogen Monoxide in part per billion (ppb)

dynamicsavgNo2 Average Nitrogen Dioxide in part per billion (ppb)

dynamicsavgNox Average Nitrogen Oxides in part per billion (ppb)

dynamicsavgPm10 Average pm10 particulates in micrograms per cubic meter (microgm3)

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 46: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

37

161 Overview

The Dynamic Air Quality information provides the latest air quality data for the air quality stations

162 On demand request

GET https www netraveldata co ukapiv2airqualitydynamic

163 Subscription request

To subscribe to this data set specify the subscription AIR QUALITY DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

AIR QUALITY DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

164 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of daily average air quality information of the format below This exampleillustrates a single dynamic Note that the specific data supplied will be dependent on the capabilities of thevarious air quality sites A null value will be returned when there is no reading is available

[

ldquosystemCodeNumberrdquo ldquo1306rdquo

ldquodynamicsrdquo [

ldquocordquo 0 77

ldquonordquo 84

ldquono2rdquo 84

ldquorhrdquo 94

ldquotemperaturerdquo 1

16 Dynamic air quality information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 47: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

38

ldquonoise 94

ldquobatteryrdquo 3 6

ldquolastUpdatedrdquo ldquo2015-11-18T12 19 32 419+0000rdquo

]

]

Table 16 1 Data fields for dynamic air quality information

Field Description

systemCodeNumber The unique identifier of the air quality site

dynamics An array of air quality dynamics for the site ndash typically one

dynamicsco Carbon Monoxide level in parts per million

dynamicsno Nitrogen Monoxide level in parts per billion

dynamicsno2 Nitrogen Dioxide level in parts per billion

dynamicsrh Relative humidity level in

dynamicstemperature Temperature in degC

dynamicsnoise Noise level in dB

dynamicsbattery Battery voltage in V

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 48: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

39

171 Overview

The static journey time information provides details on the journey time links Journey time links areprovided for Highways Agency roads (via National Traffic Control Centre) and 16 bus corridors split intoindividual links

172 On demand request

GET https www netraveldata co ukapiv2journeytimestatic

173 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

174 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of static journey time information of the format below The example belowillustrates a single journey time link

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodefinitionsrdquo [

ldquoshortDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rdrdquo

ldquolongDescriptionrdquo ldquoNewcastle - B6324 Stamfordham Rd

Westbound - Birchvale Ave to Westward Ctrdquo

ldquopointrdquo

17 Static journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 49: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

40

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquoendPointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolastUpdated 2012-01-13T12 19 32 419+0000rdquo

]

]

Table 17 1 Data fields for static journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

definitions An array of journey time link definitions ndash typically one

definitionsshortDescription A brief description of the journey time link

definitionslongDescription A longer description of the journey time link

definitionspoint The starting OSNGR location of the journey time link

definitionspointeasting The OSNGR easting

definitionspointnorthing The OSNGR northing

definitionsendPoint The end OSNGR location of the journey time link

definitionsendPointeasting The OSNGR easting

definitionsendPointnorthing The OSNGR northing

definitionscreationDate The date and time (in ISO 8601 format) when the definition was created

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 50: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

41

181 Overview

The dynamic journey time information provides the latest journey times for the journey time links

182 On demand request

GET https www netraveldata co ukapiv2journeytimedynamic

183 Subscription request

To subscribe to this data set specify the subscription JOURNEY TIME DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

JOURNEY TIME DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

184 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of dynamic journey time information of the format below The examplebelow illustrates a single journey time dynamic

[

ldquosystemCodeNumberrdquo ldquoCAJT01rdquo

ldquodynamicsrdquo [

ldquolinkTravelTimerdquo 180

ldquoplatesInrdquo 22

ldquoplatesOutrdquo 28

ldquoplateMatchesrdquo 15

ldquolastUpdatedrdquo ldquo2012-01-13T12 19 32 419+0000rdquo

18 Dynamic journey time information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 51: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

42

]

]

Table 18 1 Data fields for dynamic journey time information

Field Description

systemCodeNumber The unique identifier of the journey time link

dynamics An array of journey time link dynamics ndash typically one

dynamicslinkTravelTime Actual link travel time in seconds

dynamicsplatesIn Number of number plates recorded at the start of the link

dynamicsplatesOut Number of number plates recorded at the end of the link

dynamicsplateMatches Number of number plate matches used to calculate journey time

dynamicslastUpdated The date and time (in ISO 8601 format) when the dynamics were last updated

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 52: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

43

191 Overview

This data stream will provide the latest incidents Available in the data stream will be currently active orfuture confirmed incidents Additionally recently closed confirmed incidents will be available for a limitedtime

192 On demand request

GET https www netraveldata co ukapiv2trafficincident

193 Subscription request

To subscribe to this data set specify the subscription TRAFFIC INCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC INCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

194 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of incident information of the format below This example illustrates asingle incident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoIncidentrdquo

ldquoincidentTypeDescriptionrdquo ldquoBROKEN DOWN VEHICLE(S) rdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a broken down vehicle closing one

lane Normal traffic conditions expected from 2 pm rdquo

19 Incident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 53: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

44

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoincidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 19 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the incident

type The type normally ldquoIncidentrdquo

incidentTypeDescription A textual description of the incident type See Appendix A

shortDescription Summary of incident

longDescription Description of the incident

point The OSGNR location of the incident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the incident was created

dataSourceTypeRef The source system that created the incident

confirmedDate When the incident was confirmed

modifiedDate The data and time when the incident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 54: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

45

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the incident is in See Appendix H

incidentTime The time of the incident

endTime When the incident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 55: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

46

201 Overview

This data stream will provide the latest accidents Available in the data stream will be currently active orfuture confirmed accidents Additionally recently closed confirmed accidents will be available for a limitedtime

202 On demand request

GET https www netraveldata co ukapiv2trafficaccident

203 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ACCIDENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ACCIDENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

204 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of accident information of the format below This example illustrates asingle accident All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0515rdquo

ldquotyperdquo ldquoAccidentrdquo

ldquoaccidentTypeDescriptionrdquo ldquoCOLLISIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to a 2 car collision Normal traffic

conditions expected from 2 pm rdquo

20 Accident information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 56: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

47

ldquopointrdquo

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoaccidentTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

]

Table 201 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the accident

type The type normally ldquoAccidentrdquo

accidentTypeDescription A textual description of the accident type See Appendix B

shortDescription Summary of accident

longDescription Description of the accident

point The OSGNR location of the accident

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the accident was created

dataSourceTypeRef The source system that created the accident

confirmedDate When the accident was confirmed

modifiedDate The data and time when the accident was last modified

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 57: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

48

Field Description

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the accident is in See Appendix H

accidentTime The time of the accident

endTime When the accident will be cleared

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 58: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

49

211 Overview

This data stream will provide the latest events Available in the data stream will be currently active or futureconfirmed events Additionally recently closed confirmed events will be available for a limited time

212 On demand request

GET https www netraveldata co ukapiv2trafficevent

213 Subscription request

To subscribe to this data set specify the subscription TRAFFIC EVENT eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC EVENT

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

214 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of event information of the format below This example illustrates a singleevent All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoEventrdquo

ldquoeventTypeDescriptionrdquo ldquoEXHIBITIONrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip to the A182

minor delays are possible due to statue exhibition Normal traffic

conditions expected from 2 pm rdquo

ldquopointrdquo

21 Event information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 59: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

50

ldquoeastingrdquo 999999

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversonRouterdquo ldquoLane 3 closedrdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoorganiserrdquo ldquoN U F C rdquo

ldquovenueNamerdquo ldquoSt James Parkrdquo

]

Table 21 1 Data fields for incident information

Field Description

systemCodeNumber The unique identifier of the event

type The type normally ldquoEventrdquo

eventTypeDescription A textual description of the event type See Appendix C

shortDescription Summary of event

longDescription Description of the event

point The OSGNR location of the event

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 60: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

51

Field Description

creationDate The date and time the event was created

dataSourceTypeRef The source system that created the event

confirmedDate When the event was confirmed

modifiedDate The data and time when the event was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y when diversions are in force

phaseTypeRef A description of the phase the event is in See Appendix H

planned The planned startend time of the event

plannedstartTime The start time of the event

plannedendTime The end time of the event

organiser The organiser of the event

venueName The name of the venue for the event

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 61: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

52

221 Overview

This data stream will provide the latest roadworks Available in the data stream will be currently active orfuture confirmed roadworks Additionally recently closed confirmed roadworks will be available for a limitedtime

222 On demand request

GET https www netraveldata co ukapiv2trafficroadwork

223 Subscription request

To subscribe to this data set specify the subscription TRAFFIC ROADWORK eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

TRAFFIC ROADWORK

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

224 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of roadwork information of the format below This example illustrates asingle roadwork All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoN0514rdquo

ldquotyperdquo ldquoRoadworkrdquo

ldquoroadworksTypeDescriptionrdquo ldquoCENTRAL RESERVATION WORKrdquo

ldquoshortDescriptionrdquo ldquoOn the A19 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A19 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 999999

22 Roadwork information

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 62: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

53

ldquonorthingrdquo 199999

ldquolatituderdquo 54 9755208253257

ldquolongituderdquo -1 62522866852692

ldquolocationDescriptionrdquo ldquoA19 southbound exit for A182 near

Murtonrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquodataSourceTypeRefrdquo ldquoNTCC DATEX IIrdquo

ldquoconfirmedDaterdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquomodifiedDaterdquo ldquo2012-01-13T13 19 32 419+0000rdquo

ldquoseverityTypeRefDescriptionrdquo ldquoMEDIUMrdquo

ldquolanesAffectedTypeRefDescriptionrdquo ldquo| | Trdquo

ldquodiversionInForcerdquo ldquoYrdquo

ldquophaseTypeRefrdquo ldquoCURRENTrdquo

ldquoplannedrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquoactualrdquo

ldquostartTimerdquo ldquo2012-01-13T12 00 00 000 +0000rdquo

ldquoendTimerdquo ldquo2012-01-13T13 00 00 000 +0000rdquo

ldquocontractorrdquo ldquoB Builderrdquo

ldquotrafficSignalsrdquo ldquoYrdquo

ldquocontraflowrdquo ldquoYrdquo

]

Table 221 Data fields for roadwork information

Field Description

systemCodeNumber The unique identifier of the roadwork

type The type normally ldquoRoadworkrdquo

roadworksTypeDescription A textual description of the roadwork type See Appendix D

shortDescription Summary of roadwork

longDescription Description of the roadwork

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 63: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

54

Field Description

point The OSGNR location of the roadwork

pointeasting The OSGNR easting

pointnorthing The OSGNR northing

locationDescription Location description

creationDate The date and time the roadwork was created

dataSourceTypeRef The source system that created the roadwork

confirmedDate When the roadwork was confirmed

modifiedDate The data and time when the roadwork was last modified

severityTypeRefDescription The severity description as defined by the UTMC standard See Appendix F

lanesAffectedTypeRefDescription Textual description of the lanes affected See Appendix G

diversionsInForce Y if diversions are in force

phaseTypeRef A description of the phase the roadwork is in See Appendix H

planned The planned startend time of the roadwork

plannedstartTime The start time of the roadwork

plannedendTime The end time of the roadwork

actual The actual startend time of the roadwork

actualstartTime The start time of the roadwork

actualendTime The end time of the roadwork

contractor The contractor

trafficSignals Y if temporary traffic signals are in place

contraflow Y if a contraflow is in place

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 64: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

55

231 Overview

This data stream will provide details of variable message signs locations

232 On Demand request

GET https www netraveldata co ukapiv2vmsstatic

233 Subscription request

To subscribe to this data set specify the subscription VMS STATIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS STATIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

234 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS static information of the format below This example illustrates asingle VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquoshortDescriptionrdquo ldquoOn the A186 southboundrdquo

ldquolongDescriptionrdquo ldquoOn the A186 southbound exit slip A182rdquo

ldquopointrdquo

ldquoeastingrdquo 563987

ldquonorthingrdquo 426811

ldquolatituderdquo 54 969792147768

ldquolongituderdquo -1 58273368931618

23 VMS static

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 65: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

56

ldquoroadNamerdquo ldquoWALKER ROADrdquo

ldquocreationDaterdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquodataSourcerdquo ldquoSVMS Controllerrdquo

]

Table231 Data fields for VMS static data

Field Description

systemCodeNumber The unique identifier of the VMS

shortDescription Summary of VMS

longDescription Description of the VMS

point The OSGNR location of the VMS

pointeasting The OSGNR easting of the VMS

pointnorthing The OSGNR northing of the VMS

pointlatitude The latitude of the VMS

pointlongitude The longitude of the VMS

roadName Location description

creationDate The date and time the VMS was created

dataSource The source system that created the VMS

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 66: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

57

241 Overview

This data stream will provide details of variable message signs messages

242 On demand request

GET https www netraveldata co ukapiv2vmsdynamic

243 Subscription request

To subscribe to this data set specify the subscription VMS DYNAMIC eg

POST https www netraveldata co ukapiv2subscription

subscriptions [

VMS DYNAMIC

]

notificationUrl http ltMY_APP_DOMAINgtltPATH_FOR_NOTIFICATIONgt

244 Data content

The data content of the on demand request or the notifications notificationData field of the

notification can contain an array of VMS dynamic information of the format below This example illustratesa single VMS All dates are supplied in ISO 8601 format

[

ldquosystemCodeNumberrdquo ldquoV0514rdquo

ldquomessageTextrdquo ldquoBRIDGE CLOSED TO HIGH SIDED VEHICLESrdquo

ldquomessageTextSplitrdquo ldquoBRIDGE CLOSED~TO HIGH SIDED~VEHICLES~rdquo

ldquosignSettingReasonrdquo ldquoManual Overriderdquo

ldquolastUpdatedrdquo ldquo2012-01-13T12 00 00 000+0000rdquo

ldquolanternStaterdquo 0

ldquocategoryrdquo ldquocategoryrdquo

ldquomessageNamerdquo ldquoBridge Closedrdquo

ldquopictogramIdrdquo ldquoG6rdquo

24 VMS dynamic

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 67: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

58

]

Table 241 Data fields for VMS dynamic data

Field Description

systemCodeNumber The unique identifier of the VMS

messageText Full VMS message text

messageTextSplit Full VMS message text Lines are delimited with ~ character

signSettingReason The reason for displaying current message

lastUpdated The date and time of last update

lanternState The boolean value indicating current lantern state

category Message category

messageName Message name

pictogramId Unique Identifier for displayed pictogram image (see appendix J)

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 68: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

59

Appendices

Appendix A Incident Types _____________________________________________________________________ 60Appendix B Accident Types ____________________________________________________________________ 62Appendix C Event Types ______________________________________________________________________ 63Appendix D Roadworks Types __________________________________________________________________ 64Appendix E Car Park States ____________________________________________________________________ 65Appendix F Severity Types ____________________________________________________________________ 66Appendix G Lanes Affected Types _______________________________________________________________ 67Appendix H Phase Types ______________________________________________________________________ 68Appendix I Weather Station types _______________________________________________________________ 69

Appendix J Pictogram message Idrsquos _____________________________________________________________ 70

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 69: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

60

The following list contains all possible Incident type valuesiexcl ABNORMAL LOAD(S)iexcl AIR CRASHiexcl AIR RAIDiexcl ANIMALS ON THE ROADiexcl ATTACK ON VEHICLEiexcl AVALANCHESiexcl BLASTING WORKiexcl BRIDGE BLOCKEDiexcl BRIDGE CLOSEDiexcl BRIDGE DEMOLITION WORKiexcl BRIDGE MAINTENANCE WORKiexcl BRIDGE OPENINGiexcl BROKEN DOWN BUS(ES)iexcl BROKEN DOWN HEAVY LORRY(IES)iexcl BROKEN DOWN VEHICLE(S)iexcl BURST PIPEiexcl BURST WATER MAINiexcl BUS DISRUPTIONiexcl BUS LANE BLOCKEDiexcl BUS LANE CLOSEDiexcl CENTRE LANE(S) BLOCKEDiexcl CENTRE LANE(S) CLOSEDiexcl CHEMICAL SPILLAGE ACCIDENT(S)iexcl CHILDREN ON ROADWAYiexcl CIVIL EMERGENCYiexcl CIVIL EMERGENCY CANCELLEDiexcl CLOSED DUE TO SMOG ALERTiexcl CONGESTIONiexcl CONTRAFLOWiexcl CONVOY(S)iexcl CROWDiexcl CYCLISTS ON ROADWAYiexcl DIVERSIONiexcl EMERGENCY ALERT (EXTRA GENERATED TRAFFIC)iexcl FACILITIES CLOSEDiexcl FAULTiexcl FIREiexcl FLOODiexcl FLOWiexcl FOGiexcl GAWKING TRAFFIC - RUBBER NECKERSiexcl GUNFIRE ON ROADWAYiexcl HAIL

Appendix A Incident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 70: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

61

iexcl HEAVY FLOWiexcl ICEiexcl LANE CLOSUREiexcl LIGHT FAULTiexcl OBSTRUCTIONiexcl PEOPLE ON ROADWAYiexcl POLLUTIONiexcl POWER FAILUREiexcl PUBLIC DISTURBANCEiexcl QUEUEiexcl RADIOACTIVE LEAKiexcl RAINiexcl RIOTiexcl ROAD CLOSUREiexcl ROADSIDE FIREiexcl SANDSTORMSiexcl SECURITY ALERTiexcl SECURITY INCIDENTiexcl SIGHTSEERS OBSTRUCTING ACCESSiexcl SNOWiexcl SPEED RESTRICTIONiexcl SPILLAGEiexcl SPRAY HAZARDiexcl STRUCTURAL DAMAGEiexcl TELEPHONE FAULTiexcl TEMPORARY SIGNALiexcl TERRORIST INCIDENTiexcl TORNADOESiexcl TRAFFIC SIGNAL FAULTiexcl TRAIN DISRUPTIONiexcl UNEXPLAINED DAMAGEiexcl UNEXPLAINED EVENTiexcl WASHOUTiexcl WINDiexcl OTHER INCIDENT

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 71: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

62

The following list contains all possible Accident type valuesiexcl ACCIDENTiexcl BUS ACCIDENTiexcl COLLISIONiexcl ACCIDENT INVESTIGATION WORKiexcl ACCIDENT HISTORYiexcl CHEMICAL SPILLAGE ACCIDENTiexcl FUEL SPILLAGE ACCIDENTiexcl HAZARDOUS MATERIALS ACCIDENTiexcl HEAVY LORRY ACCIDENTiexcl JACK-KNIFED ARTICULATED LORRYiexcl JACK-KNIFED CARAVANiexcl JACK-KNIFED TRAILERiexcl MULTI-VEHICLE ACCIDENTiexcl OIL SPILLAGE ACCIDENTiexcl OVERTURNED HEAVY LORRYiexcl OVERTURNED VEHICLEiexcl SECONDARY ACCIDENTiexcl SERIOUS ACCIDENTiexcl SHED LOADiexcl VEHICLE SPUN AROUNDiexcl OTHER ACCIDENT

Appendix B Accident Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 72: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

63

The following list contains all possible Event type valuesiexcl BALL GAMEiexcl BOXING TOURNAMENTiexcl ATHLETICS MEETINGiexcl CYCLE RACEiexcl DEMONSTRATIONiexcl EVENTiexcl EXHIBITIONiexcl FAIRiexcl FESTIVALiexcl FOOTBALL MATCHiexcl FUNFAIRiexcl GOLF TOURNAMENTiexcl INTERNATIONAL SPORTS MEETINGiexcl MAJOR EVENTiexcl MARATHONiexcl MARCHiexcl MARKETiexcl MATCHiexcl PARADEiexcl PROCESSIONiexcl RACE MEETINGiexcl RUGBY MATCHiexcl SHOWiexcl SHOW JUMPINGiexcl SPORTS EVENTiexcl SPORTS MEETINGiexcl STATE OCCASIONiexcl STRIKEiexcl TENNIS TOURNAMENTiexcl TOURNAMENTiexcl TRADE FAIRiexcl WATER SPORTS MEETINGiexcl WINTER SPORTS MEETINGiexcl OTHER EVENT

Appendix C Event Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 73: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

64

The following list contains all possible Roadworks type valuesiexcl CENTRAL RESERVATION WORKiexcl GENERAL ROADWORKSiexcl OVERHEAD ROADWORKSiexcl SURFACE ROADWORKSiexcl VERGE ROADWORKSiexcl WATER MAIN WORKiexcl OTHER ROADWORKSiexcl STREETWORKS

Appendix D Roadworks Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 74: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

65

The following list contains all possible car park state valuesiexcl FAULTYiexcl SPACESiexcl ALMOST FULLiexcl FULLiexcl CLOSEDiexcl UNKNOWNiexcl OPEN

Appendix E Car Park States

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 75: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

66

The following list contains all possible severity type valuesiexcl Unknowniexcl Lowiexcl Mediumiexcl Highiexcl Other

Appendix F Severity Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 76: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

67

The following list contains all possible lanes affected type valuesiexcl iexcl Tiexcl Iiexcl I Tiexcl T Iiexcl T Tiexcl I Iiexcl I I Iiexcl I I Tiexcl T I Iiexcl I T Tiexcl T T Iiexcl T T Tiexcl I I I Iiexcl T I I Iiexcl I I I Tiexcl T T I Iiexcl I I T Tiexcl T T T Iiexcl I T T Tiexcl T T T T

Appendix G Lanes Affected Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 77: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

68

The following list contains all possible phase type valuesiexcl Futureiexcl Currentiexcl Graceiexcl Pastiexcl Archiveiexcl Deleted

Appendix H Phase Types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 78: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

69

The following list contains all possible rainOnOff type valuesiexcl Rain detector offiexcl Rain detector on

The following list contains all possible rainState type valuesiexcl Invalidiexcl No Precipitationiexcl Recent Precipitationiexcl Precipitation Nowiexcl Light Precipitationiexcl Medium Precipitationiexcl Heavy Precipitationiexcl Light Snowiexcl Medium Snowiexcl Heavy Snow

The following list contains all possible surface state type valuesiexcl Invalidiexcl Unknowniexcl Shortiexcl Slushyiexcl Dryiexcl Moistiexcl Wetiexcl Wet and Treatediexcl Frostiexcl Snowiexcl Iceiexcl Trace of Chemical

Appendix I Weather Station types

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos

Page 79: Tyne and Wear Open Data Services Platform · 2020-01-15 · 333551 HWY TTS 1549540452 G 1549540452 18 November 2015 Tyne and WearOpen Data Services Platform API Specification Tyne

Tyne and WearOpen Data Services PlatformAPI Specification

333551HWYTTS1549540452H 25 October 2019 1549540452

70

Table J1 VMS pictogram Filenames and pictogram ids

File name Pictogram id

OTHER_DANGERbmpG1

SLIPPERYROADbmpG2

QUEUEbmp G3

ROADWORKSbmp G4

ICEbmp G5

DOUBLEBENDbmp G6

SIDEWINDSbmp G7

ACCIDENTbmp G8

SP20bmp G9

SP30bmp G10

SP40bmp G11

SP50bmp G12

SP60bmp G13

RAILbmp G16

TOPLEFTARROWbmp G17

TOPRIGHTARROWbmp G18

LEFTARROWbmp G19

RIGHTARROWbmp G20

PARKINGbmp G23

Appendix J Pictogram message Idrsquos