POST api/support/{practiceId}/clinical/template/{templateType}/group

Create new category group

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

doctor id in DrApp system

globally unique identifier

Required

templateType

string

Required

Body Parameters

group details

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.TemplateSummaryVo
NameDescriptionTypeAdditional information
Caption

string

None.

TemplateXRef

string

None.

TemplateType

string

None.

GroupInvoiceTemplateXRef

string

None.

Code

string

None.

Description

string

None.

SortOrder

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Caption": "sample string 1",
  "TemplateXRef": "sample string 2",
  "TemplateType": "sample string 3",
  "GroupInvoiceTemplateXRef": "sample string 4",
  "Code": "sample string 5",
  "Description": "sample string 6",
  "SortOrder": 7
}

application/xml, text/xml

Sample:
<TemplateSummaryVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
  <Caption>sample string 1</Caption>
  <Code>sample string 5</Code>
  <Description>sample string 6</Description>
  <GroupInvoiceTemplateXRef>sample string 4</GroupInvoiceTemplateXRef>
  <SortOrder>7</SortOrder>
  <TemplateType>sample string 3</TemplateType>
  <TemplateXRef>sample string 2</TemplateXRef>
</TemplateSummaryVo>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'TemplateSummaryVo'.

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.String
NameDescriptionTypeAdditional information
Sucess

boolean

None.

ResponseCode

integer

None.

ResponseMessage

string

None.

Data

string

None.

Links

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink

None.

Response Formats

application/json, text/json

Sample:
{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": "sample string 4",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<RestApiResultOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>sample string 4</Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfstring>