Consultation Manager API


Introduction

This documentation is intended for programmers who are writing applications that interact with Consultation Manager.

This document provides an overview of the API and its components.

Overview

History
Getting Started
Rates and Limits
Request Model
Authentication Model
Application Session
System Roles
Dates and Timezones
Testing platforms
Versioning
Future Direction
Code Example

Enumerations

Result Status
Entity
Entity State
Field Type
Fieldset

Data Types

countResult
dataResultLight
dataResult
authResult
dataField
dataValue
dataObject
dataDetail

Service Methods

Security

Ping
Login
Logout
Permission Check

Search and Details

Searching
Detail
Detail Attachment
Search Options
Search Option Values
Get Fieldset fields

 

Relationships

Related Entity Counts
Related Entities
Non-Related Searching
Relate
UnRelate
Update Related Role
Get Related Roles

Actions

Create
Update
Delete
Restore

History

A record of all modifications to this document

Date Name Notes
28 July 2013 Shaun Weddell First Draft
31 July 2013 Colin McEown Reviewed and approved for initial release.

Overview

Consultation Manager can be integrated with third party applications. This documentation relates to API Version 2.

API access is only available to Enterprise clients.

Getting Started

To begin integrating with Consultation Manager, you will need to contact us for a Gateway Consumer Key and Password.

An Access Token and Password is also required. This can be either a standard Consultation Manager Username and Password that has relevant access to your system or a Client Key and Password.

Functionality available within the API will match the privileges of the authorised Access Token. For a User-Token this will be the privileges for the System Role that the user has for the project(s) being accessed. A Client-Token has unrestricted access across all projects, equivalent to the Enterprise Admin Role. (see System Roles)

Consultation Manager can provide consultantcy services to support the implementation on request.

Rates and Limits

API Access is available with different packaging of rates and limits. A setup fee applies. Pricing is available on request.

Request Model

The Consultation Manager API offers a REST-like API to interact and query data within Consultation Manager. Currently only HTTP methods "GET" and "POST" are supported for requests.

Requests are made to an endpoint format:

JSON is the preferred response format. Response formats include:

Format Description
JSON Javascript Object Notation.
POX Plain Old XML.

To make a request against API version 2 with a response format of JSON, use the following endpoint format:

Authentication Model

Authentication is based on the open standard OAuth 1.0 specification, specificically the single-legged authentication model. This differs from other implementations using two or three legged OAuth such as Twitter or Facebook. The reason for this difference is that we currently do not allow third party sites to access data on your behalf. The single legged process simplifies the authentication flow into a single call, rather than being required to inititally request an access token.

Each request has an Authorization HTTP header with the following mandatory OAuth parameters:

Name Value Description Example
Consumer Key oauth_consumer_key The Gateway Consumer Key provided. E17C4AFE-F57E-4B72-A97F-335CCF00E575
OAuth Version oauth_version The OAuth specification version. Only 1.0 is supported. 1.0
Signature Method oauth_signature_method The OAuth signature method. Only HMAC-SHA1 is supported. HMAC-SHA1
Signature oauth_signature The computed signature according to OAuth specifications. djosJKDKJSD8743243%2Fjdk33klY%3D
Timestamp oauth_timestamp A UNIX timestamp defined as the number of seconds since 00:00:00 UTC on January 1, 1970. 12569537329
Nonce oauth_nonce A unique number that should only be used once. 27293729
Token oauth_token The Access Token for the user or client. mysite1259

Note the Consumer password/secret and the Token password/secret should never be passed in the header or querystring.

An example of an Authorization header added to an API request:

More information

Application Session

A session is created when an Access Token performs a Login action. A parameter will be returned currently called appKey. This application session key should be passed as a querystring in every subsequent request. Failure to do so may cause a new session to be created, and the previous session to be invalidated.

An example of how the appKey should be passed follows:

Dates and Timezones

Dates are stored in Consultation Manager as UTC/GMT. Timezone settings can be customised at and cascade down from the Enterprise level, Project level and User level, in that order. A date returned in a response will automatically be converted to the local time based on these settings. A date sent into Consultation Manager for a search or update, should use the local time as the system will convert this back to the UTC/GMT equivalent.

Testing platforms

A default testing platform can be made available for use for debugging and testing for a fee. Data may be reset nightly. A duplicate of your production data can also be made available for testing purposes for a fee. The testing platform endpoint is the same format as the production endpoint .

Versioning

All requests to the API should specify a version to ensure stability and future changes do not impact your development

Future direction

This API will undergo ongoing development. Specifically changes are slated to support OAuth 2.0, conform more closely to RESTfull standards, improved consistency in nomenclature and responses. Please log any errors or omissions at http://support.consultationmanager.com.au.


Enumerations

The following enumerations may be returned in the response data.

Result Status

Certain responses may contain a status attribute that defines whether the action or request was successful or valid. Consumers of the service should ensure this status is parsed and a acted upon if required. The following is a list of possible status and their meaning that can be returned.

Value Description
OK The request was successful.
FAIL The request failed. The text parameter may offer a reason.
KILL Another session has been activated for the authenticated user making the request. The session should be aborted as you may recieve inconsistent results.

System Roles

A team member can be assigned a System Role for each project they are associated with. The role can be different across projects. If the user session is authorised on multiple projects, the lowest System Role is used. Custom roles can be implemented as a customisation, however the standard System Roles available are listed below.

Name Description
Team Member No system access.
Data Viewer Readonly access only.
Data Entry Limited editing access. Can create, modify and relate their own records. Unrelate is restricted.
Data Editor Edit, relate, unrelate all data. Limited Project, User or Type management.
Team Leader Edit, relate, unrelate all data. Project leader. Can assign Users and Types to their Project. Project, User and Type creation is restricted.
Enterprise Admin System Administrator. Unrestricted access.

Permissions

An authenticated user will only have the privileges for their System Role in the Project(s) they are authorised. The available permissions are listed below.

Name Description
Login Permission to login to the system.
Download Permission to download a Document attachment.
Upload Permission to upload a Document attachment.
SendCampaign Permission to Send a Campaign.
ManageUser Permission to Manage Users/Team Members.
ManageSelf Permission to Manage their own User profile.
ManageType Permission to Manage Types.
Relate Permission to Relate an Entity.
UnRelate Permission to UnRelate an Entity.
View Permission to View an Entity.
ViewCrossProject Permission to View data across Projects.
Report Permission to Generate Reports.
Add Permission to Create an Entity.
Edit Permission to Edit an Entity.
Delete Permission to Delete an Entity.
Restore Permission to Restore an Entity.
Purge Permission to Purge an Entity.
Privatise Permission to make an Entity Private in Scope.
Globalise Permission to make an Entity Global in Scope.
Admin Permission to be an Enterprise Administrator.

Entity

Data in Consultation Manager is classified into different Entities that represent fundamental groups of data. Entities can be inter-related, with an optional Relationship Role. For instance a Stakeholder and Property can be associated together with an optional Role (in this situation colloquially known as an Ownership Type) such as Owner or Landlord.

The following is a selection of common Entities available.

Name Value Description Default Scope
project 1 Represents a distinct project compartment that other Entities can be related with to segment an organisations data. Team Members are optionally assigned to with a System Role. Global
action 2 Represents a Team Member action or task. Private
document 3 Represents a document, file or resource with a binary attachment or hyperlink. Global
event 4 Represents an organisation Event, or interaction with a Stakeholder or Property. Private
property 6 Represents a physical property or geo-location. Global
stakeholder 7 Represents a person or organisation that the organisation or Team Members may interact with. Global
team member (user) 8 Represents a person within the organisation that may or may not have system access. Private
type 10 Represents a system Type such as Stakeholder Group or Event Type. Private

Entity State

An Entity can have different states that reflect its currency or deletion state. The following is a selection of common states available.

Value Description
active The Entity is active.
deleted The Entity has been deleted.

Entity Scope

Entities can be made Private to one or more projects or made Global across all projects. If the Entity is Private, projects must be assigned. Assigning projects is optional if the Entity is Global.

 

Field Type

An Entity Field has specific properties or valid values that can be assigned, the Field Type defines the type of data that this field expects or the suggested interface component to display / edit the field data. The following is a selection of common field types available.

Value Description
string Limited length string.
text Unlimited length string.
number A numeric value.
boolean Yes/no or true/false.
list Single selection list of items.
combo Single selection list of items, that also accepts a custom string value not present in the list.
tree Multi selection list of items with hierarchy.
date Date only.
datetime Date and time.
address Physical or postal address.
label Notation, computed or non-editable.
labelBlock Notation, computed or non-editable.
hidden Hidden field. For system reference or modification only.

Fieldset

A fieldset is a reference to a predefined collection of Entity fields used to define what fields should return in a Search or Detail request. The following is a selection of common Fieldsets available.

Value Description
search Subset of fields recommended to be returned in a Search.
detail Subset of fields recommended to be returned in a Detail view.
empty A very limited number of fields, essentially just any record identifiers.

Search Operator

Defines the type of search filter operator.

Name Value Description
equals 0 Include records that matches the criterion.
startswith 1 Include records that begins with the criterion.
endswith 2 Include records that ends with the criterion.
contains 3 Include records that contain the criterion.
on 4 Include records that are on the criterion date.
before 5 Include records that are before the criterion date.
after 6 Include records that are after the criterion date.
exists 7 Include records where a criterion exists.
notexists 8 Include records where a criterion does not exist.
notequals 10 Include records that does not equal the criterion.
between 11 Include records that are between two criterion dates, being the two values supplied.

Data Types

The API will return a range of responses depending on the method requested.

countResult

Parameter Data Type Description
entity string The Entity class name such as "stakeholder"; "event".
text string The display text for this result.
count integer The number of records returned within the result.

 

dataResultLight inherits from countResult

Parameter Data Type Description
entity string The Entity class name such as "stakeholder"; "event". (inherited from countResult)
text string The display text for this result. (inherited from countResult)
count integer The number of records returned within the result. (inherited from countResult)
status string See Result Status.
data dataObject array The result data. An array of dataObject.
searchUid string Internal use only. The unique identitifer for the query that returned this result.

 

dataResult inherits from countResult

Parameter Data Type Description
entity string The Entity class name such as "stakeholder"; "event". (inherited from countResult)
text string The display text for this result. (inherited from countResult)
count integer The number of records returned within the result. (inherited from countResult)
status string See Result Status.
data dataDetail array The result data. An array of dataDetail.
searchUid string Internal use only. The unique identitifer for the query that returned this result.
trace string Internal use only. The debug trace information for this result.
canEdit boolean Whether this related result allows Entities to be unrelated or relationship roles modified.
canAdd boolean Whether this related result allow Entities to be related directly.
warning boolean Internal use only. Whether the result set contains a warning.

 

authResult inherits from dataResult

Parameter Data Type Description
entity string The Entity class name such as "stakeholder"; "event". (inherited from countResult)
text string The display text for this result. (inherited from countResult)
count integer The number of records returned within the result. (inherited from countResult)
status string See Result Status. (inherited from dataResult)
data dataDetail array The result data. An array of dataDetails. (inherited from dataResult)
searchUid string Internal use only. The unique identitifer for the query that returned this result. (inherited from dataResult)
trace string Internal use only. The debug trace information for this result. (inherited from dataResult)
canEdit boolean Whether this related result allows Entities to be unrelated or relationship roles modified. (inherited from dataResult)
canAdd boolean Whether this related result allow Entities to be related directly. (inherited from dataResult)
warning boolean Internal use only. Whether the result set contains a warning.  (inherited from dataResult)
termsVersion double The latest version number the authenticated user has agreed and accepted.
clientMode short Internal use only. The service model for Consultation Manager.
userUid string The authenticated user Unique Identifier.
clientUid string The authenticated client Unique Identifier.
role string The authenitcated user's role for the current project view. See System Roles.
project string The project key(s) that the user is currently viewing.
appKey string A unique session ID generated for this application and user session.
msgType integer Internal use only. Defines a message that should be displayed to the user.
msgText string Internal use only. The message title.
msgInfo string Internal use only. The message further information.

 

dataField

Parameter Data Type Description
type string The field type. See Field Type.
name string The field name or unique reference.
entity string The Entity class name such as "stakeholder"; "event".
visible boolean Whether this field should be visible to the authenticated user.
mandatory boolean Whether a value for this field is mandatory.
values dataValue array The field values. An array of dataValues.
text string The display text for this field name.

dataValue

Parameter Data Type Description
name string The data value name. Usually only returned for a complex field such as Address which has sub components such as AddressSuburb.
value string The actual data value. This could be an identifier, text or string representations of a date or boolean.
text string The display text for the value. This may be the same as the value.
selected boolean Whether the value is selected. Usually only returned for Type based fields.
parent string The Unique Identifier (uid) for the parent of this value. Usually only returned for Type based fields.
visible boolean Whether the value should be visible to the authenticated user.

 

dataObject

Parameter Data Type Description
uid string The entity unique identifier.
description string The entity title or description.
info string A summary of the entity detail.
hasRole boolean Whether the entity has a relationship role in a related search .

 

dataDetail inherits from dataObject

Parameter Data Type Description
uid string The entity unique identifier. (inherited from dataObject)
description string The entity title or description. (inherited from dataObject)
info string A summary of the entity detail. (inherited from dataObject)
hasRole boolean Whether the entity has a relationship role in a related search. (inherited from dataObject)
entity string The Entity class name such as "stakeholder"; "event".
state string The Entity State.
key long The internal system record identifier, unique to the Entity class, but not unique across all entities.
isUrl boolean Specifies whether the entity attachment is a Document URL.
fields dataField array The field data for the entity detail.
mimeType string The entity attachment resource type.
openWith integer Internal use only. The recommended editor or viewer component for the attached resource.
canOpen boolean Internal use only. Whether the attached resource can be opened.
subscriptionStart datetime Internal use only. The subscription date start.
subscriptionEnd datetime Internal use only. The subscription date end.
subscriptionKey string Internal use only. The subscription unique identifier.

Service Methods

Ping

Tests a connection to an account is successful and a valid session.

HTTP Method GET
Service Name PING
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/ping
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/ping
Response dataResultLight

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
 

Sample Response

Login

Logs in to a particular set of projects. This sets the user scope for the subsequent requests.

HTTP Method GET
Service Name AUTH
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/auth
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/auth
Response authResult

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application. Yes -
project long the project key of the single project being logged in to for auditing purposes. Optional The last project accessed
leaving long The project key of the single project being left. Optional -
 

Sample Response

Logout

Logs the user out of the system. Mostly for auditing purposes.

HTTP Method GET
Service Name AUTHOUT
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/authOut
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/authOut
Response dataResult

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application. Yes -
 

Sample Response

Permission Check

Returns whether the Access Token has a specified Permission. If an Entity UID is supplied, the permissions for the specific Entity will be returned, otherwise only general permission.

HTTP Method GET
Service Name PERMIT
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/permit/{PERMISSION}/{ENTITY}/{ENTITY_UID}
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/permit/delete/stakeholder/72HS-JDL3-9382-JSKS3-MN8283
Response dataResultLight

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application. Yes -
 

Sample Response

Searching

Returns a collection of Entities based on the Search Option(s) and the (wild) Search Operator defined in the Search XML posted with the request.

HTTP Method POST
Service Name SEARCH
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/search/
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/search
Response dataResult

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application. Yes -
fieldset string The fieldset to return. Optional Empty
start integer The zero based start index / ordinal. Optional 0
length integer The length / number of records to return. Optional 20
getCount boolean Whether to return a record count. Optional true
getData boolean Whether to return record data. Optional true
 

XML Post

Sample Response

Create

Create a new Entity

HTTP Method POST
Service Name CREATE
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/create
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/create
Response dataResult

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
fieldset string The fieldset to return Optional Empty
 

XML Post

 

Sample Response

Update

Update an existing Entity

HTTP Method POST
Service Name UPDATE
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/update
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/update
Response dataResult

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
fieldset long The fieldset to return Optional Empty
 

XML Post

 

Sample Response

Delete

Delete an Entity

HTTP Method GET
Service Name DELETE
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/delete/{ENTITY}/{ENTITY_UID}
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/delete/Stakeholder/72HS-JDLE-9382-JSKS3-MN8283
Response dataResultLight

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
 

Sample Response

Restore

Restore (UnDelete) an Entity

HTTP Method GET
Service Name RESTORE
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/restore/{ENTITY}/{ENTITY_UID}
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/restore/Stakeholder/72HS-LDL3-9382-JSKS3-MN8283
Response dataResultLight

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
 

Sample Response

Detail

Retrieves the data specified by the Fieldset for a particular Entity.

HTTP Method GET
Service Name DETAIL
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/search/{ENTITY}/{ENTITY_UID}
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/search/Stakeholder/72HS-LDL3-9382-JSKS3-MN8283
Response dataResult

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
fieldset string The fieldset to be returned Optional Empty
 

Sample Response

Detail Attachment

Returns a Binary attachment to an Entity. Usually a Document Entity

HTTP Method GET
Service Name DETAIL_ATTACHMENT
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/search/{ENTITY}/{ENTITY_UID}/binary
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/search/Document/15CP-RKR1-6394-MOPW5-LO3016/binary
Response Binary Data

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -

Related Entity Counts

Returns the related Entity counts and the relationships the Entity supports.

HTTP Method GET
Service Name RELATED_COUNTS
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/search/{ENTITY}/{ENTITY_UID}/counts
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/search/Stakeholder/72HS-LDL3-9382-JSKS3-MN8283/counts
Response countResult Array

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
 

Sample Response

Related Entities

Returns a collection of Entities related to a specific Entity.

HTTP Method GET
Service Name RELATED_SEARCH
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/search/{ENTITY}/{ENTITY_UID}/related/{RELATED_ENTITY}
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/search/Stakeholder/72HS-LDL3-9382-JSKS3-MN8283/related/Property?fieldset=search&start=0&length=50&getData=true&getCount=true
Response dataResult

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
fieldset string The fieldset to return Optional Empty
start integer The zero based start index / ordinal Optional 0
length integer The number of records to return Optional 20
 

Sample Response

Non-Related Searching

Returns a collection of Entities that are not related to a specified Entity. This request supports posted Search XML to filter the result.

HTTP Method POST
Service Name NON_RELATED_SEARCH
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/search/{ENTITY}/{ENTITY_UID}/unrelated/{RELATED_ENTITY}
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/search/Stakeholder/72HS-LDL3-9382-JSKS3-MN8283/unrelated/Property
Response dataResult

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
fieldset string The fieldset to return Optional Empty
start integer The zero based start index / ordinal of the recordset Optional 0
length integer The number of records to return Optional 20
 

Sample Response

Relate

Relates two Entities to each other.

HTTP Method GET
Service Name RELATE
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/update/{ENTITY}/{ENTITY_UID}/relate/{RELATED_ENTITY}/{RELATED_ENTITY_UID}
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/update/Stakeholder/72HS-LDL3-9382-JSKS3-MN8283/relate/Property/R21S-KD89-TV20-RUMW2-LLP03
Response dataResultLight

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
 

Sample Response

UnRelate

UnRelate two Entities from each other.

HTTP Method GET
Service Name UNRELATE
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/update/{ENTITY}/{ENTITY_UID}/unrelate/{RELATED_ENTITY}/{RELATED_ENTITY_UID}
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/update/Stakeholder/72HS-LDL3-9382-JSKS3-MN8283/unrelate/Property/R21S-KD89-TV20-RUMW2-LLP03
Response dataResultLight

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
 

Sample Response

Update Related Role

Update a Relationship Role associated with two Entities.

HTTP Method GET
Service Name UPDATE_RELATED_ROLE
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/update/{ENTITY}/{ENTITY_UID}/role/{RELATED_ENTITY}/{RELATED_ENTITY_UID}/{ROLE}
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/update/Stakeholder/72HS-LDL3-9382-JSKS3-MN8283/role/Property/R21S-KD89-TV20-RUMW2-LLP03/Landlord
Response dataResultLight

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
 

Sample Response

Get Related Roles

Returns all Related Roles that have been assigned to an Entity pair.

HTTP Method GET
Service Name RELATED_ROLE
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/roles/{ENTITY}/{RELATED_ENTITY}
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/roles/Stakeholder/Property
Response String Array

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
 

Sample Response

Entity Search Options

Returns the available search options for a specified Entity class

HTTP Method GET
Service Name SEARCH_OPTION
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/options/{ENTITY}
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/options/Stakeholder
Response dataField Array

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
 

Sample Response

Entity Search Option Values

Returns the available values for a specified Search Option.

HTTP Method GET
Service Name SEARCH_OPTION_VALUE
Endpoint Format https://gateway.consultationmanager.com.au/RestService2.svc/{VERSION}/{RESPONSE_FORMAT}/options/{ENTITY}/{SEARCH_OPTION}
Endpoint Example https://gateway.consultationmanager.com.au/RestService2.svc/v2/json/options/Stakeholder/StakeholderGroup
Response dataField Array

Parameters

Parameter Data Type Description Required Default
appKey string The session key for this application Yes -
 

Sample Response


Code Example

The following is a c# ASP.NET sample code that utilises OAuthBase.