CreatePartRequestHeader(CreatePartRequestHeaderSetup) Method

Setup object for API invocation.

Used to create a new part request header.

This overload takes a setup object.

Syntax

'Declaration

Public Overloads Function CreatePartRequestHeader( _
   ByVal _setupParam_ CreatePartRequestHeaderSetup _
) As ToolkitResult

public ToolkitResult CreatePartRequestHeader(
   CreatePartRequestHeaderSetup _setupParam_
)

Parameters

setupParam

Setup object for API invocation.

Return Value

The following values are populated in the ToolkitResult object returned by the API method:

  • Objid - The Objid of the Header.
  • IDNum - The IDNum of the Header.

Remarks

If using the CreatePartRequestHeaderSetup variant of this API, and if the CaseIDNum property on the CreatePartRequestHeaderSetup object is set to a value, and there is a dash ("-") in the identifier, it will be assumed that it is a subcase identifier. Otherwise, it will be treated as a case identifier.

To create a Part Request Header for a case or subcase, without respect for dashes ("-") in the case/subcase identifier, see the CreatePartRequestHeaderCase or the CreatePartRequestHeaderSubcase APIs respectively.

NOTE: If you have one or more dashes ("-") in your case identifier numbering scheme, you MUST use one of the two CreatePartRequestHeaderCase/Subcase variants. Do not use this API (CreatePartRequestHeader) as it will mistakenly identify every case identifier as a subcase.

NOTE: The ContractObjId property on the CreatePartRequestHeaderSetup object should not be set (left as default) unless you need this functionality AND have installed the First Choice ClearCallCenter for ClearLogistics product and schema changes. If you do not have this product and wish to use this functionality, please contact First Choice Software.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server family

Reference

LogisticsToolkit Class LogisticsToolkit Members Overload List FChoice.Toolkits.Clarify~FChoice.Toolkits.Clarify.Logistics.CreatePartRequestHeaderSetup