LogoLogo
No Code Service CreationPowerful Integrated FormsGCloud Information
  • The OneVu Digital Platform
  • Features and Benefits
  • Core Functionality
    • Creating an account
    • Get Answers Fast
    • Submit a Request
    • Track My Requests
    • Profile
      • Changing Contact Details
        • Changing Email
        • Changing Mobile Number
        • Linking to Messenger
        • Linking to WhatsApp
      • Changing Address
      • Changing Name
      • Changing Date of Birth
      • Notification Preferences
      • Citizen Timeline
      • Family and Friends
      • Bookmarked Services
    • MyAccount
    • Two factor authentication
  • 🌩️Integrations
    • Introduction
    • Council Tax
      • Civica
      • Northgate
      • Capita
    • Payments
      • Capita Pay360
      • Civica Pay - eStore2
      • GOV.UK Pay
    • Waste
      • Bartec Collective
      • Whitespace Powersuite
      • Yotta Mayrise
      • Yotta Alloy
      • Civica APP (Flare)
    • Housing Rents/Repairs
      • Northgate
    • Benefits
      • Capita
      • Civica
      • Northgate
    • Landlords
      • Capita
      • Civica
      • Northgate
    • Business Rates
      • Capita
      • Civica
      • Northgate
    • Business Improvement Districts
      • Northgate
    • Licensing
      • IDOX Uniform
    • Environmental Health
      • Civica APP (Flare)
    • Concessionary Travel
      • IEG4 Blue Badge
    • Health
      • Digital CHC
    • Notifications
      • GOV.UK Notify
      • Facebook Messenger
      • WhatsApp
    • Fraud & Identity
      • Loqate - Bank validation
      • Xantura - RBV
      • Transunion - RBV
      • TransUnion - ID Verification
    • Maps / Assets
      • Bing Maps
      • Symology
    • Address Look Ups
      • Ordnance Survey - Places API
      • Loqate
    • Bookings
      • Microsoft Bookings
    • OAuth2 - Identity
    • DfE FSM Eligibility Checker
    • DfT Blue Badge
  • 🛠️OneVu Control
    • Data Silos
      • The basics
      • Content Management - Simple
        • Adding static content
        • Settings
      • Dynamic Content Management
        • Registration
        • Connection Requirements
        • Using back-office data
          • Simple Data Items
          • Arrays of data
          • Data Item Collections
          • Nested Collections
          • Simple Item Formatting
          • Collection Item Formatting
          • Data item calculations
        • High Level Conditions
          • Simple true / false rules
          • Dynamic true/false rules
          • Deeper Dynamic rules
          • AND Conditions
          • OR Conditions
          • NOT Conditions
        • In Section Visibility/Rules
          • If True
          • If Not True
          • If Equal To (v1)
          • If Equal To (v2)
          • If Not Equal To
          • If Greater Than
          • If Less Than
          • If Last
          • If First
          • If Null
          • If Not Null
          • Collections & complex rules
        • Importing a silo
    • Groups
      • Permissions
    • Users
    • Settings - OneVu
    • Account Management
    • Portals
    • Banners
    • Privacy Statements
    • Audit Logs
    • Diagnostics
  • 📞Customer Service Vu
    • Introduction
    • Contact Logging
      • Notes
    • A Single Timeline
    • Set up
      • Service Areas
      • Locations
  • 💬Broadcast
    • Introduction
    • Generic notifications
      • Adding From Addresses
      • Adding Email Headers
      • Adding Email Footers
      • GOV.UK Notify Templates
      • Notification Frequency
      • Broadcast Topics
        • Linking - GOV.UK Notify Template
        • Linking - Email Header
        • Linking - Email Footer
        • Linking - SMS Template
      • Broadcast Articles
        • Web Content
        • Plain Text Emails
        • HTML based emails
        • Messages
      • Topic visibility in OneVu
      • Broadcast and CitizenVu
    • eNotifications/eBilling
      • Introduction
      • Functionality
        • Opt In functionality
        • Your Profile
      • Set up
        • Setting up notification types
        • Notification content
          • Notification placeholders
          • Email (Standard)
          • Email (GOV.UK Notify)
          • SMS (GOV.UK Notify)
          • Facebook Messenger
          • WhatsApp
        • Import notification files
          • File Column Mapping
          • Bulky File Import
        • Bulk Export File
      • Notification Audit
      • Contact Management
  • 🗺️Your Area
    • Introduction
    • Community Directory
    • Your Issues
  • ☁️OneVu API
    • Introduction
    • Methods
  • 📘My Area Directories
    • Presentation
    • Creating/editing a directory
    • Defining fields in an empty directory
    • Adding records to an empty directory
    • Adding a URL endpoint to an API Directory & Hybrid Directory
    • Importing a CSV file to a Hybrid Directory
    • Importing a CSV file to a Hybrid Directory
    • Configure My Area Directory Display Component
    • Configure My Area Directory Component
    • Configure My Area Directory Component
    • Configure My Area Directory Component
    • Configure My Area Directory Container/Directory Groups component
    • Configure My Area Directory Container/Directory Groups component
    • Configure My Area to display in OneVu
  • ✅OpenProcess
    • Introduction
    • My tasks
    • Supervise Tasks
    • Search Processes
    • Start Process
    • Abandon a Process
    • Process Retention Periods
    • Building Processes
      • Your first process
      • Step Set Up
        • Standard Steps
        • Auto-completing steps
        • Branches
        • REST API Steps
          • Worked example
      • Actions
        • IEG4 Emails
        • GOV.UK Notify Emails
        • GOV.UK Notify SMS
        • WhatsApp Messages
        • Messenger Messages
    • Two-way Communication
    • 🛠️Set Up
      • Fields
      • Categories
      • Groups
        • Permissions
      • Users
      • Organisations
    • 💾Export to CSV
    • ⚡OpenProcess Flex
      • Cases Functionality
      • Process Branches
        • Nested Branches
        • Multiple Conditions
        • Advanced Conditions
      • Work allocation in branches
      • Choice Fields
      • Mandatory Fields
      • Branches - Search Processes
      • OneVu - Track my Requests
      • Dynamic Notifications
        • Worked Example
      • Worked Example - Simple
      • Worked Example - Advanced
    • 🔀OpenProcess EDMS
      • Document Indexing
        • Multiple Indexing Queues
      • Bulk Document Import
      • Create a Document
      • Set Up
        • Document Types
        • Document Templates
          • Headers
          • Footers
          • Stylesheets
          • Templates Admin/Use
        • Service Areas
        • Account Extracts
          • User Functionality
          • IT Facing Functionality
  • ☁️OpenProcess API
    • Introduction
    • Getting an API Key
    • Methods
    • Webhooks - REST API Steps
  • 📈Reporting
    • OneVu
    • CS Vu
    • OpenProcess
    • Reporting Database
  • 💏Community Content
    • OneVu
      • Council Tax
        • Capita Content
        • Civica Content
        • Northgate Content
        • Sample Demo Content
      • Benefits
        • Capita Content
        • Civica Content
        • Northgate Content
      • Business Rates
        • Capita Content
        • Civica Content
        • Northgate Content
      • Licensing
        • IDOX Uniform Content
      • Housing
        • Northgate Rents Content
        • Northgate Repairs Content
    • eDesigner
    • OpenProcess
      • Council Tax
      • Benefits
      • Business Rates
      • Building Control
      • Adult Social Care
      • Licensing
      • Planning
      • Street Name and Numbering
      • Complaints
      • Housing
      • Waste
      • Environmental Health
      • Streets and Parks
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. OpenProcess
  2. Building Processes
  3. Step Set Up
  4. REST API Steps

Worked example

PreviousREST API StepsNextActions

Last updated 3 years ago

Was this helpful?

Let's say you need a new online service, which is Report Clinical Waste.

You would:

a) build the service using eDesigner as you would normally and then

b) add a Data Mapping XML template:

c) map the content from the form to the XML template:

d) test that the output is to your liking by looking at the Forms Portal:

e) publish the form to test

f) set up a new process with the first step being a REST API step type:

g) add an action to the online form in test in System Management to call the process you've just created in step f):

h) Go intoOneVuTest and submit the form (NB - you only need to do this in OneVu if 'Customer account is mandatory' is set in the above action.)

i) Once submitted go into Search Processes inOpenProcess. You will see that the first step now has additional content that is not present on standard steps and if clicked on shows you the Request and Response sent/received from the API where the information was posted to:

The next section is where things become a little more technical.

j) In the request above we can see the 'payload' sent to the API.

This contains both the ProcessId AND within the Links array the document that was created i.e. the XML document created from the online form. I.e.

"ProcessId": "0696d843-cef3-4af6-a4be-8d93191f8345""Href": "/open-api/documents/7dea286a-e44b-4414-b3e3-b28cfd8b6f62"

The DocumentId for the XML document is shown in bold above.

Swagger UI functionality

In order to use this functionality you will need to get the appropriate API Keys. To do so you need to go to Set Up in OpenProcess and click on the new API Developer Access function:

NB in order to access this you will need to be part of a group that has the new Api Admin permission: NB in order to access this you will need to be part of a group that has the new Api Admin permission:

Once you have got into the Api Developer Access area you are able to create API Keys yourself.

The name of the key is what will show when updates are made via API:

IMPORTANT

When you click save you are then given a ONE TIME ONLY means to copy/write down/put somewhere safe these codes as shown here:

So if you forget to do this you will need to create another key.

l) Now that we have done that we can go ahead and call the Get Documents API.

You can see that the documentid in the above request is placed into relevant field:

And the response we have back provides:

{

"filename": "Formmapping.xml",

"contents": "(base64 encoded content)",

"contentType": "text/xml"

}

<ServiceRequest> 
  <Request> 
    <RequestCategorisation> 
      <FormType>NEEDLEREPORTTEST</FormType> 
      <RequestType/> 
      <BackOfficeReference/> 
    </RequestCategorisation> 
    <ClientInfo> 
      <Title>Mr</Title> 
      <FirstName>J</FirstName> 
      <LastName>M</LastName> 
      <DOB>01/01/1980</DOB> 
      <NINO/> 
      <NHSNumber/> 
      <DrivingLicenceNumber/> 
    </ClientInfo> 
    <ContactInfo> 
      <Email/> 
      <Mobile/> 
      <Telephone/> 
    </ContactInfo> 
    <PropertyInfo> 
      <AddressLine1>10 Downing Street</AddressLine1> 
      <AddressLine2>Test</AddressLine2> 
      <AddressLine3>Test</AddressLine3> 
      <AddressLine4/> 
      <PostCode>B63 3TA</PostCode> 
    </PropertyInfo> 
    <RequestInfo> 
      <RequestType>1</RequestType> 
      <RequestSpecifics>It is dumped by the tree adjacent to the dog waste bin</RequestSpecifics> 
      <RequestLocation>4</RequestLocation> 
    </RequestInfo> 
  </Request> 
</ServiceRequest> 

Thereby enabling you to extrapolate the details for back-office updates.

n) Now the back office is updated we might want to add a note to this process. This time, we will use the ProcessId passed in the original Request. With the note "Hello World" being added:

We can then check this update within OpenProcess. Rather than a user's name showing as who added the note, the name of the API Key is what is shown. So it would be worthwhile thinking of how you'd like this to be presented when creating your API Key.

o) Now let's say you want to automatically complete the step. To do this you need to retrieve the current step id for the process. So we call the Get Current Step API using the process id:

We can see the response provides us with:

{ "stepId": "716896f7-7c2b-4080-a305-136bd239e9db", "kind": "Standard", "name": "Dealing with the dumped medical waste", "startedOn": "2019-03-26T14:01:23.35", "completedOn": null }

I.e. the stepid, its type (kind), the name of the step, when it was started and the fact that it is not completed.

p) Using the stepid and processid we can then call the Complete a Step API to complete it:

k) With this we can now jump over toOpenProcess'sSwagger functionality found here ()

m) We can then decode this content () into what was sent from the form:

✅
https://openprocess-test.azurewebsites.net/swagger/ui/index#/
this is useful for testing