/
PwsGetProjectIssueCategories

PwsGetProjectIssueCategories

Owned by Min Zeng
Last updated: about 10 hours ago by Bettina Borces

Overview


This web service retrieves a list of project issue categories, based upon a unique project identifier (PwsProjectRef). 


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


PwsGetProjectIssueCategories Request

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.

ASA2SxZGgEWiNl525Vyqzw==

IncludeInactiveFlag

Boolean

No

false

If set to 'true', inactive issue categories are also included in the response.

false

ProjectIdentity

PwsProjectRef

Yes


This is the identity of the project.


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/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsGetProjectIssueCategories>
         <pws:serviceRequest>
            <req:SessionTicket>ASA2SxZGgEWiNl525Vyqzw==</req:SessionTicket>
            <web:IncludeInactiveFlag>true</web:IncludeInactiveFlag>
            <web:ProjectIdentity>
               <com:ProjectCode>P001053-WS2</com:ProjectCode>
            </web:ProjectIdentity>
         </pws:serviceRequest>
      </pws:PwsGetProjectIssueCategories>
   </soapenv:Body>
</soapenv:Envelope>


Response Format


PwsGetProjectIssueCategories Response

Response Elements


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.


Status

RequestStatus

Click here for more information.


ServerTimestampUtc

DateTime

Click here for more information.


IssueCategories

PwsProjectIssueCategory[]

A collection of project issue categories. Click here for more information.


Response Usage Example(s)


Example 01 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetProjectIssueCategoriesResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetProjectIssueCategoriesResult 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/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-06T18:04:48.4152887Z</ServerTimestampUtc>
            <a:IssueCategories>
               <a:PwsProjectIssueCategory>
                  <ProjectIssueCategoryId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">351612</ProjectIssueCategoryId>
                  <ProjectIssueCategoryUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606992779</ProjectIssueCategoryUid>
                  <a:InactiveFlag>false</a:InactiveFlag>
                  <a:Name>Design</a:Name>
                  <a:SortOrder>1</a:SortOrder>
               </a:PwsProjectIssueCategory>
               <a:PwsProjectIssueCategory>
                  <ProjectIssueCategoryId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">465610</ProjectIssueCategoryId>
                  <ProjectIssueCategoryUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607312586</ProjectIssueCategoryUid>
                  <a:InactiveFlag>true</a:InactiveFlag>
                  <a:Name>Production</a:Name>
                  <a:SortOrder>2</a:SortOrder>
               </a:PwsProjectIssueCategory>
            </a:IssueCategories>
         </PwsGetProjectIssueCategoriesResult>
      </PwsGetProjectIssueCategoriesResponse>
   </s:Body>
</s:Envelope>

PwsGetProjectIssueCategories - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

23003ProjectIdentityRequiredForGetIssueCategoriesA project identity must be specified.
54282ProjectNotFoundSpecified project does not exist.