POST api/institution/onboard
Request Information
URI Parameters
None.
Body Parameters
DtoInstitutionOnboarding| Name | Description | Type | Additional information |
|---|---|---|---|
| InstitutionName | string |
None. |
|
| InstitutionDomain | string |
None. |
|
| AddressLine1 | string |
None. |
|
| AddressLine2 | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Country | string |
None. |
|
| PostalCode | string |
None. |
|
| ContactNumber | string |
None. |
|
| ContactEmail | string |
None. |
|
| BillingCycle | string |
None. |
|
| PricingPlanId | integer |
None. |
|
| CustomPricingAmount | decimal number |
None. |
|
| Currency | string |
None. |
|
| IsSSOEnabled | boolean |
None. |
|
| SSOProvider | string |
None. |
|
| SSOEntityId | string |
None. |
|
| SSOLoginUrl | string |
None. |
|
| SSOLogoutUrl | string |
None. |
|
| SSOCertificate | string |
None. |
|
| SSOMetadataUrl | string |
None. |
|
| UserAccessStrategy | string |
None. |
|
| MaxUsers | integer |
None. |
|
| AllowSelfRegistration | boolean |
None. |
|
| AdminFirstName | string |
None. |
|
| AdminLastName | string |
None. |
|
| AdminEmail | string |
None. |
|
| AdminContactNumber | string |
None. |
|
| AdminTitle | string |
None. |
|
| Notes | string |
None. |
|
| IsActive | boolean |
None. |
|
| SubscriptionStartDate | date |
None. |
|
| SubscriptionEndDate | date |
None. |
|
| CreatedBy | string |
None. |
|
| IPAddress | string |
None. |
|
| BrowserInfo | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"InstitutionName": "sample string 1",
"InstitutionDomain": "sample string 2",
"AddressLine1": "sample string 3",
"AddressLine2": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"Country": "sample string 7",
"PostalCode": "sample string 8",
"ContactNumber": "sample string 9",
"ContactEmail": "sample string 10",
"BillingCycle": "sample string 11",
"PricingPlanId": 1,
"CustomPricingAmount": 1.0,
"Currency": "sample string 12",
"IsSSOEnabled": true,
"SSOProvider": "sample string 14",
"SSOEntityId": "sample string 15",
"SSOLoginUrl": "sample string 16",
"SSOLogoutUrl": "sample string 17",
"SSOCertificate": "sample string 18",
"SSOMetadataUrl": "sample string 19",
"UserAccessStrategy": "sample string 20",
"MaxUsers": 1,
"AllowSelfRegistration": true,
"AdminFirstName": "sample string 22",
"AdminLastName": "sample string 23",
"AdminEmail": "sample string 24",
"AdminContactNumber": "sample string 25",
"AdminTitle": "sample string 26",
"Notes": "sample string 27",
"IsActive": true,
"SubscriptionStartDate": "2026-02-28T13:04:00.1767155+05:30",
"SubscriptionEndDate": "2026-02-28T13:04:00.1767155+05:30",
"CreatedBy": "sample string 29",
"IPAddress": "sample string 30",
"BrowserInfo": "sample string 31"
}
application/xml, text/xml
Sample:
<DtoInstitutionOnboarding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Icodex.UserManagement.Services.Interfaces.Response.Dto.Institution"> <AddressLine1>sample string 3</AddressLine1> <AddressLine2>sample string 4</AddressLine2> <AdminContactNumber>sample string 25</AdminContactNumber> <AdminEmail>sample string 24</AdminEmail> <AdminFirstName>sample string 22</AdminFirstName> <AdminLastName>sample string 23</AdminLastName> <AdminTitle>sample string 26</AdminTitle> <AllowSelfRegistration>true</AllowSelfRegistration> <BillingCycle>sample string 11</BillingCycle> <BrowserInfo>sample string 31</BrowserInfo> <City>sample string 5</City> <ContactEmail>sample string 10</ContactEmail> <ContactNumber>sample string 9</ContactNumber> <Country>sample string 7</Country> <CreatedBy>sample string 29</CreatedBy> <Currency>sample string 12</Currency> <CustomPricingAmount>1</CustomPricingAmount> <IPAddress>sample string 30</IPAddress> <InstitutionDomain>sample string 2</InstitutionDomain> <InstitutionName>sample string 1</InstitutionName> <IsActive>true</IsActive> <IsSSOEnabled>true</IsSSOEnabled> <MaxUsers>1</MaxUsers> <Notes>sample string 27</Notes> <PostalCode>sample string 8</PostalCode> <PricingPlanId>1</PricingPlanId> <SSOCertificate>sample string 18</SSOCertificate> <SSOEntityId>sample string 15</SSOEntityId> <SSOLoginUrl>sample string 16</SSOLoginUrl> <SSOLogoutUrl>sample string 17</SSOLogoutUrl> <SSOMetadataUrl>sample string 19</SSOMetadataUrl> <SSOProvider>sample string 14</SSOProvider> <State>sample string 6</State> <SubscriptionEndDate>2026-02-28T13:04:00.1767155+05:30</SubscriptionEndDate> <SubscriptionStartDate>2026-02-28T13:04:00.1767155+05:30</SubscriptionStartDate> <UserAccessStrategy>sample string 20</UserAccessStrategy> </DtoInstitutionOnboarding>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.