PUT api/provider/application?applicationId={applicationId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
applicationId

globally unique identifier

Required

Body Parameters

ProviderApplicationDetails
NameDescriptionTypeAdditional information
ApplicationId

string

None.

Name

string

None.

Status

IdNamePair

None.

ProgramId

string

None.

TypeShort

string

None.

DateSubmitted

date

None.

StartDate

date

None.

EndDate

date

None.

IsSubmitted

boolean

None.

IsAttested

boolean

None.

IsApplicationComplete

boolean

None.

CurrentSection

string

None.

WebProductId

globally unique identifier

None.

UpdateAccountInfo

boolean

None.

AccountInfo

ProviderAccountInfo

None.

OrganizationInfo

ProviderOrganizationInfo

None.

ResourcesInfo

ProviderResourcesInfo

None.

AdditionalInfoRequired

AdditionalInfoRequired

None.

Request Formats

application/json, text/json

Sample:
{
  "ApplicationId": "sample string 1",
  "Name": "sample string 2",
  "Status": {
    "Id": "6a7ad9a1-91ae-4498-a003-c9492a515f49",
    "Name": "sample string 2"
  },
  "ProgramId": "sample string 3",
  "TypeShort": "sample string 4",
  "DateSubmitted": "2025-04-03T08:20:24.5208318+00:00",
  "StartDate": "2025-04-03T08:20:24.5208318+00:00",
  "EndDate": "2025-04-03T08:20:24.5208318+00:00",
  "IsSubmitted": true,
  "IsAttested": true,
  "IsApplicationComplete": true,
  "CurrentSection": "sample string 8",
  "WebProductId": "406d27dd-00f7-4507-ae18-1a7e133d91ab",
  "UpdateAccountInfo": true,
  "AccountInfo": {
    "AccountId": "sample string 1",
    "Organization": "sample string 2",
    "Website": "sample string 3",
    "PrimaryPhone": "sample string 4",
    "Address1": "sample string 5",
    "Address2": "sample string 6",
    "Address3": "sample string 7",
    "City": "sample string 8",
    "StateProvinceString": "sample string 9",
    "StateProvince": {
      "Code": "sample string 1",
      "Country": {
        "Code": "sample string 1",
        "Id": "sample string 2",
        "Name": "sample string 3",
        "EmbargoCountry": true,
        "APPresScreen": true,
        "hasStates": true
      },
      "Id": "sample string 2",
      "Name": "sample string 3"
    },
    "Country": {
      "Code": "sample string 1",
      "Id": "sample string 2",
      "Name": "sample string 3",
      "EmbargoCountry": true,
      "APPresScreen": true,
      "hasStates": true
    },
    "PostalCode": "sample string 10"
  },
  "OrganizationInfo": {
    "YearsConductingTraining": {
      "Label": "sample string 1",
      "Value": 2
    },
    "HaveOtherApproverInstitutions": true,
    "OtherApproverInstitutions": "sample string 2",
    "LearningEventFacilities": null,
    "EventConductedVia": {
      "Label": "sample string 1",
      "Value": 2
    }
  },
  "ResourcesInfo": {
    "InstructorRequirements": null,
    "OtherInstructorRequirements": "sample string 1",
    "HowYouDetermineProgramTopics": "sample string 2",
    "FeedbackEvaluation": {
      "Label": "sample string 1",
      "Value": 2
    },
    "OtherFeedbackEvaluations": "sample string 3",
    "EducationSamples": [
      {
        "Index": 1,
        "ProgramName": "sample string 2",
        "LearningObjectives": "sample string 3",
        "MeasureProgramSuccess": "sample string 4",
        "MarketingMaterialDocumentRef": {
          "Key": "3df0b5af-a184-479d-8a93-bdf94170bc3d",
          "Value": "sample string 1"
        },
        "MarketingMaterialUrl": "sample string 5",
        "EvaluationDocumentRef": {
          "Key": "2f63e3c1-bc1a-4906-ba76-6ada7b20a819",
          "Value": "sample string 1"
        },
        "EvaluationUrl": "sample string 6",
        "MarketingMaterialFileType": {
          "Key": "1823afae-a109-4c4c-94b2-9b7baa7d23fe",
          "Value": "sample string 1"
        },
        "EvaluationFileType": {
          "Key": "05dea94d-2c0f-4ad3-8e2a-d7e900bc30b8",
          "Value": "sample string 1"
        }
      },
      {
        "Index": 1,
        "ProgramName": "sample string 2",
        "LearningObjectives": "sample string 3",
        "MeasureProgramSuccess": "sample string 4",
        "MarketingMaterialDocumentRef": {
          "Key": "3df0b5af-a184-479d-8a93-bdf94170bc3d",
          "Value": "sample string 1"
        },
        "MarketingMaterialUrl": "sample string 5",
        "EvaluationDocumentRef": {
          "Key": "2f63e3c1-bc1a-4906-ba76-6ada7b20a819",
          "Value": "sample string 1"
        },
        "EvaluationUrl": "sample string 6",
        "MarketingMaterialFileType": {
          "Key": "1823afae-a109-4c4c-94b2-9b7baa7d23fe",
          "Value": "sample string 1"
        },
        "EvaluationFileType": {
          "Key": "05dea94d-2c0f-4ad3-8e2a-d7e900bc30b8",
          "Value": "sample string 1"
        }
      }
    ]
  },
  "AdditionalInfoRequired": {
    "RequiresAdditionalInformation": true,
    "ReviewYearsConductingTraining": true,
    "ReviewOtherApprovers": true,
    "ReviewLearningEnvironment": true,
    "ReviewEventConductedVia": true,
    "ReviewSample1ProgramName": true,
    "ReviewSample1LearningObjectives": true,
    "ReviewSample1MeasureProgramSuccess": true,
    "ReviewSample1MarketingDoc": true,
    "ReviewSample1EvaluationDoc": true,
    "ReviewSample2ProgramName": true,
    "ReviewSample2LearningObjectives": true,
    "ReviewSample2MeasureProgramSuccess": true,
    "ReviewSample2MarketingDoc": true,
    "ReviewSample2EvaluationDoc": true,
    "ReviewSample3ProgramName": true,
    "ReviewSample3LearningObjectives": true,
    "ReviewSample3MeasureProgramSuccess": true,
    "ReviewSample3MarketingDoc": true,
    "ReviewSample3EvaluationDoc": true,
    "UserComments": [
      {
        "IsHistorical": true,
        "CreatedOn": "2025-04-03T08:20:24.5833445+00:00",
        "NoteType": {
          "Label": "sample string 1",
          "Value": 2
        },
        "Comment": "sample string 3"
      },
      {
        "IsHistorical": true,
        "CreatedOn": "2025-04-03T08:20:24.5833445+00:00",
        "NoteType": {
          "Label": "sample string 1",
          "Value": 2
        },
        "Comment": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ProviderApplicationDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
  <AccountInfo>
    <AccountId>sample string 1</AccountId>
    <Address1>sample string 5</Address1>
    <Address2>sample string 6</Address2>
    <Address3>sample string 7</Address3>
    <City>sample string 8</City>
    <Country>
      <APPresScreen>true</APPresScreen>
      <Code>sample string 1</Code>
      <EmbargoCountry>true</EmbargoCountry>
      <Id>sample string 2</Id>
      <Name>sample string 3</Name>
      <hasStates>true</hasStates>
    </Country>
    <Organization>sample string 2</Organization>
    <PostalCode>sample string 10</PostalCode>
    <PrimaryPhone>sample string 4</PrimaryPhone>
    <StateProvince>
      <Code>sample string 1</Code>
      <Country>
        <APPresScreen>true</APPresScreen>
        <Code>sample string 1</Code>
        <EmbargoCountry>true</EmbargoCountry>
        <Id>sample string 2</Id>
        <Name>sample string 3</Name>
        <hasStates>true</hasStates>
      </Country>
      <Id>sample string 2</Id>
      <Name>sample string 3</Name>
    </StateProvince>
    <StateProvinceString>sample string 9</StateProvinceString>
    <Website>sample string 3</Website>
  </AccountInfo>
  <AdditionalInfoRequired>
    <RequiresAdditionalInformation>true</RequiresAdditionalInformation>
    <ReviewEventConductedVia>true</ReviewEventConductedVia>
    <ReviewLearningEnvironment>true</ReviewLearningEnvironment>
    <ReviewOtherApprovers>true</ReviewOtherApprovers>
    <ReviewSample1EvaluationDoc>true</ReviewSample1EvaluationDoc>
    <ReviewSample1LearningObjectives>true</ReviewSample1LearningObjectives>
    <ReviewSample1MarketingDoc>true</ReviewSample1MarketingDoc>
    <ReviewSample1MeasureProgramSuccess>true</ReviewSample1MeasureProgramSuccess>
    <ReviewSample1ProgramName>true</ReviewSample1ProgramName>
    <ReviewSample2EvaluationDoc>true</ReviewSample2EvaluationDoc>
    <ReviewSample2LearningObjectives>true</ReviewSample2LearningObjectives>
    <ReviewSample2MarketingDoc>true</ReviewSample2MarketingDoc>
    <ReviewSample2MeasureProgramSuccess>true</ReviewSample2MeasureProgramSuccess>
    <ReviewSample2ProgramName>true</ReviewSample2ProgramName>
    <ReviewSample3EvaluationDoc>true</ReviewSample3EvaluationDoc>
    <ReviewSample3LearningObjectives>true</ReviewSample3LearningObjectives>
    <ReviewSample3MarketingDoc>true</ReviewSample3MarketingDoc>
    <ReviewSample3MeasureProgramSuccess>true</ReviewSample3MeasureProgramSuccess>
    <ReviewSample3ProgramName>true</ReviewSample3ProgramName>
    <ReviewYearsConductingTraining>true</ReviewYearsConductingTraining>
    <UserComments>
      <ProviderApplicationComment>
        <Comment>sample string 3</Comment>
        <CreatedOn>2025-04-03T08:20:24.5833445+00:00</CreatedOn>
        <IsHistorical>true</IsHistorical>
        <NoteType xmlns:d5p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
          <d5p1:Label>sample string 1</d5p1:Label>
          <d5p1:Value>2</d5p1:Value>
        </NoteType>
      </ProviderApplicationComment>
      <ProviderApplicationComment>
        <Comment>sample string 3</Comment>
        <CreatedOn>2025-04-03T08:20:24.5833445+00:00</CreatedOn>
        <IsHistorical>true</IsHistorical>
        <NoteType xmlns:d5p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
          <d5p1:Label>sample string 1</d5p1:Label>
          <d5p1:Value>2</d5p1:Value>
        </NoteType>
      </ProviderApplicationComment>
    </UserComments>
  </AdditionalInfoRequired>
  <ApplicationId>sample string 1</ApplicationId>
  <CurrentSection>sample string 8</CurrentSection>
  <DateSubmitted>2025-04-03T08:20:24.5208318+00:00</DateSubmitted>
  <EndDate>2025-04-03T08:20:24.5208318+00:00</EndDate>
  <IsApplicationComplete>true</IsApplicationComplete>
  <IsAttested>true</IsAttested>
  <IsSubmitted>true</IsSubmitted>
  <Name>sample string 2</Name>
  <OrganizationInfo>
    <EventConductedVia xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
      <d3p1:Label>sample string 1</d3p1:Label>
      <d3p1:Value>2</d3p1:Value>
    </EventConductedVia>
    <HaveOtherApproverInstitutions>true</HaveOtherApproverInstitutions>
    <LearningEventFacilities xmlns:d3p1="http://schemas.microsoft.com/xrm/9.0/Contracts" i:nil="true" />
    <OtherApproverInstitutions>sample string 2</OtherApproverInstitutions>
    <YearsConductingTraining xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
      <d3p1:Label>sample string 1</d3p1:Label>
      <d3p1:Value>2</d3p1:Value>
    </YearsConductingTraining>
  </OrganizationInfo>
  <ProgramId>sample string 3</ProgramId>
  <ResourcesInfo>
    <EducationSamples>
      <EducationSample>
        <EvaluationDocumentRef xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
          <d5p1:key>2f63e3c1-bc1a-4906-ba76-6ada7b20a819</d5p1:key>
          <d5p1:value>sample string 1</d5p1:value>
        </EvaluationDocumentRef>
        <EvaluationFileType xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
          <d5p1:key>05dea94d-2c0f-4ad3-8e2a-d7e900bc30b8</d5p1:key>
          <d5p1:value>sample string 1</d5p1:value>
        </EvaluationFileType>
        <EvaluationUrl>sample string 6</EvaluationUrl>
        <Index>1</Index>
        <LearningObjectives>sample string 3</LearningObjectives>
        <MarketingMaterialDocumentRef xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
          <d5p1:key>3df0b5af-a184-479d-8a93-bdf94170bc3d</d5p1:key>
          <d5p1:value>sample string 1</d5p1:value>
        </MarketingMaterialDocumentRef>
        <MarketingMaterialFileType xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
          <d5p1:key>1823afae-a109-4c4c-94b2-9b7baa7d23fe</d5p1:key>
          <d5p1:value>sample string 1</d5p1:value>
        </MarketingMaterialFileType>
        <MarketingMaterialUrl>sample string 5</MarketingMaterialUrl>
        <MeasureProgramSuccess>sample string 4</MeasureProgramSuccess>
        <ProgramName>sample string 2</ProgramName>
      </EducationSample>
      <EducationSample>
        <EvaluationDocumentRef xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
          <d5p1:key>2f63e3c1-bc1a-4906-ba76-6ada7b20a819</d5p1:key>
          <d5p1:value>sample string 1</d5p1:value>
        </EvaluationDocumentRef>
        <EvaluationFileType xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
          <d5p1:key>05dea94d-2c0f-4ad3-8e2a-d7e900bc30b8</d5p1:key>
          <d5p1:value>sample string 1</d5p1:value>
        </EvaluationFileType>
        <EvaluationUrl>sample string 6</EvaluationUrl>
        <Index>1</Index>
        <LearningObjectives>sample string 3</LearningObjectives>
        <MarketingMaterialDocumentRef xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
          <d5p1:key>3df0b5af-a184-479d-8a93-bdf94170bc3d</d5p1:key>
          <d5p1:value>sample string 1</d5p1:value>
        </MarketingMaterialDocumentRef>
        <MarketingMaterialFileType xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
          <d5p1:key>1823afae-a109-4c4c-94b2-9b7baa7d23fe</d5p1:key>
          <d5p1:value>sample string 1</d5p1:value>
        </MarketingMaterialFileType>
        <MarketingMaterialUrl>sample string 5</MarketingMaterialUrl>
        <MeasureProgramSuccess>sample string 4</MeasureProgramSuccess>
        <ProgramName>sample string 2</ProgramName>
      </EducationSample>
    </EducationSamples>
    <FeedbackEvaluation xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
      <d3p1:Label>sample string 1</d3p1:Label>
      <d3p1:Value>2</d3p1:Value>
    </FeedbackEvaluation>
    <HowYouDetermineProgramTopics>sample string 2</HowYouDetermineProgramTopics>
    <InstructorRequirements xmlns:d3p1="http://schemas.microsoft.com/xrm/9.0/Contracts" i:nil="true" />
    <OtherFeedbackEvaluations>sample string 3</OtherFeedbackEvaluations>
    <OtherInstructorRequirements>sample string 1</OtherInstructorRequirements>
  </ResourcesInfo>
  <StartDate>2025-04-03T08:20:24.5208318+00:00</StartDate>
  <Status xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Id>6a7ad9a1-91ae-4498-a003-c9492a515f49</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </Status>
  <TypeShort>sample string 4</TypeShort>
  <UpdateAccountInfo>true</UpdateAccountInfo>
  <WebProductId>406d27dd-00f7-4507-ae18-1a7e133d91ab</WebProductId>
</ProviderApplicationDetails>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.