POST api/v1/VisualReports/Login/PostLoginForSSOUser

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

GeneralAPIObject
NameDescriptionTypeAdditional information
TenantId

integer

None.

UserId

integer

None.

CityId

integer

None.

ProgramId

integer

None.

StartValue

integer

None.

CancellationReason

string

None.

CourseId

integer

None.

TimeZone

string

None.

ModuleId

integer

None.

LoginId

string

None.

Password

string

None.

Token

string

None.

CertId

integer

None.

LocationID

integer

None.

MacId

string

None.

UniqueID

string

None.

ContainerName

string

None.

TenantName

string

None.

UDID

string

None.

PostLoginActions

boolean

None.

start

integer

None.

count

integer

None.

loc

string

None.

Request Formats

application/json, text/json

Sample:
{
  "start": 1,
  "count": 1,
  "loc": "sample string 2",
  "TenantId": 1,
  "UserId": 2,
  "CityId": 3,
  "ProgramId": 4,
  "StartValue": 5,
  "CancellationReason": "sample string 6",
  "CourseId": 7,
  "TimeZone": "sample string 8",
  "ModuleId": 9,
  "LoginId": "sample string 10",
  "Password": "sample string 11",
  "Token": "sample string 12",
  "CertId": 13,
  "LocationID": 14,
  "MacId": "sample string 15",
  "UniqueID": "sample string 16",
  "ContainerName": "sample string 17",
  "TenantName": "sample string 18",
  "UDID": "sample string 19",
  "PostLoginActions": true
}

text/html

Sample:
{"start":1,"count":1,"loc":"sample string 2","TenantId":1,"UserId":2,"CityId":3,"ProgramId":4,"StartValue":5,"CancellationReason":"sample string 6","CourseId":7,"TimeZone":"sample string 8","ModuleId":9,"LoginId":"sample string 10","Password":"sample string 11","Token":"sample string 12","CertId":13,"LocationID":14,"MacId":"sample string 15","UniqueID":"sample string 16","ContainerName":"sample string 17","TenantName":"sample string 18","UDID":"sample string 19","PostLoginActions":true}

text/xml

Sample:
<GeneralAPIObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShotClassCore.Models">
  <CancellationReason>sample string 6</CancellationReason>
  <CertId>13</CertId>
  <CityId>3</CityId>
  <ContainerName>sample string 17</ContainerName>
  <CourseId>7</CourseId>
  <LocationID>14</LocationID>
  <LoginId>sample string 10</LoginId>
  <MacId>sample string 15</MacId>
  <ModuleId>9</ModuleId>
  <Password>sample string 11</Password>
  <PostLoginActions>true</PostLoginActions>
  <ProgramId>4</ProgramId>
  <StartValue>5</StartValue>
  <TenantId>1</TenantId>
  <TenantName>sample string 18</TenantName>
  <TimeZone>sample string 8</TimeZone>
  <Token>sample string 12</Token>
  <UDID>sample string 19</UDID>
  <UniqueID>sample string 16</UniqueID>
  <UserId>2</UserId>
  <count>1</count>
  <loc>sample string 2</loc>
  <start>1</start>
</GeneralAPIObject>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Token
NameDescriptionTypeAdditional information
TokenValue

string

None.

ContainerName

string

None.

IsResetRequired

boolean

None.

HasOnBoarded

boolean

None.

EncryptionKey

string

None.

PGHuburl

string

None.

PGMobileappInsightsKey

string

None.

PGGdprlink

string

None.

PrivacyPolicyInfo

PrivacyPolicy

None.

Response Formats

application/json, text/json

Sample:
{
  "TokenValue": "sample string 1",
  "ContainerName": "sample string 2",
  "IsResetRequired": true,
  "HasOnBoarded": true,
  "EncryptionKey": "sample string 5",
  "PGHuburl": "sample string 6",
  "PGMobileappInsightsKey": "sample string 7",
  "PGGdprlink": "sample string 8",
  "PrivacyPolicyInfo": {
    "IsProductPrivacyEnable": true,
    "IsPrivacyPolicy": true,
    "PolicyUrl": "sample string 3"
  }
}

text/html

Sample:
{"TokenValue":"sample string 1","ContainerName":"sample string 2","IsResetRequired":true,"HasOnBoarded":true,"EncryptionKey":"sample string 5","PGHuburl":"sample string 6","PGMobileappInsightsKey":"sample string 7","PGGdprlink":"sample string 8","PrivacyPolicyInfo":{"IsProductPrivacyEnable":true,"IsPrivacyPolicy":true,"PolicyUrl":"sample string 3"}}

text/xml

Sample:
<Token xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShotClassCore.Models">
  <ContainerName>sample string 2</ContainerName>
  <EncryptionKey>sample string 5</EncryptionKey>
  <HasOnBoarded>true</HasOnBoarded>
  <IsResetRequired>true</IsResetRequired>
  <PGGdprlink>sample string 8</PGGdprlink>
  <PGHuburl>sample string 6</PGHuburl>
  <PGMobileappInsightsKey>sample string 7</PGMobileappInsightsKey>
  <PrivacyPolicyInfo>
    <IsPrivacyPolicy>true</IsPrivacyPolicy>
    <IsProductPrivacyEnable>true</IsProductPrivacyEnable>
    <PolicyUrl>sample string 3</PolicyUrl>
  </PrivacyPolicyInfo>
  <TokenValue>sample string 1</TokenValue>
</Token>