POST api/Portal/Auth
Internal
Request Information
URI Parameters
None.
Body Parameters
IBMS_Cloud_API.Controllers.PortalAuthController+LoginInfoName | Description | Type | Additional information |
---|---|---|---|
string |
None. |
||
Username | string |
None. |
|
Password | string |
None. |
|
ProductID | integer |
None. |
|
SessionID | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Email": "sample string 1", "Username": "sample string 2", "Password": "sample string 3", "ProductID": 4, "SessionID": "sample string 5" }
text/html
Sample:
{"Email":"sample string 1","Username":"sample string 2","Password":"sample string 3","ProductID":4,"SessionID":"sample string 5"}
application/xml, text/xml
Sample:
<PortalAuthController.LoginInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API.Controllers"> <Email>sample string 1</Email> <Password>sample string 3</Password> <ProductID>4</ProductID> <SessionID>sample string 5</SessionID> <Username>sample string 2</Username> </PortalAuthController.LoginInfo>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IBMS_Cloud_API.Controllers.PortalAuthController+EmployeeResponseName | Description | Type | Additional information |
---|---|---|---|
EmployeeID | integer |
None. |
|
Reference | string |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
string |
None. |
||
MobileNo | string |
None. |
|
JobTitle | string |
None. |
|
ExpiryDate | date |
None. |
|
AccessToken | string |
None. |
|
Company | string |
None. |
|
CompanyLogo | string |
None. |
|
Quotes | integer |
None. |
|
UseMonthlyTimesheets | boolean |
None. |
|
CoverSet | boolean |
None. |
|
Styling | IBMS_Cloud_API.Controllers.PortalAuthController+PortalStyling |
None. |
Response Formats
application/json, text/json
Sample:
{ "EmployeeID": 1, "Reference": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "Email": "sample string 5", "MobileNo": "sample string 6", "JobTitle": "sample string 7", "ExpiryDate": "2025-04-28T15:13:36.4902065+01:00", "AccessToken": "sample string 9", "Company": "sample string 10", "CompanyLogo": "sample string 11", "Quotes": 12, "UseMonthlyTimesheets": true, "CoverSet": true, "Styling": { "PrimaryMainColor": "sample string 1", "SecondaryMainColor": "sample string 2", "TertiaryMainColor": "sample string 3", "ForthColor": "sample string 4", "CompanyLogo": "sample string 5", "PrimaryTextColor": "sample string 6", "IconColor": "sample string 7", "TertiaryTextColor": "sample string 8", "SmallCompanyLogo": "sample string 9" } }
text/html
Sample:
{"EmployeeID":1,"Reference":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","Email":"sample string 5","MobileNo":"sample string 6","JobTitle":"sample string 7","ExpiryDate":"2025-04-28T15:13:36.4902065+01:00","AccessToken":"sample string 9","Company":"sample string 10","CompanyLogo":"sample string 11","Quotes":12,"UseMonthlyTimesheets":true,"CoverSet":true,"Styling":{"PrimaryMainColor":"sample string 1","SecondaryMainColor":"sample string 2","TertiaryMainColor":"sample string 3","ForthColor":"sample string 4","CompanyLogo":"sample string 5","PrimaryTextColor":"sample string 6","IconColor":"sample string 7","TertiaryTextColor":"sample string 8","SmallCompanyLogo":"sample string 9"}}
application/xml, text/xml
Sample:
<PortalAuthController.EmployeeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API.Controllers"> <AccessToken>sample string 9</AccessToken> <Company>sample string 10</Company> <CompanyLogo>sample string 11</CompanyLogo> <CoverSet>true</CoverSet> <Email>sample string 5</Email> <EmployeeID>1</EmployeeID> <ExpiryDate>2025-04-28T15:13:36.4902065+01:00</ExpiryDate> <FirstName>sample string 3</FirstName> <JobTitle>sample string 7</JobTitle> <LastName>sample string 4</LastName> <MobileNo>sample string 6</MobileNo> <Quotes>12</Quotes> <Reference>sample string 2</Reference> <Styling> <CompanyLogo>sample string 5</CompanyLogo> <ForthColor>sample string 4</ForthColor> <IconColor>sample string 7</IconColor> <PrimaryMainColor>sample string 1</PrimaryMainColor> <PrimaryTextColor>sample string 6</PrimaryTextColor> <SecondaryMainColor>sample string 2</SecondaryMainColor> <SmallCompanyLogo>sample string 9</SmallCompanyLogo> <TertiaryMainColor>sample string 3</TertiaryMainColor> <TertiaryTextColor>sample string 8</TertiaryTextColor> </Styling> <UseMonthlyTimesheets>true</UseMonthlyTimesheets> </PortalAuthController.EmployeeResponse>