PUT api/provider/application?applicationId={applicationId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
applicationId | globally unique identifier |
Required |
Body Parameters
ProviderApplicationDetailsName | Description | Type | Additional 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. |
|
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": "04c93d1b-8b09-496b-afaa-14fde2a60f18", "Name": "sample string 2" }, "ProgramId": "sample string 3", "TypeShort": "sample string 4", "DateSubmitted": "2025-07-03T10:08:13.1919119+00:00", "StartDate": "2025-07-03T10:08:13.1919119+00:00", "EndDate": "2025-07-03T10:08:13.1919119+00:00", "IsSubmitted": true, "IsAttested": true, "IsApplicationComplete": true, "CurrentSection": "sample string 8", "WebProductId": "45bcd7ab-ed38-4c06-85c1-9a2fea0de917", "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", "UpdateAccountInfo": true }, "OrganizationInfo": { "YearsConductingTraining": { "Label": "sample string 1", "Value": 2 }, "HaveOtherApproverInstitutions": true, "OtherApproverInstitutions": "sample string 2", "LearningEventFacilities": [ { "Label": "sample string 1", "Value": 2 }, { "Label": "sample string 1", "Value": 2 } ], "EventConductedVia": { "Label": "sample string 1", "Value": 2 } }, "ResourcesInfo": { "InstructorRequirements": [ { "Label": "sample string 1", "Value": 2 }, { "Label": "sample string 1", "Value": 2 } ], "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": "aeb40ec7-9120-4ad0-b7d2-41ad5a25034d", "Value": "sample string 1" }, "MarketingMaterialUrl": "sample string 5", "EvaluationDocumentRef": { "Key": "665e9569-639a-4e2e-97cf-07c72a28d3bc", "Value": "sample string 1" }, "EvaluationUrl": "sample string 6", "MarketingMaterialFileType": { "Key": "f54917d8-860c-478d-bf26-531bf486005a", "Value": "sample string 1" }, "EvaluationFileType": { "Key": "0fab3d74-6a48-4f2a-aa12-cecf12c12950", "Value": "sample string 1" } }, { "Index": 1, "ProgramName": "sample string 2", "LearningObjectives": "sample string 3", "MeasureProgramSuccess": "sample string 4", "MarketingMaterialDocumentRef": { "Key": "aeb40ec7-9120-4ad0-b7d2-41ad5a25034d", "Value": "sample string 1" }, "MarketingMaterialUrl": "sample string 5", "EvaluationDocumentRef": { "Key": "665e9569-639a-4e2e-97cf-07c72a28d3bc", "Value": "sample string 1" }, "EvaluationUrl": "sample string 6", "MarketingMaterialFileType": { "Key": "f54917d8-860c-478d-bf26-531bf486005a", "Value": "sample string 1" }, "EvaluationFileType": { "Key": "0fab3d74-6a48-4f2a-aa12-cecf12c12950", "Value": "sample string 1" } } ], "DocumentsUploaded": [ { "DocRefId": "8ced6bfd-e101-438b-acc2-8baa543e9b4c", "DocumentName": "sample string 2", "FileType": { "Key": "8d97e3a1-c5a0-4fc2-9e98-bb785a7e1197", "Value": "sample string 1" }, "Description": "sample string 3", "DateUploaded": "2025-07-03T10:08:13.2075358+00:00" }, { "DocRefId": "8ced6bfd-e101-438b-acc2-8baa543e9b4c", "DocumentName": "sample string 2", "FileType": { "Key": "8d97e3a1-c5a0-4fc2-9e98-bb785a7e1197", "Value": "sample string 1" }, "Description": "sample string 3", "DateUploaded": "2025-07-03T10:08:13.2075358+00:00" } ] }, "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-07-03T10:08:13.2075358+00:00", "NoteType": { "Label": "sample string 1", "Value": 2 }, "Comment": "sample string 3" }, { "IsHistorical": true, "CreatedOn": "2025-07-03T10:08:13.2075358+00:00", "NoteType": { "Label": "sample string 1", "Value": 2 }, "Comment": "sample string 3" } ], "NewComment": "sample string 21", "IsResubmitted": true } }
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> <UpdateAccountInfo>true</UpdateAccountInfo> <Website>sample string 3</Website> </AccountInfo> <AdditionalInfoRequired> <IsResubmitted>true</IsResubmitted> <NewComment>sample string 21</NewComment> <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-07-03T10:08:13.2075358+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-07-03T10:08:13.2075358+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-07-03T10:08:13.1919119+00:00</DateSubmitted> <EndDate>2025-07-03T10:08:13.1919119+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.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d3p1:OptionSetValueModel> <d3p1:Label>sample string 1</d3p1:Label> <d3p1:Value>2</d3p1:Value> </d3p1:OptionSetValueModel> <d3p1:OptionSetValueModel> <d3p1:Label>sample string 1</d3p1:Label> <d3p1:Value>2</d3p1:Value> </d3p1:OptionSetValueModel> </LearningEventFacilities> <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> <DocumentsUploaded> <DocumentReference> <DateUploaded>2025-07-03T10:08:13.2075358+00:00</DateUploaded> <Description>sample string 3</Description> <DocRefId>8ced6bfd-e101-438b-acc2-8baa543e9b4c</DocRefId> <DocumentName>sample string 2</DocumentName> <FileType xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic"> <d5p1:key>8d97e3a1-c5a0-4fc2-9e98-bb785a7e1197</d5p1:key> <d5p1:value>sample string 1</d5p1:value> </FileType> </DocumentReference> <DocumentReference> <DateUploaded>2025-07-03T10:08:13.2075358+00:00</DateUploaded> <Description>sample string 3</Description> <DocRefId>8ced6bfd-e101-438b-acc2-8baa543e9b4c</DocRefId> <DocumentName>sample string 2</DocumentName> <FileType xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic"> <d5p1:key>8d97e3a1-c5a0-4fc2-9e98-bb785a7e1197</d5p1:key> <d5p1:value>sample string 1</d5p1:value> </FileType> </DocumentReference> </DocumentsUploaded> <EducationSamples> <EducationSample> <EvaluationDocumentRef xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic"> <d5p1:key>665e9569-639a-4e2e-97cf-07c72a28d3bc</d5p1:key> <d5p1:value>sample string 1</d5p1:value> </EvaluationDocumentRef> <EvaluationFileType xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic"> <d5p1:key>0fab3d74-6a48-4f2a-aa12-cecf12c12950</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>aeb40ec7-9120-4ad0-b7d2-41ad5a25034d</d5p1:key> <d5p1:value>sample string 1</d5p1:value> </MarketingMaterialDocumentRef> <MarketingMaterialFileType xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic"> <d5p1:key>f54917d8-860c-478d-bf26-531bf486005a</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>665e9569-639a-4e2e-97cf-07c72a28d3bc</d5p1:key> <d5p1:value>sample string 1</d5p1:value> </EvaluationDocumentRef> <EvaluationFileType xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic"> <d5p1:key>0fab3d74-6a48-4f2a-aa12-cecf12c12950</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>aeb40ec7-9120-4ad0-b7d2-41ad5a25034d</d5p1:key> <d5p1:value>sample string 1</d5p1:value> </MarketingMaterialDocumentRef> <MarketingMaterialFileType xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic"> <d5p1:key>f54917d8-860c-478d-bf26-531bf486005a</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.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d3p1:OptionSetValueModel> <d3p1:Label>sample string 1</d3p1:Label> <d3p1:Value>2</d3p1:Value> </d3p1:OptionSetValueModel> <d3p1:OptionSetValueModel> <d3p1:Label>sample string 1</d3p1:Label> <d3p1:Value>2</d3p1:Value> </d3p1:OptionSetValueModel> </InstructorRequirements> <OtherFeedbackEvaluations>sample string 3</OtherFeedbackEvaluations> <OtherInstructorRequirements>sample string 1</OtherInstructorRequirements> </ResourcesInfo> <StartDate>2025-07-03T10:08:13.1919119+00:00</StartDate> <Status xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>04c93d1b-8b09-496b-afaa-14fde2a60f18</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </Status> <TypeShort>sample string 4</TypeShort> <WebProductId>45bcd7ab-ed38-4c06-85c1-9a2fea0de917</WebProductId> </ProviderApplicationDetails>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.