GET api/v2/General/Clerks/List?IncludeInactive={IncludeInactive}

Retrieves a list of system Clerks (Users).

Request Information

URI Parameters

Name	Description	Type	Additional information
IncludeInactive	Flag to include Clerks that have been marked Inactive in the return result.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of Clerk

Name	Description	Type	Additional information
Id	Clerks login Id	string	None.
Name	Clerks name.	string	None.
EmailAddress	Clerks primary email address.	string	None.
GroupEmailAddress	Clerks group email adrress.	string	None.
InactiveDate	Blank if clerk is active, otherwise the date clerk was made inactive.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "EmailAddress": "sample string 3",
    "GroupEmailAddress": "sample string 4",
    "InactiveDate": "sample string 5"
  },
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "EmailAddress": "sample string 3",
    "GroupEmailAddress": "sample string 4",
    "InactiveDate": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClerk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <Clerk>
    <EmailAddress>sample string 3</EmailAddress>
    <GroupEmailAddress>sample string 4</GroupEmailAddress>
    <Id>sample string 1</Id>
    <InactiveDate>sample string 5</InactiveDate>
    <Name>sample string 2</Name>
  </Clerk>
  <Clerk>
    <EmailAddress>sample string 3</EmailAddress>
    <GroupEmailAddress>sample string 4</GroupEmailAddress>
    <Id>sample string 1</Id>
    <InactiveDate>sample string 5</InactiveDate>
    <Name>sample string 2</Name>
  </Clerk>
</ArrayOfClerk>