/
Service desk

Service desk

Endpoints

 

AssetDetailApi

[Description]

/api/AssetDetailApi

/api/AssetDetailApi

Operation

Logged in User

Parameters

Body

Response

DELETE

 

key *

 

 

GET

 

key *

 

 

POST

 

 

 

 

 

AssetListApi

[Description]

/api/AssetListApi

/api/AssetListApi

Operation

Logged in User

Parameters

Body

Response

POST

 

 

 

 

 

LogListApi

[Description]

/api/LogListApi

/api/LogListApi

Operation

Logged in User

Parameters

Body

Response

POST
Return all Workbench logs.

 

 

 

 

LogHeaderApi

[Description]

/api/LogHeaderApi

/api/LogHeaderApi

Operation

Logged in User

Parameters

Body

Response

GET
Returns Log Header info including service agreement and asset tasks.

 

logHeaderId

 

 

 

LogErrorApi

[Description]

/api/LogErrorApi

/api/LogErrorApi

Operation

Logged in User

Parameters

Body

Response

POST

 

 

 

 

 

LogMaintenanceApi

[Description]

/api/LogMaintenanceApi

/api/LogMaintenanceApi

Operation

Logged in User

Parameters

Body

Response

DELETE

 

key *

 

 

GET

 

logHeaderId

 

 

POST

 

 

 

 

PULL

 

 

 

 

 

LogServiceAgreementApi

[Description]

/api/LogServiceAgreementApi

/api/LogServiceAgreementApi

Operation

Logged in User

Parameters

Body

Response

POST
Create a new Log from service agreement.

 

serviceAgreementID
serviceAgreementCode
orderNo
description
allocatedPersonId
assetID
relatedRecord
relatedRecordID

 

 

Models

 

LogApiModel

Property

Data Type

Description

Property

Data Type

Description

ReportFields

TabletLogMaintenanceReportFields

 

Key

TabletLogMaintenanceKey

 

TimesheetGrid

GridResult_TabletTimesheetLine

 

JobOutputsGrid

GridResult_TabletJobOutputsLine

 

MaterialGrid

GridResult_TabletMaterialLine

 

PlantGrid

GridResult_TabletPlantLine

 

VerticalGrid

GridResult_WebEAVGridLine_WebEAVGridKey

 

ValidationErrors

Array [MvcValidationError]

 

Back to top

LogHeaderAnalysisTransactionApiModel

Property

Data Type

Description

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.

Back to top

 

LogHeaderApiModel

Property

Data Type

Description

Property

Data Type

Description

LogHeaderID

Integer

Log header id

LogDate

String

Created date.

LogTime

String

 

LogBy

Integer

Log by person id.

LogByPerson

LogHeaderPersonApiModel

Log by person.

Status

String

Log status.

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

Log priority.

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

LogHeaderPersonApiModel

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