POST api/GroupExport

Create new Group Manifest request.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Practices	Collection of Practices.	Collection of PracticeRequest	Required

Request Formats

application/json, text/json

Sample:

{
  "Practices": [
    {
      "ExternalId": "sample string 1",
      "GroupId": "sample string 2",
      "Patients": [
        {
          "PatientId": "sample string 1"
        },
        {
          "PatientId": "sample string 1"
        }
      ]
    },
    {
      "ExternalId": "sample string 1",
      "GroupId": "sample string 2",
      "Patients": [
        {
          "PatientId": "sample string 1"
        },
        {
          "PatientId": "sample string 1"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<GroupExportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnboardingApi.Api_Model.FHIR">
  <Practices>
    <PracticeRequest>
      <ExternalId>sample string 1</ExternalId>
      <GroupId>sample string 2</GroupId>
      <Patients>
        <Patient>
          <PatientId>sample string 1</PatientId>
        </Patient>
        <Patient>
          <PatientId>sample string 1</PatientId>
        </Patient>
      </Patients>
    </PracticeRequest>
    <PracticeRequest>
      <ExternalId>sample string 1</ExternalId>
      <GroupId>sample string 2</GroupId>
      <Patients>
        <Patient>
          <PatientId>sample string 1</PatientId>
        </Patient>
        <Patient>
          <PatientId>sample string 1</PatientId>
        </Patient>
      </Patients>
    </PracticeRequest>
  </Practices>
</GroupExportRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GroupExportResponse

Name	Description	Type	Additional information
RequestId	Request ID of the Group Export Request.	string	None.
Status	Status of the request.	string	None.
Details	Details of validation error messages.	Collection of ErrorDetails	None.

Response Formats

application/json, text/json

Sample:

{
  "RequestId": "sample string 1",
  "Status": "sample string 2",
  "Details": [
    {
      "Message": "sample string 1",
      "Path": "sample string 2"
    },
    {
      "Message": "sample string 1",
      "Path": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<GroupExportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnboardingApi.Api_Model.FHIR">
  <Details>
    <ErrorDetails>
      <Message>sample string 1</Message>
      <Path>sample string 2</Path>
    </ErrorDetails>
    <ErrorDetails>
      <Message>sample string 1</Message>
      <Path>sample string 2</Path>
    </ErrorDetails>
  </Details>
  <RequestId>sample string 1</RequestId>
  <Status>sample string 2</Status>
</GroupExportResponse>