GET api/v1/admin/clients

Returns a list of clients.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of clients, including name, id and the creators user display name

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.Clients.Client

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.Collections.Generic.ListOfTwoSms.CustomerPortalRole.API.Admin.Clients.Client	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": [
      {
        "Name": "sample string 1",
        "ClientID": "f590dd0e-2134-45a0-a1a3-ff2709ba0b82",
        "UserName": "sample string 3",
        "UserID": "0385a87c-9d7d-4d80-9bea-2428e0453d3d",
        "CanDelete": true,
        "CreatorsPermission": 0
      },
      {
        "Name": "sample string 1",
        "ClientID": "f590dd0e-2134-45a0-a1a3-ff2709ba0b82",
        "UserName": "sample string 3",
        "UserID": "0385a87c-9d7d-4d80-9bea-2428e0453d3d",
        "CanDelete": true,
        "CreatorsPermission": 0
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfListOfClient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <Client>
        <Name>sample string 1</Name>
        <ClientID>f590dd0e-2134-45a0-a1a3-ff2709ba0b82</ClientID>
        <UserName>sample string 3</UserName>
        <UserID>0385a87c-9d7d-4d80-9bea-2428e0453d3d</UserID>
        <CanDelete>true</CanDelete>
        <CreatorsPermission>STANDARD_USER</CreatorsPermission>
      </Client>
      <Client>
        <Name>sample string 1</Name>
        <ClientID>f590dd0e-2134-45a0-a1a3-ff2709ba0b82</ClientID>
        <UserName>sample string 3</UserName>
        <UserID>0385a87c-9d7d-4d80-9bea-2428e0453d3d</UserID>
        <CanDelete>true</CanDelete>
        <CreatorsPermission>STANDARD_USER</CreatorsPermission>
      </Client>
    </Detail>
  </ResponseData>
</ResponseOfListOfClient>