POST api/SetUserActiveStatus

Alters the active status of the user.

Request Information

URI Parameters

None.

Body Parameters

Collection of UserStatusChange

Name	Description	Type	Additional information
ExternalId	External User ID	string	Required Max length: 100
Username	Username	string	Required Max length: 100
PracticeID	External Practice ID	string	Required Max length: 100
IsActive	User Is Active status.	boolean	None.
OnboardingInstructions	Provides processing instructions to the Onboarding API for this item	UserInstructions	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "ExternalId": "sample string 1",
    "Username": "sample string 2",
    "PracticeID": "sample string 3",
    "IsActive": true,
    "OnboardingInstructions": {
      "OnboardToCqmSolution": true,
      "OnboardToConnectEHR": true,
      "ShouldOnboardDirect": true
    }
  },
  {
    "ExternalId": "sample string 1",
    "Username": "sample string 2",
    "PracticeID": "sample string 3",
    "IsActive": true,
    "OnboardingInstructions": {
      "OnboardToCqmSolution": true,
      "OnboardToConnectEHR": true,
      "ShouldOnboardDirect": true
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserStatusChange xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnboardingApi.ApiModel">
  <UserStatusChange>
    <ExternalId>sample string 1</ExternalId>
    <IsActive>true</IsActive>
    <OnboardingInstructions>
      <OnboardToConnectEHR>true</OnboardToConnectEHR>
      <OnboardToCqmSolution>true</OnboardToCqmSolution>
      <ShouldOnboardDirect>true</ShouldOnboardDirect>
    </OnboardingInstructions>
    <PracticeID>sample string 3</PracticeID>
    <Username>sample string 2</Username>
  </UserStatusChange>
  <UserStatusChange>
    <ExternalId>sample string 1</ExternalId>
    <IsActive>true</IsActive>
    <OnboardingInstructions>
      <OnboardToConnectEHR>true</OnboardToConnectEHR>
      <OnboardToCqmSolution>true</OnboardToCqmSolution>
      <ShouldOnboardDirect>true</ShouldOnboardDirect>
    </OnboardingInstructions>
    <PracticeID>sample string 3</PracticeID>
    <Username>sample string 2</Username>
  </UserStatusChange>
</ArrayOfUserStatusChange>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of OnboardResult

Name	Description	Type	Additional information
Success	Indicates successful insert/update	boolean	None.
Message	Error message	string	None.
InReferenceToExternalId	External ID of the Practice or User	string	None.
Product	CQMsolution or ConnectEHR	string	None.
FhirR4Endpoint	FHIR R4 Endpoint	string	None.
FhirR4EndpointResource	FHIR R4 Resource Endpoint	string	None.
FhirR4OrganizationResource	FHIR R4 Organization Resource Endpoint	string	None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.