Search all child counterparts based on ownerId

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  $inlinecount	String	Query-String	Specifies that the response to the request should include a count of the number of entries in the collection
  $skip	Integer	Query-String	The number of entries to skip from the beginning of the collection
  $top	Integer	Query-String	The number of entries to return from the beginning of the collection
  AccountId	String	Body	AccountId to search
  AccountKey	AccountKey	Body	AccountKey to search
  ClientId	String	Body	ClientId to search
  ClientKey	ClientKey	Body	ClientKey to search
  FieldGroups	SearchCriteriaFieldGroups []	Body	FieldGroups controlling the presence of different fields in the response
  Keywords	String	Body	Text to search in other fields, must be at least 3 characters (with at least one letter) - otherwise 4+ digits is needed
  UserId	String	Body	UserId to search

• Response Parameters

  View Response Codes

  Name	Type	Description
  __count	Number	The total count of items in the feed.
  __next	String	The link for the next page of items in the feed.
  Data	ClientSearchResponse []	The collection of entities for this feed.
  MaxRows	Number	The maximum number of rows that can be returned (if applicable).

  HTTP Code	Description
  200	OK	Indicates that the request was performed correctly (even if there is no record found).
  201	Created	Created
  400	Bad Request	Error Code Description InvalidRequest Default error code returned when it cannot be determined which part of the request is malformed.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• Request Example

  Request URL

  POST /cs/v2/clientinfo/clients/search?$inlinecount=AllPages&$skip=1&$top=1

  Request Body

  {
    "AccountId": "72158INET",
    "AccountKey": "7O7jkyRC6p0S8umNatRBKA==",
    "ClientId": "825472",
    "ClientKey": "qWRC6bqfPBmkV|or68xT4A==",
    "FieldGroups": [
      "Accounts"
    ],
    "Keywords": "",
    "UserId": "1881236"
  }
  

• Response Example

  Response body

  {
    "Data": [
      {
        "Accounts": [
          {
            "AccountDisplayName": "Stock CFD (R)",
            "AccountGroupId": "AccountGroupId1",
            "AccountGroupName": "Group1",
            "AccountId": "72158INET",
            "AccountKey": "7O7jkyRC6p0S8umNatRBKA==",
            "IsActive": false,
            "PartnerAccountKey": "PAK - 10001/INET100JIK"
          }
        ],
        "ClientId": "825472",
        "ClientKey": "qWRC6bqfPBmkV|or68xT4A==",
        "DefaultAccountId": "82158INET",
        "DefaultAccountKey": "abcC6bqfPBmkV|or68xT4A==",
        "IsActive": false,
        "LegalAssetTypes": [
          "Bond"
        ],
        "Name": "hll",
        "Users": [
          {
            "RelationshipRole": "Unknown",
            "UserId": "1881236",
            "UserKey": "aG90Uvk5z2acv5Qqtm4AgA=="
          }
        ]
      }
    ]
  }