Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Overview


This web service retrieves the project workspace open issue alerts (PwsOpenIssueAlerts) assigned to the authenticated user

Request Format


PwsGetProjectWorkspaceAlerts Request
  • PwsGetProjectWorkspaceAlerts
    • serviceRequest: PwsGetProjectWorkspaceAlertsRq

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No

 

Click here for more information.

 

SessionTicket

String

Yes 

 

Click here for more information.

AXMZK4IOBU8dpN2JDcCpSg==

CountOnlyFlag

Boolean

No 

false

If set to 'true', the web service will include only a count of project workspace alerts. If set to 'false", the web service will return full project workspace alert details

false

IncludeOpenIssueAlertsFlag

Boolean

No 

false 

If set to 'true', details of the open issue alerts will be included in the response

false

Request Usage Example(s)


Example 01
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:web="http://projectorpsa.com/DataContracts/Shared/Web/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetProjectWorkspaceAlerts>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AXMZK4IOBU8dpN2JDcCpSg==</req:SessionTicket>
            <web:CountOnlyFlag>false</web:CountOnlyFlag>
            <web:IncludeOpenIssueAlertsFlag>false</web:IncludeOpenIssueAlertsFlag>
         </pws:serviceRequest>
      </pws:PwsGetProjectWorkspaceAlerts>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


PwsGetProjectWorkspaceAlerts Response

Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage

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

2018-03-19T18:36:30.9537148Z

OpenIssueAlerts

PwsOpenIssueAlerts

The full details of the open issue alerts

 

Response Usage Example(s)


Example 01
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetProjectWorkspaceAlertsResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetProjectWorkspaceAlertsResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Web/" 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/">2018-03-19T18:36:30.9537148Z</ServerTimestampUtc>
            <a:OpenIssueAlerts>
               <a:AlertCount i:nil="true"/>
               <a:Alerts>
                  <a:PwsOpenIssueAlert>
                     <a:CategoryIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueCategoryId i:nil="true"/>
                        <b:ProjectIssueCategoryUid>1152921504607288306</b:ProjectIssueCategoryUid>
                     </a:CategoryIdentity>
                     <a:Description>Emails are not being sent - 33017</a:Description>
                     <a:DueDate>2017-06-27T00:00:00Z</a:DueDate>
                     <a:IssueNumber>1</a:IssueNumber>
                     <a:Priority>H</a:Priority>
                     <a:ProjectIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectCode>P001229-001</b:ProjectCode>
                        <b:ProjectId i:nil="true"/>
                        <b:ProjectUid>1152921504607394118</b:ProjectUid>
                     </a:ProjectIdentity>
                     <a:ProjectIssueIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueId i:nil="true"/>
                        <b:ProjectIssueUid>1152921504606872851</b:ProjectIssueUid>
                        <b:ReferenceId i:nil="true"/>
                        <b:ExternalSystemIdentifier i:nil="true"/>
                     </a:ProjectIssueIdentity>
                     <a:StatusIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueStatusId i:nil="true"/>
                        <b:ProjectIssueStatusUid>1152921504607907772</b:ProjectIssueStatusUid>
                     </a:StatusIdentity>
                  </a:PwsOpenIssueAlert>
                  <a:PwsOpenIssueAlert>
                     <a:CategoryIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueCategoryId i:nil="true"/>
                        <b:ProjectIssueCategoryUid>1152921504607320101</b:ProjectIssueCategoryUid>
                     </a:CategoryIdentity>
                     <a:Description>Contract Term Switch (Time)</a:Description>
                     <a:DueDate>2017-08-15T00:00:00Z</a:DueDate>
                     <a:IssueNumber>1</a:IssueNumber>
                     <a:Priority>L</a:Priority>
                     <a:ProjectIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectCode>P001349-001</b:ProjectCode>
                        <b:ProjectId i:nil="true"/>
                        <b:ProjectUid>1152921504607411075</b:ProjectUid>
                     </a:ProjectIdentity>
                     <a:ProjectIssueIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueId i:nil="true"/>
                        <b:ProjectIssueUid>1152921504606873939</b:ProjectIssueUid>
                        <b:ReferenceId i:nil="true"/>
                        <b:ExternalSystemIdentifier i:nil="true"/>
                     </a:ProjectIssueIdentity>
                     <a:StatusIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueStatusId i:nil="true"/>
                        <b:ProjectIssueStatusUid>1152921504607953827</b:ProjectIssueStatusUid>
                     </a:StatusIdentity>
                  </a:PwsOpenIssueAlert>
                  <a:PwsOpenIssueAlert>
                     <a:CategoryIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueCategoryId i:nil="true"/>
                        <b:ProjectIssueCategoryUid>1152921504607320105</b:ProjectIssueCategoryUid>
                     </a:CategoryIdentity>
                     <a:Description>Contract Term Switch (Time)</a:Description>
                     <a:DueDate>2017-08-15T00:00:00Z</a:DueDate>
                     <a:IssueNumber>1</a:IssueNumber>
                     <a:Priority>L</a:Priority>
                     <a:ProjectIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectCode>P001350-001</b:ProjectCode>
                        <b:ProjectId i:nil="true"/>
                        <b:ProjectUid>1152921504607411079</b:ProjectUid>
                     </a:ProjectIdentity>
                     <a:ProjectIssueIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueId i:nil="true"/>
                        <b:ProjectIssueUid>1152921504606873941</b:ProjectIssueUid>
                        <b:ReferenceId i:nil="true"/>
                        <b:ExternalSystemIdentifier i:nil="true"/>
                     </a:ProjectIssueIdentity>
                     <a:StatusIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectIssueStatusId i:nil="true"/>
                        <b:ProjectIssueStatusUid>1152921504607953838</b:ProjectIssueStatusUid>
                     </a:StatusIdentity>
                  </a:PwsOpenIssueAlert>
               </a:Alerts>
            </a:OpenIssueAlerts>
         </PwsGetProjectWorkspaceAlertsResult>
      </PwsGetProjectWorkspaceAlertsResponse>
   </s:Body>
</s:Envelope>


PwsGetProjectWorkspaceAlerts - Common Errors and Warnings

  • No labels