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
ResponseOfListOfClientName | Description | Type | Additional information |
---|---|---|---|
Error | Error |
None. |
|
ResponseData | ResponseDataOfListOfClient |
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": "37ba1d7c-bf89-43af-a209-3c6e5b0d8e4a", "UserName": "sample string 3", "UserID": "b993e1e0-0fff-4ff1-aed9-7107bf1bb064", "CanDelete": true, "CreatorsPermission": 0 }, { "Name": "sample string 1", "ClientID": "37ba1d7c-bf89-43af-a209-3c6e5b0d8e4a", "UserName": "sample string 3", "UserID": "b993e1e0-0fff-4ff1-aed9-7107bf1bb064", "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>37ba1d7c-bf89-43af-a209-3c6e5b0d8e4a</ClientID> <UserName>sample string 3</UserName> <UserID>b993e1e0-0fff-4ff1-aed9-7107bf1bb064</UserID> <CanDelete>true</CanDelete> <CreatorsPermission>STANDARD_USER</CreatorsPermission> </Client> <Client> <Name>sample string 1</Name> <ClientID>37ba1d7c-bf89-43af-a209-3c6e5b0d8e4a</ClientID> <UserName>sample string 3</UserName> <UserID>b993e1e0-0fff-4ff1-aed9-7107bf1bb064</UserID> <CanDelete>true</CanDelete> <CreatorsPermission>STANDARD_USER</CreatorsPermission> </Client> </Detail> </ResponseData> </ResponseOfListOfClient>