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. |
Request Formats
application/json, text/json
Sample:
{ "Id": "2862041f-862a-4ea0-8cc8-2483a46ef8b3", "ProgramType": { "Id": "7fd8af77-6cd7-4762-9e8a-884f9485a594", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2024-12-14T04:14:57.5429963+00:00", "ProgramEndDate": "2024-12-14T04:14:57.5429963+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "7fd8af77-6cd7-4762-9e8a-884f9485a594", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "307cecb1-1ecf-4409-97e8-f784dab0e39c", "Country": { "Id": "7fd8af77-6cd7-4762-9e8a-884f9485a594", "Name": "sample string 2" }, "StateProvince": { "Id": "7fd8af77-6cd7-4762-9e8a-884f9485a594", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "307cecb1-1ecf-4409-97e8-f784dab0e39c", "Country": { "Id": "7fd8af77-6cd7-4762-9e8a-884f9485a594", "Name": "sample string 2" }, "StateProvince": { "Id": "7fd8af77-6cd7-4762-9e8a-884f9485a594", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "7fd8af77-6cd7-4762-9e8a-884f9485a594", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "64272633-2acd-4bf2-86e1-2168846521de", "WebProductId": "85c0daae-24bd-46d2-8e53-71c96332905a", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "39459020-5a6a-4c82-95f7-bbdfa98bece0", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2024-12-14T04:14:57.5429963+00:00", "TotalAmountPaid": 4.0, "PaymentAuthorizationNumber": "sample string 5" } }
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>64272633-2acd-4bf2-86e1-2168846521de</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>7fd8af77-6cd7-4762-9e8a-884f9485a594</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>307cecb1-1ecf-4409-97e8-f784dab0e39c</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>7fd8af77-6cd7-4762-9e8a-884f9485a594</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>7fd8af77-6cd7-4762-9e8a-884f9485a594</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>307cecb1-1ecf-4409-97e8-f784dab0e39c</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>7fd8af77-6cd7-4762-9e8a-884f9485a594</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>7fd8af77-6cd7-4762-9e8a-884f9485a594</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>2862041f-862a-4ea0-8cc8-2483a46ef8b3</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>7fd8af77-6cd7-4762-9e8a-884f9485a594</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2024-12-14T04:14:57.5429963+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2024-12-14T04:14:57.5429963+00: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>7fd8af77-6cd7-4762-9e8a-884f9485a594</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2024-12-14T04:14:57.5429963+00:00</InvoiceDate> <InvoiceId>39459020-5a6a-4c82-95f7-bbdfa98bece0</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> <SubmitProgram>true</SubmitProgram> <WebProductId>85c0daae-24bd-46d2-8e53-71c96332905a</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. |
Response Formats
application/json, text/json
Sample:
{ "Id": "cffb5d79-843e-457b-8c23-6c6a23f36bf1", "ProgramType": { "Id": "e71a37fa-34a4-4afa-817f-d9fa8f6df26d", "Name": "sample string 2" }, "ProgramId": "sample string 2", "ProgramTitle": "sample string 3", "ProgramStartDate": "2024-12-14T04:14:57.5429963+00:00", "ProgramEndDate": "2024-12-14T04:14:57.5429963+00:00", "ProgramURL": "sample string 6", "LearningObjectives": "sample string 7", "PresenterName": "sample string 8", "CreditType": { "Id": "e71a37fa-34a4-4afa-817f-d9fa8f6df26d", "Name": "sample string 2" }, "EducationalTime": 9.0, "IsAvailableOnline": true, "CourseLocations": [ { "Id": "e82ff79c-0600-4d62-af73-aa7feb464f8f", "Country": { "Id": "e71a37fa-34a4-4afa-817f-d9fa8f6df26d", "Name": "sample string 2" }, "StateProvince": { "Id": "e71a37fa-34a4-4afa-817f-d9fa8f6df26d", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" }, { "Id": "e82ff79c-0600-4d62-af73-aa7feb464f8f", "Country": { "Id": "e71a37fa-34a4-4afa-817f-d9fa8f6df26d", "Name": "sample string 2" }, "StateProvince": { "Id": "e71a37fa-34a4-4afa-817f-d9fa8f6df26d", "Name": "sample string 2" }, "StateProvinceString": "sample string 2", "City": "sample string 3" } ], "IsAttested": true, "IsRequirementMet": true, "ParentProgram": { "Id": "e71a37fa-34a4-4afa-817f-d9fa8f6df26d", "Name": "sample string 2" }, "CreditHours": 13.0, "IsOngoingProgram": true, "IsDuplicate": true, "NonLearningTime": 16.0, "ProgramStatus": { "Label": "sample string 1", "Value": 2 }, "SubmitProgram": true, "ContactId": "afa543ba-963b-417b-bccb-b0b349b49931", "WebProductId": "3919e033-e2de-467b-bb00-d0f3c42d7ab9", "WebProductName": "sample string 20", "Receipt": { "InvoiceId": "79799724-ddb1-4370-889e-94b1197e287d", "Messages": [ "sample string 1", "sample string 2" ], "InvoiceNumber": "sample string 2", "InvoiceDate": "2024-12-14T04:14:57.5429963+00:00", "TotalAmountPaid": 4.0, "PaymentAuthorizationNumber": "sample string 5" } }
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>afa543ba-963b-417b-bccb-b0b349b49931</ContactId> <CourseLocations> <CourseLocation> <City>sample string 3</City> <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>e71a37fa-34a4-4afa-817f-d9fa8f6df26d</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>e82ff79c-0600-4d62-af73-aa7feb464f8f</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>e71a37fa-34a4-4afa-817f-d9fa8f6df26d</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>e71a37fa-34a4-4afa-817f-d9fa8f6df26d</d4p1:Id> <d4p1:Name>sample string 2</d4p1:Name> </Country> <Id>e82ff79c-0600-4d62-af73-aa7feb464f8f</Id> <StateProvince xmlns:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d4p1:Id>e71a37fa-34a4-4afa-817f-d9fa8f6df26d</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>e71a37fa-34a4-4afa-817f-d9fa8f6df26d</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </CreditType> <EducationalTime>9</EducationalTime> <Id>cffb5d79-843e-457b-8c23-6c6a23f36bf1</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>e71a37fa-34a4-4afa-817f-d9fa8f6df26d</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ParentProgram> <PresenterName>sample string 8</PresenterName> <ProgramEndDate>2024-12-14T04:14:57.5429963+00:00</ProgramEndDate> <ProgramId>sample string 2</ProgramId> <ProgramStartDate>2024-12-14T04:14:57.5429963+00: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>e71a37fa-34a4-4afa-817f-d9fa8f6df26d</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </ProgramType> <ProgramURL>sample string 6</ProgramURL> <Receipt> <InvoiceDate>2024-12-14T04:14:57.5429963+00:00</InvoiceDate> <InvoiceId>79799724-ddb1-4370-889e-94b1197e287d</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> <SubmitProgram>true</SubmitProgram> <WebProductId>3919e033-e2de-467b-bb00-d0f3c42d7ab9</WebProductId> <WebProductName>sample string 20</WebProductName> </ProviderProgram>