Get Case By Reference ID

Description

This endpoint returns the Hi Marley case data associated to the Reference ID value passed in the request.

Service Name	Get Case By Reference ID
Service Type	REST
Method	GET
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/case/actions/get-case-by-reference/:refId
Production URL	https://integration.himarley.io/api/case/actions/get-case-by-reference/:refId
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
  • Query Parameter Breakdown
• API Response 
  • Response Payload Example
  • Response Fields Breakdown

API Request

Flow

1. Send API request with the path parameter of the Hi Marley case Reference ID.
2. Hi Marley receives the request and validates the Reference ID exists.
3. Hi Marley responds with the Case Data associated with the passed Reference ID value.

Request Example

https://integration.uat.marley.ai/api/case/actions/get-case-by-reference/0002383632

 

Request Path Breakdown

Property	Values	Description	Type	Required	Example	Validation
refId		The Reference ID associated with the Hi Marley Case.	string	true	0002383632	refId exists within Hi Marley.

 

Query Parameter Breakdown

Property	Values	Description	Type	Required	Example	Validation
allowMultiple		If set to true the service will return multiple cases if each has the same ReferenceId.	boolean	false	true

 

API Response 

Response Payload Example

{
    "caseData": {
        "id": "364ef9bb-fae5-4e2a-a746-cdca465a9c16",
        "archived": false,
        "claimNumber": "0002383632",
        "dateOfLoss": "2022-05-25T16:00:00.000Z",
        "brand": "TestBrand1"
    },
    "state": "open",
    "caseType": "claim",
    "customer": {
        "id": "3c2ea77a-5f3f-4260-8f46-5706d2ad7a28",
        "first": "Chili",
        "last": "Palmer",
        "email": "[e-mail]",
        "mobile": "[phone]",
        "role": "enduser",
        "optStatus": true,
        "optStatusDetail": "OPTED_IN"
    },
    "primaryContact": {
        "id": "18576b89-cd47-4dae-82d0-35ac08ec6387",
        "first": "Joe",
        "last": "Loop",
        "email": "[e-mail]",
        "role": "operator"
    },
    "createTime": "2022-05-26T12:24:45.562Z",
    "referenceId": "0002383632",
    "privacy": "public",
    "marleyNumber": "[phone]",
    "languagePreference": "en",
    "secondaryOperators": [
        {
            "id": "48e2ebc5-6055-4028-b384-66f03caba5fc",
            "first": "Linda",
            "last": "Moon",
            "email": "[e-mail]",
            "role": "operator"
        },
        {
            "id": "389ba0c9-5f21-464f-b995-6e0cefb6fe29",
            "first": "Nick",
            "last": "Carr",
            "email": "[e-mail]",
            "role": "operator"
        }
    ]
}

 

Response Fields Breakdown

Property	Element	Description	Type	Required	Example
caseData	id	The case identifier for the Hi Marley Case.	string	true	"id": "364ef9bb-fae5-4e2a-a746-cdca465a9c16"
	archived	Indicates if case is closed.	string	true	"archived": false
	claimNumber	Fields associated to claim/policy record.	string	true (only claim caseType)	"claimNumber": "0002383632"
	dateOfLoss		string	false	"dateOfLoss": "2022-05-25T16:00:00.000Z"
	policyNumber		string	true (only policy caseType)
	deductible		string	false
	brand	Subsidiary/Underwriter associated with case	string	true (only if brands are in-use)	"brand": "TestBrand1"
state		The current status of the case state. open close	enum	true	"state": "open"
caseType		The type of Hi Marley Case. case claim policy	enum	true	"caseType": "claim"
customer	id	The identifier generated and assigned to the customer.	string	true	"id": "3c2ea77a-5f3f-4260-8f46-5706d2ad7a28"
	first	The customers given name.	string	true	"first": "Chili"
	last	The last name of the person assigned to the Hi Marley case.	string	true	"last": "Palmer"
	email	The customers email address.	string	false	"email": "[e-mail]"
	mobile	The customers mobile number.	string	true	"mobile": "[phone]"
	role	The customers role. Always set to enduser.	enum	true	"role": "enduser"
	optStatus	The current opt status for the customer.	boolean	true	"optStatus": true
	optStatusDetail	Description of the current opt status for the customer.	string	true	"optStatusDetail": "OPTED_IN"
primaryContact	id	The identifier of the person assigned to the Hi Marley case.	string	true	"id": "18576b89-cd47-4dae-82d0-35ac08ec6387"
	first	The first name of the person assigned to the Hi Marley case.	string	true	"first": "Joe"
	last	The last name of the person assigned to the Hi Marley case.	string	true	"last": "Loop"
	email	The email of the person assigned to the Hi Marley case.	string	false	"email": "[e-mail]"
	role	The role of the person assigned to the Hi Marley case.	string	true	"role": "operator"
createTime		The time of the case creation.	smalldatetime	true	"createTime": "2022-05-26T12:24:45.562Z"
referenceId		The case reference identifier for the Hi Marley Case.	string	true	"referenceId": "0002383632"
privacy		The case privacy status. public private-redacted	enum	true	"privacy": "public"
marleyNumber		The assigned phone number from an organization pool used to conduct messaging for the current case.	string	true	"marleyNumber": "[phone]"
languagePreference		The preferred language for the current Hi Marley case.	enum	true	"languagePreference": "en"
secondaryOperators (array)	id	The identifier of the person assigned to the Hi Marley case.	string	true	"id": "48e2ebc5-6055-4028-b384-66f03caba5th"
	first	The first name of the person assigned to the Hi Marley case.	string	true	"first": "Linda"
	last	The last name of the person assigned to the Hi Marley case.	string	true	"last": "Moon"
	email	The email of the person assigned to the Hi Marley case.	string	true	"email": "[e-mail]"
	role	The role of the person assigned to the Hi Marley case.	enum	true	"role": "operator"

 

Common Errors to Handle

• [404] Case Not Found -More Details