Relationship

All available link relationship

Relationship Guide
fqn http://rels.temenos.com/rels/root
methodsGET
description This is considered as a first service to be called from user agent to get the links available for rest of the interaction. This service will offer links to call OData ServiceDocument, profile, search and menu
uri templates The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570
example

An atom representation of a link to the root resource

<link rel="http://rels.temenos.com/rels/root" type="application/atom+xml;type=entry" title="service root" href="root"/>

The basic structure of the http request is as follows:

GET /Prospect.svc/root HTTP/1.1

fqn http://rels.temenos.com/rels/profile
methodsGET
description This resource is available on root resource and user agent is expected to call this resource to load user profile.
uri templates The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570
example

An atom representation of a link to the profile resource

<link rel="http://rels.temenos.com/rels/profile" type="application/atom+xml;type=entry" title="User Profile" href="/profile"/>

The basic structure of the http request is as follows:

GET /Prospect.svc/root HTTP/1.1

fqn http://schemas.microsoft.com/ado/2007/08/dataservices/related/ServiceDocument
methodsGET
description This resource is available on root resource and odata client user agent can use this service to see available Odata ServiceDocument resources.
uri templates The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570
example

An atom representation of a link to the ServiceDocument resource

<link href="/" rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/ServiceDocument" type="application/atom+xml;type=entry" title="ServiceDocument"></link>

The basic structure of the http request is as follows:

GET /Prospect.svc/ HTTP/1.1

fqn http://rels.temenos.com/rels/contextenquiry
methodsGET
description This type of resource is designed to return a number of enquiries associated with one or more fields on the screen. When entering data into a form it is often useful to drill down to more detailed information about a particular value within that form. This contextenquiry link provides that capability by providing the name or names of the fields in the query parameters.
uri templates The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

application – (OPTIONAL) Query parameter provides the server with the ability to filter the list of context enquiry links by the supplied Application or Version

field – (OPTIONAL) Query parameter provides the server with the ability to filter the list of context enquiry links by the supplied field

example

An atom representation of a link to the context enquiry list resource

<link rel="http://rels.temenos.com/rels/contextenquiry" type="application/atom+xml;type=entry" title="contextenquiry" href="ContextEnquiry{&application}{&field}"/>

The basic structure of the http request is as follows:

GET /Prospect.svc/ContextEnquiry?field=Customer&field=Currency HTTP/1.1

fqn http://rels.temenos.com/rels/metadata
methodsPOST
description

This type of resource is designed to provide a runtime metadata for each field present in a T24 Application such as Customers or FundsTransfers. When entering deals into T24 on the basis of information provided in an particular field can change the behaviour of the other dependent fields i.e. can make them NOINPUT/READONLY etc.

To get the runtime metadata simply POST your entity to /T24FieldMetadata() and metadata will be returned as Feed.

This type resource can be very useful for a user agent to render the screen with the updated metadata information.

This metdata resource provides that capability by returning a Feed of T24FieldMetadata entity containing following information;

Id : Fully qualified name

Entity: Entity name

Property: Property name

Visible: Visibility of the property

Mandatory: If its mandatory

MandatorySelection: If mandatory selection field

ReadOnly: If its readonly

PrimaryKey: If its a primary key

PossibleValues: List Enumerations

uri templates The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the new FundsTransfer resource

<link rel="http://rels.temenos.com/rels/metadata" type="application/atom+xml;type=entry" title="runtime metadata" href="verFundsTransfer_News()/metadata"/>

The basic structure of the http request is as follows:

POST /Prospect.svc/verFundsTransfer_News()/metadata HTTP/1.1
Content-Length: 0

fqn http://rels.temenos.com/rels/enrichment
methodsGET
description This resource is designed to provide field enrichment to user agent for screen. This service will be available by default for each version and can be invoked while inputting or editing a record
uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

PropertyName=PropertyValue – (MANDATORY) Query parameter provides the information about the Field in Application/Version to be enriched along with the value. If invalid/no property provided resource would return HTTP error code 400

example

An atom representation of a link to the enrichment resource for FundsTransfer

<link rel="http://rels.temenos.com/rels/enrichments" type="application/atom+xml;type=entry" title="field enrichment" href="verFundsTransfer_News()/enrichment"/>

The basic structure of the http request is as follows:

GET /Prospect.svc/verFundsTransfer_News()/enrichment?CustomerNo=12345 HTTP/1.1

fqn http://rels.temenos.com/rels/contract
methodsGET
description

This type of resource is designed to provide functionality required for each Application/Version in T24 by supplying links to all possible resources (if applicable) like New Deal, List of Live Record, List of IAuth Records etc upon launching the application/version. In other terms it will act as landing page for each Application/Version in T24.

This resource will be accessible on all T24 Application/Version by default

uri templates The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570
example

An atom representation of a link to the contract Customer resource

<link rel="http://rels.temenos.com/rels/contract" type="application/atom+xml;type=entry" title="Customer Contract" href="Customers()/contract"/>

The basic structure of the http request is as follows:

GET /Prospect.svc/Customers()/contract HTTP/1.1

fqn http://rels.temenos.com/rels/populate
methodsPOST
description

This type of resource is designed to provide functionality for user to populate a record for editing of which Id is already known. If id is not supplied it would behave same as new i.e. it will generate the new Id and return the empty contract.

This resource will be accessible on all T24 Application/Version by default

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

Id : (Optional) Query parameter provided will be used as an Id to populate a record from T24

example

An atom representation of a link to the populate Customer resource

<link rel="http://rels.temenos.com/rels/populate" type="application/atom+xml;type=entry" title="Customer Populate" href="Customers()/populate{?CustomerCode=12345}"/>

The basic structure of the http request is as follows:

POST /Prospect.svc/Customers()/populate?CustomerCode=12345 HTTP/1.1

see

fqn http://rels.temenos.com/rels/see
methodsGET
description This type of resource is designed to return the latest version of a record in T24.
uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the see list resource

<link rel="http://rels.temenos.com/rels/see" type="application/atom+xml;type=entry" title="See Customer" href="verCustomer_Inputs('12345')/see"/>

The basic structure of the http request is as follows:

GET /Prospect.svc/verCustomer_Inputs('12345')/see HTTP/1.1

fqn http://rels.temenos.com/rels/copy
methodsPOST
description This type of resource is designed to expose T24 clipboard functionality to REST user agent. User agent can call this resource to save its contract which it can paste later to populate new contracts quickly.
uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the copy Customer resource

<link rel="http://rels.temenos.com/rels/copy" type="application/atom+xml;type=entry" title="Copy deal" href="verCustomer_Inputs('12345')/copy"/>

The basic structure of the http request is as follows:

POST /Prospect.svc/verCustomer_Inputs('12345')/copy HTTP/1.1

fqn http://rels.temenos.com/rels/paste
methodsPOST
description

This type of resource is designed to expose T24 clipboard functionality to REST user agent. User agent can call this resource to retrieve data which was copied using copy resource

This resource is equivalent of new resource where it will generate the new Id if applicable, default values with an addition to fill/overwrite Application/Version entity properties with copied data

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

Id : Query parameter containing Entity Id field which can be passed if user agent user would like to override auto id generation. MANDATORY if Application/Version DOES NOT support AUTO.ID else it is OPTIONAL

example

An atom representation of a link to the paste Customer resource

<link rel="http://rels.temenos.com/rels/paste" type="application/atom+xml;type=entry" title="Copy deal" href="verCustomer_Inputs()/paste{?CustomerCode=12345}"/>

The basic structure of the http request is as follows:

POST /Prospect.svc/verCustomer_Inputs()/paste HTTP/1.1

new

fqn http://rels.temenos.com/rels/new
methodsPOST
description This type of resource is designed to provide the next available ID for a T24 Application such as Customers or FundsTransfers. When entering deals into T24 it would be quite onerous to expect the user to invent a new ID for each deal; it is therefore common practice for T24 Applications to provide generated IDs that can be used for the new deal, or thrown away without ever being used. This new resource provides that capability by returning a populated or partially populated entity along with one or more links that could then be used to input or hold the new deal.
uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

Id : Query parameter containing Entity Id field which can be passed if user agent user would like to override auto id generation. MANDATORY if Application/Version DOES NOT support AUTO.ID else it is OPTIONAL

example

An atom representation of a link to the new FundsTransfer resource

<link rel="http://rels.temenos.com/rels/new" type="application/atom+xml;type=entry" title="New FundsTransfer" href="FundsTransfers()/new{?RefNo=FT00100001}"/>

The basic structure of the http request is as follows:

POST /Prospect.svc/FundsTransfers()/new HTTP/1.1
Content-Length: 0

fqn http://rels.temenos.com/rels/input
methodsPOST, PUT
description This type of resource is designed to provide a user with the ability to store new deals or modify existing deals within T24. When managing deals within T24 it is often necessary to store deals and modify deals at the same time as other users. This input resource provides that capability by allowing the user to GET an existing deal with an ETAG value and POST to store the deal with the 'If-Match' precondition providing the same ETAG value. This ensures that the deal modified by the user is the most up to date version of the deal within T24.
uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the authorise Customer resource

<link href="Customer_Inputs()" rel="http://rels.temenos.com/rels/input" type="application/atom+xml;type=entry" title="input" hreflang="en" length="0" />

The basic structure of the http request is as follows:

Request

GET /Prospect.svc/Customers('100226') HTTP/1.1

Response

ETag: "686897696a7c876b7e"

Request

POST /Prospect.svc/Customers('100226') HTTP/1.1
If-Match: "686897696a7c876b7e"
<?xml version='1.0' encoding='UTF-8'?>
<entry
xmlns="http://www.w3.org/2005/Atom"
xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xml:base="http://localhost:9081/hothouse-iris/Hothouse.svc/GB0010001/">
<id>http://localhost:9081/hothouse-iris/Hothouse.svc/GB0010001/Customer_Inputs()/new</id>
<title type="text"></title>
<updated>2014-01-13T15:51:11Z</updated>
...

fqn http://rels.temenos.com/rels/validate
methodsPOST
description

This type of resource is designed to provide user with the ability to validate input-able entry with T24 before it tries to use input

This resource would return validation errors or overrides if there are any else would return fully populated entry.

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the authorise Customer resource

<link href="Customer_Inputs()/validate" rel="http://rels.temenos.com/rels/validate" type="application/atom+xml;type=entry" title="validate enttry" hreflang="en" length="0" />

The basic structure of the http request is as follows:

POST /Prospect.svc/Customers('100226')/validate HTTP/1.1

fqn http://rels.temenos.com/rels/verify
methodsPOST
description

This type of resource is designed to provide user with the ability to VERIFY an input-able entry within T24.

NOTE: VERIFY operation in T24 is equivalent of EXECUTING a T24 Record.

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the VERIFY EBS.AUTO.FUNCTION resource

<link href="EbsAutoFunction_Tests('CUSTOMER.100')/verify" rel="http://rels.temenos.com/rels/verify" type="application/atom+xml;type=entry" title="verify entry" hreflang="en" length="0" />

The basic structure of the http request is as follows:

POST /Prospect.svc/EbsAutoFunction_Tests('CUSTOMER.100')/verify HTTP/1.1

fqn http://rels.temenos.com/rels/authorise
methodsPUT
description

This type of resource is designed to provide a deal approval facility for a T24 Application. When entering deals into T24 it is common practice to require an additional user to authorise the newly input deal. This authorise resource provides that capability by allowing the second user to PUT their approval.

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the authorise Customer resource

<link rel="http://rels.temenos.com/rels/authorise" type="application/atom+xml;type=entry" title="Authorise Customer" href="CustomersIAuth('100226')/authorise"/>

The basic structure of the http request is as follows:

PUT /Prospect.svc/CustomersIAuth('100226')/authorise HTTP/1.1

fqn http://rels.temenos.com/rels/hold
methodsPOST
description

This type of resource is designed to provide a user with the ability to store new or modified entries into hold status in T24.

User should be able to retrieve the saved data at any point of time afterwards for modification and should be able to perform normal commit on it using input resource.

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the hold Customer resource

<link href="Customer_Inputs('12345')/hold" rel="http://rels.temenos.com/rels/hold" type="application/atom+xml;type=entry" title="hold record" hreflang="en" length="0" />

The basic structure of the http request is as follows:

POST /Prospect.svc/Customers('12345')/hold HTTP/1.1

fqn http://rels.temenos.com/rels/review
methodsGET
description

This type of resource us designed to provide a latest read only copy of the data to user like see but review also updates the audit fields of the record in T24 for auditing.

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the review Customer resource

<link href="Customer_Inputs('12345')/review" rel="http://rels.temenos.com/rels/review" type="application/atom+xml;type=entry" title="review record" hreflang="en" length="0" />

The basic structure of the http request is as follows:

GET /Prospect.svc/Customers('12345')/review HTTP/1.1

fqn http://rels.temenos.com/rels/reverse
methodsPOST | PUT
description

This resource is designed to provide user a capability to reverse a Live transaction from T24 and move to history. Once the record is in Live state in T24 user can not simply delete that, it can only be reversed which is equivalent of delete in T24

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the reverse Customer resource

<link href="Customer_Inputs('12345')/reverse" rel="http://rels.temenos.com/rels/reverse" type="application/atom+xml;type=entry" title="reverse record" hreflang="en" length="0" />

The basic structure of the http request is as follows:

POST|PUT /Prospect.svc/Customers('12345')/reverse HTTP/1.1

fqn http://rels.temenos.com/rels/delete
methodsDELETE
description

This type of resource is designed to remove or mark items for deletion. When managing deals within T24 it often necessary or desirable to maintain data for a relatively short period. This delete resource provides that removal / deletion capability.

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the delete Customer resource

<link rel="http://rels.temenos.com/rels/delete" type="application/atom+xml;type=entry" title="Delete Customer" href="Customers('123')/delete"/>

The basic structure of the http request is as follows:

DELETE /Prospect.svc/Customers('123')/delete HTTP/1.1

fqn http://rels.temenos.com/rels/deliveryPreview
methodsPOST
description

This commands initializes a T24 delivery preview workflow including triggering the generation of the delivery preview data in T24

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the deliveryPreview Fundstransfer deal

<link href="verFundsTransfers('FTXXXXXX')/deliveryPreview" rel="http://rels.temenos.com/rels/deliveryPreview" type="application/atom+xml;type=entry" title="Preview deal" hreflang="en" length="0" />

The basic structure of the http request is as follows:

POST /Prospect.svc/verFundsTransfers('FTXXXXXX')/deliveryPreview HTTP/1.1

fqn http://rels.temenos.com/rels/dealSlips
methodsGET
description

This command provides specialist behavior for retrieving deal slips, from T24, associated with deal slip ids stored in the IRIS interaction context by a previous action such as authorize.

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the dealSlips Fundstransfer deal

<link href="verFundsTransfers('FTXXXXXX')/dealSlips" rel="http://rels.temenos.com/rels/dealSlips" type="application/atom+xml;type=entry" title="Preview deal" hreflang="en" length="0" />

The basic structure of the http request is as follows:

GET /Prospect.svc/verFundsTransfers('FTXXXXXX')/dealSlips HTTP/1.1

fqn http://rels.temenos.com/rels/enquiryReport
methodsGET
description

This command provides specialist behavior for retrieving the Enquiry Report via an Enquiry drilldown from T24.

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the enquiryReport Fundstransfer deal

<link href="verFundsTransfers('FTXXXXXX')/enquiryReport" rel="http://rels.temenos.com/rels/enquiryReport" type="application/atom+xml;type=entry" title="Preview deal" hreflang="en" length="0" />

The basic structure of the http request is as follows:

GET /Prospect.svc/verFundsTransfers('FTXXXXXX')/enquiryReport HTTP/1.1

fqn http://rels.temenos.com/rels/changedValues
methodsGET
description

This type of resource is designed to provide difference (delta fields) between LIVE and NAU record of T24

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the changedValues CustomerInputs deal

<link href="verCustomerInputs('12345')/changedValues" rel="http://rels.temenos.com/rels/changedValues" type="application/atom+xml;type=entry" title="Get changed values" hreflang="en" length="0" />

The basic structure of the http request is as follows:

GET /Prospect.svc/verCustomer_Inputs('12345')/changedValues HTTP/1.1

fqn http://rels.temenos.com/rels/restore
methodsPOST
description

This resource is designed to provide user a capability to restore reverse transaction from T24.

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the restore Customer resource

<link href="Customer_Inputs('12345')/restore" rel="http://rels.temenos.com/rels/restore" type="application/atom+xml;type=entry" title="restore record" hreflang="en" length="0" />

The basic structure of the http request is as follows:

POST /Prospect.svc/Customers('12345')/restore HTTP/1.1

fqn http://rels.temenos.com/rels/aapopulate
methodsPOST
description

This is a special type of resource which is only applicable on AAA versions of T24. This resource is equivalent of first time validation of an AAA deal in Browser. This resource will return all nested AAA property classes along with their properties for user.

NOTE: This resource will only be available for AAA versions.

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

An atom representation of a link to the populate Customer resource

<link rel="http://rels.temenos.com/rels/aapopulate" type="application/atom+xml;type=entry" title="AAA Populate" href="verAaArrangementActivity_AaNews('AA123456')/aapopulate"/>

The basic structure of the http request is as follows:

POST /Prospect.svc/verAaArrangementActivity_AaNews('AA123456')/aapopulate HTTP/1.1

OR

To populate a single Forward Dated TAB in AAA deal for access URL;

POST /Prospect.svc/verAaArrangementActivity_AaNews('AA123456')/aapopulate?populateForwardDateTab=true HTTP/1.1

fqn http://rels.temenos.com/rels/uploads
methodsPOST
description

This resource is capable of accepting an Streaming entity to upload binary data to T24 server like images, documents, csv etc.

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

TODO:

fqn http://rels.temenos.com/rels/downloads
methodsPOST
description

This resource is capable of streaming resources to client to download binary data like images, documents, csv etc.

uri templates

The User-Agent MUST replace every occurrence of the template parameters with a value before issuing a request for the resource. See URI Templates http://tools.ietf.org/html/rfc6570

None

example

TODO: