Get Active Cases by User Mobile Number

Description

This endpoint returns an array of caseIds for currently open cases for a given end-user or operator.

Service Name	Get Active Cases by Mobile Number
Service Type	REST
Method	GET
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/user/actions/active-cases/mobile/{mobile}
Production URL	https://integration.himarley.io/api/api/user/actions/active-cases/mobile/{mobile}
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

 

Table of Contents

• API Request
  • Flow
  • Request Example
  • Request Path Breakdown
• API Response 
  • Response Payload Example
  • Response Fields Breakdown
• Common Errors to Handle

API Request

Flow

1. Send API request with the path parameter of the customer Mobile Number.
2. Hi Marley receives the request and validates the customer Mobile Number exists.
3. Hi Marley responds with an array of Active caseIDs associated with the passed customer Mobile Number value.

Request Example

https://integration.uat.marley.ai/api/user/actions/active-cases/mobile/8471003001

 

Request Path Breakdown

Property	Description	Type	Required	Example	Validation
mobile	The mobile number associated with the customer user profile within Hi Marley.	string	true	8471003001	user record tied to mobile exists

API Response 

Response Payload Example

[
    "8f4acac7-9e757-4cc6-a2a9-e18dfae3873b3",
    "2d76861b-5ecf-4e13d-98a6-fe7dd4ebe9f23",
    "5b993562-5b21-46c40-8dc4-18931857a1643",
    "041b1c59-2efb-4b318-98ff-d51856a9a6b73",
    "ee05a77c-68c6-4498-b5953-1db8cb7c4be13"
]

 

Response Fields Breakdown

Property	Element	Description	Type	Required	Example
array of Active case IDs		The array of case IDs will be cases that have a status of 'Open' within Hi Marley.	string	false	[     "8f4acac7-9e757-4cc6-a2a9-e18dfae3873b3",     "2d76861b-5ecf-4e13d-98a6-fe7dd4ebe9f23",     "5b993562-5b21-46c40-8dc4-18931857a1643",     "041b1c59-2efb-4b318-98ff-d51856a9a6b73",     "ee05a77c-68c6-4498-b5953-1db8cb7c4be13" ]

Common Errors to Handle

• User Not found Error