GET api/v2/General/Clerks/{ClerkId}

Retrieve a Clerk (User) record.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ClerkId

The Id of the Clerk record to retrieve.

 string

Required

Body Parameters

None.

Response Information

Resource Description

Clerk
NameDescriptionTypeAdditional 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"
}

application/xml, text/xml

Sample: 
<Clerk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <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>