Jump to

• Request
• Response

Fetch CounterParty Details for given External Code

get

/service/v1/relationshipmaster/nonCustomerDetails/{externalCode}

This endpoint is used to fetch CounterParty Details for given External Code.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• externalCode: string
  relationship code for filter

Header Parameters

• appId: string
• userId: string
  userId

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created relationshipmaster

Body ()

Root Schema : NonCustomerDetailsCollection

Type: object

Response of Associated Parties Respose

Show Source

• nonCustomerDetailsDTOList(optional): array nonCustomerDetailsDTOList

{
    "description":"Response of Associated Parties Respose",
    "type":"object",
    "properties":{
        "nonCustomerDetailsDTOList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NonCustomerDetailsDTO"
            }
        }
    }
}

Nested Schema : nonCustomerDetailsDTOList

Type: array

Show Source

• Array of: object NonCustomerDetailsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/NonCustomerDetailsDTO"
    }
}

Nested Schema : NonCustomerDetailsDTO

Type: object

Show Source

• corporateId(optional): string
• corporateName(optional): string
• counterpartyid(optional): string
• counterpartyname(optional): string
• counterpartyRole(optional): string
• externalCode(optional): string
• relationshipCode(optional): string
• relationshipName(optional): string

{
    "type":"object",
    "properties":{
        "corporateId":{
            "type":"string"
        },
        "corporateName":{
            "type":"string"
        },
        "relationshipCode":{
            "type":"string"
        },
        "relationshipName":{
            "type":"string"
        },
        "counterpartyid":{
            "type":"string"
        },
        "counterpartyname":{
            "type":"string"
        },
        "counterpartyRole":{
            "type":"string"
        },
        "externalCode":{
            "type":"string"
        }
    }
}

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