GET All Connected Relationships

get https://example.com/lending/web/Lending/{Company}/{AccountNumber}/RelatedClients

Retrieve all connected relationships to a specific lending account.

Path Params

Company

string

required

The GET /System/Companies endpoint from the System Admin specification can be used to find an available value for this path parameter.

AccountNumber

integer

required

The GET /Lending endpoint, where the AccountNumber query parameter is utilized, from the Lending specification can be used to find an available value for this parameter.

Query Params

page_method

string

Different methods for determining the index of the first record, in the first page. Rowid returns the index of the first record in the returned page. Offset returns the index of a record in the first page offset by this value. Available options for pagination are -

Rowid (default)
Offset

page_start_id

string

Pointer to a page to start returning data from; must have been returned as part of next_url in a previous request.

page_offset

int64

The zero-based index value of the first record to return from a collection. A value of zero specifies the index of the first record in the collection. Values greater than zero specify a record index in the collection equal to page_offset + 1.

size

int32

≥ 1

Maximum number of resources to return, for any particular page, in the response; must be a positive, non-zero integer.

Responses

Response body

object

data

array of objects

data

object

Company

string

The unique code identifying a Company. Field values are accessed using the System Admin endpoint GET /System/Companies.

AccountNumber

int64

The unique code identifying an Account.

ClientNumber

int64

The unique Client Identifier. Field values are accessed using the Client Management endpoint GET /Clients/Profile.

Relationship

string

The Relationship code of the Client Relative to the Lending Account. Field values are accessed using the System Admin endpoint GET /System/Relationships.

AdditionalInformation

string

Additional information relevant to the Lending Account's Client Relationship.

page_info

object

In addition to the data returned by an API, page_info will be included if that response data has been paged.
The purpose of this object is to provide information about the page that is included in this response,
as well as information that will help build the next request.

size

int32

Number of entries included in the page of data returned in this response.

next_page_start_id

string

Identifies the starting row for the next page and should be included in the page_start_id query
parameter in the next request.
This information is also included in the next_url property as a convenience.

next_page_offset

int64

The number of records to skip in the next page. This value must be included in the page_offset
query parameter in the next request and is included in the next_url property as a convenience.
This value is not included in the last page returned.

next_url

string

Relative URL that can be used to obtain the next page of data.
If the current response is the last page in the dataset, this property will not be included.
To retrieve the next appropriate page, a subsequent request should include the same query
parameters that were used for data filtering (if any); though they will also be present in
this 'next_url' value.

401

User is not authorized for this operation

403

User does not have the authority to perform the requested action

500

An error occurred on the backend server

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.com/lending/web/Lending/Company/AccountNumber/RelatedClients \
3
     --header 'accept: application/json'


xxxxxxxxxx
17
 
1
{
2
  "data": [
3
    {
4
      "Company": "PPF",
5
      "AccountNumber": 123456,
6
      "ClientNumber": 100,
7
      "Relationship": "friend",
8
      "AdditionalInformation": "Related client is friend to the borrower and lives with the borrower."
9
    }
10
  ],
11
  "page_info": {
12
    "size": 10,
13
    "next_page_start_id": "0x00000000000b220",
14
    "next_page_offset": 200,
15
    "next_url": "obp/web/System/AMLATFRiskTypes?size=10&page_start_id=0x00000000000b220"
16
  }
17
}

200Connected Relationships were retrieved

400Unable to understand the request, due to invalid syntax

404The requested resource could not be found