POST api/provider/program/create?accountId={accountId}
Create provider program
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
accountId | globally unique identifier |
Required |
Body Parameters
ProviderProgramName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
ProgramType | IdNamePair |
None. |
|
ProgramId | string |
None. |
|
ProgramTitle | string |
None. |
|
ProgramStartDate | date |
None. |
|
ProgramEndDate | date |
None. |
|
ProgramURL | string |
None. |
|
LearningObjectives | string |
None. |
|
PresenterName | string |
None. |
|
CreditType | IdNamePair |
None. |
|
EducationalTime | decimal number |
None. |
|
IsAvailableOnline | boolean |
None. |
|
CourseLocations | Collection of CourseLocation |
None. |
|
IsAttested | boolean |
None. |
|
IsRequirementMet | boolean |
None. |
|
ParentProgram | IdNamePair |
None. |
|
CreditHours | decimal number |
None. |
|
IsOngoingProgram | boolean |
None. |
|
IsDuplicate | boolean |
None. |
|
NonLearningTime | decimal number |
None. |
|
ProgramStatus | OptionSetValueModel |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": "2c8db06e-28f4-4d0e-90bf-b7cfe7497b7d", "ProgramType": { "Id": "bb216ecd-c8e8-4721-b657-2ed9465a6d90", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2024-07-15T09:06:53.5773224-04:00", "ProgramEndDate": "2024-07-15T09:06:53.5773224-04:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "bb216ecd-c8e8-4721-b657-2ed9465a6d90", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "e2dd9734-b19e-4a9b-b7d7-307e1e6a5e2b", "Country": { "Id": "bb216ecd-c8e8-4721-b657-2ed9465a6d90", "Name": "sample string 2" }, "StateProvince": { "Id": "bb216ecd-c8e8-4721-b657-2ed9465a6d90", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "e2dd9734-b19e-4a9b-b7d7-307e1e6a5e2b", "Country": { "Id": "bb216ecd-c8e8-4721-b657-2ed9465a6d90", "Name": "sample string 2" }, "StateProvince": { "Id": "bb216ecd-c8e8-4721-b657-2ed9465a6d90", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "bb216ecd-c8e8-4721-b657-2ed9465a6d90", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 } }
application/xml, text/xml
Sample:
<ProviderProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models"> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>bb216ecd-c8e8-4721-b657-2ed9465a6d90</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>e2dd9734-b19e-4a9b-b7d7-307e1e6a5e2b</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>bb216ecd-c8e8-4721-b657-2ed9465a6d90</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </StateProvince> <StateProvinceString>sample string 2</StateProvinceString> </CourseLocation> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>bb216ecd-c8e8-4721-b657-2ed9465a6d90</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>e2dd9734-b19e-4a9b-b7d7-307e1e6a5e2b</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>bb216ecd-c8e8-4721-b657-2ed9465a6d90</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </StateProvince> <StateProvinceString>sample string 2</StateProvinceString> </CourseLocation> </CourseLocations> <CreditHours>13</CreditHours> <CreditType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>bb216ecd-c8e8-4721-b657-2ed9465a6d90</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>2c8db06e-28f4-4d0e-90bf-b7cfe7497b7d</Id> <IsAttested>true</IsAttested> <IsAvailableOnline>true</IsAvailableOnline> <IsDuplicate>true</IsDuplicate> <IsOngoingProgram>true</IsOngoingProgram> <IsRequirementMet>true</IsRequirementMet> <LearningObjectives>sample string 7</LearningObjectives> <NonLearningTime>16</NonLearningTime> <ParentProgram xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>bb216ecd-c8e8-4721-b657-2ed9465a6d90</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2024-07-15T09:06:53.5773224-04:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2024-07-15T09:06:53.5773224-04:00</ProgramStartDate> <ProgramStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Label>sample string 1</d2p1:Label> <d2p1:Value>2</d2p1:Value> </ProgramStatus> <ProgramTitle>sample string 3</ProgramTitle> <ProgramType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>bb216ecd-c8e8-4721-b657-2ed9465a6d90</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> </ProviderProgram>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ProviderProgramName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
ProgramType | IdNamePair |
None. |
|
ProgramId | string |
None. |
|
ProgramTitle | string |
None. |
|
ProgramStartDate | date |
None. |
|
ProgramEndDate | date |
None. |
|
ProgramURL | string |
None. |
|
LearningObjectives | string |
None. |
|
PresenterName | string |
None. |
|
CreditType | IdNamePair |
None. |
|
EducationalTime | decimal number |
None. |
|
IsAvailableOnline | boolean |
None. |
|
CourseLocations | Collection of CourseLocation |
None. |
|
IsAttested | boolean |
None. |
|
IsRequirementMet | boolean |
None. |
|
ParentProgram | IdNamePair |
None. |
|
CreditHours | decimal number |
None. |
|
IsOngoingProgram | boolean |
None. |
|
IsDuplicate | boolean |
None. |
|
NonLearningTime | decimal number |
None. |
|
ProgramStatus | OptionSetValueModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "5e43a450-f743-48ca-a51b-d67f68ece8d6", "ProgramType": { "Id": "db91ffe5-0551-475e-8acd-3df7f356f529", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2024-07-15T09:06:53.5773224-04:00", "ProgramEndDate": "2024-07-15T09:06:53.5773224-04:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "db91ffe5-0551-475e-8acd-3df7f356f529", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "f78679df-e17e-458c-ae78-ae09abf2e808", "Country": { "Id": "db91ffe5-0551-475e-8acd-3df7f356f529", "Name": "sample string 2" }, "StateProvince": { "Id": "db91ffe5-0551-475e-8acd-3df7f356f529", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "f78679df-e17e-458c-ae78-ae09abf2e808", "Country": { "Id": "db91ffe5-0551-475e-8acd-3df7f356f529", "Name": "sample string 2" }, "StateProvince": { "Id": "db91ffe5-0551-475e-8acd-3df7f356f529", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "db91ffe5-0551-475e-8acd-3df7f356f529", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 } }
application/xml, text/xml
Sample:
<ProviderProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models"> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>db91ffe5-0551-475e-8acd-3df7f356f529</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>f78679df-e17e-458c-ae78-ae09abf2e808</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>db91ffe5-0551-475e-8acd-3df7f356f529</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </StateProvince> <StateProvinceString>sample string 2</StateProvinceString> </CourseLocation> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>db91ffe5-0551-475e-8acd-3df7f356f529</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>f78679df-e17e-458c-ae78-ae09abf2e808</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>db91ffe5-0551-475e-8acd-3df7f356f529</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </StateProvince> <StateProvinceString>sample string 2</StateProvinceString> </CourseLocation> </CourseLocations> <CreditHours>13</CreditHours> <CreditType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>db91ffe5-0551-475e-8acd-3df7f356f529</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>5e43a450-f743-48ca-a51b-d67f68ece8d6</Id> <IsAttested>true</IsAttested> <IsAvailableOnline>true</IsAvailableOnline> <IsDuplicate>true</IsDuplicate> <IsOngoingProgram>true</IsOngoingProgram> <IsRequirementMet>true</IsRequirementMet> <LearningObjectives>sample string 7</LearningObjectives> <NonLearningTime>16</NonLearningTime> <ParentProgram xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>db91ffe5-0551-475e-8acd-3df7f356f529</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2024-07-15T09:06:53.5773224-04:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2024-07-15T09:06:53.5773224-04:00</ProgramStartDate> <ProgramStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Label>sample string 1</d2p1:Label> <d2p1:Value>2</d2p1:Value> </ProgramStatus> <ProgramTitle>sample string 3</ProgramTitle> <ProgramType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>db91ffe5-0551-475e-8acd-3df7f356f529</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> </ProviderProgram>