GET api/admin/{visitTypeId}/GetVisitType

Gets a specific visit type.

Request Information

URI Parameters

Name	Description	Type	Additional information
visitTypeId	the id of the visit type to get.	integer	Required

Body Parameters

None.

Response Information

Resource Description

An Http response message with the folliwing status codes: 200 = success (includes the requested visit type), 204 = not found (the visit type with the provided id does not exist) 500 = something went wrong (the request was not processed).

UiVisitType

Name	Type	Additional information
visitTypeId	integer	None.
description	string	None.
label	string	None.
formId	integer	None.
dateUpdated	date	None.
showAllQuestions	boolean	None.
defaultLocationId	integer	None.
defaultDuration	integer	None.
visitType	string	None.
externalId	string	None.
flex	string	None.
numberOfVisitSigs	byte	None.
noClientSignature	boolean	None.
useEMcode	boolean	None.
backgroundColor	string	None.
defaultRecipientId	integer	None.
formVersionId	integer	None.
IsCancellation	boolean	None.
IsEvv	boolean	None.
DisableMobileDownload	boolean	None.
MidnightSplitVisit	boolean	None.
is24HourVisit	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "visitTypeId": 1,
  "description": "sample string 2",
  "label": "sample string 3",
  "formId": 1,
  "dateUpdated": "2026-05-05T07:15:54.6558581-04:00",
  "showAllQuestions": true,
  "defaultLocationId": 1,
  "defaultDuration": 1,
  "visitType": "sample string 6",
  "externalId": "sample string 7",
  "flex": "sample string 8",
  "numberOfVisitSigs": 64,
  "noClientSignature": true,
  "useEMcode": true,
  "backgroundColor": "sample string 11",
  "defaultRecipientId": 1,
  "formVersionId": 1,
  "IsCancellation": true,
  "IsEvv": true,
  "DisableMobileDownload": true,
  "MidnightSplitVisit": true,
  "is24HourVisit": true
}

application/xml, text/xml

Sample:

<UiVisitType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO">
  <DisableMobileDownload>true</DisableMobileDownload>
  <IsCancellation>true</IsCancellation>
  <IsEvv>true</IsEvv>
  <MidnightSplitVisit>true</MidnightSplitVisit>
  <backgroundColor>sample string 11</backgroundColor>
  <dateUpdated>2026-05-05T07:15:54.6558581-04:00</dateUpdated>
  <defaultDuration>1</defaultDuration>
  <defaultLocationId>1</defaultLocationId>
  <defaultRecipientId>1</defaultRecipientId>
  <description>sample string 2</description>
  <externalId>sample string 7</externalId>
  <flex>sample string 8</flex>
  <formId>1</formId>
  <formVersionId>1</formVersionId>
  <is24HourVisit>true</is24HourVisit>
  <label>sample string 3</label>
  <noClientSignature>true</noClientSignature>
  <numberOfVisitSigs>64</numberOfVisitSigs>
  <showAllQuestions>true</showAllQuestions>
  <useEMcode>true</useEMcode>
  <visitType>sample string 6</visitType>
  <visitTypeId>1</visitTypeId>
</UiVisitType>