POST api/session/start

Initiate a patient visit by passing the required information

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PatientMSISDN	The patient msisdn/mobile number	string	Required
PatientId	The patient id / code	string	Required
CurrentVisits	The patient's current visitation count	integer	Required
TotalVisits	The patient max/total visitation count	integer	Required
TransactionDate	The current app date (ISO 8601 Format)	date	Required

Request Formats

application/json, text/json

Sample:

{
  "PatientMSISDN": "sample string 1",
  "PatientId": "sample string 2",
  "CurrentVisits": 3,
  "TotalVisits": 4,
  "TransactionDate": "2025-12-06T20:59:03.7431007+02:00"
}

application/xml, text/xml

Sample:

<Start xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MHealthCo.DataAPI.Models">
  <CurrentVisits>3</CurrentVisits>
  <PatientId>sample string 2</PatientId>
  <PatientMSISDN>sample string 1</PatientMSISDN>
  <TotalVisits>4</TotalVisits>
  <TransactionDate>2025-12-06T20:59:03.7431007+02:00</TransactionDate>
</Start>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.