GET api/clerk/{clerkId}/shop/{shopId}/terminal/{terminal}
Provides a clerk model, given a clerk id, a shop id and a teminal id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clerkId |
The clerk id. |
string |
Required |
| shopId |
The shop id. |
integer |
Required |
| terminal |
The terminal id. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
A clerk model.
PublicAPI.Models.ClerkViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ClerkId |
Clerk id |
string |
None. |
| Terminal |
Terminal identifier |
string |
None. |
| ShopId |
Shop id |
integer |
None. |
| LastAccessedAt |
Last accessed datetime |
date |
None. |
| CreatedAt |
Creation datetime |
date |
None. |
| Language |
Clerk language |
string |
None. |
| FirstName |
First name |
string |
Required String length: inclusive between 0 and 64 |
| LastName |
Last name |
string |
Required String length: inclusive between 0 and 64 |
| CreateSource | string |
String length: inclusive between 0 and 32 |
|
| Active |
(Not)Active setting |
boolean |
None. |
| UserName |
User name |
string |
String length: inclusive between 0 and 50 |
| Password |
Password |
string |
String length: inclusive between 0 and 50 |
| UserRights |
User rights |
integer |
Range: inclusive between 1 and 3 |
| SupportParameter | integer |
Range: inclusive between 0 and 1 |
Response Formats
application/json, text/json
Sample:
{
"ClerkId": "sample string 1",
"Terminal": "sample string 2",
"ShopId": 3,
"LastAccessedAt": "2025-11-03T18:27:51.5878898+01:00",
"CreatedAt": "2025-11-03T18:27:51.5878898+01:00",
"Language": "sample string 4",
"FirstName": "sample string 5",
"LastName": "sample string 6",
"CreateSource": "sample string 7",
"Active": true,
"UserName": "sample string 9",
"Password": "sample string 10",
"UserRights": 11,
"SupportParameter": 12
}
application/xml, text/xml
Sample:
<ClerkViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models"> <Active>true</Active> <CreateSource>sample string 7</CreateSource> <FirstName>sample string 5</FirstName> <LastName>sample string 6</LastName> <Password>sample string 10</Password> <SupportParameter>12</SupportParameter> <UserName>sample string 9</UserName> <UserRights>11</UserRights> <ClerkId>sample string 1</ClerkId> <CreatedAt>2025-11-03T18:27:51.5878898+01:00</CreatedAt> <Language>sample string 4</Language> <LastAccessedAt>2025-11-03T18:27:51.5878898+01:00</LastAccessedAt> <ShopId>3</ShopId> <Terminal>sample string 2</Terminal> </ClerkViewModel>