NAV Navigation
Go HTTP JavaScript Node.JS Python Ruby

Sitepass External API v3.1.27.3.Final

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

Authentication

Batch

Update or Upsert team members via a CSV file

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"multipart/form-data"},
        "Accept": []string{"application/json"},
        "Accept": []string{"string"},
        "Content-Type": []string{"string"},
        "x-api-key": []string{"string"},
        "x-api-key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/external/v1/batch/team", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /external/v1/batch/team?operation=UPSERT HTTP/1.1

Content-Type: multipart/form-data
Accept: application/json
Accept: string
Content-Type: string
x-api-key: string

var headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Accept':'string',
  'Content-Type':'string',
  'x-api-key':'string',
  'x-api-key':'API_KEY'

};

$.ajax({
  url: '/external/v1/batch/team',
  method: 'post',
  data: '?operation=UPSERT',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json',
  'Accept': 'string',
  'Content-Type': 'string',
  'x-api-key': 'string',
  'x-api-key': 'API_KEY'
}

r = requests.post('/external/v1/batch/team', params={
  'operation': 'UPSERT'
}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'multipart/form-data',
  'Accept' => 'application/json',
  'Accept' => 'string',
  'Content-Type' => 'string',
  'x-api-key' => 'string',
  'x-api-key' => 'API_KEY'
}

result = RestClient.post '/external/v1/batch/team',
  params: {
  'operation' => 'string'
}, headers: headers

p JSON.parse(result)

POST /v1/batch/team

An update operation on this endpoint with the provided CSV file will update the team members for your business. The CSV heading should map directly to the agreed upon mapping between your business and Sitepass. Please contact our development or support team for more information.

Body parameter

file: string

Parameters

Name In Type Required Description
operation query string true none
Accept header string true none
Content-Type header string true none
x-api-key header string true none
body body object false none
» file body string(binary) true none

Enumerated Values

Parameter Value
operation UPSERT
operation UPDATE
operation CREATE

Example responses

200 Response

{
  "success": true,
  "message": "string",
  "errorType": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "data": {}
}

Responses

Status Meaning Description Schema
200 OK successful operation WmsResponse
401 Unauthorized 401 response None
403 Forbidden 403 response None
404 Not Found 404 response None
500 Internal Server Error 500 response None

Configuration

Get a list of contractor categories defined in the system by contractor role id

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"string"},
        "x-api-key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/external/v1/configuration/categories/contractors/{roleId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /external/v1/configuration/categories/contractors/{roleId} HTTP/1.1

Accept: application/json
x-api-key: string

var headers = {
  'Accept':'application/json',
  'x-api-key':'string',
  'x-api-key':'API_KEY'

};

$.ajax({
  url: '/external/v1/configuration/categories/contractors/{roleId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'string',
  'x-api-key': 'API_KEY'
}

r = requests.get('/external/v1/configuration/categories/contractors/{roleId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'string',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get '/external/v1/configuration/categories/contractors/{roleId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/configuration/categories/contractors/{roleId}

Parameters

Name In Type Required Description
roleId path integer(int64) true Role ID
x-api-key header string true none

Example responses

200 Response

{
  "success": true,
  "message": "string",
  "errorType": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "data": [
    {
      "id": 0,
      "title": "string",
      "subcategories": [
        {
          "id": 0,
          "title": "string",
          "category": {},
          "mandatory": true,
          "sort": 0
        }
      ],
      "mandatory": true
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation WmsResponseListCategoryDTO
401 Unauthorized 401 response None
403 Forbidden 403 response None
404 Not Found 404 response None
500 Internal Server Error 500 response None

Get a list of team member categories defined in the system by team members role id

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"string"},
        "x-api-key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/external/v1/configuration/categories/team/{roleId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /external/v1/configuration/categories/team/{roleId} HTTP/1.1

Accept: application/json
x-api-key: string

var headers = {
  'Accept':'application/json',
  'x-api-key':'string',
  'x-api-key':'API_KEY'

};

$.ajax({
  url: '/external/v1/configuration/categories/team/{roleId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'string',
  'x-api-key': 'API_KEY'
}

r = requests.get('/external/v1/configuration/categories/team/{roleId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'string',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get '/external/v1/configuration/categories/team/{roleId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/configuration/categories/team/{roleId}

Parameters

Name In Type Required Description
roleId path integer(int64) true Role ID
x-api-key header string true none

Example responses

200 Response

{
  "success": true,
  "message": "string",
  "errorType": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "data": [
    {
      "id": 0,
      "title": "string",
      "subcategories": [
        {
          "id": 0,
          "title": "string",
          "category": {},
          "mandatory": true,
          "sort": 0
        }
      ],
      "mandatory": true
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation WmsResponseListCategoryDTO
401 Unauthorized 401 response None
403 Forbidden 403 response None
404 Not Found 404 response None
500 Internal Server Error 500 response None

Get a list of worker categories defined in the system by workers role id

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"string"},
        "x-api-key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/external/v1/configuration/categories/workers/{roleId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /external/v1/configuration/categories/workers/{roleId} HTTP/1.1

Accept: application/json
x-api-key: string

var headers = {
  'Accept':'application/json',
  'x-api-key':'string',
  'x-api-key':'API_KEY'

};

$.ajax({
  url: '/external/v1/configuration/categories/workers/{roleId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'string',
  'x-api-key': 'API_KEY'
}

r = requests.get('/external/v1/configuration/categories/workers/{roleId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'string',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get '/external/v1/configuration/categories/workers/{roleId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/configuration/categories/workers/{roleId}

Parameters

Name In Type Required Description
roleId path integer(int64) true Role ID
x-api-key header string true none

Example responses

200 Response

{
  "success": true,
  "message": "string",
  "errorType": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "data": [
    {
      "id": 0,
      "title": "string",
      "subcategories": [
        {
          "id": 0,
          "title": "string",
          "category": {},
          "mandatory": true,
          "sort": 0
        }
      ],
      "mandatory": true
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation WmsResponseListCategoryDTO
401 Unauthorized 401 response None
403 Forbidden 403 response None
404 Not Found 404 response None
500 Internal Server Error 500 response None

Get a list of roles defined in the system that are grouped by type

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"string"},
        "x-api-key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/external/v1/configuration/roles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /external/v1/configuration/roles HTTP/1.1

Accept: application/json
x-api-key: string

var headers = {
  'Accept':'application/json',
  'x-api-key':'string',
  'x-api-key':'API_KEY'

};

$.ajax({
  url: '/external/v1/configuration/roles',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'string',
  'x-api-key': 'API_KEY'
}

r = requests.get('/external/v1/configuration/roles', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'string',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get '/external/v1/configuration/roles',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/configuration/roles

Parameters

Name In Type Required Description
x-api-key header string true none

Example responses

200 Response

{
  "success": true,
  "message": "string",
  "errorType": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "data": {
    "List of Contractor roles": [
      {
        "id": 0,
        "title": "string",
        "description": "string",
        "defaultSystemRole": true,
        "selfRegistration": true
      }
    ],
    "List of Worker roles": [
      {
        "id": 0,
        "title": "string",
        "description": "string",
        "defaultSystemRole": true,
        "selfRegistration": true
      }
    ],
    "List of Team Member roles": [
      {
        "id": 0,
        "title": "string",
        "description": "string",
        "defaultSystemRole": true,
        "selfRegistration": true
      }
    ],
    "List of Visitor roles": [
      {
        "id": 0,
        "title": "string",
        "description": "string",
        "defaultSystemRole": true,
        "selfRegistration": true
      }
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation WmsResponseRoleGroupDTO
401 Unauthorized 401 response None
403 Forbidden 403 response None
404 Not Found 404 response None
500 Internal Server Error 500 response None

Contractors

Get a paginated list of contractors connected to you.

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"string"},
        "x-api-key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/external/v1/contractors", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /external/v1/contractors HTTP/1.1

Accept: application/json
x-api-key: string

var headers = {
  'Accept':'application/json',
  'x-api-key':'string',
  'x-api-key':'API_KEY'

};

$.ajax({
  url: '/external/v1/contractors',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'string',
  'x-api-key': 'API_KEY'
}

r = requests.get('/external/v1/contractors', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'string',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get '/external/v1/contractors',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/contractors

Parameters

Name In Type Required Description
limit query integer(int32) false The limit of items in a page
keyword query string false Search by contractor business name
nextIndex query integer(int32) false The starting index of the items you want to search by
x-api-key header string true none

Example responses

200 Response

{
  "data": [
    {
      "id": 0,
      "tradingName": "string",
      "legalBusinessName": "string",
      "businessDescription": "string",
      "industriesList": [
        {
          "id": 0,
          "name": "string",
          "industrySector": {
            "id": 0,
            "name": "string"
          }
        }
      ],
      "contactDetailsList": [
        {
          "id": 0,
          "format": "string",
          "primaryContact": true,
          "contact": "string",
          "contactExtra": "string"
        }
      ],
      "address": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "mailingAddress": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "businessNumbers": [
        {
          "id": 0,
          "typeId": 0,
          "value": "string",
          "type": "string"
        }
      ],
      "businessStructureName": "string",
      "registerDate": "2019-08-24T14:15:22Z",
      "timezone": "string",
      "connectionStatus": "Y",
      "role": {
        "id": 0,
        "title": "string",
        "description": "string"
      },
      "businessLogo": {
        "id": 0,
        "fileName": "string",
        "fileSizeInKB": 0,
        "fileType": "string",
        "created": "2019-08-24T14:15:22Z",
        "url": "string",
        "uploadedByAccount": {
          "id": 0,
          "firstName": "string",
          "lastName": "string",
          "primaryEmail": {
            "id": 0,
            "type": "string",
            "format": "string",
            "notifications": true,
            "contact": "string",
            "contactExtra": "string",
            "verified": true
          }
        }
      },
      "tracking": {
        "id": 0,
        "status": "APPROVED",
        "statusName": "string",
        "previousStatus": "string",
        "started": "2019-08-24T14:15:22Z",
        "verified": "2019-08-24T14:15:22Z",
        "resetDate": "2019-08-24T14:15:22Z",
        "workflowSteps": [
          {
            "stepId": 0,
            "form": {
              "structure": {
                "formKey": 0,
                "title": "string",
                "description": "string",
                "sections": {
                  "property1": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  },
                  "property2": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  }
                }
              },
              "model": {
                "id": 0,
                "formKey": 0,
                "sections": {
                  "property1": [
                    {}
                  ],
                  "property2": [
                    {}
                  ]
                }
              }
            },
            "displayTitle": "string",
            "verificationStatus": "string"
          }
        ]
      },
      "supportingDocuments": [
        {
          "id": 0,
          "fileName": "string",
          "fileSizeInKB": 0,
          "fileType": "string",
          "created": "2019-08-24T14:15:22Z",
          "url": "string",
          "uploadedByAccount": {
            "id": 0,
            "firstName": "string",
            "lastName": "string",
            "primaryEmail": {
              "id": 0,
              "type": "string",
              "format": "string",
              "notifications": true,
              "contact": "string",
              "contactExtra": "string",
              "verified": true
            }
          }
        }
      ],
      "categories": [
        {
          "id": 0,
          "title": "string",
          "subcategories": [
            {
              "id": 0,
              "title": "string",
              "category": {},
              "mandatory": true,
              "sort": 0
            }
          ],
          "mandatory": true
        }
      ],
      "worksites": [
        {
          "id": 0,
          "name": "string",
          "address": {
            "address1": "string",
            "suburb": "string",
            "state": "string",
            "postcode": "string",
            "countryCode": "string",
            "country": "string",
            "geoLocation": {
              "lat": 0,
              "lng": 0
            }
          },
          "email": "string",
          "phone": "string",
          "fax": "string",
          "areaCode": "string",
          "resources": [
            {
              "id": 0,
              "fileName": "string",
              "fileSizeInKB": 0,
              "fileType": "string",
              "created": "2019-08-24T14:15:22Z",
              "url": "string",
              "uploadedByAccount": {
                "id": 0,
                "firstName": "string",
                "lastName": "string",
                "primaryEmail": {
                  "id": 0,
                  "type": "string",
                  "format": "string",
                  "notifications": true,
                  "contact": "string",
                  "contactExtra": "string",
                  "verified": true
                }
              }
            }
          ],
          "timezone": "string",
          "status": "COMPLETE"
        }
      ],
      "currencyCode": "AUD",
      "inviteId": 0
    }
  ],
  "metadata": {
    "totalRecords": 0,
    "totalPages": 0,
    "currentPage": 0,
    "nextIndex": 0,
    "recordsPerPage": 0
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation PagingContractorDTO
401 Unauthorized 401 response None
403 Forbidden 403 response None
404 Not Found 404 response None
500 Internal Server Error 500 response None

Get a contractor connected to you.

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"string"},
        "x-api-key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/external/v1/contractors/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /external/v1/contractors/{id} HTTP/1.1

Accept: application/json
x-api-key: string

var headers = {
  'Accept':'application/json',
  'x-api-key':'string',
  'x-api-key':'API_KEY'

};

$.ajax({
  url: '/external/v1/contractors/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'string',
  'x-api-key': 'API_KEY'
}

r = requests.get('/external/v1/contractors/{id}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'string',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get '/external/v1/contractors/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/contractors/{id}

Parameters

Name In Type Required Description
id path integer(int64) true Unique Contractor Id
x-api-key header string true none

Example responses

200 Response

{
  "success": true,
  "message": "string",
  "errorType": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "data": {
    "id": 0,
    "tradingName": "string",
    "legalBusinessName": "string",
    "businessDescription": "string",
    "industriesList": [
      {
        "id": 0,
        "name": "string",
        "industrySector": {
          "id": 0,
          "name": "string"
        }
      }
    ],
    "contactDetailsList": [
      {
        "id": 0,
        "format": "string",
        "primaryContact": true,
        "contact": "string",
        "contactExtra": "string"
      }
    ],
    "address": {
      "address1": "string",
      "suburb": "string",
      "state": "string",
      "postcode": "string",
      "countryCode": "string",
      "country": "string",
      "geoLocation": {
        "lat": 0,
        "lng": 0
      }
    },
    "mailingAddress": {
      "address1": "string",
      "suburb": "string",
      "state": "string",
      "postcode": "string",
      "countryCode": "string",
      "country": "string",
      "geoLocation": {
        "lat": 0,
        "lng": 0
      }
    },
    "businessNumbers": [
      {
        "id": 0,
        "typeId": 0,
        "value": "string",
        "type": "string"
      }
    ],
    "businessStructureName": "string",
    "registerDate": "2019-08-24T14:15:22Z",
    "timezone": "string",
    "connectionStatus": "Y",
    "role": {
      "id": 0,
      "title": "string",
      "description": "string"
    },
    "businessLogo": {
      "id": 0,
      "fileName": "string",
      "fileSizeInKB": 0,
      "fileType": "string",
      "created": "2019-08-24T14:15:22Z",
      "url": "string",
      "uploadedByAccount": {
        "id": 0,
        "firstName": "string",
        "lastName": "string",
        "primaryEmail": {
          "id": 0,
          "type": "string",
          "format": "string",
          "notifications": true,
          "contact": "string",
          "contactExtra": "string",
          "verified": true
        }
      }
    },
    "tracking": {
      "id": 0,
      "status": "APPROVED",
      "statusName": "string",
      "previousStatus": "string",
      "started": "2019-08-24T14:15:22Z",
      "verified": "2019-08-24T14:15:22Z",
      "resetDate": "2019-08-24T14:15:22Z",
      "workflowSteps": [
        {
          "stepId": 0,
          "form": {
            "structure": {
              "formKey": 0,
              "title": "string",
              "description": "string",
              "sections": {
                "property1": {
                  "sectionKey": 0,
                  "title": "string",
                  "description": "string",
                  "repeatable": true,
                  "fields": [
                    {}
                  ]
                },
                "property2": {
                  "sectionKey": 0,
                  "title": "string",
                  "description": "string",
                  "repeatable": true,
                  "fields": [
                    {}
                  ]
                }
              }
            },
            "model": {
              "id": 0,
              "formKey": 0,
              "sections": {
                "property1": [
                  {
                    "id": 0,
                    "sectionKey": 0,
                    "status": "string",
                    "fields": []
                  }
                ],
                "property2": [
                  {
                    "id": 0,
                    "sectionKey": 0,
                    "status": "string",
                    "fields": []
                  }
                ]
              }
            }
          },
          "displayTitle": "string",
          "verificationStatus": "string"
        }
      ]
    },
    "supportingDocuments": [
      {
        "id": 0,
        "fileName": "string",
        "fileSizeInKB": 0,
        "fileType": "string",
        "created": "2019-08-24T14:15:22Z",
        "url": "string",
        "uploadedByAccount": {
          "id": 0,
          "firstName": "string",
          "lastName": "string",
          "primaryEmail": {
            "id": 0,
            "type": "string",
            "format": "string",
            "notifications": true,
            "contact": "string",
            "contactExtra": "string",
            "verified": true
          }
        }
      }
    ],
    "categories": [
      {
        "id": 0,
        "title": "string",
        "subcategories": [
          {
            "id": 0,
            "title": "string",
            "category": {},
            "mandatory": true,
            "sort": 0
          }
        ],
        "mandatory": true
      }
    ],
    "worksites": [
      {
        "id": 0,
        "name": "string",
        "address": {
          "address1": "string",
          "suburb": "string",
          "state": "string",
          "postcode": "string",
          "countryCode": "string",
          "country": "string",
          "geoLocation": {
            "lat": 0,
            "lng": 0
          }
        },
        "email": "string",
        "phone": "string",
        "fax": "string",
        "areaCode": "string",
        "resources": [
          {
            "id": 0,
            "fileName": "string",
            "fileSizeInKB": 0,
            "fileType": "string",
            "created": "2019-08-24T14:15:22Z",
            "url": "string",
            "uploadedByAccount": {
              "id": 0,
              "firstName": "string",
              "lastName": "string",
              "primaryEmail": {
                "id": 0,
                "type": "string",
                "format": "string",
                "notifications": true,
                "contact": "string",
                "contactExtra": "string",
                "verified": true
              }
            }
          }
        ],
        "timezone": "string",
        "status": "COMPLETE"
      }
    ],
    "currencyCode": "AUD",
    "inviteId": 0
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation WmsResponseContractorDTO
401 Unauthorized 401 response None
403 Forbidden 403 response None
404 Not Found 404 response None
500 Internal Server Error 500 response None

Resource

Get Resource by Id. This will initiate a redirect to access the file temporarily for upto 15 minutes

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        "x-api-key": []string{"string"},
        "x-api-key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/external/v1/resource/{resourceId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /external/v1/resource/{resourceId} HTTP/1.1

Accept: */*
x-api-key: string

var headers = {
  'Accept':'*/*',
  'x-api-key':'string',
  'x-api-key':'API_KEY'

};

$.ajax({
  url: '/external/v1/resource/{resourceId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': '*/*',
  'x-api-key': 'string',
  'x-api-key': 'API_KEY'
}

r = requests.get('/external/v1/resource/{resourceId}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'x-api-key' => 'string',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get '/external/v1/resource/{resourceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/resource/{resourceId}

Parameters

Name In Type Required Description
resourceId path integer(int64) true The resource Id
x-api-key header string true none

Example responses

302 Response

Responses

Status Meaning Description Schema
302 Found A signed URL will be sent to temporarily access this resource string
401 Unauthorized 401 response None
403 Forbidden 403 response None
404 Not Found 404 response None
500 Internal Server Error 500 response None

Response Headers

Status Header Type Format Description
302 Location string Redirect URL that is valid upto 15 minutes

Team

Get a paginated list of your team members

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"string"},
        "x-api-key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/external/v1/team", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /external/v1/team HTTP/1.1

Accept: application/json
x-api-key: string

var headers = {
  'Accept':'application/json',
  'x-api-key':'string',
  'x-api-key':'API_KEY'

};

$.ajax({
  url: '/external/v1/team',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'string',
  'x-api-key': 'API_KEY'
}

r = requests.get('/external/v1/team', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'string',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get '/external/v1/team',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/team

Parameters

Name In Type Required Description
limit query integer(int32) false The limit of items in a page
keyword query string false Search by worker by name, id
nextIndex query integer(int32) false The starting index of the items you want to search by
clientId query integer(int64) false Connected to your business clients. Defaults to the employer workflow if empty.
x-api-key header string true none

Example responses

200 Response

{
  "data": [
    {
      "id": 0,
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "address": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "mailingAddress": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "timezone": "string",
      "profilePhoto": {
        "id": 0,
        "fileName": "string",
        "fileSizeInKB": 0,
        "fileType": "string",
        "created": "2019-08-24T14:15:22Z",
        "url": "string",
        "uploadedByAccount": {
          "id": 0,
          "firstName": "string",
          "lastName": "string",
          "primaryEmail": {
            "id": 0,
            "type": "string",
            "format": "string",
            "notifications": true,
            "contact": "string",
            "contactExtra": "string",
            "verified": true
          }
        }
      },
      "primaryEmail": {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      },
      "primaryMobile": {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      },
      "workerContactDetails": [
        {
          "id": 0,
          "type": "string",
          "format": "string",
          "notifications": true,
          "contact": "string",
          "contactExtra": "string",
          "verified": true
        }
      ],
      "registrationDate": "2019-08-24T14:15:22Z",
      "dateOfBirth": "2019-08-24T14:15:22Z",
      "connectionStatus": "Y",
      "tracking": {
        "id": 0,
        "status": "APPROVED",
        "statusName": "string",
        "previousStatus": "string",
        "started": "2019-08-24T14:15:22Z",
        "verified": "2019-08-24T14:15:22Z",
        "resetDate": "2019-08-24T14:15:22Z",
        "workflowSteps": [
          {
            "stepId": 0,
            "form": {
              "structure": {
                "formKey": 0,
                "title": "string",
                "description": "string",
                "sections": {
                  "property1": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  },
                  "property2": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  }
                }
              },
              "model": {
                "id": 0,
                "formKey": 0,
                "sections": {
                  "property1": [
                    {}
                  ],
                  "property2": [
                    {}
                  ]
                }
              }
            },
            "displayTitle": "string",
            "verificationStatus": "string"
          }
        ]
      },
      "categories": [
        {
          "id": 0,
          "title": "string",
          "subcategories": [
            {
              "id": 0,
              "title": "string",
              "category": {},
              "mandatory": true,
              "sort": 0
            }
          ],
          "mandatory": true
        }
      ],
      "role": {
        "id": 0,
        "title": "string",
        "description": "string"
      },
      "worksites": [
        {
          "id": 0,
          "name": "string",
          "address": {
            "address1": "string",
            "suburb": "string",
            "state": "string",
            "postcode": "string",
            "countryCode": "string",
            "country": "string",
            "geoLocation": {
              "lat": 0,
              "lng": 0
            }
          },
          "email": "string",
          "phone": "string",
          "fax": "string",
          "areaCode": "string",
          "resources": [
            {
              "id": 0,
              "fileName": "string",
              "fileSizeInKB": 0,
              "fileType": "string",
              "created": "2019-08-24T14:15:22Z",
              "url": "string",
              "uploadedByAccount": {
                "id": 0,
                "firstName": "string",
                "lastName": "string",
                "primaryEmail": {
                  "id": 0,
                  "type": "string",
                  "format": "string",
                  "notifications": true,
                  "contact": "string",
                  "contactExtra": "string",
                  "verified": true
                }
              }
            }
          ],
          "timezone": "string",
          "status": "COMPLETE"
        }
      ],
      "accessRole": "WORKER",
      "username": "string"
    }
  ],
  "metadata": {
    "totalRecords": 0,
    "totalPages": 0,
    "currentPage": 0,
    "nextIndex": 0,
    "recordsPerPage": 0
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation PagingTeamMemberDTO
401 Unauthorized 401 response None
403 Forbidden 403 response None
404 Not Found 404 response None
500 Internal Server Error 500 response None

Workers

Get a paginated list of workers connected to you.

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"string"},
        "x-api-key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/external/v1/workers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /external/v1/workers HTTP/1.1

Accept: application/json
x-api-key: string

var headers = {
  'Accept':'application/json',
  'x-api-key':'string',
  'x-api-key':'API_KEY'

};

$.ajax({
  url: '/external/v1/workers',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'string',
  'x-api-key': 'API_KEY'
}

r = requests.get('/external/v1/workers', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'string',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get '/external/v1/workers',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/workers

Parameters

Name In Type Required Description
limit query integer(int32) false The limit of items in a page
keyword query string false Search by worker by name, id
nextIndex query integer(int32) false The starting index of the items you want to search by
x-api-key header string true none

Example responses

200 Response

{
  "data": [
    {
      "id": 0,
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "address": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "mailingAddress": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "timezone": "string",
      "profilePhoto": {
        "id": 0,
        "fileName": "string",
        "fileSizeInKB": 0,
        "fileType": "string",
        "created": "2019-08-24T14:15:22Z",
        "url": "string",
        "uploadedByAccount": {
          "id": 0,
          "firstName": "string",
          "lastName": "string",
          "primaryEmail": {
            "id": 0,
            "type": "string",
            "format": "string",
            "notifications": true,
            "contact": "string",
            "contactExtra": "string",
            "verified": true
          }
        }
      },
      "primaryEmail": {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      },
      "primaryMobile": {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      },
      "workerContactDetails": [
        {
          "id": 0,
          "type": "string",
          "format": "string",
          "notifications": true,
          "contact": "string",
          "contactExtra": "string",
          "verified": true
        }
      ],
      "registrationDate": "2019-08-24T14:15:22Z",
      "dateOfBirth": "2019-08-24T14:15:22Z",
      "connectionStatus": "Y",
      "contractor": {
        "id": 0,
        "tradingName": "string",
        "legalBusinessName": "string",
        "businessDescription": "string",
        "industriesList": [
          {
            "id": 0,
            "name": "string",
            "industrySector": {
              "id": 0,
              "name": "string"
            }
          }
        ],
        "contactDetailsList": [
          {
            "id": 0,
            "format": "string",
            "primaryContact": true,
            "contact": "string",
            "contactExtra": "string"
          }
        ],
        "address": {
          "address1": "string",
          "suburb": "string",
          "state": "string",
          "postcode": "string",
          "countryCode": "string",
          "country": "string",
          "geoLocation": {
            "lat": 0,
            "lng": 0
          }
        },
        "mailingAddress": {
          "address1": "string",
          "suburb": "string",
          "state": "string",
          "postcode": "string",
          "countryCode": "string",
          "country": "string",
          "geoLocation": {
            "lat": 0,
            "lng": 0
          }
        },
        "businessNumbers": [
          {
            "id": 0,
            "typeId": 0,
            "value": "string",
            "type": "string"
          }
        ],
        "businessStructureName": "string",
        "registerDate": "2019-08-24T14:15:22Z",
        "timezone": "string",
        "connectionStatus": "Y",
        "role": {
          "id": 0,
          "title": "string",
          "description": "string"
        },
        "businessLogo": {
          "id": 0,
          "fileName": "string",
          "fileSizeInKB": 0,
          "fileType": "string",
          "created": "2019-08-24T14:15:22Z",
          "url": "string",
          "uploadedByAccount": {
            "id": 0,
            "firstName": "string",
            "lastName": "string",
            "primaryEmail": {
              "id": 0,
              "type": "string",
              "format": "string",
              "notifications": true,
              "contact": "string",
              "contactExtra": "string",
              "verified": true
            }
          }
        },
        "tracking": {
          "id": 0,
          "status": "APPROVED",
          "statusName": "string",
          "previousStatus": "string",
          "started": "2019-08-24T14:15:22Z",
          "verified": "2019-08-24T14:15:22Z",
          "resetDate": "2019-08-24T14:15:22Z",
          "workflowSteps": [
            {
              "stepId": 0,
              "form": {
                "structure": {
                  "formKey": 0,
                  "title": "string",
                  "description": "string",
                  "sections": {
                    "property1": {},
                    "property2": {}
                  }
                },
                "model": {
                  "id": 0,
                  "formKey": 0,
                  "sections": {
                    "property1": [],
                    "property2": []
                  }
                }
              },
              "displayTitle": "string",
              "verificationStatus": "string"
            }
          ]
        },
        "supportingDocuments": [
          {
            "id": 0,
            "fileName": "string",
            "fileSizeInKB": 0,
            "fileType": "string",
            "created": "2019-08-24T14:15:22Z",
            "url": "string",
            "uploadedByAccount": {
              "id": 0,
              "firstName": "string",
              "lastName": "string",
              "primaryEmail": {
                "id": 0,
                "type": "string",
                "format": "string",
                "notifications": true,
                "contact": "string",
                "contactExtra": "string",
                "verified": true
              }
            }
          }
        ],
        "categories": [
          {
            "id": 0,
            "title": "string",
            "subcategories": [
              {
                "id": 0,
                "title": "string",
                "category": {},
                "mandatory": true,
                "sort": 0
              }
            ],
            "mandatory": true
          }
        ],
        "worksites": [
          {
            "id": 0,
            "name": "string",
            "address": {
              "address1": "string",
              "suburb": "string",
              "state": "string",
              "postcode": "string",
              "countryCode": "string",
              "country": "string",
              "geoLocation": {
                "lat": 0,
                "lng": 0
              }
            },
            "email": "string",
            "phone": "string",
            "fax": "string",
            "areaCode": "string",
            "resources": [
              {
                "id": 0,
                "fileName": "string",
                "fileSizeInKB": 0,
                "fileType": "string",
                "created": "2019-08-24T14:15:22Z",
                "url": "string",
                "uploadedByAccount": {
                  "id": 0,
                  "firstName": "string",
                  "lastName": "string",
                  "primaryEmail": {
                    "id": 0,
                    "type": "string",
                    "format": "string",
                    "notifications": true,
                    "contact": "string",
                    "contactExtra": "string",
                    "verified": true
                  }
                }
              }
            ],
            "timezone": "string",
            "status": "COMPLETE"
          }
        ],
        "currencyCode": "AUD",
        "inviteId": 0
      },
      "tracking": {
        "id": 0,
        "status": "APPROVED",
        "statusName": "string",
        "previousStatus": "string",
        "started": "2019-08-24T14:15:22Z",
        "verified": "2019-08-24T14:15:22Z",
        "resetDate": "2019-08-24T14:15:22Z",
        "workflowSteps": [
          {
            "stepId": 0,
            "form": {
              "structure": {
                "formKey": 0,
                "title": "string",
                "description": "string",
                "sections": {
                  "property1": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  },
                  "property2": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  }
                }
              },
              "model": {
                "id": 0,
                "formKey": 0,
                "sections": {
                  "property1": [
                    {}
                  ],
                  "property2": [
                    {}
                  ]
                }
              }
            },
            "displayTitle": "string",
            "verificationStatus": "string"
          }
        ]
      },
      "categories": [
        {
          "id": 0,
          "title": "string",
          "subcategories": [
            {
              "id": 0,
              "title": "string",
              "category": {},
              "mandatory": true,
              "sort": 0
            }
          ],
          "mandatory": true
        }
      ],
      "role": {
        "id": 0,
        "title": "string",
        "description": "string"
      },
      "worksites": [
        {
          "id": 0,
          "name": "string",
          "address": {
            "address1": "string",
            "suburb": "string",
            "state": "string",
            "postcode": "string",
            "countryCode": "string",
            "country": "string",
            "geoLocation": {
              "lat": 0,
              "lng": 0
            }
          },
          "email": "string",
          "phone": "string",
          "fax": "string",
          "areaCode": "string",
          "resources": [
            {
              "id": 0,
              "fileName": "string",
              "fileSizeInKB": 0,
              "fileType": "string",
              "created": "2019-08-24T14:15:22Z",
              "url": "string",
              "uploadedByAccount": {
                "id": 0,
                "firstName": "string",
                "lastName": "string",
                "primaryEmail": {
                  "id": 0,
                  "type": "string",
                  "format": "string",
                  "notifications": true,
                  "contact": "string",
                  "contactExtra": "string",
                  "verified": true
                }
              }
            }
          ],
          "timezone": "string",
          "status": "COMPLETE"
        }
      ],
      "contractorAdmin": true
    }
  ],
  "metadata": {
    "totalRecords": 0,
    "totalPages": 0,
    "currentPage": 0,
    "nextIndex": 0,
    "recordsPerPage": 0
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation PagingWorkerDTO
401 Unauthorized 401 response None
403 Forbidden 403 response None
404 Not Found 404 response None
500 Internal Server Error 500 response None

Get a worker connected to you.

Code samples

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "x-api-key": []string{"string"},
        "x-api-key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/external/v1/workers/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /external/v1/workers/{id} HTTP/1.1

Accept: application/json
x-api-key: string

var headers = {
  'Accept':'application/json',
  'x-api-key':'string',
  'x-api-key':'API_KEY'

};

$.ajax({
  url: '/external/v1/workers/{id}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

import requests
headers = {
  'Accept': 'application/json',
  'x-api-key': 'string',
  'x-api-key': 'API_KEY'
}

r = requests.get('/external/v1/workers/{id}', params={

}, headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-api-key' => 'string',
  'x-api-key' => 'API_KEY'
}

result = RestClient.get '/external/v1/workers/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

GET /v1/workers/{id}

Parameters

Name In Type Required Description
id path integer(int64) true Unique Worker Id
x-api-key header string true none

Example responses

200 Response

{
  "success": true,
  "message": "string",
  "errorType": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "data": {
    "id": 0,
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "address": {
      "address1": "string",
      "suburb": "string",
      "state": "string",
      "postcode": "string",
      "countryCode": "string",
      "country": "string",
      "geoLocation": {
        "lat": 0,
        "lng": 0
      }
    },
    "mailingAddress": {
      "address1": "string",
      "suburb": "string",
      "state": "string",
      "postcode": "string",
      "countryCode": "string",
      "country": "string",
      "geoLocation": {
        "lat": 0,
        "lng": 0
      }
    },
    "timezone": "string",
    "profilePhoto": {
      "id": 0,
      "fileName": "string",
      "fileSizeInKB": 0,
      "fileType": "string",
      "created": "2019-08-24T14:15:22Z",
      "url": "string",
      "uploadedByAccount": {
        "id": 0,
        "firstName": "string",
        "lastName": "string",
        "primaryEmail": {
          "id": 0,
          "type": "string",
          "format": "string",
          "notifications": true,
          "contact": "string",
          "contactExtra": "string",
          "verified": true
        }
      }
    },
    "primaryEmail": {
      "id": 0,
      "type": "string",
      "format": "string",
      "notifications": true,
      "contact": "string",
      "contactExtra": "string",
      "verified": true
    },
    "primaryMobile": {
      "id": 0,
      "type": "string",
      "format": "string",
      "notifications": true,
      "contact": "string",
      "contactExtra": "string",
      "verified": true
    },
    "workerContactDetails": [
      {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      }
    ],
    "registrationDate": "2019-08-24T14:15:22Z",
    "dateOfBirth": "2019-08-24T14:15:22Z",
    "connectionStatus": "Y",
    "contractor": {
      "id": 0,
      "tradingName": "string",
      "legalBusinessName": "string",
      "businessDescription": "string",
      "industriesList": [
        {
          "id": 0,
          "name": "string",
          "industrySector": {
            "id": 0,
            "name": "string"
          }
        }
      ],
      "contactDetailsList": [
        {
          "id": 0,
          "format": "string",
          "primaryContact": true,
          "contact": "string",
          "contactExtra": "string"
        }
      ],
      "address": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "mailingAddress": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "businessNumbers": [
        {
          "id": 0,
          "typeId": 0,
          "value": "string",
          "type": "string"
        }
      ],
      "businessStructureName": "string",
      "registerDate": "2019-08-24T14:15:22Z",
      "timezone": "string",
      "connectionStatus": "Y",
      "role": {
        "id": 0,
        "title": "string",
        "description": "string"
      },
      "businessLogo": {
        "id": 0,
        "fileName": "string",
        "fileSizeInKB": 0,
        "fileType": "string",
        "created": "2019-08-24T14:15:22Z",
        "url": "string",
        "uploadedByAccount": {
          "id": 0,
          "firstName": "string",
          "lastName": "string",
          "primaryEmail": {
            "id": 0,
            "type": "string",
            "format": "string",
            "notifications": true,
            "contact": "string",
            "contactExtra": "string",
            "verified": true
          }
        }
      },
      "tracking": {
        "id": 0,
        "status": "APPROVED",
        "statusName": "string",
        "previousStatus": "string",
        "started": "2019-08-24T14:15:22Z",
        "verified": "2019-08-24T14:15:22Z",
        "resetDate": "2019-08-24T14:15:22Z",
        "workflowSteps": [
          {
            "stepId": 0,
            "form": {
              "structure": {
                "formKey": 0,
                "title": "string",
                "description": "string",
                "sections": {
                  "property1": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  },
                  "property2": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  }
                }
              },
              "model": {
                "id": 0,
                "formKey": 0,
                "sections": {
                  "property1": [
                    {}
                  ],
                  "property2": [
                    {}
                  ]
                }
              }
            },
            "displayTitle": "string",
            "verificationStatus": "string"
          }
        ]
      },
      "supportingDocuments": [
        {
          "id": 0,
          "fileName": "string",
          "fileSizeInKB": 0,
          "fileType": "string",
          "created": "2019-08-24T14:15:22Z",
          "url": "string",
          "uploadedByAccount": {
            "id": 0,
            "firstName": "string",
            "lastName": "string",
            "primaryEmail": {
              "id": 0,
              "type": "string",
              "format": "string",
              "notifications": true,
              "contact": "string",
              "contactExtra": "string",
              "verified": true
            }
          }
        }
      ],
      "categories": [
        {
          "id": 0,
          "title": "string",
          "subcategories": [
            {
              "id": 0,
              "title": "string",
              "category": {},
              "mandatory": true,
              "sort": 0
            }
          ],
          "mandatory": true
        }
      ],
      "worksites": [
        {
          "id": 0,
          "name": "string",
          "address": {
            "address1": "string",
            "suburb": "string",
            "state": "string",
            "postcode": "string",
            "countryCode": "string",
            "country": "string",
            "geoLocation": {
              "lat": 0,
              "lng": 0
            }
          },
          "email": "string",
          "phone": "string",
          "fax": "string",
          "areaCode": "string",
          "resources": [
            {
              "id": 0,
              "fileName": "string",
              "fileSizeInKB": 0,
              "fileType": "string",
              "created": "2019-08-24T14:15:22Z",
              "url": "string",
              "uploadedByAccount": {
                "id": 0,
                "firstName": "string",
                "lastName": "string",
                "primaryEmail": {
                  "id": 0,
                  "type": "string",
                  "format": "string",
                  "notifications": true,
                  "contact": "string",
                  "contactExtra": "string",
                  "verified": true
                }
              }
            }
          ],
          "timezone": "string",
          "status": "COMPLETE"
        }
      ],
      "currencyCode": "AUD",
      "inviteId": 0
    },
    "tracking": {
      "id": 0,
      "status": "APPROVED",
      "statusName": "string",
      "previousStatus": "string",
      "started": "2019-08-24T14:15:22Z",
      "verified": "2019-08-24T14:15:22Z",
      "resetDate": "2019-08-24T14:15:22Z",
      "workflowSteps": [
        {
          "stepId": 0,
          "form": {
            "structure": {
              "formKey": 0,
              "title": "string",
              "description": "string",
              "sections": {
                "property1": {
                  "sectionKey": 0,
                  "title": "string",
                  "description": "string",
                  "repeatable": true,
                  "fields": [
                    {}
                  ]
                },
                "property2": {
                  "sectionKey": 0,
                  "title": "string",
                  "description": "string",
                  "repeatable": true,
                  "fields": [
                    {}
                  ]
                }
              }
            },
            "model": {
              "id": 0,
              "formKey": 0,
              "sections": {
                "property1": [
                  {
                    "id": 0,
                    "sectionKey": 0,
                    "status": "string",
                    "fields": []
                  }
                ],
                "property2": [
                  {
                    "id": 0,
                    "sectionKey": 0,
                    "status": "string",
                    "fields": []
                  }
                ]
              }
            }
          },
          "displayTitle": "string",
          "verificationStatus": "string"
        }
      ]
    },
    "categories": [
      {
        "id": 0,
        "title": "string",
        "subcategories": [
          {
            "id": 0,
            "title": "string",
            "category": {},
            "mandatory": true,
            "sort": 0
          }
        ],
        "mandatory": true
      }
    ],
    "role": {
      "id": 0,
      "title": "string",
      "description": "string"
    },
    "worksites": [
      {
        "id": 0,
        "name": "string",
        "address": {
          "address1": "string",
          "suburb": "string",
          "state": "string",
          "postcode": "string",
          "countryCode": "string",
          "country": "string",
          "geoLocation": {
            "lat": 0,
            "lng": 0
          }
        },
        "email": "string",
        "phone": "string",
        "fax": "string",
        "areaCode": "string",
        "resources": [
          {
            "id": 0,
            "fileName": "string",
            "fileSizeInKB": 0,
            "fileType": "string",
            "created": "2019-08-24T14:15:22Z",
            "url": "string",
            "uploadedByAccount": {
              "id": 0,
              "firstName": "string",
              "lastName": "string",
              "primaryEmail": {
                "id": 0,
                "type": "string",
                "format": "string",
                "notifications": true,
                "contact": "string",
                "contactExtra": "string",
                "verified": true
              }
            }
          }
        ],
        "timezone": "string",
        "status": "COMPLETE"
      }
    ],
    "contractorAdmin": true
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation WmsResponseWorkerDTO
401 Unauthorized 401 response None
403 Forbidden 403 response None
404 Not Found 404 response None
500 Internal Server Error 500 response None

Schemas

AddressDTO

{
  "address1": "string",
  "suburb": "string",
  "state": "string",
  "postcode": "string",
  "countryCode": "string",
  "country": "string",
  "geoLocation": {
    "lat": 0,
    "lng": 0
  }
}

Properties

Name Type Required Restrictions Description
address1 string false none none
suburb string false none none
state string false none none
postcode string false none none
countryCode string false none none
country string false none none

CategoryDTO

{
  "id": 0,
  "title": "string",
  "subcategories": [
    {
      "id": 0,
      "title": "string",
      "category": {
        "id": 0,
        "title": "string",
        "subcategories": [],
        "mandatory": true
      },
      "mandatory": true,
      "sort": 0
    }
  ],
  "mandatory": true
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none Category ID
title string false none Name of the category
subcategories [SubcategoryDTO] false none Subategories that belong to this category

ContractorBusinessNumber

{
  "id": 0,
  "typeId": 0,
  "value": "string",
  "type": "string"
}

Contractor's business numbers set against their Business profile

Properties

Name Type Required Restrictions Description
id integer(int64) false none Unique ID for the stored business number
typeId integer(int64) false none ID for the type of business number
value string false none The business number stored
type string false none The friendly name of the type of business number

ContractorContact

{
  "id": 0,
  "format": "string",
  "primaryContact": true,
  "contact": "string",
  "contactExtra": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none Unique Contact Id
format string false none Contact details format
primaryContact boolean false none Is a primary contact
contact string false none Contact value
contactExtra string false none Extra contact value, for e.g. CountryCode for mobile

ContractorDTO

{
  "id": 0,
  "tradingName": "string",
  "legalBusinessName": "string",
  "businessDescription": "string",
  "industriesList": [
    {
      "id": 0,
      "name": "string",
      "industrySector": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "contactDetailsList": [
    {
      "id": 0,
      "format": "string",
      "primaryContact": true,
      "contact": "string",
      "contactExtra": "string"
    }
  ],
  "address": {
    "address1": "string",
    "suburb": "string",
    "state": "string",
    "postcode": "string",
    "countryCode": "string",
    "country": "string",
    "geoLocation": {
      "lat": 0,
      "lng": 0
    }
  },
  "mailingAddress": {
    "address1": "string",
    "suburb": "string",
    "state": "string",
    "postcode": "string",
    "countryCode": "string",
    "country": "string",
    "geoLocation": {
      "lat": 0,
      "lng": 0
    }
  },
  "businessNumbers": [
    {
      "id": 0,
      "typeId": 0,
      "value": "string",
      "type": "string"
    }
  ],
  "businessStructureName": "string",
  "registerDate": "2019-08-24T14:15:22Z",
  "timezone": "string",
  "connectionStatus": "Y",
  "role": {
    "id": 0,
    "title": "string",
    "description": "string"
  },
  "businessLogo": {
    "id": 0,
    "fileName": "string",
    "fileSizeInKB": 0,
    "fileType": "string",
    "created": "2019-08-24T14:15:22Z",
    "url": "string",
    "uploadedByAccount": {
      "id": 0,
      "firstName": "string",
      "lastName": "string",
      "primaryEmail": {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      }
    }
  },
  "tracking": {
    "id": 0,
    "status": "APPROVED",
    "statusName": "string",
    "previousStatus": "string",
    "started": "2019-08-24T14:15:22Z",
    "verified": "2019-08-24T14:15:22Z",
    "resetDate": "2019-08-24T14:15:22Z",
    "workflowSteps": [
      {
        "stepId": 0,
        "form": {
          "structure": {
            "formKey": 0,
            "title": "string",
            "description": "string",
            "sections": {
              "property1": {
                "sectionKey": 0,
                "title": "string",
                "description": "string",
                "repeatable": true,
                "fields": [
                  {
                    "fieldKey": 0,
                    "type": "ALL",
                    "readableWidgetType": "string",
                    "label": "string",
                    "description": "string",
                    "options": []
                  }
                ]
              },
              "property2": {
                "sectionKey": 0,
                "title": "string",
                "description": "string",
                "repeatable": true,
                "fields": [
                  {
                    "fieldKey": 0,
                    "type": "ALL",
                    "readableWidgetType": "string",
                    "label": "string",
                    "description": "string",
                    "options": []
                  }
                ]
              }
            }
          },
          "model": {
            "id": 0,
            "formKey": 0,
            "sections": {
              "property1": [
                {
                  "id": 0,
                  "sectionKey": 0,
                  "status": "string",
                  "fields": [
                    {}
                  ]
                }
              ],
              "property2": [
                {
                  "id": 0,
                  "sectionKey": 0,
                  "status": "string",
                  "fields": [
                    {}
                  ]
                }
              ]
            }
          }
        },
        "displayTitle": "string",
        "verificationStatus": "string"
      }
    ]
  },
  "supportingDocuments": [
    {
      "id": 0,
      "fileName": "string",
      "fileSizeInKB": 0,
      "fileType": "string",
      "created": "2019-08-24T14:15:22Z",
      "url": "string",
      "uploadedByAccount": {
        "id": 0,
        "firstName": "string",
        "lastName": "string",
        "primaryEmail": {
          "id": 0,
          "type": "string",
          "format": "string",
          "notifications": true,
          "contact": "string",
          "contactExtra": "string",
          "verified": true
        }
      }
    }
  ],
  "categories": [
    {
      "id": 0,
      "title": "string",
      "subcategories": [
        {
          "id": 0,
          "title": "string",
          "category": {},
          "mandatory": true,
          "sort": 0
        }
      ],
      "mandatory": true
    }
  ],
  "worksites": [
    {
      "id": 0,
      "name": "string",
      "address": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "email": "string",
      "phone": "string",
      "fax": "string",
      "areaCode": "string",
      "resources": [
        {
          "id": 0,
          "fileName": "string",
          "fileSizeInKB": 0,
          "fileType": "string",
          "created": "2019-08-24T14:15:22Z",
          "url": "string",
          "uploadedByAccount": {
            "id": 0,
            "firstName": "string",
            "lastName": "string",
            "primaryEmail": {
              "id": 0,
              "type": "string",
              "format": "string",
              "notifications": true,
              "contact": "string",
              "contactExtra": "string",
              "verified": true
            }
          }
        }
      ],
      "timezone": "string",
      "status": "COMPLETE"
    }
  ],
  "currencyCode": "AUD",
  "inviteId": 0
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none Unique Contractor Id
tradingName string false none The trading name
legalBusinessName string false none Legal business name
businessDescription string false none Contractor's description of their business, formatted in HTML
industriesList [Industry] false none Industries that the business belongs to

EntityRoleDTO

{
  "id": 0,
  "title": "string",
  "description": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none none
title string false none none
description string false none none

FormDTO

{
  "structure": {
    "formKey": 0,
    "title": "string",
    "description": "string",
    "sections": {
      "property1": {
        "sectionKey": 0,
        "title": "string",
        "description": "string",
        "repeatable": true,
        "fields": [
          {
            "fieldKey": 0,
            "type": "ALL",
            "readableWidgetType": "string",
            "label": "string",
            "description": "string",
            "options": [
              {
                "optionKey": 0,
                "value": "string"
              }
            ]
          }
        ]
      },
      "property2": {
        "sectionKey": 0,
        "title": "string",
        "description": "string",
        "repeatable": true,
        "fields": [
          {
            "fieldKey": 0,
            "type": "ALL",
            "readableWidgetType": "string",
            "label": "string",
            "description": "string",
            "options": [
              {
                "optionKey": 0,
                "value": "string"
              }
            ]
          }
        ]
      }
    }
  },
  "model": {
    "id": 0,
    "formKey": 0,
    "sections": {
      "property1": [
        {
          "id": 0,
          "sectionKey": 0,
          "status": "string",
          "fields": [
            {
              "id": 0,
              "fieldKey": 0,
              "values": [
                "string"
              ],
              "resources": [
                {
                  "id": 0,
                  "fileName": "string",
                  "fileSizeInKB": 0,
                  "fileType": "string",
                  "created": "2019-08-24T14:15:22Z",
                  "url": "string",
                  "uploadedByAccount": {
                    "id": 0,
                    "firstName": "string",
                    "lastName": "string",
                    "primaryEmail": {}
                  }
                }
              ]
            }
          ]
        }
      ],
      "property2": [
        {
          "id": 0,
          "sectionKey": 0,
          "status": "string",
          "fields": [
            {
              "id": 0,
              "fieldKey": 0,
              "values": [
                "string"
              ],
              "resources": [
                {
                  "id": 0,
                  "fileName": "string",
                  "fileSizeInKB": 0,
                  "fileType": "string",
                  "created": "2019-08-24T14:15:22Z",
                  "url": "string",
                  "uploadedByAccount": {
                    "id": 0,
                    "firstName": "string",
                    "lastName": "string",
                    "primaryEmail": {}
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

Properties

None

FormModelDTO

{
  "id": 0,
  "formKey": 0,
  "sections": {
    "property1": [
      {
        "id": 0,
        "sectionKey": 0,
        "status": "string",
        "fields": [
          {
            "id": 0,
            "fieldKey": 0,
            "values": [
              "string"
            ],
            "resources": [
              {
                "id": 0,
                "fileName": "string",
                "fileSizeInKB": 0,
                "fileType": "string",
                "created": "2019-08-24T14:15:22Z",
                "url": "string",
                "uploadedByAccount": {
                  "id": 0,
                  "firstName": "string",
                  "lastName": "string",
                  "primaryEmail": {
                    "id": 0,
                    "type": "string",
                    "format": "string",
                    "notifications": true,
                    "contact": "string",
                    "contactExtra": "string",
                    "verified": true
                  }
                }
              }
            ]
          }
        ]
      }
    ],
    "property2": [
      {
        "id": 0,
        "sectionKey": 0,
        "status": "string",
        "fields": [
          {
            "id": 0,
            "fieldKey": 0,
            "values": [
              "string"
            ],
            "resources": [
              {
                "id": 0,
                "fileName": "string",
                "fileSizeInKB": 0,
                "fileType": "string",
                "created": "2019-08-24T14:15:22Z",
                "url": "string",
                "uploadedByAccount": {
                  "id": 0,
                  "firstName": "string",
                  "lastName": "string",
                  "primaryEmail": {
                    "id": 0,
                    "type": "string",
                    "format": "string",
                    "notifications": true,
                    "contact": "string",
                    "contactExtra": "string",
                    "verified": true
                  }
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none none
formKey integer(int64) false none none
sections object false none none
» additionalProperties [SectionModelDTO] false none none

FormStructureDTO

{
  "formKey": 0,
  "title": "string",
  "description": "string",
  "sections": {
    "property1": {
      "sectionKey": 0,
      "title": "string",
      "description": "string",
      "repeatable": true,
      "fields": [
        {
          "fieldKey": 0,
          "type": "ALL",
          "readableWidgetType": "string",
          "label": "string",
          "description": "string",
          "options": [
            {
              "optionKey": 0,
              "value": "string"
            }
          ]
        }
      ]
    },
    "property2": {
      "sectionKey": 0,
      "title": "string",
      "description": "string",
      "repeatable": true,
      "fields": [
        {
          "fieldKey": 0,
          "type": "ALL",
          "readableWidgetType": "string",
          "label": "string",
          "description": "string",
          "options": [
            {
              "optionKey": 0,
              "value": "string"
            }
          ]
        }
      ]
    }
  }
}

Properties

Name Type Required Restrictions Description
formKey integer(int64) false none none
title string false none none
description string false none none
sections object false none none

GeoLocationDTO

{
  "lat": 0,
  "lng": 0
}

Properties

Name Type Required Restrictions Description
lat number false none none
lng number false none none

Industry

{
  "id": 0,
  "name": "string",
  "industrySector": {
    "id": 0,
    "name": "string"
  }
}

Industry information of a contractor

Properties

Name Type Required Restrictions Description
id integer(int64) false none Industry ID
name string false none Industry Name

IndustrySectorDTO

{
  "id": 0,
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none none
name string false none none

Paging

{
  "data": [
    {}
  ],
  "metadata": {
    "totalRecords": 0,
    "totalPages": 0,
    "currentPage": 0,
    "nextIndex": 0,
    "recordsPerPage": 0
  }
}

Properties

Name Type Required Restrictions Description
data [object] false none none

PagingContractorDTO

{
  "data": [
    {
      "id": 0,
      "tradingName": "string",
      "legalBusinessName": "string",
      "businessDescription": "string",
      "industriesList": [
        {
          "id": 0,
          "name": "string",
          "industrySector": {
            "id": 0,
            "name": "string"
          }
        }
      ],
      "contactDetailsList": [
        {
          "id": 0,
          "format": "string",
          "primaryContact": true,
          "contact": "string",
          "contactExtra": "string"
        }
      ],
      "address": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "mailingAddress": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "businessNumbers": [
        {
          "id": 0,
          "typeId": 0,
          "value": "string",
          "type": "string"
        }
      ],
      "businessStructureName": "string",
      "registerDate": "2019-08-24T14:15:22Z",
      "timezone": "string",
      "connectionStatus": "Y",
      "role": {
        "id": 0,
        "title": "string",
        "description": "string"
      },
      "businessLogo": {
        "id": 0,
        "fileName": "string",
        "fileSizeInKB": 0,
        "fileType": "string",
        "created": "2019-08-24T14:15:22Z",
        "url": "string",
        "uploadedByAccount": {
          "id": 0,
          "firstName": "string",
          "lastName": "string",
          "primaryEmail": {
            "id": 0,
            "type": "string",
            "format": "string",
            "notifications": true,
            "contact": "string",
            "contactExtra": "string",
            "verified": true
          }
        }
      },
      "tracking": {
        "id": 0,
        "status": "APPROVED",
        "statusName": "string",
        "previousStatus": "string",
        "started": "2019-08-24T14:15:22Z",
        "verified": "2019-08-24T14:15:22Z",
        "resetDate": "2019-08-24T14:15:22Z",
        "workflowSteps": [
          {
            "stepId": 0,
            "form": {
              "structure": {
                "formKey": 0,
                "title": "string",
                "description": "string",
                "sections": {
                  "property1": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  },
                  "property2": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  }
                }
              },
              "model": {
                "id": 0,
                "formKey": 0,
                "sections": {
                  "property1": [
                    {}
                  ],
                  "property2": [
                    {}
                  ]
                }
              }
            },
            "displayTitle": "string",
            "verificationStatus": "string"
          }
        ]
      },
      "supportingDocuments": [
        {
          "id": 0,
          "fileName": "string",
          "fileSizeInKB": 0,
          "fileType": "string",
          "created": "2019-08-24T14:15:22Z",
          "url": "string",
          "uploadedByAccount": {
            "id": 0,
            "firstName": "string",
            "lastName": "string",
            "primaryEmail": {
              "id": 0,
              "type": "string",
              "format": "string",
              "notifications": true,
              "contact": "string",
              "contactExtra": "string",
              "verified": true
            }
          }
        }
      ],
      "categories": [
        {
          "id": 0,
          "title": "string",
          "subcategories": [
            {
              "id": 0,
              "title": "string",
              "category": {},
              "mandatory": true,
              "sort": 0
            }
          ],
          "mandatory": true
        }
      ],
      "worksites": [
        {
          "id": 0,
          "name": "string",
          "address": {
            "address1": "string",
            "suburb": "string",
            "state": "string",
            "postcode": "string",
            "countryCode": "string",
            "country": "string",
            "geoLocation": {
              "lat": 0,
              "lng": 0
            }
          },
          "email": "string",
          "phone": "string",
          "fax": "string",
          "areaCode": "string",
          "resources": [
            {
              "id": 0,
              "fileName": "string",
              "fileSizeInKB": 0,
              "fileType": "string",
              "created": "2019-08-24T14:15:22Z",
              "url": "string",
              "uploadedByAccount": {
                "id": 0,
                "firstName": "string",
                "lastName": "string",
                "primaryEmail": {
                  "id": 0,
                  "type": "string",
                  "format": "string",
                  "notifications": true,
                  "contact": "string",
                  "contactExtra": "string",
                  "verified": true
                }
              }
            }
          ],
          "timezone": "string",
          "status": "COMPLETE"
        }
      ],
      "currencyCode": "AUD",
      "inviteId": 0
    }
  ],
  "metadata": {
    "totalRecords": 0,
    "totalPages": 0,
    "currentPage": 0,
    "nextIndex": 0,
    "recordsPerPage": 0
  }
}

Properties

Name Type Required Restrictions Description
data [ContractorDTO] false none none

PagingMetadata

{
  "totalRecords": 0,
  "totalPages": 0,
  "currentPage": 0,
  "nextIndex": 0,
  "recordsPerPage": 0
}

Properties

Name Type Required Restrictions Description
totalRecords integer(int32) false none none
totalPages integer(int32) false none none
currentPage integer(int32) false none none
nextIndex integer(int32) false none none
recordsPerPage integer(int32) false none none

PagingTeamMemberDTO

{
  "data": [
    {
      "id": 0,
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "address": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "mailingAddress": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "timezone": "string",
      "profilePhoto": {
        "id": 0,
        "fileName": "string",
        "fileSizeInKB": 0,
        "fileType": "string",
        "created": "2019-08-24T14:15:22Z",
        "url": "string",
        "uploadedByAccount": {
          "id": 0,
          "firstName": "string",
          "lastName": "string",
          "primaryEmail": {
            "id": 0,
            "type": "string",
            "format": "string",
            "notifications": true,
            "contact": "string",
            "contactExtra": "string",
            "verified": true
          }
        }
      },
      "primaryEmail": {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      },
      "primaryMobile": {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      },
      "workerContactDetails": [
        {
          "id": 0,
          "type": "string",
          "format": "string",
          "notifications": true,
          "contact": "string",
          "contactExtra": "string",
          "verified": true
        }
      ],
      "registrationDate": "2019-08-24T14:15:22Z",
      "dateOfBirth": "2019-08-24T14:15:22Z",
      "connectionStatus": "Y",
      "tracking": {
        "id": 0,
        "status": "APPROVED",
        "statusName": "string",
        "previousStatus": "string",
        "started": "2019-08-24T14:15:22Z",
        "verified": "2019-08-24T14:15:22Z",
        "resetDate": "2019-08-24T14:15:22Z",
        "workflowSteps": [
          {
            "stepId": 0,
            "form": {
              "structure": {
                "formKey": 0,
                "title": "string",
                "description": "string",
                "sections": {
                  "property1": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  },
                  "property2": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  }
                }
              },
              "model": {
                "id": 0,
                "formKey": 0,
                "sections": {
                  "property1": [
                    {}
                  ],
                  "property2": [
                    {}
                  ]
                }
              }
            },
            "displayTitle": "string",
            "verificationStatus": "string"
          }
        ]
      },
      "categories": [
        {
          "id": 0,
          "title": "string",
          "subcategories": [
            {
              "id": 0,
              "title": "string",
              "category": {},
              "mandatory": true,
              "sort": 0
            }
          ],
          "mandatory": true
        }
      ],
      "role": {
        "id": 0,
        "title": "string",
        "description": "string"
      },
      "worksites": [
        {
          "id": 0,
          "name": "string",
          "address": {
            "address1": "string",
            "suburb": "string",
            "state": "string",
            "postcode": "string",
            "countryCode": "string",
            "country": "string",
            "geoLocation": {
              "lat": 0,
              "lng": 0
            }
          },
          "email": "string",
          "phone": "string",
          "fax": "string",
          "areaCode": "string",
          "resources": [
            {
              "id": 0,
              "fileName": "string",
              "fileSizeInKB": 0,
              "fileType": "string",
              "created": "2019-08-24T14:15:22Z",
              "url": "string",
              "uploadedByAccount": {
                "id": 0,
                "firstName": "string",
                "lastName": "string",
                "primaryEmail": {
                  "id": 0,
                  "type": "string",
                  "format": "string",
                  "notifications": true,
                  "contact": "string",
                  "contactExtra": "string",
                  "verified": true
                }
              }
            }
          ],
          "timezone": "string",
          "status": "COMPLETE"
        }
      ],
      "accessRole": "WORKER",
      "username": "string"
    }
  ],
  "metadata": {
    "totalRecords": 0,
    "totalPages": 0,
    "currentPage": 0,
    "nextIndex": 0,
    "recordsPerPage": 0
  }
}

Properties

Name Type Required Restrictions Description
data [TeamMemberDTO] false none none

PagingWorkerDTO

{
  "data": [
    {
      "id": 0,
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "address": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "mailingAddress": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "timezone": "string",
      "profilePhoto": {
        "id": 0,
        "fileName": "string",
        "fileSizeInKB": 0,
        "fileType": "string",
        "created": "2019-08-24T14:15:22Z",
        "url": "string",
        "uploadedByAccount": {
          "id": 0,
          "firstName": "string",
          "lastName": "string",
          "primaryEmail": {
            "id": 0,
            "type": "string",
            "format": "string",
            "notifications": true,
            "contact": "string",
            "contactExtra": "string",
            "verified": true
          }
        }
      },
      "primaryEmail": {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      },
      "primaryMobile": {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      },
      "workerContactDetails": [
        {
          "id": 0,
          "type": "string",
          "format": "string",
          "notifications": true,
          "contact": "string",
          "contactExtra": "string",
          "verified": true
        }
      ],
      "registrationDate": "2019-08-24T14:15:22Z",
      "dateOfBirth": "2019-08-24T14:15:22Z",
      "connectionStatus": "Y",
      "contractor": {
        "id": 0,
        "tradingName": "string",
        "legalBusinessName": "string",
        "businessDescription": "string",
        "industriesList": [
          {
            "id": 0,
            "name": "string",
            "industrySector": {
              "id": 0,
              "name": "string"
            }
          }
        ],
        "contactDetailsList": [
          {
            "id": 0,
            "format": "string",
            "primaryContact": true,
            "contact": "string",
            "contactExtra": "string"
          }
        ],
        "address": {
          "address1": "string",
          "suburb": "string",
          "state": "string",
          "postcode": "string",
          "countryCode": "string",
          "country": "string",
          "geoLocation": {
            "lat": 0,
            "lng": 0
          }
        },
        "mailingAddress": {
          "address1": "string",
          "suburb": "string",
          "state": "string",
          "postcode": "string",
          "countryCode": "string",
          "country": "string",
          "geoLocation": {
            "lat": 0,
            "lng": 0
          }
        },
        "businessNumbers": [
          {
            "id": 0,
            "typeId": 0,
            "value": "string",
            "type": "string"
          }
        ],
        "businessStructureName": "string",
        "registerDate": "2019-08-24T14:15:22Z",
        "timezone": "string",
        "connectionStatus": "Y",
        "role": {
          "id": 0,
          "title": "string",
          "description": "string"
        },
        "businessLogo": {
          "id": 0,
          "fileName": "string",
          "fileSizeInKB": 0,
          "fileType": "string",
          "created": "2019-08-24T14:15:22Z",
          "url": "string",
          "uploadedByAccount": {
            "id": 0,
            "firstName": "string",
            "lastName": "string",
            "primaryEmail": {
              "id": 0,
              "type": "string",
              "format": "string",
              "notifications": true,
              "contact": "string",
              "contactExtra": "string",
              "verified": true
            }
          }
        },
        "tracking": {
          "id": 0,
          "status": "APPROVED",
          "statusName": "string",
          "previousStatus": "string",
          "started": "2019-08-24T14:15:22Z",
          "verified": "2019-08-24T14:15:22Z",
          "resetDate": "2019-08-24T14:15:22Z",
          "workflowSteps": [
            {
              "stepId": 0,
              "form": {
                "structure": {
                  "formKey": 0,
                  "title": "string",
                  "description": "string",
                  "sections": {
                    "property1": {},
                    "property2": {}
                  }
                },
                "model": {
                  "id": 0,
                  "formKey": 0,
                  "sections": {
                    "property1": [],
                    "property2": []
                  }
                }
              },
              "displayTitle": "string",
              "verificationStatus": "string"
            }
          ]
        },
        "supportingDocuments": [
          {
            "id": 0,
            "fileName": "string",
            "fileSizeInKB": 0,
            "fileType": "string",
            "created": "2019-08-24T14:15:22Z",
            "url": "string",
            "uploadedByAccount": {
              "id": 0,
              "firstName": "string",
              "lastName": "string",
              "primaryEmail": {
                "id": 0,
                "type": "string",
                "format": "string",
                "notifications": true,
                "contact": "string",
                "contactExtra": "string",
                "verified": true
              }
            }
          }
        ],
        "categories": [
          {
            "id": 0,
            "title": "string",
            "subcategories": [
              {
                "id": 0,
                "title": "string",
                "category": {},
                "mandatory": true,
                "sort": 0
              }
            ],
            "mandatory": true
          }
        ],
        "worksites": [
          {
            "id": 0,
            "name": "string",
            "address": {
              "address1": "string",
              "suburb": "string",
              "state": "string",
              "postcode": "string",
              "countryCode": "string",
              "country": "string",
              "geoLocation": {
                "lat": 0,
                "lng": 0
              }
            },
            "email": "string",
            "phone": "string",
            "fax": "string",
            "areaCode": "string",
            "resources": [
              {
                "id": 0,
                "fileName": "string",
                "fileSizeInKB": 0,
                "fileType": "string",
                "created": "2019-08-24T14:15:22Z",
                "url": "string",
                "uploadedByAccount": {
                  "id": 0,
                  "firstName": "string",
                  "lastName": "string",
                  "primaryEmail": {
                    "id": 0,
                    "type": "string",
                    "format": "string",
                    "notifications": true,
                    "contact": "string",
                    "contactExtra": "string",
                    "verified": true
                  }
                }
              }
            ],
            "timezone": "string",
            "status": "COMPLETE"
          }
        ],
        "currencyCode": "AUD",
        "inviteId": 0
      },
      "tracking": {
        "id": 0,
        "status": "APPROVED",
        "statusName": "string",
        "previousStatus": "string",
        "started": "2019-08-24T14:15:22Z",
        "verified": "2019-08-24T14:15:22Z",
        "resetDate": "2019-08-24T14:15:22Z",
        "workflowSteps": [
          {
            "stepId": 0,
            "form": {
              "structure": {
                "formKey": 0,
                "title": "string",
                "description": "string",
                "sections": {
                  "property1": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  },
                  "property2": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  }
                }
              },
              "model": {
                "id": 0,
                "formKey": 0,
                "sections": {
                  "property1": [
                    {}
                  ],
                  "property2": [
                    {}
                  ]
                }
              }
            },
            "displayTitle": "string",
            "verificationStatus": "string"
          }
        ]
      },
      "categories": [
        {
          "id": 0,
          "title": "string",
          "subcategories": [
            {
              "id": 0,
              "title": "string",
              "category": {},
              "mandatory": true,
              "sort": 0
            }
          ],
          "mandatory": true
        }
      ],
      "role": {
        "id": 0,
        "title": "string",
        "description": "string"
      },
      "worksites": [
        {
          "id": 0,
          "name": "string",
          "address": {
            "address1": "string",
            "suburb": "string",
            "state": "string",
            "postcode": "string",
            "countryCode": "string",
            "country": "string",
            "geoLocation": {
              "lat": 0,
              "lng": 0
            }
          },
          "email": "string",
          "phone": "string",
          "fax": "string",
          "areaCode": "string",
          "resources": [
            {
              "id": 0,
              "fileName": "string",
              "fileSizeInKB": 0,
              "fileType": "string",
              "created": "2019-08-24T14:15:22Z",
              "url": "string",
              "uploadedByAccount": {
                "id": 0,
                "firstName": "string",
                "lastName": "string",
                "primaryEmail": {
                  "id": 0,
                  "type": "string",
                  "format": "string",
                  "notifications": true,
                  "contact": "string",
                  "contactExtra": "string",
                  "verified": true
                }
              }
            }
          ],
          "timezone": "string",
          "status": "COMPLETE"
        }
      ],
      "contractorAdmin": true
    }
  ],
  "metadata": {
    "totalRecords": 0,
    "totalPages": 0,
    "currentPage": 0,
    "nextIndex": 0,
    "recordsPerPage": 0
  }
}

Properties

Name Type Required Restrictions Description
data [WorkerDTO] false none none

ResourceDTO

{
  "id": 0,
  "fileName": "string",
  "fileSizeInKB": 0,
  "fileType": "string",
  "created": "2019-08-24T14:15:22Z",
  "url": "string",
  "uploadedByAccount": {
    "id": 0,
    "firstName": "string",
    "lastName": "string",
    "primaryEmail": {
      "id": 0,
      "type": "string",
      "format": "string",
      "notifications": true,
      "contact": "string",
      "contactExtra": "string",
      "verified": true
    }
  }
}

Resource objects contain an Id and a URL, that can be used to access the resource stored

Properties

Name Type Required Restrictions Description
id integer(int64) false none Unique Resource ID stored for a resource, this can be used to reference the associated resource
fileName string false none User defined file name of the resource
fileSizeInKB integer(int64) false none The file resource size in KB
fileType string false none The file resource type
created string(date-time) false none Date the resource was uploaded
url string false none The resource URL that you can call to download the resource

RoleDTO

{
  "id": 0,
  "title": "string",
  "description": "string",
  "defaultSystemRole": true,
  "selfRegistration": true
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none Unique Role ID
title string false none Role Title
description string false none Role Description
defaultSystemRole boolean false none Default System Role
selfRegistration boolean false none Can the role self register from the client portal

RoleGroupDTO

{
  "List of Contractor roles": [
    {
      "id": 0,
      "title": "string",
      "description": "string",
      "defaultSystemRole": true,
      "selfRegistration": true
    }
  ],
  "List of Worker roles": [
    {
      "id": 0,
      "title": "string",
      "description": "string",
      "defaultSystemRole": true,
      "selfRegistration": true
    }
  ],
  "List of Team Member roles": [
    {
      "id": 0,
      "title": "string",
      "description": "string",
      "defaultSystemRole": true,
      "selfRegistration": true
    }
  ],
  "List of Visitor roles": [
    {
      "id": 0,
      "title": "string",
      "description": "string",
      "defaultSystemRole": true,
      "selfRegistration": true
    }
  ]
}

Roles grouped by workflow entities

Properties

Name Type Required Restrictions Description
List of Contractor roles [RoleDTO] false none none

SectionDTO

{
  "sectionKey": 0,
  "title": "string",
  "description": "string",
  "repeatable": true,
  "fields": [
    {
      "fieldKey": 0,
      "type": "ALL",
      "readableWidgetType": "string",
      "label": "string",
      "description": "string",
      "options": [
        {
          "optionKey": 0,
          "value": "string"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
sectionKey integer(int64) false none none
title string false none none
description string false none none
repeatable boolean false none none
fields [WidgetDTO] false none none

SectionModelDTO

{
  "id": 0,
  "sectionKey": 0,
  "status": "string",
  "fields": [
    {
      "id": 0,
      "fieldKey": 0,
      "values": [
        "string"
      ],
      "resources": [
        {
          "id": 0,
          "fileName": "string",
          "fileSizeInKB": 0,
          "fileType": "string",
          "created": "2019-08-24T14:15:22Z",
          "url": "string",
          "uploadedByAccount": {
            "id": 0,
            "firstName": "string",
            "lastName": "string",
            "primaryEmail": {
              "id": 0,
              "type": "string",
              "format": "string",
              "notifications": true,
              "contact": "string",
              "contactExtra": "string",
              "verified": true
            }
          }
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none none
sectionKey integer(int64) false none none
status string false none none
fields [WidgetModelDTO] false none none

SelectionOption

{
  "optionKey": 0,
  "value": "string"
}

Properties

Name Type Required Restrictions Description
optionKey integer(int64) false none none
value string false none none

StepDTO

{
  "stepId": 0,
  "form": {
    "structure": {
      "formKey": 0,
      "title": "string",
      "description": "string",
      "sections": {
        "property1": {
          "sectionKey": 0,
          "title": "string",
          "description": "string",
          "repeatable": true,
          "fields": [
            {
              "fieldKey": 0,
              "type": "ALL",
              "readableWidgetType": "string",
              "label": "string",
              "description": "string",
              "options": [
                {
                  "optionKey": 0,
                  "value": "string"
                }
              ]
            }
          ]
        },
        "property2": {
          "sectionKey": 0,
          "title": "string",
          "description": "string",
          "repeatable": true,
          "fields": [
            {
              "fieldKey": 0,
              "type": "ALL",
              "readableWidgetType": "string",
              "label": "string",
              "description": "string",
              "options": [
                {
                  "optionKey": 0,
                  "value": "string"
                }
              ]
            }
          ]
        }
      }
    },
    "model": {
      "id": 0,
      "formKey": 0,
      "sections": {
        "property1": [
          {
            "id": 0,
            "sectionKey": 0,
            "status": "string",
            "fields": [
              {
                "id": 0,
                "fieldKey": 0,
                "values": [
                  "string"
                ],
                "resources": [
                  {
                    "id": 0,
                    "fileName": "string",
                    "fileSizeInKB": 0,
                    "fileType": "string",
                    "created": "2019-08-24T14:15:22Z",
                    "url": "string",
                    "uploadedByAccount": {}
                  }
                ]
              }
            ]
          }
        ],
        "property2": [
          {
            "id": 0,
            "sectionKey": 0,
            "status": "string",
            "fields": [
              {
                "id": 0,
                "fieldKey": 0,
                "values": [
                  "string"
                ],
                "resources": [
                  {
                    "id": 0,
                    "fileName": "string",
                    "fileSizeInKB": 0,
                    "fileType": "string",
                    "created": "2019-08-24T14:15:22Z",
                    "url": "string",
                    "uploadedByAccount": {}
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "displayTitle": "string",
  "verificationStatus": "string"
}

Properties

Name Type Required Restrictions Description
stepId integer(int64) false none none

SubcategoryDTO

{
  "id": 0,
  "title": "string",
  "category": {
    "id": 0,
    "title": "string",
    "subcategories": [
      {
        "id": 0,
        "title": "string",
        "category": {},
        "mandatory": true,
        "sort": 0
      }
    ],
    "mandatory": true
  },
  "mandatory": true,
  "sort": 0
}

Subcategory Information

Properties

Name Type Required Restrictions Description
id integer(int64) false none Subcategory ID
title string false none Name of the subcategory

TeamMemberDTO

{
  "id": 0,
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "address": {
    "address1": "string",
    "suburb": "string",
    "state": "string",
    "postcode": "string",
    "countryCode": "string",
    "country": "string",
    "geoLocation": {
      "lat": 0,
      "lng": 0
    }
  },
  "mailingAddress": {
    "address1": "string",
    "suburb": "string",
    "state": "string",
    "postcode": "string",
    "countryCode": "string",
    "country": "string",
    "geoLocation": {
      "lat": 0,
      "lng": 0
    }
  },
  "timezone": "string",
  "profilePhoto": {
    "id": 0,
    "fileName": "string",
    "fileSizeInKB": 0,
    "fileType": "string",
    "created": "2019-08-24T14:15:22Z",
    "url": "string",
    "uploadedByAccount": {
      "id": 0,
      "firstName": "string",
      "lastName": "string",
      "primaryEmail": {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      }
    }
  },
  "primaryEmail": {
    "id": 0,
    "type": "string",
    "format": "string",
    "notifications": true,
    "contact": "string",
    "contactExtra": "string",
    "verified": true
  },
  "primaryMobile": {
    "id": 0,
    "type": "string",
    "format": "string",
    "notifications": true,
    "contact": "string",
    "contactExtra": "string",
    "verified": true
  },
  "workerContactDetails": [
    {
      "id": 0,
      "type": "string",
      "format": "string",
      "notifications": true,
      "contact": "string",
      "contactExtra": "string",
      "verified": true
    }
  ],
  "registrationDate": "2019-08-24T14:15:22Z",
  "dateOfBirth": "2019-08-24T14:15:22Z",
  "connectionStatus": "Y",
  "tracking": {
    "id": 0,
    "status": "APPROVED",
    "statusName": "string",
    "previousStatus": "string",
    "started": "2019-08-24T14:15:22Z",
    "verified": "2019-08-24T14:15:22Z",
    "resetDate": "2019-08-24T14:15:22Z",
    "workflowSteps": [
      {
        "stepId": 0,
        "form": {
          "structure": {
            "formKey": 0,
            "title": "string",
            "description": "string",
            "sections": {
              "property1": {
                "sectionKey": 0,
                "title": "string",
                "description": "string",
                "repeatable": true,
                "fields": [
                  {
                    "fieldKey": 0,
                    "type": "ALL",
                    "readableWidgetType": "string",
                    "label": "string",
                    "description": "string",
                    "options": []
                  }
                ]
              },
              "property2": {
                "sectionKey": 0,
                "title": "string",
                "description": "string",
                "repeatable": true,
                "fields": [
                  {
                    "fieldKey": 0,
                    "type": "ALL",
                    "readableWidgetType": "string",
                    "label": "string",
                    "description": "string",
                    "options": []
                  }
                ]
              }
            }
          },
          "model": {
            "id": 0,
            "formKey": 0,
            "sections": {
              "property1": [
                {
                  "id": 0,
                  "sectionKey": 0,
                  "status": "string",
                  "fields": [
                    {}
                  ]
                }
              ],
              "property2": [
                {
                  "id": 0,
                  "sectionKey": 0,
                  "status": "string",
                  "fields": [
                    {}
                  ]
                }
              ]
            }
          }
        },
        "displayTitle": "string",
        "verificationStatus": "string"
      }
    ]
  },
  "categories": [
    {
      "id": 0,
      "title": "string",
      "subcategories": [
        {
          "id": 0,
          "title": "string",
          "category": {},
          "mandatory": true,
          "sort": 0
        }
      ],
      "mandatory": true
    }
  ],
  "role": {
    "id": 0,
    "title": "string",
    "description": "string"
  },
  "worksites": [
    {
      "id": 0,
      "name": "string",
      "address": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "email": "string",
      "phone": "string",
      "fax": "string",
      "areaCode": "string",
      "resources": [
        {
          "id": 0,
          "fileName": "string",
          "fileSizeInKB": 0,
          "fileType": "string",
          "created": "2019-08-24T14:15:22Z",
          "url": "string",
          "uploadedByAccount": {
            "id": 0,
            "firstName": "string",
            "lastName": "string",
            "primaryEmail": {
              "id": 0,
              "type": "string",
              "format": "string",
              "notifications": true,
              "contact": "string",
              "contactExtra": "string",
              "verified": true
            }
          }
        }
      ],
      "timezone": "string",
      "status": "COMPLETE"
    }
  ],
  "accessRole": "WORKER",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none Unique Sitepass Id
firstName string false none First name
middleName string false none Middle name
lastName string false none Last name

UploadedByAccountDTO

{
  "id": 0,
  "firstName": "string",
  "lastName": "string",
  "primaryEmail": {
    "id": 0,
    "type": "string",
    "format": "string",
    "notifications": true,
    "contact": "string",
    "contactExtra": "string",
    "verified": true
  }
}

Account information of the user who uploaded the Resource.

Properties

Name Type Required Restrictions Description
id integer(int64) false none Unique Sitepass Id
firstName string false none First name
lastName string false none Last name

ValidationError

{
  "errorMessage": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {}
    },
    "property2": {
      "errorMessage": "string",
      "errors": {}
    }
  }
}

Properties

Name Type Required Restrictions Description
errorMessage string false none none
errors object false none none

WidgetDTO

{
  "fieldKey": 0,
  "type": "ALL",
  "readableWidgetType": "string",
  "label": "string",
  "description": "string",
  "options": [
    {
      "optionKey": 0,
      "value": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
fieldKey integer(int64) false none none
type string false none none
readableWidgetType string false none none
label string false none none
description string false none none
options [SelectionOption] false none none

Enumerated Values

Property Value
type ALL
type RADIO
type RANGE
type CHECK_BOX
type TEXT_BOX
type SELECT_LIST
type MULTI_SELECT_LIST
type PASSWORD
type EMAIL
type URL
type NUMERIC
type SUMMARY_DISPLAY
type DATE
type FILE_UPLOAD
type EXPIRY_DATE
type TEXT_AREA
type ACKNOWLEDGEMENT
type TIME
type DATE_AND_TIME
type DECIMAL
type RATING
type VIDEO
type CURRENCY
type PHONE_NUMBER
type DURATION
type FILE_DOWNLOAD
type BUTTON_TABS
type EMBED_FILE

WidgetModelDTO

{
  "id": 0,
  "fieldKey": 0,
  "values": [
    "string"
  ],
  "resources": [
    {
      "id": 0,
      "fileName": "string",
      "fileSizeInKB": 0,
      "fileType": "string",
      "created": "2019-08-24T14:15:22Z",
      "url": "string",
      "uploadedByAccount": {
        "id": 0,
        "firstName": "string",
        "lastName": "string",
        "primaryEmail": {
          "id": 0,
          "type": "string",
          "format": "string",
          "notifications": true,
          "contact": "string",
          "contactExtra": "string",
          "verified": true
        }
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none none
fieldKey integer(int64) false none none
values [string] false none none
resources [ResourceDTO] false none [Resource objects contain an Id and a URL, that can be used to access the resource stored]

WmsResponse

{
  "success": true,
  "message": "string",
  "errorType": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "data": {}
}

Properties

Name Type Required Restrictions Description
success boolean false none none
message string false none none
errorType string false none none
errors object false none none
data object false none none

WmsResponseContractorDTO

{
  "success": true,
  "message": "string",
  "errorType": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "data": {
    "id": 0,
    "tradingName": "string",
    "legalBusinessName": "string",
    "businessDescription": "string",
    "industriesList": [
      {
        "id": 0,
        "name": "string",
        "industrySector": {
          "id": 0,
          "name": "string"
        }
      }
    ],
    "contactDetailsList": [
      {
        "id": 0,
        "format": "string",
        "primaryContact": true,
        "contact": "string",
        "contactExtra": "string"
      }
    ],
    "address": {
      "address1": "string",
      "suburb": "string",
      "state": "string",
      "postcode": "string",
      "countryCode": "string",
      "country": "string",
      "geoLocation": {
        "lat": 0,
        "lng": 0
      }
    },
    "mailingAddress": {
      "address1": "string",
      "suburb": "string",
      "state": "string",
      "postcode": "string",
      "countryCode": "string",
      "country": "string",
      "geoLocation": {
        "lat": 0,
        "lng": 0
      }
    },
    "businessNumbers": [
      {
        "id": 0,
        "typeId": 0,
        "value": "string",
        "type": "string"
      }
    ],
    "businessStructureName": "string",
    "registerDate": "2019-08-24T14:15:22Z",
    "timezone": "string",
    "connectionStatus": "Y",
    "role": {
      "id": 0,
      "title": "string",
      "description": "string"
    },
    "businessLogo": {
      "id": 0,
      "fileName": "string",
      "fileSizeInKB": 0,
      "fileType": "string",
      "created": "2019-08-24T14:15:22Z",
      "url": "string",
      "uploadedByAccount": {
        "id": 0,
        "firstName": "string",
        "lastName": "string",
        "primaryEmail": {
          "id": 0,
          "type": "string",
          "format": "string",
          "notifications": true,
          "contact": "string",
          "contactExtra": "string",
          "verified": true
        }
      }
    },
    "tracking": {
      "id": 0,
      "status": "APPROVED",
      "statusName": "string",
      "previousStatus": "string",
      "started": "2019-08-24T14:15:22Z",
      "verified": "2019-08-24T14:15:22Z",
      "resetDate": "2019-08-24T14:15:22Z",
      "workflowSteps": [
        {
          "stepId": 0,
          "form": {
            "structure": {
              "formKey": 0,
              "title": "string",
              "description": "string",
              "sections": {
                "property1": {
                  "sectionKey": 0,
                  "title": "string",
                  "description": "string",
                  "repeatable": true,
                  "fields": [
                    {}
                  ]
                },
                "property2": {
                  "sectionKey": 0,
                  "title": "string",
                  "description": "string",
                  "repeatable": true,
                  "fields": [
                    {}
                  ]
                }
              }
            },
            "model": {
              "id": 0,
              "formKey": 0,
              "sections": {
                "property1": [
                  {
                    "id": 0,
                    "sectionKey": 0,
                    "status": "string",
                    "fields": []
                  }
                ],
                "property2": [
                  {
                    "id": 0,
                    "sectionKey": 0,
                    "status": "string",
                    "fields": []
                  }
                ]
              }
            }
          },
          "displayTitle": "string",
          "verificationStatus": "string"
        }
      ]
    },
    "supportingDocuments": [
      {
        "id": 0,
        "fileName": "string",
        "fileSizeInKB": 0,
        "fileType": "string",
        "created": "2019-08-24T14:15:22Z",
        "url": "string",
        "uploadedByAccount": {
          "id": 0,
          "firstName": "string",
          "lastName": "string",
          "primaryEmail": {
            "id": 0,
            "type": "string",
            "format": "string",
            "notifications": true,
            "contact": "string",
            "contactExtra": "string",
            "verified": true
          }
        }
      }
    ],
    "categories": [
      {
        "id": 0,
        "title": "string",
        "subcategories": [
          {
            "id": 0,
            "title": "string",
            "category": {},
            "mandatory": true,
            "sort": 0
          }
        ],
        "mandatory": true
      }
    ],
    "worksites": [
      {
        "id": 0,
        "name": "string",
        "address": {
          "address1": "string",
          "suburb": "string",
          "state": "string",
          "postcode": "string",
          "countryCode": "string",
          "country": "string",
          "geoLocation": {
            "lat": 0,
            "lng": 0
          }
        },
        "email": "string",
        "phone": "string",
        "fax": "string",
        "areaCode": "string",
        "resources": [
          {
            "id": 0,
            "fileName": "string",
            "fileSizeInKB": 0,
            "fileType": "string",
            "created": "2019-08-24T14:15:22Z",
            "url": "string",
            "uploadedByAccount": {
              "id": 0,
              "firstName": "string",
              "lastName": "string",
              "primaryEmail": {
                "id": 0,
                "type": "string",
                "format": "string",
                "notifications": true,
                "contact": "string",
                "contactExtra": "string",
                "verified": true
              }
            }
          }
        ],
        "timezone": "string",
        "status": "COMPLETE"
      }
    ],
    "currencyCode": "AUD",
    "inviteId": 0
  }
}

Properties

Name Type Required Restrictions Description
success boolean false none none
message string false none none
errorType string false none none
errors object false none none

WmsResponseListCategoryDTO

{
  "success": true,
  "message": "string",
  "errorType": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "data": [
    {
      "id": 0,
      "title": "string",
      "subcategories": [
        {
          "id": 0,
          "title": "string",
          "category": {},
          "mandatory": true,
          "sort": 0
        }
      ],
      "mandatory": true
    }
  ]
}

Properties

Name Type Required Restrictions Description
success boolean false none none
message string false none none
errorType string false none none
errors object false none none
data [CategoryDTO] false none none

WmsResponseRoleGroupDTO

{
  "success": true,
  "message": "string",
  "errorType": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "data": {
    "List of Contractor roles": [
      {
        "id": 0,
        "title": "string",
        "description": "string",
        "defaultSystemRole": true,
        "selfRegistration": true
      }
    ],
    "List of Worker roles": [
      {
        "id": 0,
        "title": "string",
        "description": "string",
        "defaultSystemRole": true,
        "selfRegistration": true
      }
    ],
    "List of Team Member roles": [
      {
        "id": 0,
        "title": "string",
        "description": "string",
        "defaultSystemRole": true,
        "selfRegistration": true
      }
    ],
    "List of Visitor roles": [
      {
        "id": 0,
        "title": "string",
        "description": "string",
        "defaultSystemRole": true,
        "selfRegistration": true
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
success boolean false none none
message string false none none
errorType string false none none
errors object false none none

WmsResponseWorkerDTO

{
  "success": true,
  "message": "string",
  "errorType": "string",
  "errors": {
    "property1": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    },
    "property2": {
      "errorMessage": "string",
      "errors": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "data": {
    "id": 0,
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "address": {
      "address1": "string",
      "suburb": "string",
      "state": "string",
      "postcode": "string",
      "countryCode": "string",
      "country": "string",
      "geoLocation": {
        "lat": 0,
        "lng": 0
      }
    },
    "mailingAddress": {
      "address1": "string",
      "suburb": "string",
      "state": "string",
      "postcode": "string",
      "countryCode": "string",
      "country": "string",
      "geoLocation": {
        "lat": 0,
        "lng": 0
      }
    },
    "timezone": "string",
    "profilePhoto": {
      "id": 0,
      "fileName": "string",
      "fileSizeInKB": 0,
      "fileType": "string",
      "created": "2019-08-24T14:15:22Z",
      "url": "string",
      "uploadedByAccount": {
        "id": 0,
        "firstName": "string",
        "lastName": "string",
        "primaryEmail": {
          "id": 0,
          "type": "string",
          "format": "string",
          "notifications": true,
          "contact": "string",
          "contactExtra": "string",
          "verified": true
        }
      }
    },
    "primaryEmail": {
      "id": 0,
      "type": "string",
      "format": "string",
      "notifications": true,
      "contact": "string",
      "contactExtra": "string",
      "verified": true
    },
    "primaryMobile": {
      "id": 0,
      "type": "string",
      "format": "string",
      "notifications": true,
      "contact": "string",
      "contactExtra": "string",
      "verified": true
    },
    "workerContactDetails": [
      {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      }
    ],
    "registrationDate": "2019-08-24T14:15:22Z",
    "dateOfBirth": "2019-08-24T14:15:22Z",
    "connectionStatus": "Y",
    "contractor": {
      "id": 0,
      "tradingName": "string",
      "legalBusinessName": "string",
      "businessDescription": "string",
      "industriesList": [
        {
          "id": 0,
          "name": "string",
          "industrySector": {
            "id": 0,
            "name": "string"
          }
        }
      ],
      "contactDetailsList": [
        {
          "id": 0,
          "format": "string",
          "primaryContact": true,
          "contact": "string",
          "contactExtra": "string"
        }
      ],
      "address": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "mailingAddress": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "businessNumbers": [
        {
          "id": 0,
          "typeId": 0,
          "value": "string",
          "type": "string"
        }
      ],
      "businessStructureName": "string",
      "registerDate": "2019-08-24T14:15:22Z",
      "timezone": "string",
      "connectionStatus": "Y",
      "role": {
        "id": 0,
        "title": "string",
        "description": "string"
      },
      "businessLogo": {
        "id": 0,
        "fileName": "string",
        "fileSizeInKB": 0,
        "fileType": "string",
        "created": "2019-08-24T14:15:22Z",
        "url": "string",
        "uploadedByAccount": {
          "id": 0,
          "firstName": "string",
          "lastName": "string",
          "primaryEmail": {
            "id": 0,
            "type": "string",
            "format": "string",
            "notifications": true,
            "contact": "string",
            "contactExtra": "string",
            "verified": true
          }
        }
      },
      "tracking": {
        "id": 0,
        "status": "APPROVED",
        "statusName": "string",
        "previousStatus": "string",
        "started": "2019-08-24T14:15:22Z",
        "verified": "2019-08-24T14:15:22Z",
        "resetDate": "2019-08-24T14:15:22Z",
        "workflowSteps": [
          {
            "stepId": 0,
            "form": {
              "structure": {
                "formKey": 0,
                "title": "string",
                "description": "string",
                "sections": {
                  "property1": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  },
                  "property2": {
                    "sectionKey": 0,
                    "title": "string",
                    "description": "string",
                    "repeatable": true,
                    "fields": []
                  }
                }
              },
              "model": {
                "id": 0,
                "formKey": 0,
                "sections": {
                  "property1": [
                    {}
                  ],
                  "property2": [
                    {}
                  ]
                }
              }
            },
            "displayTitle": "string",
            "verificationStatus": "string"
          }
        ]
      },
      "supportingDocuments": [
        {
          "id": 0,
          "fileName": "string",
          "fileSizeInKB": 0,
          "fileType": "string",
          "created": "2019-08-24T14:15:22Z",
          "url": "string",
          "uploadedByAccount": {
            "id": 0,
            "firstName": "string",
            "lastName": "string",
            "primaryEmail": {
              "id": 0,
              "type": "string",
              "format": "string",
              "notifications": true,
              "contact": "string",
              "contactExtra": "string",
              "verified": true
            }
          }
        }
      ],
      "categories": [
        {
          "id": 0,
          "title": "string",
          "subcategories": [
            {
              "id": 0,
              "title": "string",
              "category": {},
              "mandatory": true,
              "sort": 0
            }
          ],
          "mandatory": true
        }
      ],
      "worksites": [
        {
          "id": 0,
          "name": "string",
          "address": {
            "address1": "string",
            "suburb": "string",
            "state": "string",
            "postcode": "string",
            "countryCode": "string",
            "country": "string",
            "geoLocation": {
              "lat": 0,
              "lng": 0
            }
          },
          "email": "string",
          "phone": "string",
          "fax": "string",
          "areaCode": "string",
          "resources": [
            {
              "id": 0,
              "fileName": "string",
              "fileSizeInKB": 0,
              "fileType": "string",
              "created": "2019-08-24T14:15:22Z",
              "url": "string",
              "uploadedByAccount": {
                "id": 0,
                "firstName": "string",
                "lastName": "string",
                "primaryEmail": {
                  "id": 0,
                  "type": "string",
                  "format": "string",
                  "notifications": true,
                  "contact": "string",
                  "contactExtra": "string",
                  "verified": true
                }
              }
            }
          ],
          "timezone": "string",
          "status": "COMPLETE"
        }
      ],
      "currencyCode": "AUD",
      "inviteId": 0
    },
    "tracking": {
      "id": 0,
      "status": "APPROVED",
      "statusName": "string",
      "previousStatus": "string",
      "started": "2019-08-24T14:15:22Z",
      "verified": "2019-08-24T14:15:22Z",
      "resetDate": "2019-08-24T14:15:22Z",
      "workflowSteps": [
        {
          "stepId": 0,
          "form": {
            "structure": {
              "formKey": 0,
              "title": "string",
              "description": "string",
              "sections": {
                "property1": {
                  "sectionKey": 0,
                  "title": "string",
                  "description": "string",
                  "repeatable": true,
                  "fields": [
                    {}
                  ]
                },
                "property2": {
                  "sectionKey": 0,
                  "title": "string",
                  "description": "string",
                  "repeatable": true,
                  "fields": [
                    {}
                  ]
                }
              }
            },
            "model": {
              "id": 0,
              "formKey": 0,
              "sections": {
                "property1": [
                  {
                    "id": 0,
                    "sectionKey": 0,
                    "status": "string",
                    "fields": []
                  }
                ],
                "property2": [
                  {
                    "id": 0,
                    "sectionKey": 0,
                    "status": "string",
                    "fields": []
                  }
                ]
              }
            }
          },
          "displayTitle": "string",
          "verificationStatus": "string"
        }
      ]
    },
    "categories": [
      {
        "id": 0,
        "title": "string",
        "subcategories": [
          {
            "id": 0,
            "title": "string",
            "category": {},
            "mandatory": true,
            "sort": 0
          }
        ],
        "mandatory": true
      }
    ],
    "role": {
      "id": 0,
      "title": "string",
      "description": "string"
    },
    "worksites": [
      {
        "id": 0,
        "name": "string",
        "address": {
          "address1": "string",
          "suburb": "string",
          "state": "string",
          "postcode": "string",
          "countryCode": "string",
          "country": "string",
          "geoLocation": {
            "lat": 0,
            "lng": 0
          }
        },
        "email": "string",
        "phone": "string",
        "fax": "string",
        "areaCode": "string",
        "resources": [
          {
            "id": 0,
            "fileName": "string",
            "fileSizeInKB": 0,
            "fileType": "string",
            "created": "2019-08-24T14:15:22Z",
            "url": "string",
            "uploadedByAccount": {
              "id": 0,
              "firstName": "string",
              "lastName": "string",
              "primaryEmail": {
                "id": 0,
                "type": "string",
                "format": "string",
                "notifications": true,
                "contact": "string",
                "contactExtra": "string",
                "verified": true
              }
            }
          }
        ],
        "timezone": "string",
        "status": "COMPLETE"
      }
    ],
    "contractorAdmin": true
  }
}

Properties

Name Type Required Restrictions Description
success boolean false none none
message string false none none
errorType string false none none
errors object false none none

WorkerContactDetailsDTO

{
  "id": 0,
  "type": "string",
  "format": "string",
  "notifications": true,
  "contact": "string",
  "contactExtra": "string",
  "verified": true
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none Unique Contact
type string false none Type of contact
format string false none Contact details format
notifications boolean false none Whether this contact should be used for notifications
contact string false none Contact value
contactExtra string false none Extra contact value, for e.g. CountryCode for mobile
verified boolean false none Has the user verified their contact information

WorkerDTO

{
  "id": 0,
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "address": {
    "address1": "string",
    "suburb": "string",
    "state": "string",
    "postcode": "string",
    "countryCode": "string",
    "country": "string",
    "geoLocation": {
      "lat": 0,
      "lng": 0
    }
  },
  "mailingAddress": {
    "address1": "string",
    "suburb": "string",
    "state": "string",
    "postcode": "string",
    "countryCode": "string",
    "country": "string",
    "geoLocation": {
      "lat": 0,
      "lng": 0
    }
  },
  "timezone": "string",
  "profilePhoto": {
    "id": 0,
    "fileName": "string",
    "fileSizeInKB": 0,
    "fileType": "string",
    "created": "2019-08-24T14:15:22Z",
    "url": "string",
    "uploadedByAccount": {
      "id": 0,
      "firstName": "string",
      "lastName": "string",
      "primaryEmail": {
        "id": 0,
        "type": "string",
        "format": "string",
        "notifications": true,
        "contact": "string",
        "contactExtra": "string",
        "verified": true
      }
    }
  },
  "primaryEmail": {
    "id": 0,
    "type": "string",
    "format": "string",
    "notifications": true,
    "contact": "string",
    "contactExtra": "string",
    "verified": true
  },
  "primaryMobile": {
    "id": 0,
    "type": "string",
    "format": "string",
    "notifications": true,
    "contact": "string",
    "contactExtra": "string",
    "verified": true
  },
  "workerContactDetails": [
    {
      "id": 0,
      "type": "string",
      "format": "string",
      "notifications": true,
      "contact": "string",
      "contactExtra": "string",
      "verified": true
    }
  ],
  "registrationDate": "2019-08-24T14:15:22Z",
  "dateOfBirth": "2019-08-24T14:15:22Z",
  "connectionStatus": "Y",
  "contractor": {
    "id": 0,
    "tradingName": "string",
    "legalBusinessName": "string",
    "businessDescription": "string",
    "industriesList": [
      {
        "id": 0,
        "name": "string",
        "industrySector": {
          "id": 0,
          "name": "string"
        }
      }
    ],
    "contactDetailsList": [
      {
        "id": 0,
        "format": "string",
        "primaryContact": true,
        "contact": "string",
        "contactExtra": "string"
      }
    ],
    "address": {
      "address1": "string",
      "suburb": "string",
      "state": "string",
      "postcode": "string",
      "countryCode": "string",
      "country": "string",
      "geoLocation": {
        "lat": 0,
        "lng": 0
      }
    },
    "mailingAddress": {
      "address1": "string",
      "suburb": "string",
      "state": "string",
      "postcode": "string",
      "countryCode": "string",
      "country": "string",
      "geoLocation": {
        "lat": 0,
        "lng": 0
      }
    },
    "businessNumbers": [
      {
        "id": 0,
        "typeId": 0,
        "value": "string",
        "type": "string"
      }
    ],
    "businessStructureName": "string",
    "registerDate": "2019-08-24T14:15:22Z",
    "timezone": "string",
    "connectionStatus": "Y",
    "role": {
      "id": 0,
      "title": "string",
      "description": "string"
    },
    "businessLogo": {
      "id": 0,
      "fileName": "string",
      "fileSizeInKB": 0,
      "fileType": "string",
      "created": "2019-08-24T14:15:22Z",
      "url": "string",
      "uploadedByAccount": {
        "id": 0,
        "firstName": "string",
        "lastName": "string",
        "primaryEmail": {
          "id": 0,
          "type": "string",
          "format": "string",
          "notifications": true,
          "contact": "string",
          "contactExtra": "string",
          "verified": true
        }
      }
    },
    "tracking": {
      "id": 0,
      "status": "APPROVED",
      "statusName": "string",
      "previousStatus": "string",
      "started": "2019-08-24T14:15:22Z",
      "verified": "2019-08-24T14:15:22Z",
      "resetDate": "2019-08-24T14:15:22Z",
      "workflowSteps": [
        {
          "stepId": 0,
          "form": {
            "structure": {
              "formKey": 0,
              "title": "string",
              "description": "string",
              "sections": {
                "property1": {
                  "sectionKey": 0,
                  "title": "string",
                  "description": "string",
                  "repeatable": true,
                  "fields": [
                    {}
                  ]
                },
                "property2": {
                  "sectionKey": 0,
                  "title": "string",
                  "description": "string",
                  "repeatable": true,
                  "fields": [
                    {}
                  ]
                }
              }
            },
            "model": {
              "id": 0,
              "formKey": 0,
              "sections": {
                "property1": [
                  {
                    "id": 0,
                    "sectionKey": 0,
                    "status": "string",
                    "fields": []
                  }
                ],
                "property2": [
                  {
                    "id": 0,
                    "sectionKey": 0,
                    "status": "string",
                    "fields": []
                  }
                ]
              }
            }
          },
          "displayTitle": "string",
          "verificationStatus": "string"
        }
      ]
    },
    "supportingDocuments": [
      {
        "id": 0,
        "fileName": "string",
        "fileSizeInKB": 0,
        "fileType": "string",
        "created": "2019-08-24T14:15:22Z",
        "url": "string",
        "uploadedByAccount": {
          "id": 0,
          "firstName": "string",
          "lastName": "string",
          "primaryEmail": {
            "id": 0,
            "type": "string",
            "format": "string",
            "notifications": true,
            "contact": "string",
            "contactExtra": "string",
            "verified": true
          }
        }
      }
    ],
    "categories": [
      {
        "id": 0,
        "title": "string",
        "subcategories": [
          {
            "id": 0,
            "title": "string",
            "category": {},
            "mandatory": true,
            "sort": 0
          }
        ],
        "mandatory": true
      }
    ],
    "worksites": [
      {
        "id": 0,
        "name": "string",
        "address": {
          "address1": "string",
          "suburb": "string",
          "state": "string",
          "postcode": "string",
          "countryCode": "string",
          "country": "string",
          "geoLocation": {
            "lat": 0,
            "lng": 0
          }
        },
        "email": "string",
        "phone": "string",
        "fax": "string",
        "areaCode": "string",
        "resources": [
          {
            "id": 0,
            "fileName": "string",
            "fileSizeInKB": 0,
            "fileType": "string",
            "created": "2019-08-24T14:15:22Z",
            "url": "string",
            "uploadedByAccount": {
              "id": 0,
              "firstName": "string",
              "lastName": "string",
              "primaryEmail": {
                "id": 0,
                "type": "string",
                "format": "string",
                "notifications": true,
                "contact": "string",
                "contactExtra": "string",
                "verified": true
              }
            }
          }
        ],
        "timezone": "string",
        "status": "COMPLETE"
      }
    ],
    "currencyCode": "AUD",
    "inviteId": 0
  },
  "tracking": {
    "id": 0,
    "status": "APPROVED",
    "statusName": "string",
    "previousStatus": "string",
    "started": "2019-08-24T14:15:22Z",
    "verified": "2019-08-24T14:15:22Z",
    "resetDate": "2019-08-24T14:15:22Z",
    "workflowSteps": [
      {
        "stepId": 0,
        "form": {
          "structure": {
            "formKey": 0,
            "title": "string",
            "description": "string",
            "sections": {
              "property1": {
                "sectionKey": 0,
                "title": "string",
                "description": "string",
                "repeatable": true,
                "fields": [
                  {
                    "fieldKey": 0,
                    "type": "ALL",
                    "readableWidgetType": "string",
                    "label": "string",
                    "description": "string",
                    "options": []
                  }
                ]
              },
              "property2": {
                "sectionKey": 0,
                "title": "string",
                "description": "string",
                "repeatable": true,
                "fields": [
                  {
                    "fieldKey": 0,
                    "type": "ALL",
                    "readableWidgetType": "string",
                    "label": "string",
                    "description": "string",
                    "options": []
                  }
                ]
              }
            }
          },
          "model": {
            "id": 0,
            "formKey": 0,
            "sections": {
              "property1": [
                {
                  "id": 0,
                  "sectionKey": 0,
                  "status": "string",
                  "fields": [
                    {}
                  ]
                }
              ],
              "property2": [
                {
                  "id": 0,
                  "sectionKey": 0,
                  "status": "string",
                  "fields": [
                    {}
                  ]
                }
              ]
            }
          }
        },
        "displayTitle": "string",
        "verificationStatus": "string"
      }
    ]
  },
  "categories": [
    {
      "id": 0,
      "title": "string",
      "subcategories": [
        {
          "id": 0,
          "title": "string",
          "category": {},
          "mandatory": true,
          "sort": 0
        }
      ],
      "mandatory": true
    }
  ],
  "role": {
    "id": 0,
    "title": "string",
    "description": "string"
  },
  "worksites": [
    {
      "id": 0,
      "name": "string",
      "address": {
        "address1": "string",
        "suburb": "string",
        "state": "string",
        "postcode": "string",
        "countryCode": "string",
        "country": "string",
        "geoLocation": {
          "lat": 0,
          "lng": 0
        }
      },
      "email": "string",
      "phone": "string",
      "fax": "string",
      "areaCode": "string",
      "resources": [
        {
          "id": 0,
          "fileName": "string",
          "fileSizeInKB": 0,
          "fileType": "string",
          "created": "2019-08-24T14:15:22Z",
          "url": "string",
          "uploadedByAccount": {
            "id": 0,
            "firstName": "string",
            "lastName": "string",
            "primaryEmail": {
              "id": 0,
              "type": "string",
              "format": "string",
              "notifications": true,
              "contact": "string",
              "contactExtra": "string",
              "verified": true
            }
          }
        }
      ],
      "timezone": "string",
      "status": "COMPLETE"
    }
  ],
  "contractorAdmin": true
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none Unique Sitepass Id
firstName string false none First name
middleName string false none Middle name
lastName string false none Last name

Workflow

{
  "id": 0,
  "status": "APPROVED",
  "statusName": "string",
  "previousStatus": "string",
  "started": "2019-08-24T14:15:22Z",
  "verified": "2019-08-24T14:15:22Z",
  "resetDate": "2019-08-24T14:15:22Z",
  "workflowSteps": [
    {
      "stepId": 0,
      "form": {
        "structure": {
          "formKey": 0,
          "title": "string",
          "description": "string",
          "sections": {
            "property1": {
              "sectionKey": 0,
              "title": "string",
              "description": "string",
              "repeatable": true,
              "fields": [
                {
                  "fieldKey": 0,
                  "type": "ALL",
                  "readableWidgetType": "string",
                  "label": "string",
                  "description": "string",
                  "options": [
                    {}
                  ]
                }
              ]
            },
            "property2": {
              "sectionKey": 0,
              "title": "string",
              "description": "string",
              "repeatable": true,
              "fields": [
                {
                  "fieldKey": 0,
                  "type": "ALL",
                  "readableWidgetType": "string",
                  "label": "string",
                  "description": "string",
                  "options": [
                    {}
                  ]
                }
              ]
            }
          }
        },
        "model": {
          "id": 0,
          "formKey": 0,
          "sections": {
            "property1": [
              {
                "id": 0,
                "sectionKey": 0,
                "status": "string",
                "fields": [
                  {
                    "id": 0,
                    "fieldKey": 0,
                    "values": [],
                    "resources": []
                  }
                ]
              }
            ],
            "property2": [
              {
                "id": 0,
                "sectionKey": 0,
                "status": "string",
                "fields": [
                  {
                    "id": 0,
                    "fieldKey": 0,
                    "values": [],
                    "resources": []
                  }
                ]
              }
            ]
          }
        }
      },
      "displayTitle": "string",
      "verificationStatus": "string"
    }
  ]
}

Workflow tracking information

Properties

Name Type Required Restrictions Description
id integer(int64) false none Unique workflow tracking ID
status string false none Status Code
statusName string false none Friendly status name of the current workflow status
previousStatus string false none Friendly status name of the previous workflow status
started string(date-time) false none Date the workflow tracking was created
verified string(date-time) false none Last verified date of the tracking
resetDate string(date-time) false none Reset date of the workflow, if one is set
workflowSteps [StepDTO] false none Workflow step and the data entered on the step

Enumerated Values

Property Value
status APPROVED
status APPROVED_CONDITIONAL
status SUBMITTED_FOR_APPROVAL
status PENDING
status IN_PROGRESS
status NOT_STARTED
status DECLINED
status EXPIRED
status NOT_APPLICABLE
status MANDATORY
status REGISTERED
status NO_STATUS

WorksiteDTO

{
  "id": 0,
  "name": "string",
  "address": {
    "address1": "string",
    "suburb": "string",
    "state": "string",
    "postcode": "string",
    "countryCode": "string",
    "country": "string",
    "geoLocation": {
      "lat": 0,
      "lng": 0
    }
  },
  "email": "string",
  "phone": "string",
  "fax": "string",
  "areaCode": "string",
  "resources": [
    {
      "id": 0,
      "fileName": "string",
      "fileSizeInKB": 0,
      "fileType": "string",
      "created": "2019-08-24T14:15:22Z",
      "url": "string",
      "uploadedByAccount": {
        "id": 0,
        "firstName": "string",
        "lastName": "string",
        "primaryEmail": {
          "id": 0,
          "type": "string",
          "format": "string",
          "notifications": true,
          "contact": "string",
          "contactExtra": "string",
          "verified": true
        }
      }
    }
  ],
  "timezone": "string",
  "status": "COMPLETE"
}

Properties

Name Type Required Restrictions Description
id integer(int64) false none none
name string false none none