POST api/session/end

Complete a patient visit by passing the required information Returns Compliency Status / Results

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Id	The Session Id Obtained from the initial start handshake	integer	Required
CounsellorMSISDN	The patient id / code	string	Required
VoucherCurrent	The current voucher code used	string	Required
VoucherNext	The next voucher code	string	Required
TransactionDate	The current app date (ISO 8601 Format)	date	Required
NextVisit	The patients next app date (ISO 8601 Format)	date	Required

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "CounsellorMSISDN": "sample string 2",
  "VoucherCurrent": "sample string 3",
  "VoucherNext": "sample string 4",
  "TransactionDate": "2025-12-06T21:01:14.3509768+02:00",
  "NextVisit": "2025-12-06T21:01:14.3509768+02:00"
}

application/xml, text/xml

Sample:

<Visit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MHealthCo.DataAPI.Models">
  <CounsellorMSISDN>sample string 2</CounsellorMSISDN>
  <Id>1</Id>
  <NextVisit>2025-12-06T21:01:14.3509768+02:00</NextVisit>
  <TransactionDate>2025-12-06T21:01:14.3509768+02:00</TransactionDate>
  <VoucherCurrent>sample string 3</VoucherCurrent>
  <VoucherNext>sample string 4</VoucherNext>
</Visit>

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.