POST MyPortal/GetFormForImport

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Models.ImportFormRequest

Name	Type	Additional information
AppKey	globally unique identifier	None.
CustomerId	integer	None.
PracticeId	integer	None.
ImportFormId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "AppKey": "14507197-0bf6-4daa-87a2-417ebdda6afd",
  "CustomerId": 2,
  "PracticeId": 3,
  "ImportFormId": 4
}

application/xml, text/xml

Sample:

<ImportFormRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <AppKey>14507197-0bf6-4daa-87a2-417ebdda6afd</AppKey>
  <CustomerId>2</CustomerId>
  <ImportFormId>4</ImportFormId>
  <PracticeId>3</PracticeId>
</ImportFormRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientComms.API.Models.ImportFormResponse

Name	Type	Additional information
FormName	string	None.
FormContentType	PatientComms.DataAccess.Enumerations.Forms.FormContentType	None.
FormGroups	Collection of PatientComms.API.Models.FormGroupItem	None.
ErrorMessage	string	None.
ErrorStackTrace	string	None.

Response Formats

application/json, text/json

Sample:

{
  "FormName": "sample string 1",
  "FormContentType": 0,
  "FormGroups": [
    {
      "SortOrder": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "FormGroupType": 0,
      "ImportFormFields": [
        {
          "SortOrder": 1,
          "Name": "sample string 2",
          "Description": "sample string 3",
          "Type": 0,
          "Required": true,
          "ImportFormFieldOptions": [
            {
              "SortOrder": 1,
              "Text": "sample string 2",
              "OptionType": 0
            },
            {
              "SortOrder": 1,
              "Text": "sample string 2",
              "OptionType": 0
            }
          ]
        },
        {
          "SortOrder": 1,
          "Name": "sample string 2",
          "Description": "sample string 3",
          "Type": 0,
          "Required": true,
          "ImportFormFieldOptions": [
            {
              "SortOrder": 1,
              "Text": "sample string 2",
              "OptionType": 0
            },
            {
              "SortOrder": 1,
              "Text": "sample string 2",
              "OptionType": 0
            }
          ]
        }
      ]
    },
    {
      "SortOrder": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "FormGroupType": 0,
      "ImportFormFields": [
        {
          "SortOrder": 1,
          "Name": "sample string 2",
          "Description": "sample string 3",
          "Type": 0,
          "Required": true,
          "ImportFormFieldOptions": [
            {
              "SortOrder": 1,
              "Text": "sample string 2",
              "OptionType": 0
            },
            {
              "SortOrder": 1,
              "Text": "sample string 2",
              "OptionType": 0
            }
          ]
        },
        {
          "SortOrder": 1,
          "Name": "sample string 2",
          "Description": "sample string 3",
          "Type": 0,
          "Required": true,
          "ImportFormFieldOptions": [
            {
              "SortOrder": 1,
              "Text": "sample string 2",
              "OptionType": 0
            },
            {
              "SortOrder": 1,
              "Text": "sample string 2",
              "OptionType": 0
            }
          ]
        }
      ]
    }
  ],
  "ErrorMessage": "sample string 2",
  "ErrorStackTrace": "sample string 3"
}

application/xml, text/xml

Sample:

<ImportFormResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <ErrorStackTrace>sample string 3</ErrorStackTrace>
  <FormContentType>MedicalHistoryForm</FormContentType>
  <FormGroups>
    <FormGroupItem>
      <Description>sample string 3</Description>
      <FormGroupType>Unknown</FormGroupType>
      <ImportFormFields>
        <ImportFormField>
          <Description>sample string 3</Description>
          <ImportFormFieldOptions>
            <ImportFormFieldOptions>
              <OptionType>Unknown</OptionType>
              <SortOrder>1</SortOrder>
              <Text>sample string 2</Text>
            </ImportFormFieldOptions>
            <ImportFormFieldOptions>
              <OptionType>Unknown</OptionType>
              <SortOrder>1</SortOrder>
              <Text>sample string 2</Text>
            </ImportFormFieldOptions>
          </ImportFormFieldOptions>
          <Name>sample string 2</Name>
          <Required>true</Required>
          <SortOrder>1</SortOrder>
          <Type>Text</Type>
        </ImportFormField>
        <ImportFormField>
          <Description>sample string 3</Description>
          <ImportFormFieldOptions>
            <ImportFormFieldOptions>
              <OptionType>Unknown</OptionType>
              <SortOrder>1</SortOrder>
              <Text>sample string 2</Text>
            </ImportFormFieldOptions>
            <ImportFormFieldOptions>
              <OptionType>Unknown</OptionType>
              <SortOrder>1</SortOrder>
              <Text>sample string 2</Text>
            </ImportFormFieldOptions>
          </ImportFormFieldOptions>
          <Name>sample string 2</Name>
          <Required>true</Required>
          <SortOrder>1</SortOrder>
          <Type>Text</Type>
        </ImportFormField>
      </ImportFormFields>
      <Name>sample string 2</Name>
      <SortOrder>1</SortOrder>
    </FormGroupItem>
    <FormGroupItem>
      <Description>sample string 3</Description>
      <FormGroupType>Unknown</FormGroupType>
      <ImportFormFields>
        <ImportFormField>
          <Description>sample string 3</Description>
          <ImportFormFieldOptions>
            <ImportFormFieldOptions>
              <OptionType>Unknown</OptionType>
              <SortOrder>1</SortOrder>
              <Text>sample string 2</Text>
            </ImportFormFieldOptions>
            <ImportFormFieldOptions>
              <OptionType>Unknown</OptionType>
              <SortOrder>1</SortOrder>
              <Text>sample string 2</Text>
            </ImportFormFieldOptions>
          </ImportFormFieldOptions>
          <Name>sample string 2</Name>
          <Required>true</Required>
          <SortOrder>1</SortOrder>
          <Type>Text</Type>
        </ImportFormField>
        <ImportFormField>
          <Description>sample string 3</Description>
          <ImportFormFieldOptions>
            <ImportFormFieldOptions>
              <OptionType>Unknown</OptionType>
              <SortOrder>1</SortOrder>
              <Text>sample string 2</Text>
            </ImportFormFieldOptions>
            <ImportFormFieldOptions>
              <OptionType>Unknown</OptionType>
              <SortOrder>1</SortOrder>
              <Text>sample string 2</Text>
            </ImportFormFieldOptions>
          </ImportFormFieldOptions>
          <Name>sample string 2</Name>
          <Required>true</Required>
          <SortOrder>1</SortOrder>
          <Type>Text</Type>
        </ImportFormField>
      </ImportFormFields>
      <Name>sample string 2</Name>
      <SortOrder>1</SortOrder>
    </FormGroupItem>
  </FormGroups>
  <FormName>sample string 1</FormName>
</ImportFormResponse>