Overview

This specifies the identity of a contract type. Contract Types can be identified by a ContractTypeName or ContractTypeUid. When specifying an PwsContractTypeRef as an input to a web service, you may specify one or both the ContractTypeName and ContractTypeUid. However, if you do specify both they must both refer to the same contract type or the contract type reference will not be considered valid. When a PwsContractTypeRef is returned in the response to a web service, both the ContractTypeName and ContractTypeUid will be populated, and guaranteed to refer to a single contract type.

Format

PwsContractTypeRef

PwsContractTypeRef
- ContractTypeId: Int32
- ContractTypeName: String (50)
- ContractTypeUid: Int64

Elements

Element

Data Type

Required?

Default

Description

Sample Data

ContractTypeId

Int32

On Insert: No

On Update: No

The contract type Id is a unique identifier for a contract type. For internal use only.

ContractTypeName

String (50)

On Insert: Yes

On Update: Yes (if the ContractTypeUid is not supplied)

The contract type name is a unique identifier for a contract type

Contract Type - Not to Exceed

ContractTypeUid

Int64

On Insert: No

On Update: Yes (if the ContractTypeName is not supplied)

A unique and immutable Id for a contract type

1152921504606846982

Usage Example(s)

Example 01 - without Uid

                    <ContractTypeIdentity>
                        <ContractTypeId i:nil="true"/>
                        <ContractTypeName>Contract Type - Not to Exceed</ContractTypeName>
                        <ContractTypeUid>1152921504606846982</ContractTypeUid>
                     </ContractTypeIdentity>