Description
This API will return the Hi Marley Operator associated with the passed email. Note that email must be passed as a header in this request.
| Service Name | Get Operator by Email |
| Service Type | REST |
| Method | GET |
| UAT (Sandbox) URL | https://integration.uat.marley.ai/api/v2/operators/ |
| Production URL | https://integration.himarley.io/api/v2/operators/ |
| Technical Documentation | View technical documentation with sample request and response payloads hosted on Postman. |
Table of Contents
API Request
Flow
- Send API request with the operator email as a header.
- Hi Marley receives the request and validates the user exists; this is validated by checking if an existing email is present for any operator in that org.
- Hi Marley responds with the operator's object data.
Request Example
HEADER: email: "james.zimmerman@himarley.com"
https://integration.uat.marley.ai/api/v2/operators/
Request Header Breakdown
| Property | Description | Type | Required | Example | Validation |
The email for the operator. |
string | true | "james.zimmerman@himarley.com" |
|
API Response
Response Payload Example
{
"id": "14db69c0-af9c-41a4-a9e9-403d4b6898ae1",
"firstName": "James",
"lastName": "Zimmerman",
"email": "james.zimmerman@himarley.com",
"mobile": "8449627539",
"title": "operator",
"roles": [
"OPERATOR"
]
}Response Fields Breakdown
| Element | Description | Type | Required | Example |
| id | The identifier generated and assigned to the operator. | string | true | "id": "14db69c0-af9c-41a4-a9e9-403d4b6898ae1" |
| firstName | The operators given name. | string | true | "first": "James" |
| lastName | The operators surname. | string | true | "last": "Zimmerman" |
| The operators email address. | string | true | "email": "james.zimmerman@himarley.com" | |
| mobile | The operators mobile number. | int | false | "mobile": "5552325555" |
title |
The operators title. |
string |
false |
"title": "operator" |
| role | The operators role. | enum | true | "role": "operator" |
Comments
0 comments
Please sign in to leave a comment.