CSMT-CRL-D-CustomerRelationshipManagement 1.0.10

No votes yet

Description

Microservice for Parties relationship information management

Endpoints

production

development

https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext

Paths

/v1/customers/party/relationships

create-party-relationship

Summary

Create a relationship between member and a customer

Description

Sets the relation between a member with a Customer

Security

OAuth2 Application Flow

(oauth2 application)

Token URL

https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token

Scopes

/api/v1

Client ID

X-IBM-Client-Id

(apiKey located in header)

Parameters

client_id

Required in header

string

Client ID generated during application registration

Authorization

Required in header

string

The Authorization Token received during login

Required in header

string

Content-Types that are acceptable for the response

uuid

Required in header

string

128 bit UUID that you generate for every request

Accept-Language

Optional in header

string

List of acceptable human languages for response

Content-Type

Required in header

string

Content-Types that are sent in the request

countryCode

Required in header

string

Country code in 2 character ISO 3166 format

businesscode

Required in header

string

Business code identified during application registration

ChannelId

Required in header

string

Channel where request originated

sid

Required in header

string

SessionId sent by Consumer

source

Required in header

number

SourceSystem or Source Application calling the API

{
    "maxLength": 6
}

stationName

Optional in header

string

Computer name calling or executing API

{
    "maxLength": 8
}

operator

Required in header

string

Executive ID accesing API

{
    "maxLength": 10
}

createPartyRelationshipRequest

Optional in body

object

CreatePartyRelationshipRequest

Responses

200

Successful operation.

400

Type	Code	Details
error	invalidRequest	Missing or invalid Parameters

ErrorResponse

401

Type	Code	Details
error	unAuthorized	Authorization credentials are missing or invalid

ErrorResponse

403

Type	Code	Details	More Info
error	accessNotConfigured	The request operation is not configured to access this resource	Channel/Country/Business provided in the request is not supported currently

ErrorResponse

404

Type	Code	Details	More Info
error	resourceNotFound	The requested resource was not found	Empty resource/resource not found

ErrorResponse

422

Type	Code	Details
error	businessValidationFailed	Business validation error occured on one or more parameters

ErrorResponse

500

Type	Code	Details
fatal	serverUnavailable	The request failed due to an internal error/server unavailability

ErrorResponse

Example Request

curl --request POST \
  --url https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships \
  --header 'Accept: REPLACE_THIS_VALUE' \
  --header 'Accept-Language: REPLACE_THIS_VALUE' \
  --header 'Authorization: REPLACE_THIS_VALUE' \
  --header 'ChannelId: REPLACE_THIS_VALUE' \
  --header 'Content-Type: REPLACE_THIS_VALUE' \
  --header 'X-IBM-Client-Id: REPLACE_THIS_KEY' \
  --header 'accept: application/json' \
  --header 'businesscode: REPLACE_THIS_VALUE' \
  --header 'client_id: REPLACE_THIS_VALUE' \
  --header 'content-type: application/json' \
  --header 'countryCode: REPLACE_THIS_VALUE' \
  --header 'operator: REPLACE_THIS_VALUE' \
  --header 'sid: REPLACE_THIS_VALUE' \
  --header 'source: REPLACE_THIS_VALUE' \
  --header 'stationName: REPLACE_THIS_VALUE' \
  --header 'uuid: REPLACE_THIS_VALUE' \
  --data '{"partyRelationship":{"customerId":"73335782","jobTitle":"01","partyId":"2445","percentageOwnership":25,"relationshipType":"04","partyRoleType":"01","product":{"productCode":"0993","productInstrument":"32","contractNumber":"337822"}}}'

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["X-IBM-Client-Id"] = 'REPLACE_THIS_KEY'
request["Authorization"] = 'REPLACE_THIS_VALUE'
request["client_id"] = 'REPLACE_THIS_VALUE'
request["Accept"] = 'REPLACE_THIS_VALUE'
request["uuid"] = 'REPLACE_THIS_VALUE'
request["Accept-Language"] = 'REPLACE_THIS_VALUE'
request["Content-Type"] = 'REPLACE_THIS_VALUE'
request["countryCode"] = 'REPLACE_THIS_VALUE'
request["businesscode"] = 'REPLACE_THIS_VALUE'
request["ChannelId"] = 'REPLACE_THIS_VALUE'
request["sid"] = 'REPLACE_THIS_VALUE'
request["source"] = 'REPLACE_THIS_VALUE'
request["stationName"] = 'REPLACE_THIS_VALUE'
request["operator"] = 'REPLACE_THIS_VALUE'
request["content-type"] = 'application/json'
request["accept"] = 'application/json'
request.body = "{\"partyRelationship\":{\"customerId\":\"73335782\",\"jobTitle\":\"01\",\"partyId\":\"2445\",\"percentageOwnership\":25,\"relationshipType\":\"04\",\"partyRoleType\":\"01\",\"product\":{\"productCode\":\"0993\",\"productInstrument\":\"32\",\"contractNumber\":\"337822\"}}}"

response = http.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("perf.api.externalapib2b.wlb.lac.nsroot.net:7100")

payload = "{\"partyRelationship\":{\"customerId\":\"73335782\",\"jobTitle\":\"01\",\"partyId\":\"2445\",\"percentageOwnership\":25,\"relationshipType\":\"04\",\"partyRoleType\":\"01\",\"product\":{\"productCode\":\"0993\",\"productInstrument\":\"32\",\"contractNumber\":\"337822\"}}}"

headers = {
    'X-IBM-Client-Id': "REPLACE_THIS_KEY",
    'Authorization': "REPLACE_THIS_VALUE",
    'client_id': "REPLACE_THIS_VALUE",
    'Accept': "REPLACE_THIS_VALUE",
    'uuid': "REPLACE_THIS_VALUE",
    'Accept-Language': "REPLACE_THIS_VALUE",
    'Content-Type': "REPLACE_THIS_VALUE",
    'countryCode': "REPLACE_THIS_VALUE",
    'businesscode': "REPLACE_THIS_VALUE",
    'ChannelId': "REPLACE_THIS_VALUE",
    'sid': "REPLACE_THIS_VALUE",
    'source': "REPLACE_THIS_VALUE",
    'stationName': "REPLACE_THIS_VALUE",
    'operator': "REPLACE_THIS_VALUE",
    'content-type': "application/json",
    'accept': "application/json"
    }

conn.request("POST", "/mx-gcgapi/perfext/api/v1/customers/party/relationships", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "7100",
  CURLOPT_URL => "https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"partyRelationship\":{\"customerId\":\"73335782\",\"jobTitle\":\"01\",\"partyId\":\"2445\",\"percentageOwnership\":25,\"relationshipType\":\"04\",\"partyRoleType\":\"01\",\"product\":{\"productCode\":\"0993\",\"productInstrument\":\"32\",\"contractNumber\":\"337822\"}}}",
  CURLOPT_HTTPHEADER => [
    "Accept: REPLACE_THIS_VALUE",
    "Accept-Language: REPLACE_THIS_VALUE",
    "Authorization: REPLACE_THIS_VALUE",
    "ChannelId: REPLACE_THIS_VALUE",
    "Content-Type: REPLACE_THIS_VALUE",
    "X-IBM-Client-Id: REPLACE_THIS_KEY",
    "accept: application/json",
    "businesscode: REPLACE_THIS_VALUE",
    "client_id: REPLACE_THIS_VALUE",
    "content-type: application/json",
    "countryCode: REPLACE_THIS_VALUE",
    "operator: REPLACE_THIS_VALUE",
    "sid: REPLACE_THIS_VALUE",
    "source: REPLACE_THIS_VALUE",
    "stationName: REPLACE_THIS_VALUE",
    "uuid: REPLACE_THIS_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"partyRelationship\":{\"customerId\":\"73335782\",\"jobTitle\":\"01\",\"partyId\":\"2445\",\"percentageOwnership\":25,\"relationshipType\":\"04\",\"partyRoleType\":\"01\",\"product\":{\"productCode\":\"0993\",\"productInstrument\":\"32\",\"contractNumber\":\"337822\"}}}");
Request request = new Request.Builder()
  .url("https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships")
  .post(body)
  .addHeader("X-IBM-Client-Id", "REPLACE_THIS_KEY")
  .addHeader("Authorization", "REPLACE_THIS_VALUE")
  .addHeader("client_id", "REPLACE_THIS_VALUE")
  .addHeader("Accept", "REPLACE_THIS_VALUE")
  .addHeader("uuid", "REPLACE_THIS_VALUE")
  .addHeader("Accept-Language", "REPLACE_THIS_VALUE")
  .addHeader("Content-Type", "REPLACE_THIS_VALUE")
  .addHeader("countryCode", "REPLACE_THIS_VALUE")
  .addHeader("businesscode", "REPLACE_THIS_VALUE")
  .addHeader("ChannelId", "REPLACE_THIS_VALUE")
  .addHeader("sid", "REPLACE_THIS_VALUE")
  .addHeader("source", "REPLACE_THIS_VALUE")
  .addHeader("stationName", "REPLACE_THIS_VALUE")
  .addHeader("operator", "REPLACE_THIS_VALUE")
  .addHeader("content-type", "application/json")
  .addHeader("accept", "application/json")
  .build();

Response response = client.newCall(request).execute();

const request = require('request');

const options = {
  method: 'POST',
  url: 'https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships',
  headers: {
    'X-IBM-Client-Id': 'REPLACE_THIS_KEY',
    Authorization: 'REPLACE_THIS_VALUE',
    client_id: 'REPLACE_THIS_VALUE',
    Accept: 'REPLACE_THIS_VALUE',
    uuid: 'REPLACE_THIS_VALUE',
    'Accept-Language': 'REPLACE_THIS_VALUE',
    'Content-Type': 'REPLACE_THIS_VALUE',
    countryCode: 'REPLACE_THIS_VALUE',
    businesscode: 'REPLACE_THIS_VALUE',
    ChannelId: 'REPLACE_THIS_VALUE',
    sid: 'REPLACE_THIS_VALUE',
    source: 'REPLACE_THIS_VALUE',
    stationName: 'REPLACE_THIS_VALUE',
    operator: 'REPLACE_THIS_VALUE',
    'content-type': 'application/json',
    accept: 'application/json'
  },
  body: {
    partyRelationship: {
      customerId: '73335782',
      jobTitle: '01',
      partyId: '2445',
      percentageOwnership: 25,
      relationshipType: '04',
      partyRoleType: '01',
      product: {productCode: '0993', productInstrument: '32', contractNumber: '337822'}
    }
  },
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

var client = new RestClient("https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships");
var request = new RestRequest(Method.POST);
request.AddHeader("X-IBM-Client-Id", "REPLACE_THIS_KEY");
request.AddHeader("Authorization", "REPLACE_THIS_VALUE");
request.AddHeader("client_id", "REPLACE_THIS_VALUE");
request.AddHeader("Accept", "REPLACE_THIS_VALUE");
request.AddHeader("uuid", "REPLACE_THIS_VALUE");
request.AddHeader("Accept-Language", "REPLACE_THIS_VALUE");
request.AddHeader("Content-Type", "REPLACE_THIS_VALUE");
request.AddHeader("countryCode", "REPLACE_THIS_VALUE");
request.AddHeader("businesscode", "REPLACE_THIS_VALUE");
request.AddHeader("ChannelId", "REPLACE_THIS_VALUE");
request.AddHeader("sid", "REPLACE_THIS_VALUE");
request.AddHeader("source", "REPLACE_THIS_VALUE");
request.AddHeader("stationName", "REPLACE_THIS_VALUE");
request.AddHeader("operator", "REPLACE_THIS_VALUE");
request.AddHeader("content-type", "application/json");
request.AddHeader("accept", "application/json");
request.AddParameter("REPLACE_THIS_VALUE", "{\"partyRelationship\":{\"customerId\":\"73335782\",\"jobTitle\":\"01\",\"partyId\":\"2445\",\"percentageOwnership\":25,\"relationshipType\":\"04\",\"partyRoleType\":\"01\",\"product\":{\"productCode\":\"0993\",\"productInstrument\":\"32\",\"contractNumber\":\"337822\"}}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

update-party-relationship

Summary

Updates the relationship between a party with a customer

Description

Updates the relationship between a party with a customer

Security

OAuth2 Application Flow

(oauth2 application)

Token URL

https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token

Scopes

/api/v1

Client ID

X-IBM-Client-Id

(apiKey located in header)

Parameters

client_id

Required in header

string

Client ID generated during application registration

Authorization

Required in header

string

The Authorization Token received during login

Required in header

string

Content-Types that are acceptable for the response

uuid

Required in header

string

128 bit UUID that you generate for every request

Accept-Language

Optional in header

string

List of acceptable human languages for response

Content-Type

Required in header

string

Content-Types that are sent in the request

countryCode

Required in header

string

Country code in 2 character ISO 3166 format

businesscode

Required in header

string

Business code identified during application registration

ChannelId

Required in header

string

Channel where request originated

sid

Required in header

string

SessionId sent by Consumer

stationName

Optional in header

string

Computer name calling or executing API

{
    "maxLength": 8
}

source

Required in header

number

SourceSystem or Source Application calling the API

{
    "maxLength": 6
}

operator

Required in header

string

Executive ID accesing API

{
    "maxLength": 10
}

updatePartyRelationshipRequest

Optional in body

object

UpdatePartyRelationshipRequest

Responses

200

Successful operation.

400

Type	Code	Details
error	invalidRequest	Missing or invalid Parameters

ErrorResponse

401

Type	Code	Details
error	unAuthorized	Authorization credentials are missing or invalid

ErrorResponse

403

Type	Code	Details	More Info
error	accessNotConfigured	The request operation is not configured to access this resource	Channel/Country/Business provided in the request is not supported currently

ErrorResponse

404

Type	Code	Details	More Info
error	resourceNotFound	The requested resource was not found	Empty resource/resource not found

ErrorResponse

422

Type	Code	Details
error	businessValidationFailed	Business validation error occured on one or more parameters

ErrorResponse

500

Type	Code	Details
fatal	serverUnavailable	The request failed due to an internal error/server unavailability

ErrorResponse

Example Request

curl --request PUT \
  --url https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships \
  --header 'Accept: REPLACE_THIS_VALUE' \
  --header 'Accept-Language: REPLACE_THIS_VALUE' \
  --header 'Authorization: REPLACE_THIS_VALUE' \
  --header 'ChannelId: REPLACE_THIS_VALUE' \
  --header 'Content-Type: REPLACE_THIS_VALUE' \
  --header 'X-IBM-Client-Id: REPLACE_THIS_KEY' \
  --header 'accept: application/json' \
  --header 'businesscode: REPLACE_THIS_VALUE' \
  --header 'client_id: REPLACE_THIS_VALUE' \
  --header 'content-type: application/json' \
  --header 'countryCode: REPLACE_THIS_VALUE' \
  --header 'operator: REPLACE_THIS_VALUE' \
  --header 'sid: REPLACE_THIS_VALUE' \
  --header 'source: REPLACE_THIS_VALUE' \
  --header 'stationName: REPLACE_THIS_VALUE' \
  --header 'uuid: REPLACE_THIS_VALUE' \
  --data '{"requestType":"M","partyRelationship":{"customerId":"73335782","jobTitle":"01","partyId":"2445","percentageOwnership":25,"relationshipType":"04","partyRoleType":"01","product":{"productCode":"0993","productInstrument":"32","contractNumber":"337822"}}}'

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Put.new(url)
request["X-IBM-Client-Id"] = 'REPLACE_THIS_KEY'
request["Authorization"] = 'REPLACE_THIS_VALUE'
request["client_id"] = 'REPLACE_THIS_VALUE'
request["Accept"] = 'REPLACE_THIS_VALUE'
request["uuid"] = 'REPLACE_THIS_VALUE'
request["Accept-Language"] = 'REPLACE_THIS_VALUE'
request["Content-Type"] = 'REPLACE_THIS_VALUE'
request["countryCode"] = 'REPLACE_THIS_VALUE'
request["businesscode"] = 'REPLACE_THIS_VALUE'
request["ChannelId"] = 'REPLACE_THIS_VALUE'
request["sid"] = 'REPLACE_THIS_VALUE'
request["stationName"] = 'REPLACE_THIS_VALUE'
request["source"] = 'REPLACE_THIS_VALUE'
request["operator"] = 'REPLACE_THIS_VALUE'
request["content-type"] = 'application/json'
request["accept"] = 'application/json'
request.body = "{\"requestType\":\"M\",\"partyRelationship\":{\"customerId\":\"73335782\",\"jobTitle\":\"01\",\"partyId\":\"2445\",\"percentageOwnership\":25,\"relationshipType\":\"04\",\"partyRoleType\":\"01\",\"product\":{\"productCode\":\"0993\",\"productInstrument\":\"32\",\"contractNumber\":\"337822\"}}}"

response = http.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("perf.api.externalapib2b.wlb.lac.nsroot.net:7100")

payload = "{\"requestType\":\"M\",\"partyRelationship\":{\"customerId\":\"73335782\",\"jobTitle\":\"01\",\"partyId\":\"2445\",\"percentageOwnership\":25,\"relationshipType\":\"04\",\"partyRoleType\":\"01\",\"product\":{\"productCode\":\"0993\",\"productInstrument\":\"32\",\"contractNumber\":\"337822\"}}}"

headers = {
    'X-IBM-Client-Id': "REPLACE_THIS_KEY",
    'Authorization': "REPLACE_THIS_VALUE",
    'client_id': "REPLACE_THIS_VALUE",
    'Accept': "REPLACE_THIS_VALUE",
    'uuid': "REPLACE_THIS_VALUE",
    'Accept-Language': "REPLACE_THIS_VALUE",
    'Content-Type': "REPLACE_THIS_VALUE",
    'countryCode': "REPLACE_THIS_VALUE",
    'businesscode': "REPLACE_THIS_VALUE",
    'ChannelId': "REPLACE_THIS_VALUE",
    'sid': "REPLACE_THIS_VALUE",
    'stationName': "REPLACE_THIS_VALUE",
    'source': "REPLACE_THIS_VALUE",
    'operator': "REPLACE_THIS_VALUE",
    'content-type': "application/json",
    'accept': "application/json"
    }

conn.request("PUT", "/mx-gcgapi/perfext/api/v1/customers/party/relationships", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "7100",
  CURLOPT_URL => "https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "{\"requestType\":\"M\",\"partyRelationship\":{\"customerId\":\"73335782\",\"jobTitle\":\"01\",\"partyId\":\"2445\",\"percentageOwnership\":25,\"relationshipType\":\"04\",\"partyRoleType\":\"01\",\"product\":{\"productCode\":\"0993\",\"productInstrument\":\"32\",\"contractNumber\":\"337822\"}}}",
  CURLOPT_HTTPHEADER => [
    "Accept: REPLACE_THIS_VALUE",
    "Accept-Language: REPLACE_THIS_VALUE",
    "Authorization: REPLACE_THIS_VALUE",
    "ChannelId: REPLACE_THIS_VALUE",
    "Content-Type: REPLACE_THIS_VALUE",
    "X-IBM-Client-Id: REPLACE_THIS_KEY",
    "accept: application/json",
    "businesscode: REPLACE_THIS_VALUE",
    "client_id: REPLACE_THIS_VALUE",
    "content-type: application/json",
    "countryCode: REPLACE_THIS_VALUE",
    "operator: REPLACE_THIS_VALUE",
    "sid: REPLACE_THIS_VALUE",
    "source: REPLACE_THIS_VALUE",
    "stationName: REPLACE_THIS_VALUE",
    "uuid: REPLACE_THIS_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"requestType\":\"M\",\"partyRelationship\":{\"customerId\":\"73335782\",\"jobTitle\":\"01\",\"partyId\":\"2445\",\"percentageOwnership\":25,\"relationshipType\":\"04\",\"partyRoleType\":\"01\",\"product\":{\"productCode\":\"0993\",\"productInstrument\":\"32\",\"contractNumber\":\"337822\"}}}");
Request request = new Request.Builder()
  .url("https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships")
  .put(body)
  .addHeader("X-IBM-Client-Id", "REPLACE_THIS_KEY")
  .addHeader("Authorization", "REPLACE_THIS_VALUE")
  .addHeader("client_id", "REPLACE_THIS_VALUE")
  .addHeader("Accept", "REPLACE_THIS_VALUE")
  .addHeader("uuid", "REPLACE_THIS_VALUE")
  .addHeader("Accept-Language", "REPLACE_THIS_VALUE")
  .addHeader("Content-Type", "REPLACE_THIS_VALUE")
  .addHeader("countryCode", "REPLACE_THIS_VALUE")
  .addHeader("businesscode", "REPLACE_THIS_VALUE")
  .addHeader("ChannelId", "REPLACE_THIS_VALUE")
  .addHeader("sid", "REPLACE_THIS_VALUE")
  .addHeader("stationName", "REPLACE_THIS_VALUE")
  .addHeader("source", "REPLACE_THIS_VALUE")
  .addHeader("operator", "REPLACE_THIS_VALUE")
  .addHeader("content-type", "application/json")
  .addHeader("accept", "application/json")
  .build();

Response response = client.newCall(request).execute();

const request = require('request');

const options = {
  method: 'PUT',
  url: 'https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships',
  headers: {
    'X-IBM-Client-Id': 'REPLACE_THIS_KEY',
    Authorization: 'REPLACE_THIS_VALUE',
    client_id: 'REPLACE_THIS_VALUE',
    Accept: 'REPLACE_THIS_VALUE',
    uuid: 'REPLACE_THIS_VALUE',
    'Accept-Language': 'REPLACE_THIS_VALUE',
    'Content-Type': 'REPLACE_THIS_VALUE',
    countryCode: 'REPLACE_THIS_VALUE',
    businesscode: 'REPLACE_THIS_VALUE',
    ChannelId: 'REPLACE_THIS_VALUE',
    sid: 'REPLACE_THIS_VALUE',
    stationName: 'REPLACE_THIS_VALUE',
    source: 'REPLACE_THIS_VALUE',
    operator: 'REPLACE_THIS_VALUE',
    'content-type': 'application/json',
    accept: 'application/json'
  },
  body: {
    requestType: 'M',
    partyRelationship: {
      customerId: '73335782',
      jobTitle: '01',
      partyId: '2445',
      percentageOwnership: 25,
      relationshipType: '04',
      partyRoleType: '01',
      product: {productCode: '0993', productInstrument: '32', contractNumber: '337822'}
    }
  },
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

var client = new RestClient("https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships");
var request = new RestRequest(Method.PUT);
request.AddHeader("X-IBM-Client-Id", "REPLACE_THIS_KEY");
request.AddHeader("Authorization", "REPLACE_THIS_VALUE");
request.AddHeader("client_id", "REPLACE_THIS_VALUE");
request.AddHeader("Accept", "REPLACE_THIS_VALUE");
request.AddHeader("uuid", "REPLACE_THIS_VALUE");
request.AddHeader("Accept-Language", "REPLACE_THIS_VALUE");
request.AddHeader("Content-Type", "REPLACE_THIS_VALUE");
request.AddHeader("countryCode", "REPLACE_THIS_VALUE");
request.AddHeader("businesscode", "REPLACE_THIS_VALUE");
request.AddHeader("ChannelId", "REPLACE_THIS_VALUE");
request.AddHeader("sid", "REPLACE_THIS_VALUE");
request.AddHeader("stationName", "REPLACE_THIS_VALUE");
request.AddHeader("source", "REPLACE_THIS_VALUE");
request.AddHeader("operator", "REPLACE_THIS_VALUE");
request.AddHeader("content-type", "application/json");
request.AddHeader("accept", "application/json");
request.AddParameter("REPLACE_THIS_VALUE", "{\"requestType\":\"M\",\"partyRelationship\":{\"customerId\":\"73335782\",\"jobTitle\":\"01\",\"partyId\":\"2445\",\"percentageOwnership\":25,\"relationshipType\":\"04\",\"partyRoleType\":\"01\",\"product\":{\"productCode\":\"0993\",\"productInstrument\":\"32\",\"contractNumber\":\"337822\"}}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

/v1/customers/party/customer-relationships/retrieve

retrieve-customer-relationship-by-party

Summary

Retrieve the customer information related to a party

Description

Retrieves the customer information related to a particular party

Security

OAuth2 Application Flow

(oauth2 application)

Token URL

https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token

Scopes

/api/v1

Client ID

X-IBM-Client-Id

(apiKey located in header)

Parameters

client_id

Required in header

string

Client ID generated during application registration

Authorization

Required in header

string

The Authorization Token received during login

Required in header

string

Content-Types that are acceptable for the response

uuid

Required in header

string

128 bit UUID that you generate for every request

Accept-Language

Optional in header

string

List of acceptable human languages for response

Content-Type

Required in header

string

Content-Types that are sent in the request

countryCode

Required in header

string

Country code in 2 character ISO 3166 format

businesscode

Required in header

string

Business code identified during application registration

ChannelId

Required in header

string

Channel where request originated

sid

Required in header

string

SessionId sent by Consumer

stationName

Optional in header

string

Computer name calling or executing API

{
    "maxLength": 8
}

source

Required in header

number

SourceSystem or Source Application calling the API

{
    "maxLength": 6
}

operator

Required in header

string

Executive ID accesing API

{
    "maxLength": 10
}

retrieveCustomerByPartyRequest

Optional in body

object

RetrieveCustomerByPartyRequest

Responses

200

Successful operation.

RetrieveCustomerByPartyResponse

400

Type	Code	Details
error	invalidRequest	Missing or invalid Parameters

ErrorResponse

401

Type	Code	Details
error	unAuthorized	Authorization credentials are missing or invalid

ErrorResponse

403

Type	Code	Details	More Info
error	accessNotConfigured	The request operation is not configured to access this resource	Channel/Country/Business provided in the request is not supported currently

ErrorResponse

404

Type	Code	Details	More Info
error	resourceNotFound	The requested resource was not found	Empty resource/resource not found

ErrorResponse

422

Type	Code	Details
error	businessValidationFailed	Business validation error occured on one or more parameters

ErrorResponse

500

Type	Code	Details
fatal	serverUnavailable	The request failed due to an internal error/server unavailability

ErrorResponse

Example Request

curl --request POST \
  --url https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/customer-relationships/retrieve \
  --header 'Accept: REPLACE_THIS_VALUE' \
  --header 'Accept-Language: REPLACE_THIS_VALUE' \
  --header 'Authorization: REPLACE_THIS_VALUE' \
  --header 'ChannelId: REPLACE_THIS_VALUE' \
  --header 'Content-Type: REPLACE_THIS_VALUE' \
  --header 'X-IBM-Client-Id: REPLACE_THIS_KEY' \
  --header 'accept: application/json' \
  --header 'businesscode: REPLACE_THIS_VALUE' \
  --header 'client_id: REPLACE_THIS_VALUE' \
  --header 'content-type: application/json' \
  --header 'countryCode: REPLACE_THIS_VALUE' \
  --header 'operator: REPLACE_THIS_VALUE' \
  --header 'sid: REPLACE_THIS_VALUE' \
  --header 'source: REPLACE_THIS_VALUE' \
  --header 'stationName: REPLACE_THIS_VALUE' \
  --header 'uuid: REPLACE_THIS_VALUE' \
  --data '{"partyId":"889363","pageIdWithContract":5,"pageIdWithoutContract":10}'

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/customer-relationships/retrieve")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["X-IBM-Client-Id"] = 'REPLACE_THIS_KEY'
request["Authorization"] = 'REPLACE_THIS_VALUE'
request["client_id"] = 'REPLACE_THIS_VALUE'
request["Accept"] = 'REPLACE_THIS_VALUE'
request["uuid"] = 'REPLACE_THIS_VALUE'
request["Accept-Language"] = 'REPLACE_THIS_VALUE'
request["Content-Type"] = 'REPLACE_THIS_VALUE'
request["countryCode"] = 'REPLACE_THIS_VALUE'
request["businesscode"] = 'REPLACE_THIS_VALUE'
request["ChannelId"] = 'REPLACE_THIS_VALUE'
request["sid"] = 'REPLACE_THIS_VALUE'
request["stationName"] = 'REPLACE_THIS_VALUE'
request["source"] = 'REPLACE_THIS_VALUE'
request["operator"] = 'REPLACE_THIS_VALUE'
request["content-type"] = 'application/json'
request["accept"] = 'application/json'
request.body = "{\"partyId\":\"889363\",\"pageIdWithContract\":5,\"pageIdWithoutContract\":10}"

response = http.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("perf.api.externalapib2b.wlb.lac.nsroot.net:7100")

payload = "{\"partyId\":\"889363\",\"pageIdWithContract\":5,\"pageIdWithoutContract\":10}"

headers = {
    'X-IBM-Client-Id': "REPLACE_THIS_KEY",
    'Authorization': "REPLACE_THIS_VALUE",
    'client_id': "REPLACE_THIS_VALUE",
    'Accept': "REPLACE_THIS_VALUE",
    'uuid': "REPLACE_THIS_VALUE",
    'Accept-Language': "REPLACE_THIS_VALUE",
    'Content-Type': "REPLACE_THIS_VALUE",
    'countryCode': "REPLACE_THIS_VALUE",
    'businesscode': "REPLACE_THIS_VALUE",
    'ChannelId': "REPLACE_THIS_VALUE",
    'sid': "REPLACE_THIS_VALUE",
    'stationName': "REPLACE_THIS_VALUE",
    'source': "REPLACE_THIS_VALUE",
    'operator': "REPLACE_THIS_VALUE",
    'content-type': "application/json",
    'accept': "application/json"
    }

conn.request("POST", "/mx-gcgapi/perfext/api/v1/customers/party/customer-relationships/retrieve", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "7100",
  CURLOPT_URL => "https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/customer-relationships/retrieve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"partyId\":\"889363\",\"pageIdWithContract\":5,\"pageIdWithoutContract\":10}",
  CURLOPT_HTTPHEADER => [
    "Accept: REPLACE_THIS_VALUE",
    "Accept-Language: REPLACE_THIS_VALUE",
    "Authorization: REPLACE_THIS_VALUE",
    "ChannelId: REPLACE_THIS_VALUE",
    "Content-Type: REPLACE_THIS_VALUE",
    "X-IBM-Client-Id: REPLACE_THIS_KEY",
    "accept: application/json",
    "businesscode: REPLACE_THIS_VALUE",
    "client_id: REPLACE_THIS_VALUE",
    "content-type: application/json",
    "countryCode: REPLACE_THIS_VALUE",
    "operator: REPLACE_THIS_VALUE",
    "sid: REPLACE_THIS_VALUE",
    "source: REPLACE_THIS_VALUE",
    "stationName: REPLACE_THIS_VALUE",
    "uuid: REPLACE_THIS_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"partyId\":\"889363\",\"pageIdWithContract\":5,\"pageIdWithoutContract\":10}");
Request request = new Request.Builder()
  .url("https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/customer-relationships/retrieve")
  .post(body)
  .addHeader("X-IBM-Client-Id", "REPLACE_THIS_KEY")
  .addHeader("Authorization", "REPLACE_THIS_VALUE")
  .addHeader("client_id", "REPLACE_THIS_VALUE")
  .addHeader("Accept", "REPLACE_THIS_VALUE")
  .addHeader("uuid", "REPLACE_THIS_VALUE")
  .addHeader("Accept-Language", "REPLACE_THIS_VALUE")
  .addHeader("Content-Type", "REPLACE_THIS_VALUE")
  .addHeader("countryCode", "REPLACE_THIS_VALUE")
  .addHeader("businesscode", "REPLACE_THIS_VALUE")
  .addHeader("ChannelId", "REPLACE_THIS_VALUE")
  .addHeader("sid", "REPLACE_THIS_VALUE")
  .addHeader("stationName", "REPLACE_THIS_VALUE")
  .addHeader("source", "REPLACE_THIS_VALUE")
  .addHeader("operator", "REPLACE_THIS_VALUE")
  .addHeader("content-type", "application/json")
  .addHeader("accept", "application/json")
  .build();

Response response = client.newCall(request).execute();

const request = require('request');

const options = {
  method: 'POST',
  url: 'https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/customer-relationships/retrieve',
  headers: {
    'X-IBM-Client-Id': 'REPLACE_THIS_KEY',
    Authorization: 'REPLACE_THIS_VALUE',
    client_id: 'REPLACE_THIS_VALUE',
    Accept: 'REPLACE_THIS_VALUE',
    uuid: 'REPLACE_THIS_VALUE',
    'Accept-Language': 'REPLACE_THIS_VALUE',
    'Content-Type': 'REPLACE_THIS_VALUE',
    countryCode: 'REPLACE_THIS_VALUE',
    businesscode: 'REPLACE_THIS_VALUE',
    ChannelId: 'REPLACE_THIS_VALUE',
    sid: 'REPLACE_THIS_VALUE',
    stationName: 'REPLACE_THIS_VALUE',
    source: 'REPLACE_THIS_VALUE',
    operator: 'REPLACE_THIS_VALUE',
    'content-type': 'application/json',
    accept: 'application/json'
  },
  body: {partyId: '889363', pageIdWithContract: 5, pageIdWithoutContract: 10},
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

var client = new RestClient("https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/customer-relationships/retrieve");
var request = new RestRequest(Method.POST);
request.AddHeader("X-IBM-Client-Id", "REPLACE_THIS_KEY");
request.AddHeader("Authorization", "REPLACE_THIS_VALUE");
request.AddHeader("client_id", "REPLACE_THIS_VALUE");
request.AddHeader("Accept", "REPLACE_THIS_VALUE");
request.AddHeader("uuid", "REPLACE_THIS_VALUE");
request.AddHeader("Accept-Language", "REPLACE_THIS_VALUE");
request.AddHeader("Content-Type", "REPLACE_THIS_VALUE");
request.AddHeader("countryCode", "REPLACE_THIS_VALUE");
request.AddHeader("businesscode", "REPLACE_THIS_VALUE");
request.AddHeader("ChannelId", "REPLACE_THIS_VALUE");
request.AddHeader("sid", "REPLACE_THIS_VALUE");
request.AddHeader("stationName", "REPLACE_THIS_VALUE");
request.AddHeader("source", "REPLACE_THIS_VALUE");
request.AddHeader("operator", "REPLACE_THIS_VALUE");
request.AddHeader("content-type", "application/json");
request.AddHeader("accept", "application/json");
request.AddParameter("REPLACE_THIS_VALUE", "{\"partyId\":\"889363\",\"pageIdWithContract\":5,\"pageIdWithoutContract\":10}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Example Response

Definition

POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/customer-relationships/retrieve

Response

{
  "moreInfoWithContractFlag": true,
  "moreInfoWithoutContractFlag": false,
  "pageIdWithContract": 5,
  "pageIdWithoutContract": 10,
  "party": [
    {
      "jobTitle": "CEO",
      "partyRelationship": {
        "customerId": "888093876",
        "relationshipType": "07",
        "customerName": "JUAN PABLO DE LA ROSA ALLENDE",
        "partyRoleType": "Director",
        "percentageOwnership": 30,
        "product": {
          "productCode": "0993",
          "productInstrument": "32",
          "contractNumber": "337822"
        }
      }
    }
  ]
}

/v1/customers/party/relationships/retrieve

retrieve-party-by-customer-relationship

Summary

Get the parties information just sending the client Id

Description

Get the relationship information from parties who are related to a customer

Security

OAuth2 Application Flow

(oauth2 application)

Token URL

https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token

Scopes

/api/v1

Client ID

X-IBM-Client-Id

(apiKey located in header)

Parameters

client_id

Required in header

string

Client ID generated during application registration

Authorization

Required in header

string

The Authorization Token received during login

Required in header

string

Content-Types that are acceptable for the response

uuid

Required in header

string

128 bit UUID that you generate for every request

Accept-Language

Optional in header

string

List of acceptable human languages for response

Content-Type

Required in header

string

Content-Types that are sent in the request

countryCode

Required in header

string

Country code in 2 character ISO 3166 format

businesscode

Required in header

string

Business code identified during application registration

ChannelId

Required in header

string

Channel where request originated

sid

Required in header

string

SessionId sent by Consumer

source

Required in header

number

SourceSystem or Source Application calling the API

{
    "maxLength": 6
}

operator

Required in header

string

Executive ID accesing API

{
    "maxLength": 10
}

retrievePartyRelationshipRequest

Optional in body

object

RetrievePartyRelationshipRequest

Responses

200

Successful operation.

RetrievePartyRelationshipResponse

400

Type	Code	Details
error	invalidRequest	Missing or invalid Parameters

ErrorResponse

401

Type	Code	Details
error	unAuthorized	Authorization credentials are missing or invalid

ErrorResponse

403

Type	Code	Details	More Info
error	accessNotConfigured	The request operation is not configured to access this resource	Channel/Country/Business provided in the request is not supported currently

ErrorResponse

404

Type	Code	Details	More Info
error	resourceNotFound	The requested resource was not found	Empty resource/resource not found

ErrorResponse

422

Type	Code	Details
error	businessValidationFailed	Business validation error occured on one or more parameters

ErrorResponse

500

Type	Code	Details
fatal	serverUnavailable	The request failed due to an internal error/server unavailability

ErrorResponse

Example Request

curl --request POST \
  --url https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships/retrieve \
  --header 'Accept: REPLACE_THIS_VALUE' \
  --header 'Accept-Language: REPLACE_THIS_VALUE' \
  --header 'Authorization: REPLACE_THIS_VALUE' \
  --header 'ChannelId: REPLACE_THIS_VALUE' \
  --header 'Content-Type: REPLACE_THIS_VALUE' \
  --header 'X-IBM-Client-Id: REPLACE_THIS_KEY' \
  --header 'accept: application/json' \
  --header 'businesscode: REPLACE_THIS_VALUE' \
  --header 'client_id: REPLACE_THIS_VALUE' \
  --header 'content-type: application/json' \
  --header 'countryCode: REPLACE_THIS_VALUE' \
  --header 'operator: REPLACE_THIS_VALUE' \
  --header 'sid: REPLACE_THIS_VALUE' \
  --header 'source: REPLACE_THIS_VALUE' \
  --header 'uuid: REPLACE_THIS_VALUE' \
  --data '{"customerId":"34466334","pageIdWithContract":5,"pageIdWithoutContract":10}'

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships/retrieve")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["X-IBM-Client-Id"] = 'REPLACE_THIS_KEY'
request["Authorization"] = 'REPLACE_THIS_VALUE'
request["client_id"] = 'REPLACE_THIS_VALUE'
request["Accept"] = 'REPLACE_THIS_VALUE'
request["uuid"] = 'REPLACE_THIS_VALUE'
request["Accept-Language"] = 'REPLACE_THIS_VALUE'
request["Content-Type"] = 'REPLACE_THIS_VALUE'
request["countryCode"] = 'REPLACE_THIS_VALUE'
request["businesscode"] = 'REPLACE_THIS_VALUE'
request["ChannelId"] = 'REPLACE_THIS_VALUE'
request["sid"] = 'REPLACE_THIS_VALUE'
request["source"] = 'REPLACE_THIS_VALUE'
request["operator"] = 'REPLACE_THIS_VALUE'
request["content-type"] = 'application/json'
request["accept"] = 'application/json'
request.body = "{\"customerId\":\"34466334\",\"pageIdWithContract\":5,\"pageIdWithoutContract\":10}"

response = http.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("perf.api.externalapib2b.wlb.lac.nsroot.net:7100")

payload = "{\"customerId\":\"34466334\",\"pageIdWithContract\":5,\"pageIdWithoutContract\":10}"

headers = {
    'X-IBM-Client-Id': "REPLACE_THIS_KEY",
    'Authorization': "REPLACE_THIS_VALUE",
    'client_id': "REPLACE_THIS_VALUE",
    'Accept': "REPLACE_THIS_VALUE",
    'uuid': "REPLACE_THIS_VALUE",
    'Accept-Language': "REPLACE_THIS_VALUE",
    'Content-Type': "REPLACE_THIS_VALUE",
    'countryCode': "REPLACE_THIS_VALUE",
    'businesscode': "REPLACE_THIS_VALUE",
    'ChannelId': "REPLACE_THIS_VALUE",
    'sid': "REPLACE_THIS_VALUE",
    'source': "REPLACE_THIS_VALUE",
    'operator': "REPLACE_THIS_VALUE",
    'content-type': "application/json",
    'accept': "application/json"
    }

conn.request("POST", "/mx-gcgapi/perfext/api/v1/customers/party/relationships/retrieve", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "7100",
  CURLOPT_URL => "https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships/retrieve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"customerId\":\"34466334\",\"pageIdWithContract\":5,\"pageIdWithoutContract\":10}",
  CURLOPT_HTTPHEADER => [
    "Accept: REPLACE_THIS_VALUE",
    "Accept-Language: REPLACE_THIS_VALUE",
    "Authorization: REPLACE_THIS_VALUE",
    "ChannelId: REPLACE_THIS_VALUE",
    "Content-Type: REPLACE_THIS_VALUE",
    "X-IBM-Client-Id: REPLACE_THIS_KEY",
    "accept: application/json",
    "businesscode: REPLACE_THIS_VALUE",
    "client_id: REPLACE_THIS_VALUE",
    "content-type: application/json",
    "countryCode: REPLACE_THIS_VALUE",
    "operator: REPLACE_THIS_VALUE",
    "sid: REPLACE_THIS_VALUE",
    "source: REPLACE_THIS_VALUE",
    "uuid: REPLACE_THIS_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"customerId\":\"34466334\",\"pageIdWithContract\":5,\"pageIdWithoutContract\":10}");
Request request = new Request.Builder()
  .url("https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships/retrieve")
  .post(body)
  .addHeader("X-IBM-Client-Id", "REPLACE_THIS_KEY")
  .addHeader("Authorization", "REPLACE_THIS_VALUE")
  .addHeader("client_id", "REPLACE_THIS_VALUE")
  .addHeader("Accept", "REPLACE_THIS_VALUE")
  .addHeader("uuid", "REPLACE_THIS_VALUE")
  .addHeader("Accept-Language", "REPLACE_THIS_VALUE")
  .addHeader("Content-Type", "REPLACE_THIS_VALUE")
  .addHeader("countryCode", "REPLACE_THIS_VALUE")
  .addHeader("businesscode", "REPLACE_THIS_VALUE")
  .addHeader("ChannelId", "REPLACE_THIS_VALUE")
  .addHeader("sid", "REPLACE_THIS_VALUE")
  .addHeader("source", "REPLACE_THIS_VALUE")
  .addHeader("operator", "REPLACE_THIS_VALUE")
  .addHeader("content-type", "application/json")
  .addHeader("accept", "application/json")
  .build();

Response response = client.newCall(request).execute();

const request = require('request');

const options = {
  method: 'POST',
  url: 'https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships/retrieve',
  headers: {
    'X-IBM-Client-Id': 'REPLACE_THIS_KEY',
    Authorization: 'REPLACE_THIS_VALUE',
    client_id: 'REPLACE_THIS_VALUE',
    Accept: 'REPLACE_THIS_VALUE',
    uuid: 'REPLACE_THIS_VALUE',
    'Accept-Language': 'REPLACE_THIS_VALUE',
    'Content-Type': 'REPLACE_THIS_VALUE',
    countryCode: 'REPLACE_THIS_VALUE',
    businesscode: 'REPLACE_THIS_VALUE',
    ChannelId: 'REPLACE_THIS_VALUE',
    sid: 'REPLACE_THIS_VALUE',
    source: 'REPLACE_THIS_VALUE',
    operator: 'REPLACE_THIS_VALUE',
    'content-type': 'application/json',
    accept: 'application/json'
  },
  body: {customerId: '34466334', pageIdWithContract: 5, pageIdWithoutContract: 10},
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

var client = new RestClient("https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships/retrieve");
var request = new RestRequest(Method.POST);
request.AddHeader("X-IBM-Client-Id", "REPLACE_THIS_KEY");
request.AddHeader("Authorization", "REPLACE_THIS_VALUE");
request.AddHeader("client_id", "REPLACE_THIS_VALUE");
request.AddHeader("Accept", "REPLACE_THIS_VALUE");
request.AddHeader("uuid", "REPLACE_THIS_VALUE");
request.AddHeader("Accept-Language", "REPLACE_THIS_VALUE");
request.AddHeader("Content-Type", "REPLACE_THIS_VALUE");
request.AddHeader("countryCode", "REPLACE_THIS_VALUE");
request.AddHeader("businesscode", "REPLACE_THIS_VALUE");
request.AddHeader("ChannelId", "REPLACE_THIS_VALUE");
request.AddHeader("sid", "REPLACE_THIS_VALUE");
request.AddHeader("source", "REPLACE_THIS_VALUE");
request.AddHeader("operator", "REPLACE_THIS_VALUE");
request.AddHeader("content-type", "application/json");
request.AddHeader("accept", "application/json");
request.AddParameter("REPLACE_THIS_VALUE", "{\"customerId\":\"34466334\",\"pageIdWithContract\":5,\"pageIdWithoutContract\":10}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Example Response

Definition

POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships/retrieve

Response

{
  "moreInfoWithContractFlag": true,
  "moreInfoWithoutContractFlag": false,
  "pageIdWithContract": 5,
  "pageIdWithoutContract": 10,
  "party": [
    {
      "fullName": "Fernando Diaz Miranda",
      "jobTitle": "20",
      "partyId": 4476222,
      "relationshipType": 4,
      "partyRoleType": "Director",
      "percentageOwnership": 50,
      "product": {
        "productCode": "433",
        "paymentInstrumentId": "20",
        "contractNumber": "337822"
      }
    }
  ]
}

Definitions

CreatePartyRelationshipRequest

{
    "type": "object",
    "properties": {
        "partyRelationship": {
            "$ref": "#/definitions/PartyRelationship"
        }
    }
}

PartyRelationship

{
    "type": "object",
    "properties": {
        "customerId": {
            "description": "Client number or product owner",
            "type": "string",
            "example": "73335782",
            "maxLength": 12,
            "pattern": "^\\d{12}$"
        },
        "jobTitle": {
            "description": "Type of job that the member does.",
            "type": "string",
            "example": "01",
            "maxLength": 2,
            "pattern": "^\\d{2}$"
        },
        "partyId": {
            "description": "Client number generated for the member",
            "type": "string",
            "example": "2445",
            "maxLength": 12,
            "pattern": "^\\d{12}$"
        },
        "percentageOwnership": {
            "description": "Percent of participation of the member in the product",
            "type": "number",
            "format": "float",
            "example": 25,
            "maxLength": 2,
            "pattern": "^\\d{2}$"
        },
        "relationshipType": {
            "description": "What is the member's relationship with client",
            "type": "string",
            "example": "04",
            "maxLength": 4,
            "pattern": "^\\d{4}$"
        },
        "partyRoleType": {
            "description": "Type o member",
            "type": "string",
            "example": "01",
            "maxLength": 2,
            "pattern": "^\\d{2}$"
        },
        "product": {
            "$ref": "#/definitions/Product"
        }
    },
    "required": [
        "customerId",
        "partyId",
        "partyRoleType"
    ]
}

Product

{
    "type": "object",
    "properties": {
        "productCode": {
            "description": "Banamex product ID",
            "type": "string",
            "example": "0993",
            "maxLength": 4,
            "pattern": "^\\d{4}$"
        },
        "productInstrument": {
            "description": "Instrument related to the product",
            "type": "string",
            "example": "32",
            "maxLength": 2,
            "pattern": "^\\d{2}$"
        },
        "contractNumber": {
            "description": "Client's contract",
            "type": "string",
            "example": "337822",
            "maxLength": 12,
            "pattern": "^\\d{12}$"
        }
    }
}

UpdatePartyRelationshipRequest

{
    "type": "object",
    "properties": {
        "requestType": {
            "description": "To remove or update the relation information ('V - remove', 'M - update')",
            "type": "string",
            "example": "M",
            "maxLength": 1,
            "pattern": "^[A-Z]*$"
        },
        "partyRelationship": {
            "$ref": "#/definitions/PartyRelationship"
        }
    },
    "required": [
        "requestType"
    ]
}

RetrieveCustomerByPartyRequest

{
    "type": "object",
    "properties": {
        "partyId": {
            "description": "Member Id to identify",
            "type": "string",
            "example": "889363",
            "maxLength": 12,
            "pattern": "^\\d{12}$"
        },
        "pageIdWithContract": {
            "description": "PageId for parties with contract",
            "type": "integer",
            "example": 5,
            "maxLength": 2,
            "pattern": "^\\d{2}$"
        },
        "pageIdWithoutContract": {
            "description": "PageId for parties without contract",
            "type": "integer",
            "example": 10,
            "maxLength": 2,
            "pattern": "^\\d{2}$"
        }
    },
    "required": [
        "partyId"
    ]
}

RetrieveCustomerByPartyResponse

{
    "type": "object",
    "properties": {
        "moreInfoWithContractFlag": {
            "description": "Flag to know if there is more members with a banamex contract (any kind of contract) to retrieve",
            "type": "boolean",
            "example": true
        },
        "moreInfoWithoutContractFlag": {
            "description": "Flag to know if there is more members without a banamex contract (any kind of contract) to retrieve",
            "type": "boolean",
            "example": false
        },
        "pageIdWithContract": {
            "description": "PageId for parties with contract",
            "type": "integer",
            "example": 5,
            "maxLength": 2,
            "pattern": "^\\d{2}$"
        },
        "pageIdWithoutContract": {
            "description": "PageId for parties without contract",
            "type": "integer",
            "example": 10,
            "maxLength": 2,
            "pattern": "^\\d{2}$"
        },
        "party": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/PartyDetails"
            }
        }
    }
}

PartyDetails

{
    "type": "object",
    "properties": {
        "jobTitle": {
            "description": "Type of job in the company",
            "type": "string",
            "example": "CEO"
        },
        "partyRelationship": {
            "$ref": "#/definitions/PartyRelationshipDetails"
        }
    }
}

PartyRelationshipDetails

{
    "type": "object",
    "properties": {
        "customerId": {
            "description": "Customer Id",
            "type": "string",
            "example": "888093876"
        },
        "relationshipType": {
            "description": "Relationship beetween the member and customer",
            "type": "string",
            "example": "07"
        },
        "customerName": {
            "description": "Name of the customer",
            "type": "string",
            "example": "JUAN PABLO DE LA ROSA ALLENDE"
        },
        "partyRoleType": {
            "description": "Position in the board of directors",
            "type": "string",
            "example": "Director"
        },
        "percentageOwnership": {
            "description": "Percent of amount indicated in policy",
            "type": "number",
            "format": "double",
            "example": 30
        },
        "product": {
            "$ref": "#/definitions/Product"
        }
    }
}

RetrievePartyRelationshipRequest

{
    "type": "object",
    "properties": {
        "customerId": {
            "description": "Customer Id",
            "type": "string",
            "example": "34466334",
            "maxLength": 12,
            "pattern": "^\\d{12}$"
        },
        "pageIdWithContract": {
            "description": "PageId for parties with contract",
            "type": "integer",
            "example": 5,
            "maxLength": 2,
            "pattern": "^\\d{2}$"
        },
        "pageIdWithoutContract": {
            "description": "PageId for parties without contract",
            "type": "integer",
            "example": 10,
            "maxLength": 2,
            "pattern": "^\\d{2}$"
        }
    },
    "required": [
        "customerId",
        "moreInfoWithContractFlag",
        "partiesNumberToFetch"
    ]
}

RetrievePartyRelationshipResponse

{
    "type": "object",
    "properties": {
        "moreInfoWithContractFlag": {
            "description": "Flag to know if there is more members with a banamex contract (any kind of contract) to retrieve",
            "type": "boolean",
            "example": true
        },
        "moreInfoWithoutContractFlag": {
            "description": "Flag to know if there is more members without a banamex contract (any kind of contract) to retrieve",
            "type": "boolean",
            "example": false
        },
        "pageIdWithContract": {
            "description": "PageId for parties with contract",
            "type": "integer",
            "example": 5,
            "maxLength": 2,
            "pattern": "^\\d{2}$"
        },
        "pageIdWithoutContract": {
            "description": "PageId for parties without contract",
            "type": "integer",
            "example": 10,
            "maxLength": 2,
            "pattern": "^\\d{2}$"
        },
        "party": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/PartyDetailsInformation"
            }
        }
    }
}

PartyDetailsInformation

{
    "type": "object",
    "properties": {
        "fullName": {
            "description": "Complete name of the member",
            "type": "string",
            "example": "Fernando Diaz Miranda",
            "maxLength": 55
        },
        "jobTitle": {
            "description": "Type of job in the company",
            "type": "string",
            "example": "20"
        },
        "partyId": {
            "description": "Member Id",
            "type": "integer",
            "format": "int32",
            "example": 4476222
        },
        "relationshipType": {
            "description": "Relationship between the member and customer",
            "type": "integer",
            "format": "int32",
            "example": 4
        },
        "partyRoleType": {
            "description": "Position in the board of directors",
            "type": "string",
            "example": "Director"
        },
        "percentageOwnership": {
            "description": "Percent of amount indicated in policy",
            "type": "number",
            "format": "double",
            "example": 50
        },
        "product": {
            "$ref": "#/definitions/ProductDetails"
        }
    }
}

ProductDetails

{
    "type": "object",
    "properties": {
        "productCode": {
            "description": "Product hired related to the member",
            "type": "string",
            "example": "433"
        },
        "paymentInstrumentId": {
            "description": "Instrument of payment",
            "type": "string",
            "example": "20"
        },
        "contractNumber": {
            "description": "Client's contract",
            "type": "string",
            "example": "337822"
        }
    }
}

ErrorResponse

{
    "properties": {
        "type": {
            "type": "string",
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "More Info can be used to pass any additional details",
            "type": "string"
        },
        "uuid": {
            "description": "128 bit UUID that you generate for every request",
            "type": "string"
        },
        "timestamp": {
            "description": "Timestamp of the error",
            "type": "string"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

perf.developer.banamex.com

Menu

CSMT-CRL-D-CustomerRelationshipManagement

CSMT-CRL-D-CustomerRelationshipManagement 1.0.10

Paths

/v1/customers/party/relationships

/v1/customers/party/customer-relationships/retrieve

/v1/customers/party/relationships/retrieve

Definitions