POST MyPortal/GetImportFormsList

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Models.ImportFormsRequest

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

Request Formats

application/json, text/json

Sample:

{
  "AppKey": "4a9ddcde-78be-4532-a9d7-2e89b31b5a55",
  "CustomerId": 2,
  "PracticeId": 3
}

application/xml, text/xml

Sample:

<ImportFormsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <AppKey>4a9ddcde-78be-4532-a9d7-2e89b31b5a55</AppKey>
  <CustomerId>2</CustomerId>
  <PracticeId>3</PracticeId>
</ImportFormsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientComms.API.Models.ImportFormsResponse

Name	Type	Additional information
FormsForImport	Collection of PatientComms.API.Models.ImportFormListItem	None.
ErrorMessage	string	None.
ErrorStackTrace	string	None.

Response Formats

application/json, text/json

Sample:

{
  "FormsForImport": [
    {
      "ImportFormId": 1,
      "ImportFormName": "sample string 2"
    },
    {
      "ImportFormId": 1,
      "ImportFormName": "sample string 2"
    }
  ],
  "ErrorMessage": "sample string 1",
  "ErrorStackTrace": "sample string 2"
}

application/xml, text/xml

Sample:

<ImportFormsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <ErrorMessage>sample string 1</ErrorMessage>
  <ErrorStackTrace>sample string 2</ErrorStackTrace>
  <FormsForImport>
    <ImportFormListItem>
      <ImportFormId>1</ImportFormId>
      <ImportFormName>sample string 2</ImportFormName>
    </ImportFormListItem>
    <ImportFormListItem>
      <ImportFormId>1</ImportFormId>
      <ImportFormName>sample string 2</ImportFormName>
    </ImportFormListItem>
  </FormsForImport>
</ImportFormsResponse>