POST api/provider/program/create?accountId={accountId}
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. |
|
SubmitProgram | boolean |
None. |
|
ContactId | globally unique identifier |
None. |
|
WebProductId | globally unique identifier |
None. |
|
WebProductName | string |
None. |
|
Receipt | Receipt |
None. |
|
IsDuplicateAllowed | boolean |
None. |
|
IsRosterUploadAllowed | boolean |
None. |
|
SubmissionDate | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": "65c14354-ea28-4e46-b23e-4b2ac0451746", "ProgramType": { "Id": "9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-07-03T09:40:30.7854508-04:00", "ProgramEndDate": "2025-07-03T09:40:30.7854508-04:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "2ff6b125-df60-40b0-a834-56434c7dd488", "Country": { "Id": "9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3", "Name": "sample string 2" }, "StateProvince": { "Id": "9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "2ff6b125-df60-40b0-a834-56434c7dd488", "Country": { "Id": "9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3", "Name": "sample string 2" }, "StateProvince": { "Id": "9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "1ed6601c-e75e-47f3-bb38-07bdc0c92dd2", "WebProductId": "adfdfcbf-38e4-4fa4-8e3f-512aaa88994e", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "6b231c38-8613-406e-af8c-57a7dcc08cba", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-07-03T09:40:30.7854508-04:00", "TotalAmountPaid": 4.0, "PaymentAuthorizationNumber": "sample string 5" }, "IsDuplicateAllowed": true, "IsRosterUploadAllowed": true, "SubmissionDate": "sample string 23" }
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"> <ContactId>1ed6601c-e75e-47f3-bb38-07bdc0c92dd2</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>2ff6b125-df60-40b0-a834-56434c7dd488</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3</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>9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>2ff6b125-df60-40b0-a834-56434c7dd488</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3</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>9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>65c14354-ea28-4e46-b23e-4b2ac0451746</Id> <IsAttested>true</IsAttested> <IsAvailableOnline>true</IsAvailableOnline> <IsDuplicate>true</IsDuplicate> <IsDuplicateAllowed>true</IsDuplicateAllowed> <IsOngoingProgram>true</IsOngoingProgram> <IsRequirementMet>true</IsRequirementMet> <IsRosterUploadAllowed>true</IsRosterUploadAllowed> <LearningObjectives>sample string 7</LearningObjectives> <NonLearningTime>16</NonLearningTime> <ParentProgram xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-07-03T09:40:30.7854508-04:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-07-03T09:40:30.7854508-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>9f2e50d3-9ebf-4cfc-95d9-34ebe85b16c3</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-07-03T09:40:30.7854508-04:00</InvoiceDate> <InvoiceId>6b231c38-8613-406e-af8c-57a7dcc08cba</InvoiceId> <InvoiceNumber>sample string 2</InvoiceNumber> <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Messages> <PaymentAuthorizationNumber>sample string 5</PaymentAuthorizationNumber> <TotalAmountPaid>4</TotalAmountPaid> </Receipt> <SubmissionDate>sample string 23</SubmissionDate> <SubmitProgram>true</SubmitProgram> <WebProductId>adfdfcbf-38e4-4fa4-8e3f-512aaa88994e</WebProductId> <WebProductName>sample string 20</WebProductName> </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. |
|
SubmitProgram | boolean |
None. |
|
ContactId | globally unique identifier |
None. |
|
WebProductId | globally unique identifier |
None. |
|
WebProductName | string |
None. |
|
Receipt | Receipt |
None. |
|
IsDuplicateAllowed | boolean |
None. |
|
IsRosterUploadAllowed | boolean |
None. |
|
SubmissionDate | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "a79e88ca-f42b-444c-9d13-3f8ea1a27bab", "ProgramType": { "Id": "7d056ca6-1da4-48c2-af5a-4b2f4406c615", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2025-07-03T09:40:30.7854508-04:00", "ProgramEndDate": "2025-07-03T09:40:30.7854508-04:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "7d056ca6-1da4-48c2-af5a-4b2f4406c615", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "c6b128ad-9a5c-4b5d-867b-0cf6161580ef", "Country": { "Id": "7d056ca6-1da4-48c2-af5a-4b2f4406c615", "Name": "sample string 2" }, "StateProvince": { "Id": "7d056ca6-1da4-48c2-af5a-4b2f4406c615", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "c6b128ad-9a5c-4b5d-867b-0cf6161580ef", "Country": { "Id": "7d056ca6-1da4-48c2-af5a-4b2f4406c615", "Name": "sample string 2" }, "StateProvince": { "Id": "7d056ca6-1da4-48c2-af5a-4b2f4406c615", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "7d056ca6-1da4-48c2-af5a-4b2f4406c615", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "d6ba9afe-d2f1-4a6d-ab35-ed61cf9f730c", "WebProductId": "44f08ae7-e934-4456-98f2-8997bae6130e", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "d6af2bbd-0fe4-4890-87e1-97566e83d1f9", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2025-07-03T09:40:30.7854508-04:00", "TotalAmountPaid": 4.0, "PaymentAuthorizationNumber": "sample string 5" }, "IsDuplicateAllowed": true, "IsRosterUploadAllowed": true, "SubmissionDate": "sample string 23" }
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"> <ContactId>d6ba9afe-d2f1-4a6d-ab35-ed61cf9f730c</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>7d056ca6-1da4-48c2-af5a-4b2f4406c615</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>c6b128ad-9a5c-4b5d-867b-0cf6161580ef</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>7d056ca6-1da4-48c2-af5a-4b2f4406c615</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>7d056ca6-1da4-48c2-af5a-4b2f4406c615</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>c6b128ad-9a5c-4b5d-867b-0cf6161580ef</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>7d056ca6-1da4-48c2-af5a-4b2f4406c615</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>7d056ca6-1da4-48c2-af5a-4b2f4406c615</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>a79e88ca-f42b-444c-9d13-3f8ea1a27bab</Id> <IsAttested>true</IsAttested> <IsAvailableOnline>true</IsAvailableOnline> <IsDuplicate>true</IsDuplicate> <IsDuplicateAllowed>true</IsDuplicateAllowed> <IsOngoingProgram>true</IsOngoingProgram> <IsRequirementMet>true</IsRequirementMet> <IsRosterUploadAllowed>true</IsRosterUploadAllowed> <LearningObjectives>sample string 7</LearningObjectives> <NonLearningTime>16</NonLearningTime> <ParentProgram xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d2p1:Id>7d056ca6-1da4-48c2-af5a-4b2f4406c615</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2025-07-03T09:40:30.7854508-04:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2025-07-03T09:40:30.7854508-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>7d056ca6-1da4-48c2-af5a-4b2f4406c615</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2025-07-03T09:40:30.7854508-04:00</InvoiceDate> <InvoiceId>d6af2bbd-0fe4-4890-87e1-97566e83d1f9</InvoiceId> <InvoiceNumber>sample string 2</InvoiceNumber> <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Messages> <PaymentAuthorizationNumber>sample string 5</PaymentAuthorizationNumber> <TotalAmountPaid>4</TotalAmountPaid> </Receipt> <SubmissionDate>sample string 23</SubmissionDate> <SubmitProgram>true</SubmitProgram> <WebProductId>44f08ae7-e934-4456-98f2-8997bae6130e</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram>