Missouri Employee Phone Directory APIv.1
TOC

Missouri Employee Phone Directory API

Introduction

Version

v.1

Author

OA ITSD

Description

The following document describe the RESTful API of the employee phone directory.

Base URI

https://phone-directory-api.mo.gov/data_api/employeedirectory/

Index of Resources and Operations

  1. Employee phone number
    1. Search by first name
    2. Search by last name
    3. Search by phone number

1. Employee phone number

Description

This resource represents an employee phone number.

Resource URI

https://phone-directory-api.mo.gov/data_api/employeedirectory/search/

1.1 Search by first name

Description

Returns employee phone number

URI

https://phone-directory-api.mo.gov/data_api/employeedirectory/search/firstname/{firstName}

URI Parameters

{firstName}
firstname

HTTP Method

GET

Resource Formats

Authentication

Request Entities

n/a

Responses

200 OK
The data set is returned as the response entity.

Response Entities

?
1
2
3
4
5
6
{
"firstName": "JOHN",
"lastName": "DOE",
"agency": "OFFICE ADMINISTRATION-OPER",
"phoneNumber": "573-751-9999"
}
The data returned when there is an employee matching the parameter provided.

1.2 Search by last name

Description

Returns employee phone number

URI

https://phone-directory-api.mo.gov/data_api/employeedirectory/search/lastname/{lastName}

URI Parameters

{lastName}
lastName

HTTP Method

GET

Resource Formats

Authentication

Request Entities

n/a

Responses

200 OK
The data set is returned as the response entity.

Response Entities

?
1
2
3
4
5
6
{
"firstName": "JOHN",
"lastName": "DOE",
"agency": "OFFICE ADMINISTRATION-OPER",
"phoneNumber": "573-751-9999"
}
The data returned when there is an employee matching the parameter provided.

1.3 Search by phone number

Description

Returns employee phone number

URI

https://phone-directory-api.mo.gov/data_api/employeedirectory/search/phoneNumber/{phoneNumber}

URI Parameters

{phoneNumber}
phoneNumber

HTTP Method

GET

Resource Formats

Authentication

Request Entities

n/a

Responses

200 OK
The data set is returned as the response entity.

Response Entities

?
1
2
3
4
5
6
{
"firstName": "JOHN",
"lastName": "DOE",
"agency": "OFFICE ADMINISTRATION-OPER",
"phoneNumber": "573-751-9999"
}
The data returned when there is an employee phone number ends with the parameter provided.