Overview

This web service returns basic information about an Advanced Analytical Module (AAM) integration

Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.

Request Format

PwsGetAamIntegrations
- serviceRequest: PwsGetAamIntegrationsRq
  - RequestId: Int32
  - SessionTicket: String
  - AamIntegrationIdentity: PwsAamIntegrationRef
  - AamType: String

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information.	`1`
SessionTicket	String	Yes	Click here for more information.	`AQAXIgeu3zqNKQ0tJ2+nww==`
AamIntegrationIdentity	PwsAamIntegrationRef	Yes	This structure represents all of the unique identifying fields associated with an Advanced Analytical Module (AAM) integration.
AamType	String	Yes	O or M O stands for Other Compatible BI Tool M stands for MS Power BI	`M`

Request Usage Example(s)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetAamIntegrations>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AQAXIgeu3zqNKQ0tJ2+nww==</req:SessionTicket>
            <req:AamIntegrationIdentity>
               <com:AamIntegrationName>Projector BI</com:AamIntegrationName>
               <com:AamIntegrationUid>1152921504606847099</com:AamIntegrationUid>
            </req:AamIntegrationIdentity>
            <req:AamType>M</req:AamType>
         </pws:serviceRequest>
      </pws:PwsGetAamIntegrations>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetAamIntegrationsResponse
- PwsGetAamIntegrationsResult: PwsGetAamIntegrationsRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - AamIntegrations: PwsAamIntegrationElement[]
  - InlineDashboardsEnabledFlag: Boolean

Response Elements

Element	Data Type	Description	Sample Data

Element	Data Type	Description	Sample Data
Messages	PwsMessage[]	The web service response status and message. Click here for more information.
ResponseId	Int32	Click here for more information	`1`
Status	RequestStatus	Click here for more information	`Ok`
ServerTimestampUtc	DateTime	Click here for more information	`2025-02-10T16:26:17.5017589Z`
AamIntegrations	PwsAamIntegrationElement[]	This structure contains an Aam Integration detail structure (PwsAamIntegrationDetail)
InlineDashboardsEnabledFlag	Boolean	If ‘true’ inline dashboards are enabled for the Aam dashboard	`false`

Response Usage Example(s)

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetAamIntegrationsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetAamIntegrationsResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2025-02-10T16:26:17.5017589Z</ServerTimestampUtc>
            <a:AamIntegrations xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsAamIntegrationElement>
                  <b:AamIntegrationDetail>
                     <b:AamIntegrationId i:nil="true"/>
                     <b:AamIntegrationName>Projector BI</b:AamIntegrationName>
                     <b:AamIntegrationUid>1152921504606847099</b:AamIntegrationUid>
                     <b:AamType>M</b:AamType>
                     <b:AamInstallationParams i:type="b:PwsAamPbInstallationParams">
                        <b:PbApiUrlOverride i:nil="true"/>
                        <b:PbAuthorityUrlOverride i:nil="true"/>
                        <b:PbBase64EncryptedApplicationId>VIi9ByalddtXB4KCwKbOaITwVwSNnd/9/+zibRWnvBC1km1wOWFeMteDVP4fOHl2LVhWwp8cHpTvSlP9Daw8BOitnb5vPxFAfBkCTbIZVDY=</b:PbBase64EncryptedApplicationId>
                        <b:PbBase64EncryptedPassword>cxJSWSaVxBPaEF53+nI3hHPVQhWbQZNk+HlsPkjuhCE=</b:PbBase64EncryptedPassword>
                        <b:PbBase64EncryptedUsername>u8dVoC0zvlcbfA0BUPoG2J83xvDUOttBcl2eX4MzJ//wp28GSqvrh2goDBojBPzBPiqybxFyZCwhcZSIFSBP+w==</b:PbBase64EncryptedUsername>
                        <b:PbInlineDashboardWorkspaceId i:nil="true"/>
                        <b:PbResourceUrlOverride i:nil="true"/>
                     </b:AamInstallationParams>
                     <b:NewAamIntegrationName i:nil="true"/>
                  </b:AamIntegrationDetail>
                  <b:AamTypeDisplayValue>MS Power BI</b:AamTypeDisplayValue>
               </b:PwsAamIntegrationElement>
            </a:AamIntegrations>
            <a:InlineDashboardsEnabledFlag>false</a:InlineDashboardsEnabledFlag>
         </PwsGetAamIntegrationsResult>
      </PwsGetAamIntegrationsResponse>
   </s:Body>
</s:Envelope>

PwsGetAamIntegrations - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText

ErrorNumber	ErrorCode	ErrorText
10126	InvalidEnumerationValueSpecified	An invalid value was specified for AamType. Valid values are M, O.
50021	RefStructureMismatch	Projector BI Integration (PwsAamIntegrationRef) contains mismatched elements.
50406	InvalidParametersForWebService	Error 50406, State 1: Invalid request parameters

API Documentation

PwsGetAamIntegrations