POST api/ProviderPrograms?parentCourseId={parentCourseId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
parentCourseId

System.Guid

Required

Body Parameters

Altai.Web.Services.Models.ProviderProgram
NameDescriptionTypeAdditional information
Id

System.String

None.
ProgramId

System.String

None.
PreviousProgramId

System.String

None.
ProgramType

Altai.Web.Services.Models.Shared.IdNameDescriptionPair

None.
ProgramTypeString

System.String

None.
ProgramTitle

System.String

None.
ProgramStartDate

System.DateTime

None.
ProgramEndDate

System.DateTime

None.
SubmissionDate

System.DateTime

None.
ProgramWebsite

System.String

None.
ProgramDescription

System.String

None.
CreditType

Altai.Web.Services.Models.Shared.IdNamePair

None.
CreditTypeString

System.String

None.
RelevantFunctionalAreas

System.Collections.Generic.ICollection`1[Altai.Web.Services.Models.FunctionalArea]

None.
RelevantFunctionalAreaResponsibilities

System.Collections.Generic.ICollection`1[Altai.Web.Services.Models.FunctionalAreaResponsibility]

None.
AttendanceMonitoredBy

System.Collections.Generic.ICollection`1[Altai.Web.Services.Models.OptionSetValue]

None.
CourseLocations

System.Collections.Generic.ICollection`1[Altai.Web.Services.Models.CourseLocation]

None.
OtherAttendanceMonitors

System.String

None.
Attestation

System.Boolean

None.
PresenterNames

System.String

None.
ScheduledProgramTime

System.Decimal

None.
ScheduledNonLearningTime

System.Decimal

None.
TotalCreditHoursRequested

System.Decimal

None.
IsActivityOngoing

System.Boolean

None.
ProgramOccurrence

Altai.Web.Services.Models.OptionSetValue

None.
ProgramStatus

Altai.Web.Services.Models.OptionSetValue

None.
ProgramStatusString

System.String

None.
Provider

Altai.Web.Services.Models.Shared.IdNamePair

None.
CreditHours

System.Decimal

None.
HRCIComments

System.String

None.
UserComments

System.String

None.
ReviewCourseType

System.Boolean

None.
ReviewName

System.Boolean

None.
ReviewStartDate

System.Boolean

None.
ReviewEndDate

System.Boolean

None.
ReviewProgramWebsite

System.Boolean

None.
ReviewPresenterNames

System.Boolean

None.
ReviewDescription

System.Boolean

None.
ReviewCreditType

System.Boolean

None.
ReviewFunctionalAreas

System.Boolean

None.
ReviewFunctionalAreaRresponsibilities

System.Boolean

None.
ReviewtTotalTime

System.Boolean

None.
ReviewNonLearningTime

System.Boolean

None.
ReviewOngoingActivity

System.Boolean

None.
ReviewProgramLocation

System.Boolean

None.
SessionGridFile

System.String

None.
PresenterBioFile

System.String

None.
ProgramAgendaFile

System.String

None.
IsDuplicateAllowed

System.Boolean

None.
IsDuplicated

System.Boolean

None.
ParentProgramCreatedOn

System.DateTime

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": "sample string 1",
  "ProgramId": "sample string 2",
  "PreviousProgramId": "sample string 3",
  "ProgramType": {
    "Description": "sample string 1",
    "Id": "0ddb1313-57f1-4407-af10-0e5aac514f0b",
    "Name": "sample string 3"
  },
  "ProgramTypeString": "sample string 3",
  "ProgramTitle": "sample string 4",
  "ProgramStartDate": "2025-04-04T08:55:16.1861247-04:00",
  "ProgramEndDate": "2025-04-04T08:55:16.1861247-04:00",
  "SubmissionDate": "2025-04-04T08:55:16.1861247-04:00",
  "ProgramWebsite": "sample string 5",
  "ProgramDescription": "sample string 6",
  "CreditType": {
    "Id": "e859c422-b868-4114-999c-f49f7a1ff600",
    "Name": "sample string 2"
  },
  "CreditTypeString": "sample string 2",
  "RelevantFunctionalAreas": [
    {
      "Id": "0f778463-378c-46fe-9df5-517626dbb458",
      "Name": "sample string 2"
    },
    {
      "Id": "0f778463-378c-46fe-9df5-517626dbb458",
      "Name": "sample string 2"
    }
  ],
  "RelevantFunctionalAreaResponsibilities": [
    {
      "Id": "76d6a864-58f0-46dd-b3eb-55d0f87efea7",
      "FunctionalAreaId": "310da0f1-e41a-4dec-b48c-77adb3da64fa",
      "Name": "sample string 3"
    },
    {
      "Id": "76d6a864-58f0-46dd-b3eb-55d0f87efea7",
      "FunctionalAreaId": "310da0f1-e41a-4dec-b48c-77adb3da64fa",
      "Name": "sample string 3"
    }
  ],
  "AttendanceMonitoredBy": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  ],
  "CourseLocations": [
    {
      "Id": "3380a504-b67e-476e-a1ac-b14cce3535a6",
      "Country": {
        "Id": "sample string 1",
        "Code": "sample string 2",
        "Name": "sample string 3"
      },
      "StateProvince": {
        "Id": "68640361-351d-4c54-97cc-8f36524f8236",
        "Code": "sample string 2",
        "Name": "sample string 3",
        "Country": {
          "Id": "sample string 1",
          "Code": "sample string 2",
          "Name": "sample string 3"
        }
      },
      "StateProvinceString": "sample string 2",
      "City": "sample string 3"
    },
    {
      "Id": "3380a504-b67e-476e-a1ac-b14cce3535a6",
      "Country": {
        "Id": "sample string 1",
        "Code": "sample string 2",
        "Name": "sample string 3"
      },
      "StateProvince": {
        "Id": "68640361-351d-4c54-97cc-8f36524f8236",
        "Code": "sample string 2",
        "Name": "sample string 3",
        "Country": {
          "Id": "sample string 1",
          "Code": "sample string 2",
          "Name": "sample string 3"
        }
      },
      "StateProvinceString": "sample string 2",
      "City": "sample string 3"
    }
  ],
  "OtherAttendanceMonitors": "sample string 7",
  "Attestation": true,
  "PresenterNames": "sample string 9",
  "ScheduledProgramTime": 1.0,
  "ScheduledNonLearningTime": 1.0,
  "TotalCreditHoursRequested": 1.0,
  "IsActivityOngoing": true,
  "ProgramOccurrence": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "ProgramStatus": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "ProgramStatusString": "sample string 2",
  "Provider": {
    "Id": "e859c422-b868-4114-999c-f49f7a1ff600",
    "Name": "sample string 2"
  },
  "CreditHours": 1.0,
  "HRCIComments": "sample string 10",
  "UserComments": "sample string 11",
  "ReviewCourseType": true,
  "ReviewName": true,
  "ReviewStartDate": true,
  "ReviewEndDate": true,
  "ReviewProgramWebsite": true,
  "ReviewPresenterNames": true,
  "ReviewDescription": true,
  "ReviewCreditType": true,
  "ReviewFunctionalAreas": true,
  "ReviewFunctionalAreaRresponsibilities": true,
  "ReviewtTotalTime": true,
  "ReviewNonLearningTime": true,
  "ReviewOngoingActivity": true,
  "ReviewProgramLocation": true,
  "SessionGridFile": null,
  "PresenterBioFile": null,
  "ProgramAgendaFile": null,
  "IsDuplicateAllowed": false,
  "IsDuplicated": false,
  "ParentProgramCreatedOn": null
}

application/xml, text/xml

Sample: 
<ProviderProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
  <AttendanceMonitoredBy>
    <OptionSetValue>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </OptionSetValue>
    <OptionSetValue>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </OptionSetValue>
  </AttendanceMonitoredBy>
  <Attestation>true</Attestation>
  <CourseLocations>
    <CourseLocation>
      <City>sample string 3</City>
      <Country>
        <Code>sample string 2</Code>
        <Id>sample string 1</Id>
        <Name>sample string 3</Name>
      </Country>
      <Id>3380a504-b67e-476e-a1ac-b14cce3535a6</Id>
      <StateProvince>
        <Code>sample string 2</Code>
        <Country>
          <Code>sample string 2</Code>
          <Id>sample string 1</Id>
          <Name>sample string 3</Name>
        </Country>
        <Id>68640361-351d-4c54-97cc-8f36524f8236</Id>
        <Name>sample string 3</Name>
      </StateProvince>
      <StateProvinceString>sample string 2</StateProvinceString>
    </CourseLocation>
    <CourseLocation>
      <City>sample string 3</City>
      <Country>
        <Code>sample string 2</Code>
        <Id>sample string 1</Id>
        <Name>sample string 3</Name>
      </Country>
      <Id>3380a504-b67e-476e-a1ac-b14cce3535a6</Id>
      <StateProvince>
        <Code>sample string 2</Code>
        <Country>
          <Code>sample string 2</Code>
          <Id>sample string 1</Id>
          <Name>sample string 3</Name>
        </Country>
        <Id>68640361-351d-4c54-97cc-8f36524f8236</Id>
        <Name>sample string 3</Name>
      </StateProvince>
      <StateProvinceString>sample string 2</StateProvinceString>
    </CourseLocation>
  </CourseLocations>
  <CreditHours>1</CreditHours>
  <CreditType xmlns:d2p1="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models.Shared">
    <d2p1:Id>e859c422-b868-4114-999c-f49f7a1ff600</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </CreditType>
  <HRCIComments>sample string 10</HRCIComments>
  <Id>sample string 1</Id>
  <IsActivityOngoing>true</IsActivityOngoing>
  <OtherAttendanceMonitors>sample string 7</OtherAttendanceMonitors>
  <PresenterNames>sample string 9</PresenterNames>
  <PreviousProgramId>sample string 3</PreviousProgramId>
  <ProgramDescription>sample string 6</ProgramDescription>
  <ProgramEndDate>2025-04-04T08:55:16.1861247-04:00</ProgramEndDate>
  <ProgramId>sample string 2</ProgramId>
  <ProgramOccurrence>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </ProgramOccurrence>
  <ProgramStartDate>2025-04-04T08:55:16.1861247-04:00</ProgramStartDate>
  <ProgramStatus>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
  </ProgramStatus>
  <ProgramTitle>sample string 4</ProgramTitle>
  <ProgramType xmlns:d2p1="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models.Shared">
    <d2p1:Id>0ddb1313-57f1-4407-af10-0e5aac514f0b</d2p1:Id>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Description>sample string 1</d2p1:Description>
  </ProgramType>
  <ProgramWebsite>sample string 5</ProgramWebsite>
  <Provider xmlns:d2p1="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models.Shared">
    <d2p1:Id>e859c422-b868-4114-999c-f49f7a1ff600</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </Provider>
  <RelevantFunctionalAreaResponsibilities>
    <FunctionalAreaResponsibility>
      <FunctionalAreaId>310da0f1-e41a-4dec-b48c-77adb3da64fa</FunctionalAreaId>
      <Id>76d6a864-58f0-46dd-b3eb-55d0f87efea7</Id>
      <Name>sample string 3</Name>
    </FunctionalAreaResponsibility>
    <FunctionalAreaResponsibility>
      <FunctionalAreaId>310da0f1-e41a-4dec-b48c-77adb3da64fa</FunctionalAreaId>
      <Id>76d6a864-58f0-46dd-b3eb-55d0f87efea7</Id>
      <Name>sample string 3</Name>
    </FunctionalAreaResponsibility>
  </RelevantFunctionalAreaResponsibilities>
  <RelevantFunctionalAreas>
    <FunctionalArea>
      <Id>0f778463-378c-46fe-9df5-517626dbb458</Id>
      <Name>sample string 2</Name>
    </FunctionalArea>
    <FunctionalArea>
      <Id>0f778463-378c-46fe-9df5-517626dbb458</Id>
      <Name>sample string 2</Name>
    </FunctionalArea>
  </RelevantFunctionalAreas>
  <ReviewCourseType>true</ReviewCourseType>
  <ReviewCreditType>true</ReviewCreditType>
  <ReviewDescription>true</ReviewDescription>
  <ReviewEndDate>true</ReviewEndDate>
  <ReviewFunctionalAreaRresponsibilities>true</ReviewFunctionalAreaRresponsibilities>
  <ReviewFunctionalAreas>true</ReviewFunctionalAreas>
  <ReviewName>true</ReviewName>
  <ReviewNonLearningTime>true</ReviewNonLearningTime>
  <ReviewOngoingActivity>true</ReviewOngoingActivity>
  <ReviewPresenterNames>true</ReviewPresenterNames>
  <ReviewProgramLocation>true</ReviewProgramLocation>
  <ReviewProgramWebsite>true</ReviewProgramWebsite>
  <ReviewStartDate>true</ReviewStartDate>
  <ReviewtTotalTime>true</ReviewtTotalTime>
  <ScheduledNonLearningTime>1</ScheduledNonLearningTime>
  <ScheduledProgramTime>1</ScheduledProgramTime>
  <SubmissionDate>2025-04-04T08:55:16.1861247-04:00</SubmissionDate>
  <UserComments>sample string 11</UserComments>
</ProviderProgram>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ProviderProgram'.

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.