Partner Role

Partner Role - Get

HTTP Request

GET /api/v1/partner-roles/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific partner role within the financial organization structure, identified by the provided ID, to facilitate understanding of organizational hierarchy and role responsibilities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Update

HTTP Request

PUT /api/v1/partner-roles/{id}

Interactive Demo

📋 Description: Updates the details of a specified partner role within the financial organization structure, allowing for modifications to the hierarchy and organizational alignment of financial entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	PartnerRoleDto	true	Request body containing the updated partner role information, including role attributes and hierarchy details relevant to the financial organization structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "partnerId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Delete

HTTP Request

DELETE /api/v1/partner-roles/{id}

Interactive Demo

📋 Description: Deletes a specified partner role from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Delete Or Decommission

HTTP Request

PUT /api/v1/partner-roles/remove/{id}

Interactive Demo

📋 Description: Removes a specified partner role from the financial organization structure, ensuring the hierarchy reflects current business relationships and operational needs.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Delete Or Decommission All

HTTP Request

PUT /api/v1/partner-roles/remove/bulk

Interactive Demo

📋 Description: Removes multiple partner roles from the financial organization structure in a single operation, streamlining the management of hierarchical relationships within the financial entity.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of partner role identifiers to be removed in bulk from the financial organization’s structure, ensuring efficient management of hierarchical relationships.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Decommission

HTTP Request

PUT /api/v1/partner-roles/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified partner role within the financial organization structure, effectively removing it from the hierarchy and ensuring accurate representation of the entity’s operational framework.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/partner-roles/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions partner roles within the financial organization structure that were modified before the specified date, ensuring the hierarchy remains current and aligned with organizational needs.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning partner roles in the financial organization structure, ensuring that only roles modified before this date are affected.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Decommission Before Now

HTTP Request

PUT /api/v1/partner-roles/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions partner roles that have been modified before the current date, ensuring the financial organization structure remains up-to-date and aligned with operational requirements. This operation aids in maintaining an accurate hierarchy within the financial entity.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Decommission All

HTTP Request

PUT /api/v1/partner-roles/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple partner roles within the financial organization structure, allowing for efficient management of hierarchy changes across financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of partner role identifiers and associated metadata for bulk decommissioning within the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Create Or Update Bulk

HTTP Request

PUT /api/v1/partner-roles/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple partner roles within the financial organization structure, ensuring alignment with the established hierarchy and organizational framework.

Parameters

Name	In	Type	Required	Description
body	body	PartnerRoleDto	true	Request body containing a bulk array of partner role definitions, including attributes such as role name, hierarchy level, and associated financial entity identifiers, to facilitate the creation or update of organizational structures.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Create Or Update

HTTP Request

PUT /api/v1/partner-roles/createOrUpdate

Interactive Demo

📋 Description: Creates or updates partner roles within the financial organization structure, ensuring alignment with the current hierarchy and organizational needs.

Parameters

Name	In	Type	Required	Description
body	body	PartnerRoleDto	true	Request body containing the details of partner roles, including role attributes and hierarchy information relevant to the financial organization structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "partnerId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Bulk Update

HTTP Request

PUT /api/v1/partner-roles/bulk

Interactive Demo

📋 Description: Updates multiple partner roles within the financial organization structure, allowing for efficient management of organizational hierarchy and alignment of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PartnerRoleDto	true	Request body containing an array of partner role definitions to update the organizational structure and hierarchy within the financial entity.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Bulk Create

HTTP Request

POST /api/v1/partner-roles/bulk

Interactive Demo

📋 Description: Creates multiple partner roles within the financial organization structure, enabling efficient management of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PartnerRoleDto	true	Request body containing a list of partner role definitions, including attributes such as role name, responsibilities, and associated financial entities, to facilitate the bulk creation of organizational hierarchy within the financial structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPartnerRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Bulk Delete

HTTP Request

DELETE /api/v1/partner-roles/bulk

Interactive Demo

📋 Description: Deletes multiple partner roles within the financial organization structure, enabling the efficient management of organizational hierarchy and ensuring alignment with business requirements.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of partner role identifiers to be deleted from the financial organization structure hierarchy.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Search

HTTP Request

POST /api/v1/partner-roles/search

Interactive Demo

📋 Description: Submits a request to search for partner roles within the financial organization structure, enabling users to identify and analyze hierarchical relationships and roles associated with financial entities.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	PartnerRoleDtoFilter	false	Request body containing criteria for searching partner roles within the financial organization structure, including attributes related to organizational hierarchy and entity classification.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "notDisplayIdIn": [
    "string"
  ],
  "nameLike": "string",
  "partnerIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePartnerRoleDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Detach Partner

HTTP Request

POST /api/v1/partner-roles/detach/partner/{partner_id}

Interactive Demo

📋 Description: Detaches a specified partner role from the financial organization structure, allowing for adjustments in the hierarchy and relationships within the entity. This operation is essential for maintaining accurate organizational alignment and role management.

Parameters

Name	In	Type	Required	Description
partner_id	path	integer(int64)	true	Unique identifier for the partner within the financial organization structure, used to detach the specified partner’s role from the hierarchy.
body	body	PartnerRoleDto	true	Request body containing the details of the partner role to be detached from the specified financial entity, including relevant identifiers and metadata.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Attach Partner

HTTP Request

POST /api/v1/partner-roles/attach/partner/{partner_id}

Interactive Demo

📋 Description: Attaches a specified partner role to a financial entity within the organizational structure, facilitating the integration of hierarchical relationships in the financial organization.

Parameters

Name	In	Type	Required	Description
partner_id	path	integer(int64)	true	Unique identifier for the financial entity partner, used to associate specific roles within the organizational structure.
body	body	PartnerRoleDto	true	Request body containing the details of the partner role to be attached to the specified financial entity, including role attributes and associated permissions within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Find All

HTTP Request

GET /api/v1/partner-roles

Interactive Demo

📋 Description: Retrieves a list of partner roles within the financial organization structure, providing insights into the hierarchy and relationships of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of partner roles within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePartnerRoleDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Create

HTTP Request

POST /api/v1/partner-roles

Interactive Demo

📋 Description: Creates a new partner role within the financial organization structure, enabling the establishment of hierarchical relationships and enhancing the management of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	PartnerRoleDto	true	Request body containing the details of partner roles, including role definitions and associated financial entity hierarchies, to facilitate organizational structure management.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "partnerId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePartnerRoleDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "partnerId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Get All By Partner

HTTP Request

GET /api/v1/partner-roles/partner/{id}

Interactive Demo

📋 Description: Retrieves the details of a specific partner role within the financial organization structure, identified by the provided partner ID, to support hierarchical and organizational analysis.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing users to efficiently retrieve and navigate through the hierarchical structure of partner roles within the financial organization.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePartnerRoleDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "partnerId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partner Role - Get Metadata

HTTP Request

GET /api/v1/partner-roles/meta

Interactive Demo

📋 Description: Retrieves metadata related to partner roles within the financial organization structure, providing insights into the hierarchy and relationships of financial entities. This operation supports effective organizational management and strategic decision-making.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---