GET api/Clients?clientId={clientId}&userId={userId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId | string |
Required |
|
userId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ClientName | Description | Type | Additional information |
---|---|---|---|
Id | string |
None. |
|
id | string |
None. |
|
IsClient | boolean |
None. |
|
UserId | string |
Required Max length: 128 |
|
Name | string |
Required Max length: 100 |
|
string |
Max length: 100 |
||
Notes | string |
Max length: 5000 |
|
Created | date |
None. |
|
LastModified | date |
None. |
|
LastSelected | date |
None. |
|
Active | boolean |
None. |
|
Deleted | date |
None. |
|
SimulationCount | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "sample string 1", "id": "sample string 2", "IsClient": true, "UserId": "sample string 3", "Name": "sample string 4", "Email": "sample string 5", "Notes": "sample string 6", "Created": "2024-12-22T23:30:09.9432456+00:00", "LastModified": "2024-12-22T23:30:09.9432456+00:00", "LastSelected": "2024-12-22T23:30:09.9432456+00:00", "Active": true, "Deleted": "2024-12-22T23:30:09.9432456+00:00", "SimulationCount": 9 }
application/xml, text/xml
Sample:
<Client xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CificoAPI.Models"> <Active>true</Active> <Created>2024-12-22T23:30:09.9432456+00:00</Created> <Deleted>2024-12-22T23:30:09.9432456+00:00</Deleted> <Email>sample string 5</Email> <Id>sample string 1</Id> <LastModified>2024-12-22T23:30:09.9432456+00:00</LastModified> <LastSelected>2024-12-22T23:30:09.9432456+00:00</LastSelected> <Name>sample string 4</Name> <Notes>sample string 6</Notes> <SimulationCount>9</SimulationCount> <UserId>sample string 3</UserId> <id>sample string 2</id> </Client>