logo
API docs by Redocly

Service Partner Gateway (v1.2.8)

Download OpenAPI specification:Download

E-mail: api@tuatahifibre.co.nz

Overview

The Service Partner Gateway (SPG) is used to exchange jobs and job updates between TFF and Service Partners.

SPG Overview

The Workorders API is invoked by Service Partners to provide updates and details for workorders and tasks to SPG.

Updates must be send as events, which include the workorder(s) and task(s) being updated with all necessary details. The main method to submit an event to:

  POST /events

This is a generic method which accepts events on any type. The Workorders API also provides the alternative convenience methods for each event type. These convenience methods are simply wrapping a work order payload into an event-compliant object and forward it to the /event endpoint

Events flow

Update Task Schedule

The work can be resumed by sending the following event:

  • UpdateTaskScheduleEvent (start, end)

Event API

Send an event to the Service Partner Gateway

Send an event to the Service Partner Gateway. This is a generic method for sending events of any supported type.

Authorizations:
tff_oAuth_client_cred
header Parameters
X-Transaction-Id
string

Represents the unique message identifier associated with the Event.

Request Body schema: application/json
required
One of
eventId
string

When available, consumer can provide an event id linked to this event in their system

eventDateTime
string (common.datetime.cdatetime) (1|2\d{3})-(0[1-9]|1[012])-(0[1-9]|[12]\d|3[0...

LFC API Standard Date Time format The date and time in RFC3339 with 'Z' as tzd, microseconds optional, valid formats are ["yyyy-MM-dd'T'HH:mm:ssZ", "yyyy-MM-dd'T'HH:mm:ss.SSSZ" ]

eventType
required
string
Value: "UpdateTaskScheduleEvent"

Event type

required
object (event.workorder.UpdateTaskScheduleEvent)

Represents an Update Task Schedule Event

Responses

Request samples

Content type
application/json
{
  • "eventId": "string",
  • "eventDateTime": "string",
  • "eventType": "UpdateTaskScheduleEvent",
  • "workorder": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": "string",
  • "cause": "string",
  • "details": [
    ]
}

Event Types

Update Task Schedule

Send a new schedule for a single Task, or for every Task on the same Work Order.

Authorizations:
tff_oAuth_client_cred
header Parameters
X-Transaction-Id
string

Represents the unique message identifier associated with the Event.

Request Body schema: application/json
wonum
required
string

Original Id assigned by TFF to the Work Order.

required
Array of event.workorder.task.UpdateTaskAppointment (object)

A list of tasks associated with the Work Order.

Responses

Request samples

Content type
application/json
{
  • "wonum": "string",
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": "string",
  • "cause": "string",
  • "details": [
    ]
}