Jump to

• Request
• Response

Fetch relationship master for given relationship code

get

/service/v1/relationshipmaster/associatedParty

This endpoint is used to fetch relationship master for given relationship code.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• relationshipCode: string
  Relationship code

Header Parameters

• appId: string
• branchCode: string
  branchCode
• userId: string
  userId

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created relationshipmaster

Body ()

Root Schema : AssociatedPartiesResponseList

Type: object

Response of Associated Parties Respose

Show Source

• corporates(optional): object corporates
• counterparties(optional): object counterparties
  Counterparties
• partyId(optional): string
  Party Id

{
    "description":"Response of Associated Parties Respose",
    "type":"object",
    "properties":{
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "counterparties":{
            "type":"object",
            "description":"Counterparties",
            "properties":{
                "buyer":{
                    "type":"array",
                    "description":"Contains all associated buyer Counterparty details of party Id",
                    "items":{
                        "$ref":"#/definitions/AssociatedParties"
                    }
                },
                "seller":{
                    "type":"array",
                    "description":"Contains all associated seller Counterparty details of party Id",
                    "items":{
                        "$ref":"#/definitions/AssociatedParties"
                    }
                }
            }
        },
        "corporates":{
            "type":"object",
            "properties":{
                "buyer":{
                    "type":"array",
                    "description":"Contains all associated corporate details of Buyer party Id",
                    "items":{
                        "$ref":"#/definitions/AssociatedParties"
                    }
                },
                "seller":{
                    "type":"array",
                    "description":"Contains all associated corporate details of Seller party Id",
                    "items":{
                        "$ref":"#/definitions/AssociatedParties"
                    }
                }
            }
        }
    }
}

Nested Schema : corporates

Type: object

Show Source

• buyer(optional): array buyer
  Contains all associated corporate details of Buyer party Id
• seller(optional): array seller
  Contains all associated corporate details of Seller party Id

{
    "type":"object",
    "properties":{
        "buyer":{
            "type":"array",
            "description":"Contains all associated corporate details of Buyer party Id",
            "items":{
                "$ref":"#/definitions/AssociatedParties"
            }
        },
        "seller":{
            "type":"array",
            "description":"Contains all associated corporate details of Seller party Id",
            "items":{
                "$ref":"#/definitions/AssociatedParties"
            }
        }
    }
}

Nested Schema : counterparties

Type: object

Counterparties

Show Source

• buyer(optional): array buyer
  Contains all associated buyer Counterparty details of party Id
• seller(optional): array seller
  Contains all associated seller Counterparty details of party Id

{
    "type":"object",
    "description":"Counterparties",
    "properties":{
        "buyer":{
            "type":"array",
            "description":"Contains all associated buyer Counterparty details of party Id",
            "items":{
                "$ref":"#/definitions/AssociatedParties"
            }
        },
        "seller":{
            "type":"array",
            "description":"Contains all associated seller Counterparty details of party Id",
            "items":{
                "$ref":"#/definitions/AssociatedParties"
            }
        }
    }
}

Nested Schema : buyer

Type: array

Contains all associated corporate details of Buyer party Id

Show Source

• Array of: object AssociatedParties
  Response of Associated Parties Respose

{
    "type":"array",
    "description":"Contains all associated corporate details of Buyer party Id",
    "items":{
        "$ref":"#/definitions/AssociatedParties"
    }
}

Nested Schema : seller

Type: array

Contains all associated corporate details of Seller party Id

Show Source

• Array of: object AssociatedParties
  Response of Associated Parties Respose

{
    "type":"array",
    "description":"Contains all associated corporate details of Seller party Id",
    "items":{
        "$ref":"#/definitions/AssociatedParties"
    }
}

Nested Schema : AssociatedParties

Type: object

Response of Associated Parties Respose

Show Source

• data(optional): array data
  Contains all associated buyer Counterparty details of party Id
• paging(optional): object PagingDto

{
    "description":"Response of Associated Parties Respose",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "description":"Contains all associated buyer Counterparty details of party Id",
            "items":{
                "$ref":"#/definitions/AssociatedPartyData"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Contains all associated buyer Counterparty details of party Id

Show Source

• Array of: object AssociatedPartyData
  Response of Associated Parties Response

{
    "type":"array",
    "description":"Contains all associated buyer Counterparty details of party Id",
    "items":{
        "$ref":"#/definitions/AssociatedPartyData"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : AssociatedPartyData

Type: object

Response of Associated Parties Response

Show Source

• customerId(optional): string
  Associated Counter/Corporate Id
• customerName(optional): string
  Name of associated Counter/Corporate Id

{
    "description":"Response of Associated Parties Response",
    "type":"object",
    "properties":{
        "customerId":{
            "type":"string",
            "description":"Associated Counter/Corporate Id"
        },
        "customerName":{
            "type":"string",
            "description":"Name of associated Counter/Corporate Id"
        }
    }
}

Nested Schema : buyer

Type: array

Contains all associated buyer Counterparty details of party Id

Show Source

• Array of: object AssociatedParties
  Response of Associated Parties Respose

{
    "type":"array",
    "description":"Contains all associated buyer Counterparty details of party Id",
    "items":{
        "$ref":"#/definitions/AssociatedParties"
    }
}

Nested Schema : seller

Type: array

Contains all associated seller Counterparty details of party Id

Show Source

• Array of: object AssociatedParties
  Response of Associated Parties Respose

{
    "type":"array",
    "description":"Contains all associated seller Counterparty details of party Id",
    "items":{
        "$ref":"#/definitions/AssociatedParties"
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top