Getting started with Service Point

Complete the online access request form with the following information.

  • Organisation name
  • Organisation prefix
  • Organisation ABN
  • Organisation address
  • Users (a minimum of two are required including a main designated contact for the organisation)
    • First name
    • Surname
    • Contact number
    • Position
    • Email
  • Application
    • Project name
    • Proposed application
    • Estimated number of transactions per day
    • Estimated launch date

Note: Tooltips are available in all forms to assist in entering information. These are accessible by hovering the mouse over the field title.

Initial testing in a sandbox environment

After the access request form is received, an email is sent to each user, providing login credentials to set up a new account. This account allows access to the Service Point test and development environment (sandbox).

This account can be used to access the Self-Service Management Interface (SSMI) to view the administration pages. An organisation and its unique identifier are shown in the upper right portion of the interface. This identifier has been created by Service Point and is used to associate the activity and Service Point registers, as well as the user and API keys.

Move to production

When an application is ready to go live, access will be created in the production environment and URL supplied. To initiate a move into production please contact Spatial Services.

Log into the SSMI for account administration

All users will receive a system-generated email providing a temporary password which must be changed within seven days. If a password is not set within seven days, user's access is blocked. If access is blocked, contact Spatial Services.

The designated contact will be provided with administrative rights to manage the organisation. They can add users and maintain the Activity Register. The Activity Register is used to determine the purpose of transactional data and allows the creation of the anonymised codes required when integrating with a form or application.

Create users

Create user

Users are created from the administration tab and are given different roles and access levels, determined by the organisation administrator/designated contact.

When creating a user, the following user types can be chosen:

  • Access type – API or individual
    • API access is for development teams to embed the Service Point client.
    • Individual access is to administer and view the Activity Register.
  • Level of access - admin or standard
    • Admin allows the user administration rights and can manage the Activity Register by creating the activity, site and agreement.
    • Standard users can view transactions.

Create the Service Point Activity Register

Items menu

To access location-based analytics and reporting services using Service Point, an organisation must add activities to the Activity Register, then submit transactions into the Service Point Register referencing those activities.

Login to the SSMI to access the Activity Register tab and select the activities icon. Users with administrative privileges can maintain their organisation’s activity, site and agreement information using the appropriate administration pages.

Select add activity. Activity naming conventions should be determined by the organisation and should be relevant to the application submitting the transaction.

Add Activity table

Each organisation, activity and site created in the register is automatically assigned its own anonymised ID to meet strict privacy guidelines. Additional optional fields:

  • Amount: nominated activity dollar value
  • Agreement: designed for the not-for-profit sector, a set funding agreement linked to transactions.

Select add site. Site information is optional, however it can improve business analytics if services are provided to clients from service centres. Generally, forms submitted online would not require a site to be defined.

Add Site table

The location-based analytics that are a key feature of Service Point rely on the accuracy of data in the Activity Register.

No personal data is stored within Service Point or by Spatial Services.

Sample

Sample data

API reference guide

This is a guide for developers to interact with Service Point via its API interface. This set of services allow developers to log in to Service Point and to validate and submit transactions.

Integration with NSW Point

Using NSW Point V2 with Service Point

NSW Point V2 address validation is the preferred source of geographic references required for Service Point's location-based reporting. NSW Point V2 provides accurate and current geographic data at the time of address validation.

The following steps outline how NSW Point V2 predictive address validation services can be used to:

  • Validate an address
  • Request the address details and geographic references for the validated address
  • Submit the geographic references as a transaction into Service Point

There are alternative ways to gather the necessary geographic references for a Service Point transaction, contact us to discuss these options if required.

Process steps:

  1. NSW Point V2 Predictive1 API (https://point.digital.nsw.gov.au/v2/api/predictive1) is used to suggest addresses based upon the user's input. Once a suggested address is selected by the user, the identifier (id) for that address can be used in step 2.

    Example: perform a GET request

    https://point.digital.nsw.gov.au/v2/api/predictive1?address=346 Pan&dataset=gnaflive&stateTerritory=NSW&maxNumberResults=10&addressType=physical

    Returns:

    
                                        
  2. Submit the address identifier (id) from step 1 to NSW Point V2 Predictive2 (https://point.digital.nsw.gov.au/v2/api/predictive2) along with the appropriate outfields that are required to return the geographic references for a Service Point transaction.

    Example: perform a POST request with at least the following output fields. Additional output fields can be used, if required.

    Endpoint:

    https://point.digital.nsw.gov.au/v2/api/predictive2

    Post data:

    
                                        

    Returns:

    
                                        
  3. Create the transaction to be submitted to Service Point. The data format required for the transaction is defined in the Transaction API reference.

    Build the input data by adding the:

    • Activity ID - the identifier for the transaction activity.
    • Transaction date (as an epoch in milliseconds).
    • Site ID of the site location where the transaction took place. The site record must already exist in the Service Point Activity Register. Sites are an optional Service Point feature - if sites are not used, site ID should be excluded from the transaction.
    • Geographic references
      • mbId
      • sa1Id
      • sa2Id
      • sa3Id
      • sa4Id
      • lgaName
      • localityName
      • stateElectoralName
      • commElectoralName
    • Secondary geographies can be sourced as per steps 1 and 2 and then nested into the transaction as described in the Transaction API reference.

    The assembled transaction should be arranged like the example below.

    
                                        
  4. Log in to Service Point (https://servicepoint.digital.nsw.gov.au/v1/api/login) using API login username and password (set up via the Service Point administration pages). See the Login API reference for a full explanation of the process.

  5. (Recommended during development) Call the Service Point validation service to validate the transaction information prior to transaction submission (https://servicepoint.digital.nsw.gov.au/v1/api/validate). See the Validate API reference.

  6. Submit the transaction to the Service Point transaction service (https://servicepoint.digital.nsw.gov.au/v1/api/transaction). See the Transaction API reference.

Frequently asked questions

How do I integrate Service Point into an application?

Refer to the API reference material. Anonymised codes created in the Activity Register are required to submit the transactions.

Do I need to use NSW Point in conjunction with Service Point?

Service Point is recommended to be used in conjunction with NSW Point V2. NSW Point V2 accesses a national address data set provided through Spatial Services. Key ASGS details are provided by the Predictive 2 output in NSW Point V2 and are submitted to Service Point through a transaction. For further details please see the NSW Point V2 workflow.

What is the cost to access Service Point and NSW Point?

Spatial Services provides NSW Point and Service Point free of charge to NSW State Government agencies.

Should I use the Widget or a direct API web service in my form to connect to Service Point?

Each organisation will have its own preferred option and should rely on their development team for the best advice. The most reliable and secure method is to access the direct API web service. When using the NSW Point Address Widget to connect to Service Point, a transaction is created when the address validation is selected on the form. In an instance where a customer does not complete a form submission the transaction will still be recorded in the Service Point Register.

What mandatory fields are required to use Service Point?

To set up and start using Service Point the only two mandatory fields are organisation and activity. Optional fields are site, amount and agreement. Geographic references are encouraged, as without these, no location-based reporting is possible. Service Point is most useful when all fields are entered.

A transaction validation service is provided to ensure the transaction data is valid before sending to Service Point.

How do I obtain my organisation ID?

Spatial Services will supply this unique generated code following the completion of the access request form. This is supplied by email to the designated contact once the request is processed. This code is the key organisation ID to link users and transactions to the Activity Register. Once logged into the Self-Service Management Interface the organisation ID is shown on the top-right hand corner, under the username.

What is the organisation prefix?

Each organisation must use a unique, short name prefix (i.e. SS for Spatial Services). An organisation's preference for this is submitted with the initial access request form. If this preference is already in use, Spatial Services notifies the designated contact to establish an alternative. Together with the organisation ID, this prefix will link users and transactions to the Activity Register. It is possible for an individual to be a user for more than one organisation.

Our organisation has many activities (and/or sites), do I have to enter each separately?

A feature that supports the ability to bulk upload this data using a CSV file is currently under development.

How can an organisation add additional users and administrators?

User management will be an internal process for each organisation. Spatial Services will create the initial organisation user who will have administrative rights within the SSMI.

How can I find out my user name?

A user name always includes the organisation prefix, but the remainder of the naming format will be determined by each organisation. The organisation's designated contact or the Spatial Services team can offer assistance.

How can I reset my password?

Contact Service Delivery for assistance. Passwords should be updated every 90 days for security reasons.

Why am I unable to make changes to information in the Activity Register? (I cannot add, retire, update, etc.)

These features are linked to user access, which is determined by each organisation. Users with view access will not be able to edit fields in the Activity Register but can see the activity codes to use for implementation. To edit details a user must be granted administrative access. The designated contact can edit these access levels.

What is the process to view the Service Point Register?

The Service Point Register is functionally separated from the Activity Register, which is critical for data privacy. Spatial Services facilitates the Service Point Register through the Spatial Hosting Portal. An additional account setup and login is required to see the transactions and dashboards.

How can I create an account in the Spatial Hosting Portal?

An account can be created via the Portal login page. Users must provide Spatial Services with their user name details to enable viewing of their organisation's Service Point group. This access includes a data view and a dashboard.

What is held in Service Point Register data?

The Service Point Register stores codes created for an organisation, including activity and anonymised transaction details and geographies. These codes are important for maintaining privacy. An organisation can identify its own unique codes for activity and site. This is in addition to the deidentified geographic data fields returned from NSW Point validation, which are provided against the transaction.

How many applications can I have?

The Service Point Management Interface allows for users to add in an unlimited amount of activity IDs for each individual form. Each form/application must have a unique activity to provide a unique report for each application.

How can our organisation update our address dataset?

Spatial Services offers Bulk Address Validation as part of the Whole of Government Addressing program. The NSW Point Website provides information on the Bulk Address Validation Process and application form.

*Charges may apply for Bulk Address Validation.

How do I know transactions are processing correctly?

Once you have access to our sandbox or production accounts our team can help you by checking that API requests are being sent and received correctly, with correct details. Users will also have access in the Spatial Collaboration Portal to view the data which has been received by Service Point.

My password email link has expired. How do I get a new one?

The password reset link will remain active for seven days. After this time, contact Service Delivery to generate a new email link.