POST api/VscmClientListV01?securityToken={securityToken}

Request Information

URI Parameters

Name	Description	Type	Additional information
securityToken		string	Required

Body Parameters

ClientSearchRequestV01

Name	Type	Additional information
Id	integer	None.
Ids	Collection of integer	None.
UseCache	boolean	None.
Active	boolean	None.
ClientName	string	String length: inclusive between 3 and 100
ClientNamePartial	boolean	None.
ClientNames	Collection of string	None.
Page	integer	None.
NumRows	integer	Range: inclusive between 10 and 10000

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Ids": [
    1,
    2
  ],
  "UseCache": true,
  "Active": true,
  "ClientName": "sample string 2",
  "ClientNamePartial": true,
  "ClientNames": [
    "sample string 1",
    "sample string 2"
  ],
  "Page": 1,
  "NumRows": 1
}

application/xml, text/xml

Sample:

<ClientSearchRequestV01 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VisibleSecurity.Core.Request">
  <Active>true</Active>
  <ClientName>sample string 2</ClientName>
  <ClientNamePartial>true</ClientNamePartial>
  <ClientNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ClientNames>
  <Id>1</Id>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </Ids>
  <NumRows>1</NumRows>
  <Page>1</Page>
  <UseCache>true</UseCache>
</ClientSearchRequestV01>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VscmBasePageResponseV01OfVscmClientResponseV01

Name	Type	Additional information
Page	integer	None.
Count	integer	None.
TotalPage	integer	None.
TotalCount	integer	None.
List	Collection of VscmClientResponseV01	None.
IsSuccessful	boolean	None.
Message	string	None.
TimeInMs	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "Page": 1,
  "Count": 2,
  "TotalPage": 3,
  "TotalCount": 4,
  "List": [
    {
      "ClientName": "sample string 1",
      "DisplayClientName": "sample string 2",
      "Active": true,
      "Aliases": [
        {
          "ClientAliasName": "sample string 1",
          "IsSuccessful": true,
          "Message": "sample string 2",
          "TimeInMs": 1.1
        },
        {
          "ClientAliasName": "sample string 1",
          "IsSuccessful": true,
          "Message": "sample string 2",
          "TimeInMs": 1.1
        }
      ],
      "IsSuccessful": true,
      "Message": "sample string 4",
      "TimeInMs": 1.1
    },
    {
      "ClientName": "sample string 1",
      "DisplayClientName": "sample string 2",
      "Active": true,
      "Aliases": [
        {
          "ClientAliasName": "sample string 1",
          "IsSuccessful": true,
          "Message": "sample string 2",
          "TimeInMs": 1.1
        },
        {
          "ClientAliasName": "sample string 1",
          "IsSuccessful": true,
          "Message": "sample string 2",
          "TimeInMs": 1.1
        }
      ],
      "IsSuccessful": true,
      "Message": "sample string 4",
      "TimeInMs": 1.1
    }
  ],
  "IsSuccessful": true,
  "Message": "sample string 5",
  "TimeInMs": 1.1
}

application/xml, text/xml

Sample:

<VscmBasePageResponseV01OfVscmClientResponseV01gpwYjo42 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VisibleSecurity.Core.Response">
  <IsSuccessful>true</IsSuccessful>
  <Message>sample string 5</Message>
  <TimeInMs>1.1</TimeInMs>
  <Count>2</Count>
  <List>
    <VscmClientResponseV01>
      <IsSuccessful>true</IsSuccessful>
      <Message>sample string 4</Message>
      <TimeInMs>1.1</TimeInMs>
      <Active>true</Active>
      <Aliases>
        <VscmClientAliasResponseV01>
          <IsSuccessful>true</IsSuccessful>
          <Message>sample string 2</Message>
          <TimeInMs>1.1</TimeInMs>
          <ClientAliasName>sample string 1</ClientAliasName>
        </VscmClientAliasResponseV01>
        <VscmClientAliasResponseV01>
          <IsSuccessful>true</IsSuccessful>
          <Message>sample string 2</Message>
          <TimeInMs>1.1</TimeInMs>
          <ClientAliasName>sample string 1</ClientAliasName>
        </VscmClientAliasResponseV01>
      </Aliases>
      <ClientName>sample string 1</ClientName>
      <DisplayClientName>sample string 2</DisplayClientName>
    </VscmClientResponseV01>
    <VscmClientResponseV01>
      <IsSuccessful>true</IsSuccessful>
      <Message>sample string 4</Message>
      <TimeInMs>1.1</TimeInMs>
      <Active>true</Active>
      <Aliases>
        <VscmClientAliasResponseV01>
          <IsSuccessful>true</IsSuccessful>
          <Message>sample string 2</Message>
          <TimeInMs>1.1</TimeInMs>
          <ClientAliasName>sample string 1</ClientAliasName>
        </VscmClientAliasResponseV01>
        <VscmClientAliasResponseV01>
          <IsSuccessful>true</IsSuccessful>
          <Message>sample string 2</Message>
          <TimeInMs>1.1</TimeInMs>
          <ClientAliasName>sample string 1</ClientAliasName>
        </VscmClientAliasResponseV01>
      </Aliases>
      <ClientName>sample string 1</ClientName>
      <DisplayClientName>sample string 2</DisplayClientName>
    </VscmClientResponseV01>
  </List>
  <Page>1</Page>
  <TotalCount>4</TotalCount>
  <TotalPage>3</TotalPage>
</VscmBasePageResponseV01OfVscmClientResponseV01gpwYjo42>