Service desk
Endpoints
AssetDetailApi
[Description]
/api/AssetDetailApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
DELETE |
| key * |
|
|
GET |
| key * |
|
|
POST |
|
|
|
|
AssetListApi
[Description]
/api/AssetListApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST |
|
|
|
|
LogListApi
[Description]
/api/LogListApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST |
|
|
|
|
LogHeaderApi
[Description]
/api/LogHeaderApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET |
| logHeaderId |
|
|
LogErrorApi
[Description]
/api/LogErrorApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST |
|
|
|
|
LogMaintenanceApi
[Description]
/api/LogMaintenanceApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
DELETE |
| key * |
|
|
GET |
| logHeaderId |
|
|
POST |
|
|
|
|
PULL |
|
|
|
|
LogServiceAgreementApi
[Description]
/api/LogServiceAgreementApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST |
| serviceAgreementID |
|
|
Models
LogApiModel
Property | Data Type | Description |
---|---|---|
ReportFields |
| |
Key |
| |
TimesheetGrid |
| |
JobOutputsGrid |
| |
MaterialGrid |
| |
PlantGrid |
| |
VerticalGrid |
| |
ValidationErrors | Array [MvcValidationError] |
|
LogHeaderAnalysisTransactionApiModel
Property | Data Type | Description |
---|---|---|
AnalysisTranID | Integer |
|
LogHeaderID | Integer |
|
AssetID | Integer | Asset id. |
TranReference | String | Transaction reference. |
TranDate | String | Transaction date. |
AnalysisGroupCode | String | Transaction Group code. |
AnalysisCode | String | Analysis code. |
Quantity | Number | Quantity. |
TranStatus | String | Transaction status. |
Details | String | Details. |
JobOutputID | Integer | Id of the Job Output. |
ExtraJobOutputID | Integer |
|
UpdateFlag | Boolean | Update status. |
LogHeaderApiModel
Property | Data Type | Description |
---|---|---|
LogHeaderID | Integer | Log header id |
LogDate | String | Created date. |
LogTime | String |
|
LogBy | Integer | Log by person id. |
LogByPerson | Log by person. | |
Status | String | |
StreetNo | String | Address of the log. |
Street | String | Address of the log. |
Ward | String | Address of the log. |
Suburb | String | Address of the log. |
Phone | String | Phone number. |
Priority | String | |
ContractRef | String | Contract referenced. |
LogType | String | Log type. |
ProfitCentreCode | String | Profit Centre related. |
CompanyID | Integer | Client company. |
OrderNo | String | Client order number. |
InvContact | Integer |
|
InvPhone | String |
|
Parent | Integer | Parent log. |
Child | Integer | Child log. |
Allocation | Integer | Allocation status. |
AllocationPerson | Allocated person. | |
LocationCode | String | Location code |
ServiceType | String | Service type. |
JobCode | String | Job code. |
SchdDate | String | Scheduled date. |
SchdTime | String | Scheduled time. |
CompletedTime | String | Completed time. |
CompletedDate | String | Completed date. |
SiteContact | Integer | Site contact. |
SitePhone | String | Site contact phone. |
Description | String | Description text. |
PONumber | String | Purchase Order number. |
FinalDate | String | Final date. |
FinalTime | String | Final time. |
Escalation | String | Escalation status. |
EscalationTime | String | Escalation time. |
SalesOrderNo | Integer | Sales order number. |
ExpectedHours | Number | Expected hours to complete the job. |
ContactDetails | String | Contact detail. |
ArriveDate | String | Onsite arrival date. |
ArriveTime | String | Onsite arrival time. |
SiteAddressID | Integer | Site address id. |
RestoreDate | String | Restore date. |
RestoreTime | String | Restore time. |
CompletedByID | Integer | Id of person completed the job. |
FinalisedByID | Integer | Id of person finalised the job. |
Comment | String | Comments. |
EventTimeStamp | String |
|
DispatcherID | Integer |
|
ServiceAgreementID | Integer | Service Agreement document id. |
SiteContactName | String | Site contact person. |
InvoiceContactName | String | Invoice contact person. |
NextEscalationRunDate | String |
|
City | String | City. |
Country | String | Country. |
Latitude | Number | Latitude of address in map. |
Longitude | Number | Longitude of address in map. |
LogAddress | String | Log address. |
ReviewByID | Integer | id of reviewed person. |
AssetTaskID | Integer | Task id. |
RunID | Integer | Run id. |
SchdDateNext | String | Next scheduled date. |
SchdTimeNext | String | Next schedule time. |
PercentComplete | Number | Percent complete. |
ActualTimeUnitsQuantity | Number | Actual |
WorkGroupID | Integer | Workgroup id |
SequenceNumber | Integer | Sequence number. |
SchdDateOriginal | String | Original scheduled date. |
SchdTimeOriginal | String | Original scheduled time. |
SentFlag | Integer | Sent status. |
WorkOrderNo | Integer | Work Order number |
OutputQuantity | Number | Output quanity. |
SchdDateHours | Number |
|
SchdDateMaximumHours | Number |
|
RestoreDateTargetHours | Number |
|
CompleteDateTargetHours | Number |
|
StartedDateActualHours | Number |
|
RestoreDateActualHours | Number |
|
CompletedDateLDHours | Number |
|
SchdDateUnits | String |
|
SchdDateMaximumUnits | String |
|
RestoreDateTargetUnits | String |
|
CompleteDateTargetUnits | String |
|
StartedDateActualUnits | String |
|
RestoreDateActualUnits | String |
|
CompletedDateLDUnits | String |
|
SchdDateTarget | String |
|
SchdTimeTarget | String |
|
SchdDateMaximum | String |
|
SchdTimeMaximum | String |
|
RestoreDateTarget | String |
|
RestoreTimeTarget | String |
|
StartedDateActual | String | Actual started date. |
StartedTimeActual | String | Actual started time. |
RestoreDateActual | String | Actual restored date. |
RestoreTimeActual | String | Actual restored time. |
CompleteDateTarget | String |
|
CompleteTimeTarget | String |
|
ArriveDateLDHours | Number |
|
ArriveDateLDUnits | String |
|
FinalDateLDHours | Number |
|
FinalDateLDUnits | String |
|
CancelledDate | String | Cancelled date. |
CancelledTime | String | Cancelled time. |
CancelledByID | Integer | Person who cancelled by id. |
AssetID | Integer | Asset id. |
CompletionDetails | String | Details of completion. |
WorkCentreCode | String | Work Centre code. |
AssetLocation | String | Asset location. |
Run |
| |
AssetTask |
| |
ServiceAgreement | Service agreement | |
Asset |
| |
StoredFiles | Array [StoredFilesApiModel] |
|
LogDetails | Array [LogHeaderDetailsApiModel] |
|
AnalysisTransactions |
| |
Extensions | Array [LogHeaderExtension] |
|
LogHeaderAssetApiModel
Property | Data Type | Description |
---|---|---|
AssetID | Integer | Asset id. |
AssetCode | String | Asset code. |
ExternalCode | String | External code |
Description | String | Description text. |
JobCode | String | Job code. |
ScheduleCode | String | Schedule code. |
Quantity | Number | Quantity. |
Unit | String | Unit measurement. |
Details | String | Details. |
Inactive | Integer | Inactive status. |
CompanyID | Integer | Company id. |
CompanyName | String | Company name. |
ParentAssetID | Integer | Parent asset id. |
AssetLocation | String | Asset location. |
StreetNo | String | Asset location field. |
Street | String | Asset location field. |
Suburb | String | Asset location field. |
City | String | Asset location field. |
Country | String | Asset location field. |
AssetAttributeValues |
| |
AssetContracts | Array [LogHeaderAssetContractApiModel] |
|
LogHeaderAssetAttributeValueApiModel
Property | Data Type | Description |
---|---|---|
DataLabel | String |
|
DataType | Integer |
|
DateData | String |
|
NumericData | Number |
|
TextData | String |
|
Delete | Boolean |
|
LogHeaderAssetContractApiModel
Property | Data Type | Description |
---|---|---|
AssetContractID | Integer | Asset contract id. |
ContractCode | String | Contract code. |
Delete | Boolean |
|
LogHeaderAssetTaskApiModel
Property | Data Type | Description |
---|---|---|
AssetTaskID | Integer |
|
AssetTaskDescription | String |
|
AssetTaskDetails | String |
|
ContractCode | String | Contract code. |
ScheduleCode | String | Schedule code. |
AssetContractID | Integer | Asset contract id. |
TaskID | Integer | Task id. |
WorkGroupID | Integer | Work group id |
RunID | Integer |
|
RunCode | Integer |
|
FrequencyCode | String |
|
Recurring | Integer |
|
OutputCode | String |
|
SequenceNumber | Integer |
|
BudgetTimeUnitsQuantity | Number |
|
BudgetTimeUnit | String |
|
RunDayNumber | Integer |
|
RunDay | String |
|
Inactive | Integer | Inactive status. |
ScheduledStartDate | String | Scheduled start date. |
UseExemptionDates | Integer |
|
AssetCode | String | Asset code. |
AssetID | Integer | Asset id. |
WorkOrderNo | Integer | Work Order number. |
ServiceAgreementID | Integer | Service agreement id. |
ExpectedAnnualQuantity | Number |
|
ServiceType | String | Service type. |
ScheduledEndDate | String | Schedule end date. |
Task |
|
LogHeaderDetailsApiModel
Property | Data Type | Description |
---|---|---|
LogDetailID | Integer |
|
LogHeaderID | Integer | Log header id. |
DetailDate | String | Date. |
DetailTime | String | Time. |
DetailType | String | Type. |
PersonID | Integer | Id of person. |
Comments | String | Comments. |
TSCreated | Integer |
|
TimesheetDate | String |
|
ActivityCode | String | Activity code. |
Hours | Number |
|
JobTranID | Integer | Id of job transaction. |
WorkCentreCode | String | Work Centre code. |
Reference | String | Reference. |
ReferenceDescription | String | Reference description. |
LogHeaderExtension
Property | Data Type | Description |
---|---|---|
Name | String |
|
Type | String | ='String', 'Int', 'Bool', 'Decimal', 'DateTime'. |
ValueStr | String | Value string. |
ValueInt | Integer | Value integer. |
ValueBool | Boolean | Value boolean. |
ValueDec | Number | Value decimal. |
ValueDate | String | Value date. |
LogHeaderPersonApiModel
Property | Data Type | Description |
---|---|---|
PersonID | Integer | Person id. |
FullName | String | Person full name. |
LogHeaderRunApiModel
Property | Data Type | Description |
---|---|---|
RunID | Integer |
|
RunCode | String |
|
RunDescription | String |
|
RunDetails | String |
|
WorkGroupID | Integer |
|
DefaultPersonID | Integer |
|
Duration | Integer |
|
RunDay | String |
|
RouteCode | String |
|
Inactive | Integer |
|
ScheduleCode | String |
|
OutputCode | String |
|
LogHeaderServiceAgreementApiModel
Property | Data Type | Description |
---|---|---|
ID | Integer |
|
Code | String | Service Agreement code. |
Description | String | SA description. |
Details | String | SA detail |
ClientSource | String | The source of the Client |
CompanyID | Integer | Client company id. |
DefaultJobCode | String | The default job code. |
DefaultParentJobCode | String | The Job Code used as the default Parent Job. |
DefaultAgreement | Integer | Default agreement status. |
DefaultLogDescription | String | The default description on new logs created under this Service Agreement |
DefaultAllocation | Integer | The default person in the Allocate To field on new logs. |
DefaultDispatcherID | Integer | The default dispatcher id on new logs. |
Inactive | Integer | Inactive status. |
JobTemplateCode | String | Job template code |
DefaultReportID | Integer | The default report on new logs. |
DefaultCity | String | The default city on new logs. |
DefaultCountry | String | The default country on new logs. |
LogHeaderTaskApiModel
Property | Data Type | Description |
---|---|---|
TaskID | Integer | Task id. |
TaskCode | String | Task code. |
Description | String | Task description. |
Details | String | Details. |
JobCode | String | Job code. |
StartDate | String | Start date. |
EndDate | String | End date. |
WorkDays | Integer | Working days. |
TaskManagerID | Integer | Id of task manager. |
Inactive | Integer | Inactive status. |
PercentCompleteOnSummary | Integer | Percent of complete. |
WorkCentreCode | String | Work Centre code. |
WorkCentreDesc | String | Work Centre description. |
BudgetHours | Number | Number of hours budgeted. |
ActualHours | Number | Actual hours. |
EstimateHours | Number | Number of hours estimated. |
Completed | Number |
|
MachineID | Integer | Machine id. |
SequenceNo | Integer | Sequence number. |
ProductionQty | Number | Quanity of production. |
ParentTaskID | Integer | Id of parent task. |
DefFrequencyCode | String |
|
DefRecurring | Integer |
|
WorkGroupID | Integer | Work group id. |
TaskTypeID | Integer | Task type by id. |
TaskLag | Integer |
|
DefServiceAgreementID | Integer | Service Agreement id. |
LogHeaderWorkGroupApiModel
Property | Data Type | Description |
---|---|---|
WorkGroupID | Integer | Work group id. |
Description | String | Description. |
ServiceDeskKey
Property | Data Type | Description |
---|---|---|
LogHeaderId | Integer | Log header id. |
LogServiceAgreementApiKey
Property | Data Type | Description |
---|---|---|
ServiceAgreementID | Integer | Id of Service agreement. |
ServiceAgreementCode | String | Code of Service agreement |
OrderNo | String | Order number. |
LogHeaderID | Integer | Log header id. |
AssetID | Integer | Related asset id |
ServiceDeskLine
Property | Data Type | Description |
---|---|---|
LogHeaderIdLink |
| |
EscalationFlag | String |
|
LogHeaderId | Integer | Log header id. |
LogDate | Log date. | |
LogStatus | String | Log status. |
Description | String | Description. |
LogPriorityDescription | String | Priority description. |
SchdDate | String | Scheduled date. |
LogByPerson | String | Created person. |
JobCode | String | Job code. |
JobDescription | String | Job description. |
Client | String | Client company. |
SchdDateOriginal | String | Original scheduled date. |
Allocation | Integer | Allocated person. |
FromTime | String |
|
JSON | String |
|
ServiceAgreementID | Integer | The related Service Agreement. |
ServiceType | String | Service type. |
ProfitCentreCode | String | Profit Centre code. |
JobProfitCentreCode | String | Job Profit Centre code. |
LogType | String | Log type. |
ActivityCode | String | Activity code. |
WorkCentreCode | String | Work centre code. |
CompletedDate | String | Completed date. |
FinalDate | String | Finalised date. |
EventTimeStamp | String |
|
UpdatedDate | String | Updated date. |
Status | String | Status. |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey |
| |
CurrentKey |
| |
Key |
| |
Index | Integer |
|
TabletLogMaintenanceReportFields
Property | Data Type | Description |
---|---|---|
LogNo | Log number | |
AllocatedTo | Allocated person. | |
LogDate | Log date. | |
LogTime | TimeViewData | Log time. |
OriginalLogDate | Original log date. | |
Description | Description. | |
Client | Client company. | |
SiteContact | Site contact. | |
ContactPhoneNo | Contact phone. | |
Address | Address. | |
ContactDetail | Contact detail. | |
JobCode | Job code. | |
Status | Status. | |
Details | Details. | |
ArrivedOnSiteDate | Date arrived on Site. | |
ArrivedOnSiteTime | Time arrived on Site. | |
CompletedDate | Completed date. | |
CompletedTime | Completed time. | |
CompletionDetails | Completed details. | |
ExpectedHours | Number of hours expected. | |
Priority | Priority status. | |
AssetID | Asset id. | |
ExtensionFields | Extension fields. | |
RetailSummaryHours |
| |
RetailSummaryLabour |
| |
RetailSummaryMaterial |
| |
RetailSummaryPlant |
| |
RetailSummaryTotal |
| |
OutputSummary | Output summary. |
TabletJobOutputsKey
Property | Data Type | Description |
---|---|---|
DocketId | Integer | Docket id. |
ScheduleCode | String | Schedule code. |
OutputCode | String | Output code. |
JobCode | String | Job code. |
TabletJobOutputsLine
Property | Data Type | Description |
---|---|---|
DocketDate | String | Docket date. |
JobCode | Job code. | |
ScheduleCode | Schedule code. | |
OutputCode | Output code. | |
Unit | String | Unit measurement. |
Rate | Rate. | |
Quantity | Quantity. | |
Value | Value. | |
Details | Details | |
Delete |
| |
DocketNo | Docket number. | |
Status | String | Status. |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey |
| |
CurrentKey |
| |
Key |
| |
Index | Integer |
|
TabletMaterialDetailKey
Property | Data Type | Description |
---|---|---|
DocketId | Integer | Docket id. |
CatalogLineId | Integer | Catalogue line id |
MaterialCode | String |
|
CompanyId | Integer | Company id |
ActivityCode | String | Activity code. |
ItemId | Integer |
|
RateCode | String | Rate code. |
WorkCentreCode | String | Work centre code. |
JobCode | String | Job code. |
FormId | String | Form id. |
TabletMaterialLine
Property | Data Type | Description |
---|---|---|
DocketDate | String | Docket date. |
JobCode | Job code. | |
MaterialCode | Material code. | |
Supplier | String | Supplier name. |
SupplierValue |
| |
RateCode | String |
|
DocketNo | Docket number. | |
ActivityCode | String | Activity code. |
ActivityCodeValue | Activity code. | |
WorkCentreCode | Work centre code. | |
Description | Description. | |
Quantity | Quantity. | |
Unit | String | Unit measurements. |
Delete |
| |
EnteredRate | Manual entered rate. | |
EnteredCost | Manual entered cost. | |
Status | String | Status |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey |
| |
CurrentKey |
| |
Key |
| |
Index | Integer |
|
TabletPlantDetailKey
Property | Data Type | Description |
---|---|---|
Idx | Integer |
|
PersonId | Integer | Person id. |
DocketId | Integer | Docket id. |
CatalogLineId | CatalogLineId | Catalogue line id. |
PlantCode | String | Plant code. |
CompanyId | Integer | Client company id. |
ActivityCode | String | Activity code. |
ItemId | Integer |
|
RateCode | String | Rate code |
WorkCentreCode | String | Work centre code. |
HasOtherTimesheetGroup | Boolean | Other Timesheet Group |
TranType | String |
|
JobCode | String | Job code. |
FormId |
| Form id. |
TabletPlantLine
Property | Data Type | Description |
---|---|---|
DocketDate | String | Docket date |
JobCode | Job code | |
PlantCodeExternal | Plant code external | |
PlantCodeInternal | Plant code Internal. | |
TranType | String |
|
Supplier | String | Supplier name. |
SupplierValue |
| |
RateCode | String | Rate code. |
DocketNo | Docket number | |
ActivityCode | String | Activity code. |
ActivityCodeValue | Activity code. | |
WorkCentreCode | Work Centre code. | |
Description | Description. | |
Comments | Comments. | |
Quantity | Quanity. | |
Unit | String | Unit measurement. |
Delete | Value in ‘Delete’ check box. | |
CostRate | Cost rate. | |
EnteredRate | Manual entered rate. | |
EnteredCost | Manual entered cost. | |
ActivityCodeLookup |
| |
SupplierControl |
| |
RateCodeControl |
| |
ActivityCodeControl |
| |
Status | String | Status |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey |
| |
CurrentKey |
| |
Key |
| |
Index | Integer |
|
TabletLogMaintenanceKey
Property | Data Type | Description |
---|---|---|
LogHeaderId | Integer | Log header id. |
TabletTimesheetDetailKey
Property | Data Type | Description |
---|---|---|
DocketId | Integer | Docket id. |
PersonId | Integer | Person id. |
JobCode | String | Job code. |
ActivityCode | String | Activity code. |
ActivityType | String | Activity type. |
ActivitySubType | String | Activity sub type. |
TimeCode | String | |
WorkCentreCode | String | Work Centre code. |
PersonCode | String | Person code. |
TimesheetGroupID | Integer | Timesheet group id. |
ProfileID | Integer |
|
BreakDuration | Number | Break duration. |
TabletTimesheetLine
Property | Data Type | Description |
---|---|---|
Selected |
| |
Person | Person. | |
DocketDate | String | Docket date. |
JobCode | String | Job code. |
JobCodeLookup |
| |
Action | Action. | |
ActivityCode | Activity code. | |
WorkCentreCode | Work Centre code. | |
Allowance | Allowance. | |
ActivityType | String | Activity type. |
StartTime | Start time. | |
EndTime | End time. | |
TimeCode | String | |
Description | Description. | |
Quantity | Quantity. | |
Details | String | Details |
Delete | Value in ‘Delete’ check box. | |
OutputMeasure | To indicate the number of Outputs completed by that person in the period of time. | |
ActivitySubType | String | Activity sub type. |
TimeCodes | Array [Tuple_String] | |
EmployeeProfiles | Array [KeyValuePair] | Employee profile. |
SubContractor | Boolean | Subcontractor info. |
PlantIssues | Plant issue for is for users who also enter their plant items. | |
DocketNo | Docket number. | |
EmployeeProfile | Employee profile | |
TimesheetBreaks | Timesheet break. | |
Status | String | Status. |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey |
| |
CurrentKey |
| |
Key |
| |
Index | Integer |
|
Example
%Title
- 1 Endpoints
- 1.1 AssetDetailApi
- 1.2 AssetListApi
- 1.3 LogListApi
- 1.4 LogHeaderApi
- 1.5 LogErrorApi
- 1.6 LogMaintenanceApi
- 1.7 LogServiceAgreementApi
- 2 Models
- 2.1 LogApiModel
- 2.2 LogHeaderAnalysisTransactionApiModel
- 2.3 LogHeaderApiModel
- 2.4 LogHeaderAssetApiModel
- 2.5 LogHeaderAssetAttributeValueApiModel
- 2.6 LogHeaderAssetContractApiModel
- 2.7 LogHeaderAssetTaskApiModel
- 2.8 LogHeaderDetailsApiModel
- 2.9 LogHeaderExtension
- 2.10 LogHeaderPersonApiModel
- 2.11 LogHeaderRunApiModel
- 2.12 LogHeaderServiceAgreementApiModel
- 2.13 LogHeaderTaskApiModel
- 2.14 LogHeaderWorkGroupApiModel
- 2.15 ServiceDeskKey
- 2.16 LogServiceAgreementApiKey
- 2.17 ServiceDeskLine
- 2.18 TabletLogMaintenanceReportFields
- 2.19 TabletJobOutputsKey
- 2.20 TabletJobOutputsLine
- 2.21 TabletMaterialDetailKey
- 2.22 TabletMaterialLine
- 2.23 TabletPlantDetailKey
- 2.24 TabletPlantLine
- 2.25 TabletLogMaintenanceKey
- 2.26 TabletTimesheetDetailKey
- 2.27 TabletTimesheetLine
- 3 Example
- 3.1 %Title