POST api/provider/create
Request Information
URI Parameters
None.
Body Parameters
CreateProviderAccount| Name | Description | Type | Additional information |
|---|---|---|---|
| AreYouAnAffiliateChapter | boolean |
None. |
|
| AffiliateChapters | string |
None. |
|
| ShrmAffiliateType | IdNamePair |
None. |
|
| AffiliateChaptersOther | string |
None. |
|
| ShrmRegion | OptionSetValueModel |
None. |
|
| AccountType | string |
None. |
|
| ContactId | string |
None. |
|
| ContactEmail | string |
None. |
|
| ContactPortalId | string |
None. |
|
| ContactFirstName | string |
None. |
|
| ContactLastName | string |
None. |
|
| ContactPrimaryPhone | string |
None. |
|
| ContactAddress1 | string |
None. |
|
| ContactAddress2 | string |
None. |
|
| ContactAddress3 | string |
None. |
|
| ContactCity | string |
None. |
|
| ContactPostalCode | string |
None. |
|
| ContactStateProvince | StateProvince |
None. |
|
| ContactStateProvinceString | string |
None. |
|
| ContactCountry | Country |
None. |
|
| ProviderName | string |
None. |
|
| ProviderAddress1 | string |
None. |
|
| ProviderAddress2 | string |
None. |
|
| ProviderAddress3 | string |
None. |
|
| ProviderCountry | Country |
None. |
|
| ProviderStateProvince | StateProvince |
None. |
|
| ProviderStateProvinceString | string |
None. |
|
| ProviderCity | string |
None. |
|
| ProviderPostalCode | string |
None. |
|
| ProviderPhone | string |
None. |
|
| ProviderWebsite | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"AreYouAnAffiliateChapter": true,
"AffiliateChapters": "sample string 2",
"ShrmAffiliateType": {
"Id": "a6e39fbc-271a-40f2-a2b8-ac05ea5bedb7",
"Name": "sample string 2"
},
"AffiliateChaptersOther": "sample string 3",
"ShrmRegion": {
"Label": "sample string 1",
"Value": 2
},
"AccountType": "sample string 4",
"ContactId": "sample string 5",
"ContactEmail": "sample string 6",
"ContactPortalId": "sample string 7",
"ContactFirstName": "sample string 8",
"ContactLastName": "sample string 9",
"ContactPrimaryPhone": "sample string 10",
"ContactAddress1": "sample string 11",
"ContactAddress2": "sample string 12",
"ContactAddress3": "sample string 13",
"ContactCity": "sample string 14",
"ContactPostalCode": "sample string 15",
"ContactStateProvince": {
"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"
},
"ContactStateProvinceString": "sample string 16",
"ContactCountry": {
"Code": "sample string 1",
"Id": "sample string 2",
"Name": "sample string 3",
"EmbargoCountry": true,
"APPresScreen": true,
"hasStates": true
},
"ProviderName": "sample string 17",
"ProviderAddress1": "sample string 18",
"ProviderAddress2": "sample string 19",
"ProviderAddress3": "sample string 20",
"ProviderCountry": {
"Code": "sample string 1",
"Id": "sample string 2",
"Name": "sample string 3",
"EmbargoCountry": true,
"APPresScreen": true,
"hasStates": true
},
"ProviderStateProvince": {
"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"
},
"ProviderStateProvinceString": "sample string 21",
"ProviderCity": "sample string 22",
"ProviderPostalCode": "sample string 23",
"ProviderPhone": "sample string 24",
"ProviderWebsite": "sample string 25"
}
application/xml, text/xml
Sample:
<CreateProviderAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
<AccountType>sample string 4</AccountType>
<AffiliateChapters>sample string 2</AffiliateChapters>
<AffiliateChaptersOther>sample string 3</AffiliateChaptersOther>
<AreYouAnAffiliateChapter>true</AreYouAnAffiliateChapter>
<ContactAddress1>sample string 11</ContactAddress1>
<ContactAddress2>sample string 12</ContactAddress2>
<ContactAddress3>sample string 13</ContactAddress3>
<ContactCity>sample string 14</ContactCity>
<ContactCountry>
<APPresScreen>true</APPresScreen>
<Code>sample string 1</Code>
<EmbargoCountry>true</EmbargoCountry>
<Id>sample string 2</Id>
<Name>sample string 3</Name>
<hasStates>true</hasStates>
</ContactCountry>
<ContactEmail>sample string 6</ContactEmail>
<ContactFirstName>sample string 8</ContactFirstName>
<ContactId>sample string 5</ContactId>
<ContactLastName>sample string 9</ContactLastName>
<ContactPortalId>sample string 7</ContactPortalId>
<ContactPostalCode>sample string 15</ContactPostalCode>
<ContactPrimaryPhone>sample string 10</ContactPrimaryPhone>
<ContactStateProvince>
<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>
</ContactStateProvince>
<ContactStateProvinceString>sample string 16</ContactStateProvinceString>
<ProviderAddress1>sample string 18</ProviderAddress1>
<ProviderAddress2>sample string 19</ProviderAddress2>
<ProviderAddress3>sample string 20</ProviderAddress3>
<ProviderCity>sample string 22</ProviderCity>
<ProviderCountry>
<APPresScreen>true</APPresScreen>
<Code>sample string 1</Code>
<EmbargoCountry>true</EmbargoCountry>
<Id>sample string 2</Id>
<Name>sample string 3</Name>
<hasStates>true</hasStates>
</ProviderCountry>
<ProviderName>sample string 17</ProviderName>
<ProviderPhone>sample string 24</ProviderPhone>
<ProviderPostalCode>sample string 23</ProviderPostalCode>
<ProviderStateProvince>
<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>
</ProviderStateProvince>
<ProviderStateProvinceString>sample string 21</ProviderStateProvinceString>
<ProviderWebsite>sample string 25</ProviderWebsite>
<ShrmAffiliateType xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d2p1:Id>a6e39fbc-271a-40f2-a2b8-ac05ea5bedb7</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</ShrmAffiliateType>
<ShrmRegion 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>
</ShrmRegion>
</CreateProviderAccount>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CreateProviderAccountResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ContactId | globally unique identifier |
None. |
|
| PortalId | string |
None. |
|
| AccountId | globally unique identifier |
None. |
|
| ProviderStatus | OptionSetValueModel |
None. |
|
| ProviderPreScreen | boolean |
None. |
|
| ProviderPreScreenOverride | boolean |
None. |
|
| IsDuplicate | boolean |
None. |
|
| IsEmbargo | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"ContactId": "add00cc9-3116-4ebf-b278-33f03edec2d2",
"PortalId": "sample string 2",
"AccountId": "c16124ad-5b39-4d7d-b9f2-3609eb9f80e6",
"ProviderStatus": {
"Label": "sample string 1",
"Value": 2
},
"ProviderPreScreen": true,
"ProviderPreScreenOverride": true,
"IsDuplicate": true,
"IsEmbargo": true
}
application/xml, text/xml
Sample:
<CreateProviderAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
<AccountId>c16124ad-5b39-4d7d-b9f2-3609eb9f80e6</AccountId>
<ContactId>add00cc9-3116-4ebf-b278-33f03edec2d2</ContactId>
<IsDuplicate>true</IsDuplicate>
<IsEmbargo>true</IsEmbargo>
<PortalId>sample string 2</PortalId>
<ProviderPreScreen>true</ProviderPreScreen>
<ProviderPreScreenOverride>true</ProviderPreScreenOverride>
<ProviderStatus 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>
</ProviderStatus>
</CreateProviderAccountResponse>