Jump to

• Request
• Response
• Examples

Get an employee number

get

{basePath}/employees

{basePath}/employees?OrgShortName=tfoinc&LocRef= fdmnh144&EmployeeId=5

API returns a specific employee.

Request

Supported Media Types

• application/json

Query Parameters

• EmployeeId(required): integer(int64)
  Employee ID number.
• locRef(required): string
  The location identifier.
• orgShortName(required): string
  The organization identifier.

Header Parameters

• If-Modified-Since: string
  Standard http caching header (http caching link).
• If-None-Match: string
  Standard http caching header (http caching link).

Back to Top

Response

Supported Media Types

• application/json

200 Response

The employee number.

Headers

• ETag: string
  The current entity-tag for the selected representation. See RFC 7232 Section 2.3 (https://tools.ietf.org/html/rfc7232#section-2.3).
• Last-Modified: string
  A timestamp indicating the date and time at which the origin server believes the selected representation was last modified. See RFC 7232 Section 2.2 (https://tools.ietf.org/html/rfc7232#section-2.2).

Body ()

Root Schema : EmployeeView

Type: object

A view of an employee for integrators.

Show Source

• employeeNumber(required): integer(int32)
  Minimum Value: 1

  Employee number.

  Example: 42

{
    "description":"A view of an employee for integrators.",
    "type":"object",
    "required":[
        "employeeNumber"
    ],
    "properties":{
        "employeeNumber":{
            "description":"Employee number.",
            "type":"integer",
            "format":"int32",
            "minimum":"1",
            "example":"42"
        }
    }
}

304 Response

304 Not Modified

400 Response

400 Bad Request

Body ()

Root Schema : EmployeesApiProblemDetails

Type: object

Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). The content type for this response is `application/problem+json`

Show Source

• details: string
  A human-readable explanation specific to this occurrence of the problem.

  Example: The OrgShortName value is required.
• instance: string
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

  Example: required_value_missing
• title: string
  A short, human-readable summary of the problem type.

  Example: Required value not specified.
• type: string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: error:validation

{
    "description":"Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807).\n\nThe content type for this response is `application/problem+json`\n",
    "type":"object",
    "example":{
        "type":"error:validation",
        "title":"Required value not specified.",
        "details":"The OrgShortName value is required.",
        "instance":"required_value_missing"
    },
    "properties":{
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"error:validation"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"Required value not specified."
        },
        "details":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"The OrgShortName value is required."
        },
        "instance":{
            "description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
            "type":"string",
            "example":"required_value_missing"
        }
    }
}

Example:

{
    "type":"error:validation",
    "title":"Required value not specified.",
    "details":"The OrgShortName value is required.",
    "instance":"required_value_missing"
}

401 Response

401 Unauthorized

403 Response

403 Forbidden

404 Response

404 Requested resource not found

Back to Top

Examples

Example Request Body

Not applicable for this endpoint.

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "employeeNumber": 42
}

Back to Top