Backend for Frontend (0.1)

Download OpenAPI specification:Download

REST API for Frontend

Party

Get party

path Parameters
partyId
required
string
header Parameters
Prefer
string

Responses

Response samples

Content type
application/json
{
  • "partyTypeId": "string",
  • "code": "string",
  • "partyShortName": "string",
  • "partyLegalName": "string",
  • "statusId": "string",
  • "parentPartyId": 0,
  • "parentPartyCode": "string",
  • "partyClassGroupId": "string",
  • "userLoginId": 0,
  • "username": "string",
  • "partyClassificationGroupId": 0,
  • "partyClassificationGroupCode": "string",
  • "orgUnitPath": "string",
  • "commonName": "string",
  • "vendor": {
    },
  • "lastUpdatedUserLoginId": 0,
  • "attributes": [
    ],
  • "classifications": [
    ],
  • "contents": [
    ],
  • "name": "string",
  • "partyId": 0
}

Update party

path Parameters
partyId
required
integer <int32>
Request Body schema: application/json
partyTypeId
string

Party Type ID

code
string

Party Code

partyShortName
string

Party Short Name or Trade Name

partyLegalName
string

Party Legal Name

statusId
string

Party Status

parentPartyId
integer <int32>

Parent Party ID

parentPartyCode
string

Parent Party Code

partyClassGroupId
string

Party Class Group ID

userLoginId
integer <int32>

User Login ID

username
string

Username

partyClassificationGroupId
integer <int32>

Party Classification Group ID

partyClassificationGroupCode
string

Party Class Group Code

orgUnitPath
string

Organization Unit Path

commonName
string

Common Name

object (Vendor)

Vendor

lastUpdatedUserLoginId
integer <int32>

Last Updated User Login ID

Array of objects (PartyAttribute) unique

Party Attributes

Array of objects (PartyClassification) unique

PartyClassifications

Array of objects (PartyContent) unique

Contents

name
string
partyId
integer <int32>

Primary Key

Responses

Request samples

Content type
application/json
{
  • "partyTypeId": "string",
  • "code": "string",
  • "partyShortName": "string",
  • "partyLegalName": "string",
  • "statusId": "string",
  • "parentPartyId": 0,
  • "parentPartyCode": "string",
  • "partyClassGroupId": "string",
  • "userLoginId": 0,
  • "username": "string",
  • "partyClassificationGroupId": 0,
  • "partyClassificationGroupCode": "string",
  • "orgUnitPath": "string",
  • "commonName": "string",
  • "vendor": {
    },
  • "lastUpdatedUserLoginId": 0,
  • "attributes": [
    ],
  • "classifications": [
    ],
  • "contents": [
    ],
  • "name": "string",
  • "partyId": 0
}

Response samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "success": true,
  • "warnings": {
    },
  • "errors": {
    },
  • "comment": {
    },
  • "uniqueID": {
    }
}

Get party mechanisms

path Parameters
partyId
required
integer <int32>
partyContactMechId
required
string

Responses

Response samples

Content type
application/json
{
  • "partyContactMechId": 0,
  • "partyId": 0,
  • "contactMechId": 0,
  • "contactMechPurposeTypeId": "string",
  • "fromDate": "2019-08-24",
  • "thruDate": "2019-08-24",
  • "roleTypeId": "string",
  • "allowSolicitation": true,
  • "extension": "string",
  • "verified": true,
  • "yearsWithContactMech": 0,
  • "monthsWithContactMech": 0,
  • "partyContactMechPurposes": [
    ],
  • "contactMechTypeId": "string",
  • "contactMechTypeName": "string",
  • "contactMechPurposeTypeName": "string",
  • "infoString": "string"
}

Update Party contact mechanisms

path Parameters
partyId
required
integer <int32>
partyContactMechId
required
integer <int32>
Request Body schema: application/json
partyContactMechId
integer <int32>

Primary Key

partyId
integer <int32>

Party ID

contactMechId
integer <int32>

Contact Mechanism ID

contactMechPurposeTypeId
string

Contact Mechanism Purpose Type ID

fromDate
string <date>

From Date

thruDate
string <date>

Thru Date

roleTypeId
string

Role Type ID

allowSolicitation
boolean

Allow Solicitation

extension
string

Extension

verified
boolean

Verified

yearsWithContactMech
integer <int32>

Years with Contact Mechanism

monthsWithContactMech
integer <int32>

Months with Contact Mechanism

Array of objects (PartyContactMechPurpose) unique

Party Contact Mechanism Purposes

contactMechTypeId
string

Contact Mechanism Type ID

contactMechTypeName
string

Contact Mechanism Type Name

contactMechPurposeTypeName
string

Contact Mechanism Purpose Type Name

infoString
string

Info String

Responses

Request samples

Content type
application/json
{
  • "partyContactMechId": 0,
  • "partyId": 0,
  • "contactMechId": 0,
  • "contactMechPurposeTypeId": "string",
  • "fromDate": "2019-08-24",
  • "thruDate": "2019-08-24",
  • "roleTypeId": "string",
  • "allowSolicitation": true,
  • "extension": "string",
  • "verified": true,
  • "yearsWithContactMech": 0,
  • "monthsWithContactMech": 0,
  • "partyContactMechPurposes": [
    ],
  • "contactMechTypeId": "string",
  • "contactMechTypeName": "string",
  • "contactMechPurposeTypeName": "string",
  • "infoString": "string"
}

Response samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "success": true,
  • "warnings": {
    },
  • "errors": {
    },
  • "comment": {
    },
  • "uniqueID": {
    }
}

Search parties

query Parameters
field
string
keyword
string
partyCode
string
username
string
email
string
parentId
integer <int32>
partyId
integer <int32>
partyTypeId
string
roleTypeId
string
orgUnitPath
string
start
integer <int32>
limit
integer <int32>
view
string

Responses

Add a new party

Request Body schema: application/json
partyTypeId
string

Party Type ID

code
string

Party Code

partyShortName
string

Party Short Name or Trade Name

partyLegalName
string

Party Legal Name

statusId
string

Party Status

parentPartyId
integer <int32>

Parent Party ID

parentPartyCode
string

Parent Party Code

partyClassGroupId
string

Party Class Group ID

userLoginId
integer <int32>

User Login ID

username
string

Username

partyClassificationGroupId
integer <int32>

Party Classification Group ID

partyClassificationGroupCode
string

Party Class Group Code

orgUnitPath
string

Organization Unit Path

commonName
string

Common Name

object (Vendor)

Vendor

lastUpdatedUserLoginId
integer <int32>

Last Updated User Login ID

Array of objects (PartyAttribute) unique

Party Attributes

Array of objects (PartyClassification) unique

PartyClassifications

Array of objects (PartyContent) unique

Contents

name
string
partyId
integer <int32>

Primary Key

Responses

Request samples

Content type
application/json
{
  • "partyTypeId": "string",
  • "code": "string",
  • "partyShortName": "string",
  • "partyLegalName": "string",
  • "statusId": "string",
  • "parentPartyId": 0,
  • "parentPartyCode": "string",
  • "partyClassGroupId": "string",
  • "userLoginId": 0,
  • "username": "string",
  • "partyClassificationGroupId": 0,
  • "partyClassificationGroupCode": "string",
  • "orgUnitPath": "string",
  • "commonName": "string",
  • "vendor": {
    },
  • "lastUpdatedUserLoginId": 0,
  • "attributes": [
    ],
  • "classifications": [
    ],
  • "contents": [
    ],
  • "name": "string",
  • "partyId": 0
}

Response samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "success": true,
  • "warnings": {
    },
  • "errors": {
    },
  • "comment": {
    },
  • "uniqueID": {
    }
}

Get Party contact mechanisms

path Parameters
partyId
required
integer <int32>
query Parameters
contactMechTypeId
string
contactMechPurposeTypeId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Party contact mechanisms

path Parameters
partyId
required
integer <int32>
Request Body schema: application/json
partyContactMechId
integer <int32>

Primary Key

partyId
integer <int32>

Party ID

contactMechId
integer <int32>

Contact Mechanism ID

contactMechPurposeTypeId
string

Contact Mechanism Purpose Type ID

fromDate
string <date>

From Date

thruDate
string <date>

Thru Date

roleTypeId
string

Role Type ID

allowSolicitation
boolean

Allow Solicitation

extension
string

Extension

verified
boolean

Verified

yearsWithContactMech
integer <int32>

Years with Contact Mechanism

monthsWithContactMech
integer <int32>

Months with Contact Mechanism

Array of objects (PartyContactMechPurpose) unique

Party Contact Mechanism Purposes

contactMechTypeId
string

Contact Mechanism Type ID

contactMechTypeName
string

Contact Mechanism Type Name

contactMechPurposeTypeName
string

Contact Mechanism Purpose Type Name

infoString
string

Info String

Responses

Request samples

Content type
application/json
{
  • "partyContactMechId": 0,
  • "partyId": 0,
  • "contactMechId": 0,
  • "contactMechPurposeTypeId": "string",
  • "fromDate": "2019-08-24",
  • "thruDate": "2019-08-24",
  • "roleTypeId": "string",
  • "allowSolicitation": true,
  • "extension": "string",
  • "verified": true,
  • "yearsWithContactMech": 0,
  • "monthsWithContactMech": 0,
  • "partyContactMechPurposes": [
    ],
  • "contactMechTypeId": "string",
  • "contactMechTypeName": "string",
  • "contactMechPurposeTypeName": "string",
  • "infoString": "string"
}

Response samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "success": true,
  • "warnings": {
    },
  • "errors": {
    },
  • "comment": {
    },
  • "uniqueID": {
    }
}

Get leads

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add new leads

Request Body schema: application/json
partyTypeId
string

Party Type ID

code
string

Party Code

partyShortName
string

Party Short Name or Trade Name

partyLegalName
string

Party Legal Name

statusId
string

Party Status

parentPartyId
integer <int32>

Parent Party ID

parentPartyCode
string

Parent Party Code

partyClassGroupId
string

Party Class Group ID

userLoginId
integer <int32>

User Login ID

username
string

Username

partyClassificationGroupId
integer <int32>

Party Classification Group ID

partyClassificationGroupCode
string

Party Class Group Code

orgUnitPath
string

Organization Unit Path

commonName
string

Common Name

object (Vendor)

Vendor

lastUpdatedUserLoginId
integer <int32>

Last Updated User Login ID

Array of objects (PartyAttribute) unique

Party Attributes

Array of objects (PartyClassification) unique

PartyClassifications

Array of objects (PartyContent) unique

Contents

name
string
partyId
integer <int32>

Primary Key

Responses

Request samples

Content type
application/json
{
  • "partyTypeId": "string",
  • "code": "string",
  • "partyShortName": "string",
  • "partyLegalName": "string",
  • "statusId": "string",
  • "parentPartyId": 0,
  • "parentPartyCode": "string",
  • "partyClassGroupId": "string",
  • "userLoginId": 0,
  • "username": "string",
  • "partyClassificationGroupId": 0,
  • "partyClassificationGroupCode": "string",
  • "orgUnitPath": "string",
  • "commonName": "string",
  • "vendor": {
    },
  • "lastUpdatedUserLoginId": 0,
  • "attributes": [
    ],
  • "classifications": [
    ],
  • "contents": [
    ],
  • "name": "string",
  • "partyId": 0
}

Response samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "success": true,
  • "warnings": {
    },
  • "errors": {
    },
  • "comment": {
    },
  • "uniqueID": {
    }
}

Get party relationships

path Parameters
partyId
required
integer <int32>
query Parameters
roleTypeIdFrom
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get employee basic infos

path Parameters
partyId
required
integer <int32>
query Parameters
keywords
string
username
string
isEnabled
boolean
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalElements": 0,
  • "elements": [
    ]
}

Get Party Available Credits

path Parameters
partyId
required
integer <int32>
query Parameters
fromPartyId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "partyIdFrom": 0,
  • "partyIdTo": 0,
  • "availableCredits": 0,
  • "creditLimit": 0
}

Customer Profile

Profile Read

Request Body schema: application/json
echoToken
string

A reference for additional message identification, assigned by the requesting host system.

timestamp
integer <int64>

ISO 8601 encoded timestamp indicating the creation date and time of the message.

target
string

Test or Production target system indicator.

targetName
string

The name of the Test or Production system.

version
string

The OpenTravel message version indicated by a decimal value.

transactionIdentifier
string

Unique identifier to relate all messages within a transaction (e.g. this would be sent in all request and response messages that are part of an on-going transaction).

sequenceNmbr
integer <int32>

The sequence number of the transaction assigned by the sending system for ordered message processing or message resynchronization.

transactionStatusCode
string

This indicates where this message falls within a sequence of messages.

retransmissionIndicator
boolean

When true, indicates the message is being re-sent after a failure.

correlationID
string

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.

primaryLangID
string

The primary language preference for the message encoded as ISO 639-3.

altLangID
string

The alternate language for a customer or message encoded as ISO 639-3.

object (UniqueIDType)

Provides unique identification information.

offset
integer <int32>
limit
integer <int32>
maxResponses
integer <int32>
detailsInd
boolean
object (ReadRequests)

A grouping of Read Requests by travel vertical.

Responses

Request samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "uniqueID": {
    },
  • "offset": 0,
  • "limit": 0,
  • "maxResponses": 0,
  • "detailsInd": true,
  • "readRequests": {
    }
}

Response samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "success": true,
  • "warnings": {
    },
  • "errors": {
    },
  • "infos": {
    },
  • "comment": {
    },
  • "uniqueIDs": [
    ],
  • "profiles": {
    }
}

Profile Modify

Request Body schema: application/json
echoToken
string

A reference for additional message identification, assigned by the requesting host system.

timestamp
integer <int64>

ISO 8601 encoded timestamp indicating the creation date and time of the message.

target
string

Test or Production target system indicator.

targetName
string

The name of the Test or Production system.

version
string

The OpenTravel message version indicated by a decimal value.

transactionIdentifier
string

Unique identifier to relate all messages within a transaction (e.g. this would be sent in all request and response messages that are part of an on-going transaction).

sequenceNmbr
integer <int32>

The sequence number of the transaction assigned by the sending system for ordered message processing or message resynchronization.

transactionStatusCode
string

This indicates where this message falls within a sequence of messages.

retransmissionIndicator
boolean

When true, indicates the message is being re-sent after a failure.

correlationID
string

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.

primaryLangID
string

The primary language preference for the message encoded as ISO 639-3.

altLangID
string

The alternate language for a customer or message encoded as ISO 639-3.

Array of objects (UniqueIDType)

Identifies the profile for which information is being merged from the profiles identified by the ObsoleteProfileID together with the owner of the profile or an id provided by the client.

object (ProfileType)

Root element for profile content.

object (POSType)

Point of Sale (POS) identifies the party or connection channel making the request.

Responses

Request samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "uniqueIDs": [
    ],
  • "profileModify": {
    },
  • "pos": {
    }
}

Response samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "success": true,
  • "warnings": {
    },
  • "errors": {
    },
  • "infos": {
    },
  • "comment": {
    },
  • "uniqueIDs": [
    ]
}

Profile Create

Request Body schema: application/json
echoToken
string

A reference for additional message identification, assigned by the requesting host system.

timestamp
integer <int64>

ISO 8601 encoded timestamp indicating the creation date and time of the message.

target
string

Test or Production target system indicator.

targetName
string

The name of the Test or Production system.

version
string

The OpenTravel message version indicated by a decimal value.

transactionIdentifier
string

Unique identifier to relate all messages within a transaction (e.g. this would be sent in all request and response messages that are part of an on-going transaction).

sequenceNmbr
integer <int32>

The sequence number of the transaction assigned by the sending system for ordered message processing or message resynchronization.

transactionStatusCode
string

This indicates where this message falls within a sequence of messages.

retransmissionIndicator
boolean

When true, indicates the message is being re-sent after a failure.

correlationID
string

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.

primaryLangID
string

The primary language preference for the message encoded as ISO 639-3.

altLangID
string

The alternate language for a customer or message encoded as ISO 639-3.

object (UniqueIDType)

Provides unique identification information.

object (ProfileType)

Root element for profile content.

object (POSType)

Point of Sale (POS) identifies the party or connection channel making the request.

Responses

Request samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "uniqueID": {
    },
  • "profile": {
    },
  • "pos": {
    }
}

Response samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "success": true,
  • "warnings": {
    },
  • "errors": {
    },
  • "infos": {
    },
  • "comment": {
    },
  • "uniqueIDs": [
    ]
}

Communication

Send Enquiry Email

Request Body schema: application/json
subject
string

Subject

toAddresses
Array of strings

To Addresses

toName
string

To Name

fromEmail
string

From Email

fromName
string

From Name

htmlMsg
string

HTML Message

templateName
string

Template Name

object

Data Model

attachments
Array of strings

Attachments

object

Data Map

bcc
Array of strings

Blind Copy Addresses (bcc)

cc
Array of strings

Carbon Copy Addresses (cc)

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "toAddresses": [
    ],
  • "toName": "string",
  • "fromEmail": "string",
  • "fromName": "string",
  • "htmlMsg": "string",
  • "templateName": "string",
  • "dataModel": {
    },
  • "attachments": [
    ],
  • "dataMap": {
    },
  • "bcc": [
    ],
  • "cc": [
    ]
}

Response samples

Content type
application/json
{
  • "echoToken": "string",
  • "timestamp": 0,
  • "target": "string",
  • "targetName": "string",
  • "version": "string",
  • "transactionIdentifier": "string",
  • "sequenceNmbr": 0,
  • "transactionStatusCode": "string",
  • "retransmissionIndicator": true,
  • "correlationID": "string",
  • "primaryLangID": "string",
  • "altLangID": "string",
  • "success": true,
  • "warnings": {
    },
  • "errors": {
    },
  • "comment": {
    },
  • "uniqueID": {
    }
}