Jump to

• Request
• Response

Fetch the relationshipmaster for given associated party

get

/service/v1/relationshipmaster/associatedParties/lov

This endpoints is used to get all relationshipmaster for given associated party.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• associatedPartyRole: string
  Can be either B/S. B-Buyer, S- Supplier.
• customerId: string
  Customer Id of associated to parties.
• customerName: string
  Customer name of associated to parties.
• isChildDataReq: string
  flag for child data required
• isNetting: boolean
  Netting flag for fetching exact CP's who are on-boarded as Buyer as well as Seller.
• name: string
  Party Name whose associated parties have to be found.
• partyId: string
  The party whose associated parties have to be identified. Either partyId or name is required. If party id and name both are sent, then system will use party id.
• relationshipCode: string
  Relationship code for filter

Header Parameters

• appId(required): string
• branchCode(required): string
  branchCode
• userId(required): 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 : AssociatedPartiesLov

Type: object

Response of Associated Parties Respose

Show Source

• data: array data
  Contains all associated buyer Counterparty details of party Id
• paging: object PagingDto
  Paging Dto

{
    "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/AssociatedPartyLovData"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Contains all associated buyer Counterparty details of party Id

Show Source

• Array of: object AssociatedPartyLovData
  Response of Associated Parties Response

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

Nested Schema : PagingDto

Type: object

Paging Dto

Show Source

• totalResults: integer
  Total Results

{
    "type":"object",
    "description":"Paging Dto",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total Results"
        }
    }
}

Nested Schema : AssociatedPartyLovData

Type: object

Response of Associated Parties Response

Show Source

• customerId: string
  Associated Counter/Corporate Id
• customerName: 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"
        }
    }
}

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