Endpoint Parameters
-
Request parameters
Name Type Origin Description $inlinecount InlineCountValue Query-String Indication of whether the total count of elements must be returned. $skip Int Query-String Optional number of elements to skip. $top Int Query-String Optional number of elements to retrieve. 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 UserId String Body UserId to search -
Response Parameters
View Response CodesName Type Description Accounts AccountInfo [] Accounts info ClientId String ClientId ClientKey String ClientKey DefaultAccountId String Default Account Id DefaultAccountKey String Default Account key LegalAssetTypes AssetType [] Legal Assets Name String Name of the client Users UserInfo [] Users info -
Request Example
Request URL
POST cs/v2/clientinfo/clients/search/?$top=99&$skip=99&$inlinecount=None
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==", "PartnerAccountKey": "PAK - 10001/INET100JIK" } ], "ClientId": "825472", "ClientKey": "qWRC6bqfPBmkV|or68xT4A==", "ClientType": "House", "ContractType": "JointAccount", "DefaultAccountId": "82158INET", "DefaultAccountKey": "abcC6bqfPBmkV|or68xT4A==", "LegalAssetTypes": [ "Bond" ], "Name": "hll", "PartnerPlatformId": "1", "Users": [ { "UserId": "1881236", "UserKey": "aG90Uvk5z2acv5Qqtm4AgA==" } ] } ] }