GET Employee groups

Overview

Returns Employee Groups. Employee Groups are used to group client records.

HTTP Request

GET /v1/realpay/{merchant_number}/general/employee_groups

Path Parameters

• merchant_number (string, required)

Query Parameters

• Version (string, required, default: v1)

Success Response (200)

Schema: EmployeeGroupsGetResponse

Example

{
  "EmployeeGroupsGetResponse": [
    {
      "EmployeeGroupCode": "GA",
      "EmployeeGroupDescription": "Group11"
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Fields

• EmployeeGroupsGetResponse[].EmployeeGroupCode (string, maxLength 2)
• EmployeeGroupsGetResponse[].EmployeeGroupDescription (string, maxLength 40)

Error Responses

• 400 BadRequest
• 401 Unauthorized
• 404 NotFound
• 500 InternalError
• 503 ServiceUnavailable