OpsUpdateResource
Request
The service request contains:
Name | Data Type | Required? | Default Value | Discussion |
---|---|---|---|---|
Resources | ResourceDescriptor | Yes | ResourceDescriptor is defined below |
ResourceDescriptor
Name | Data Type | Required? | Default Value | Discussion |
---|---|---|---|---|
ReferenceSystemId | string(20) | yes | If matches that of a resource already in Projector, then the new information replaces the old information. If it does not match then a new user will be created. If it is null then a resource will be created, but they will not be accessible via web services. | |
VendorReferenceSystemId | string(20) | yes, on insert | If null on update, then field is not updated. | |
EffectiveDate | date | yes, on insert | Required on update only if any fields tracked historically are specified. | |
FirstName | string(20) | yes, on insert | Either both or neither FirstName and LastName must be non-null. Null means leave unchanged. | |
LastName | string(20) | yes, on insert | See above. | |
MiddleName | string(20) | no | null | If FirstName and LastName are not null then this field will be update with the specified middle name. Otherwise, a null value leaves this field unchanged. |
DisplayName | string(30) | yes, on insert | Null on update means leave as is. | |
Initials | string(10) | yes, on insert | Null on update means leave as is. | |
EmailAddress | string(100) | yes, on insert | Null on update means leave as is. | |
PrimaryUserRoleName | string(50) | no | Resource | Significant only when inserting new resource. |
TimeCardApprovalFlag | bool | no | Installation-specific dafult | Set to true if timecards from this resource require approval. Null on update means leave as is. |
UpdateApprovalUsersFlag | bool | no | true | If false, then the approval user fields (TimeCardApprovalUserReferenceSystemId and ExpenseApprovalUserReferenceSystemId) are unchanged on update. If true, then they are changed by this request. |
TimeCardApprovalUserReferenceSystemId | string(20) | no | null | On update, if UpdateApprovalUsersFlag is true, then this value is updated. |
ExpenseApprovalUserReferenceSystemId | string(20) | no | null | On update, if UpdateApprovalUsersFlag is true, then this value is updated. |
UserInactiveFlag | bool | no | true | Null on update means leave as is. |
UserPmFlag | bool | no | false | If true, then user appears on lists when selecting a project manager. Null on update means leave as is. |
UserOpsCultureName | string(15) | yes, on insert | Null on update means leave as is. | |
NewUserTempPassword | string(50) | yes, on insert (if the user will be activated) | Ignored on update | |
CostCenterNumber | string(40) | Either CostCenterNumber or CostCenterName must be supplied on insert. Null on update means leave as is. | ||
CostCenterName | string(50) | Either CostCenterNumber or CostCenterName must be supplied on insert. Null on update means leave as is. | ||
LocationName | string(50) | yes, on insert | Null on update means leave as is. | |
DepartmentName | string(50) | yes, on insert | Either both or neither DepartmentName and TitleName must be non-null. Null on update means leave as is. | |
TitleName | string(50) | yes, on insert | Either both or neither DepartmentName and TitleName must be non-null. Null on update means leave as is. | |
BillableFlag | boolean | yes, on insert | true | Null on update means leave as is. |
TemporaryWorkerFlag | boolean | yes, on insert | false | Null on update means leave as is. |
ExceptionRdcHourlyRate | float | no | If this is unspecified and UpdateExceptionRdcFlag is true, then this is set to null, which means there is no override. Either both or neither of ExceptionRdcHourlyRate and ExceptionRdcCurrencyCode must be provided. | |
ExceptionRdcCurrencyCode | string(30) | no | See ExceptionRdcHourlyRate | |
UpdateExceptionRdcFlag | boolean | no | true | If false then neither ExceptionRdcHourlyRate or ExceptionRdcCurrencyCode are updated. If true, then both are updated with the values specified. |
PayCategory | string(1) | no | "S" on insert, unchanged on update | "S" = Salaried, "H" = Hourly, "O" = Salaried with overtime |
TrackMissingTimeFlag | boolean | no | true | Null on update means leave as is. |
MissingTimeEmailFlag | boolean | no | true | Null on update means leave as is. |
AllowApproveOwnTimecardsFlag | boolean | no | true | Null on update means leave as is. |
ResourceTypeCode | string(20) | yes, on insert | Required on insert. Any specified attributes in the request act as overrides to the resource type defaults. | |
ResetResourceTypeAttributesFlag | boolean | no | false | Use this flag when updating ResourceTypeCode. If true, apply default settings based on the resource type. If false, then we'll apply Projector's default settings. If any settings are also provided in this request, then we'll use those.
|
string | no | UDF name #1 | ||
UdfValue1 | string | no | UDF value #1: | |
UdfName2 | string | no | UDF name #2 | |
UdfValue2 | string | no | UDF value #2: | |
UdfName3 | string | no | UDF name #3 | |
UdfValue3 | string | no | UDF value #3: | |
PurgeFutureChangesFlag | boolean | no | false | If true, then delete all resource history records on or after the specified EffectiveDate. |
NewReferenceSystemId | string | no | Update this resource's reference ID | |
UpdateManagerUserFlag | boolean | no | false | Set resource's manager. Must also specify ManagerUserReferenceSystemId |
ManagerUserReferenceSystemId | string | no | ||
RequestedTimeOffApprovalUserReferenceSystemId | string | no | Set time off request approver | |
UpdateSubcontractorInvoiceVendorFlag | boolean | no | false | |
SubcontractorInvoiceVendorNumber | string | no | ||
SubcontractorInvoiceVendorName | string | no | ||
UpdateExpenseReportVendorFlag | boolean | no | false | |
ExpenseReportVendorNumber | string | no | ||
ExpenseReportVendorName | string | no | ||
TimeEntryDelegateUserReferenceSystemId | string | no | Set user that can enter time on behalf of this user | |
ExpenseEntryDelegateUserReferenceSystemId | string | no | Set user that can enter expense on behalf of this user | |
ActualHolidaysFlag | boolean | no | false | See Resource Types Editor |
ScheduledHolidaysFlag | boolean | no | false | See Resource Types Editor |
UpdateDelegateUsersFlag | boolean | no | false |
Setting UDF values: The table below lists the different user defined field types, and the format expected for UDF values. A non-required UDF can be deleted by specifying the Udf Name and leaving the Udf valule null.
UDF Type | UDF Value Format | Examples |
---|---|---|
Date | dd-MMM-yyyy or dd/mm/yyyy | 1-Jan-2009; 1/1/2009 |
Integer | String representation of an integral value | 27; -214 |
Resource | Resource employee ID, as stored in Projector | 57004; EMP1004 |
Text | Any text string | |
Text List | One of the valid values configured for the UDF | (depends on UDF configuration) |
Yes/No | 0 for No; 1 for Yes | 0; 1 |
Response
The following data is returned:
Name | Data Type | Discussion |
---|---|---|
ResourceStatusList | list of ResourceStatus items | see below |
ResourceErrors | list of ResourceError items | see below |
Errors
Error Code | Error | Discussion |
---|---|---|
61388 | Invalid Vendor Number or Name | |
Each ResourceStatus item contains:
Name | Data Type | Discussion |
---|---|---|
LineItemStatus | string | "ItemInserted" = Item did not previously exist. |
"ItemFailed" = Check the error list |
OpsError | OpsWebError | See Responses |
Each ResourceError item contains:
Name | Data Type | Discussion |
---|---|---|
Index | int | Index of the record (position in Resources that failed. |
OpsError | OpsWebError | See Responses |
Changelog
4.4
Parameter | Notes |
---|---|
ResourceDescriptor.ResourceTypeCode | Added as a request parameter |
ResourceDescriptor.ResetResourceTypeAttributesFlag | Added as a request parameter |