...
This structure is used to uniquely identify a client. Clients project issue. Project issues can be identified by ClientNumber or ClientUid. When specifying a PwsClientRef as an input to a web service, you may specify one or both the ClientNumber and ClientUid. However, if you do specify both they must both refer to the same client or the client reference will not be considered valid. When a PwsClientRef is returned in the response to a web service, both the ClientNumber and ClientUid will be populated, and guaranteed to refer to a single clientProjectIssueUid, and it can also be tagged by a user defined ID called ReferenceId. The reference id is not stored with the issue in the database, but may be used as described below to correlate submitted issues (especially new ones) to errors that may be returned in the response from the PwsSaveProjectIssues service.
Format
| Panel | ||
|---|---|---|
| ||
|
Elements
Element | Data Type | Required? | Description | Sample Data | |||||
|---|---|---|---|---|---|---|---|---|---|
ClientIdProjectIssueId | Int32 | No | The client project issue Id is a unique identifier for a clientProject. For internal use only. | ||||||
ProjectIssueUid | Int64 | Yes | A unique and immutable identifier for a project issue. | 1152921504606875454 | |||||
ClientNumberReferenceId | String (20) One of ClientNumber or ClientUid is required | The client number is a unique identifier for a client. If not specified, this field will be auto generated. | ClientUid | Int64 | See ClientNumber | The client Uid is a unique and immutable identifier for a client | No | This is a user-defined ID for project issue. It allows user to tag project issues that are submitted in a web service request, and is echoed in the web service response to allow user to correlate project issues in the response to the ones in request. | #3 |
| ExternalSystemIdentifier | String (20) | No | The external system identifier is a unique identifier for a project issue. |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<ProjectIssueId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">28485</ProjectIssueId> <com:PwsClientRef> <com:ClientNumber>C000121</com:ClientNumber><ProjectIssueUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606875461</ProjectIssueUid> </com:PwsClientRef> <ReferenceId xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">#1</ReferenceId> <ExternalSystemIdentifier i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> |