? format=jsonld
type: ApiDocumentation
title: mc-estimates v3
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: Adder
supported class: Category
supported class: ContractorCompany
supported class: District
supported class: Estimate
supported class: EstimateLine
supported class: LinePrice
supported class: User
supported class: Entrypoint
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: Error/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/title
  title: title
  required: false
  readable: true
  writeable: false
  description: A short, human-readable summary of the problem.
supported property: SupportedProperty
  property: Error/detail
  title: detail
  required: false
  readable: true
  writeable: false
  description: A human-readable explanation specific to this occurrence of the problem.
supported property: SupportedProperty
  property: Error/instance
  title: instance
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
supported property: SupportedProperty
  property: Error/type
  title: type
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the problem type
supported property: SupportedProperty
  property: Error/meta
  title: meta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Error resource.
  method: GET
  returns: Error
  title: getError
description: A representation of common errors.
sub class of: Error

Error/id
type: Property
domain: Error
the hydra core vocabulary: id
range: string

Error/title
type: Property
domain: Error
the hydra core vocabulary: title
range: string

Error/detail
type: Property
domain: Error
the hydra core vocabulary: detail
range: string

Error/instance
type: Property
domain: Error
the hydra core vocabulary: instance
range: string

Error/type
type: Property
domain: Error
the hydra core vocabulary: type
range: string

Error/meta
type: Property
domain: Error
the hydra core vocabulary: meta

Error/source
type: Property
domain: Error
the hydra core vocabulary: source

Error/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

Error/trace
type: Property
domain: Error
the hydra core vocabulary: trace

Error/message
type: Property
domain: Error
the hydra core vocabulary: message
range: string

Error/code
type: Property
domain: Error
the hydra core vocabulary: code
range: integer

Error/file
type: Property
domain: Error
the hydra core vocabulary: file
range: string

Error/line
type: Property
domain: Error
the hydra core vocabulary: line
range: integer

ConstraintViolation
type: Class
title: ConstraintViolation
supported property: SupportedProperty
  property: ConstraintViolation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/errorTitle
  title: errorTitle
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/detail
  title: detail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
description: Unprocessable entity
sub class of: Error

ConstraintViolation/status
type: Property
domain: ConstraintViolation
the hydra core vocabulary: status
range: integer

ConstraintViolation/errorTitle
type: Property
domain: ConstraintViolation
the hydra core vocabulary: errorTitle
range: string

ConstraintViolation/violations
type: Property
domain: ConstraintViolation
the hydra core vocabulary: violations
range: ConstraintViolationList

ConstraintViolation/detail
type: Property
domain: ConstraintViolation
the hydra core vocabulary: detail
range: string

ConstraintViolation/message
type: Property
domain: ConstraintViolation
the hydra core vocabulary: message
range: string

ConstraintViolation/code
type: Property
domain: ConstraintViolation
the hydra core vocabulary: code
range: string
range: integer

ConstraintViolation/file
type: Property
domain: ConstraintViolation
the hydra core vocabulary: file
range: string

ConstraintViolation/line
type: Property
domain: ConstraintViolation
the hydra core vocabulary: line
range: integer

ConstraintViolation/description
type: Property
domain: ConstraintViolation
the hydra core vocabulary: description
range: string

ConstraintViolation/type
type: Property
domain: ConstraintViolation
the hydra core vocabulary: type
range: string

ConstraintViolation/title
type: Property
domain: ConstraintViolation
the hydra core vocabulary: title
range: string

ConstraintViolation/instance
type: Property
domain: ConstraintViolation
the hydra core vocabulary: instance
range: string

ConstraintViolation/statusCode
type: Property
domain: ConstraintViolation
the hydra core vocabulary: statusCode
range: integer

ConstraintViolation/headers
type: Property
domain: ConstraintViolation
the hydra core vocabulary: headers

ConstraintViolation/trace
type: Property
domain: ConstraintViolation
the hydra core vocabulary: trace

ConstraintViolation/previous
type: Property
domain: ConstraintViolation
the hydra core vocabulary: previous
range: integer

Adder
type: Class
title: Adder
supported property: SupportedProperty
  property: Adder/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Adder/multiplicationFactor
  title: multiplicationFactor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Adder/fixedAmount
  title: fixedAmount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Adder/district
  title: district
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Adder/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Adder/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Adder/contractorCompany
  title: contractorCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Adder/startDate
  title: startDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Adder/endDate
  title: endDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Adder/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Adder/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Adder/multiplier
  title: multiplier
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Adder resource.
  method: GET
  returns: Adder
  title: getAdder

Adder/name
type: Property
domain: Adder
the hydra core vocabulary: name
range: string

Adder/multiplicationFactor
type: Property
domain: Adder
the hydra core vocabulary: multiplicationFactor
range: string

Adder/fixedAmount
type: Property
domain: Adder
the hydra core vocabulary: fixedAmount
range: string

Adder/district
type: Link
domain: Adder
the hydra core vocabulary: district
max cardinality: 1
range: District

Adder/updatedAt
type: Property
domain: Adder
the hydra core vocabulary: updatedAt
range: dateTime

Adder/createdBy
type: Property
domain: Adder
the hydra core vocabulary: createdBy
range: string

Adder/contractorCompany
type: Link
domain: Adder
the hydra core vocabulary: contractorCompany
max cardinality: 1
range: ContractorCompany

Adder/startDate
type: Property
domain: Adder
the hydra core vocabulary: startDate
range: dateTime

Adder/endDate
type: Property
domain: Adder
the hydra core vocabulary: endDate
range: dateTime

Adder/updatedBy
type: Property
domain: Adder
the hydra core vocabulary: updatedBy
range: string

Adder/createdAt
type: Property
domain: Adder
the hydra core vocabulary: createdAt
range: dateTime

Adder/multiplier
type: Property
domain: Adder
the hydra core vocabulary: multiplier
range: decimal

Category
type: Class
title: Category
supported property: SupportedProperty
  property: Category/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/parent
  title: parent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/children
  title: children
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Category/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Category resource.
  method: GET
  returns: owl:Nothing
  title: getCategory

Category/name
type: Property
domain: Category
the hydra core vocabulary: name
range: string

Category/parent
type: Link
domain: Category
the hydra core vocabulary: parent
max cardinality: 1
range: Category

Category/children
type: Link
domain: Category
the hydra core vocabulary: children
range: Category

Category/updatedAt
type: Property
domain: Category
the hydra core vocabulary: updatedAt
range: dateTime

Category/createdBy
type: Property
domain: Category
the hydra core vocabulary: createdBy
range: string

Category/updatedBy
type: Property
domain: Category
the hydra core vocabulary: updatedBy
range: string

Category/createdAt
type: Property
domain: Category
the hydra core vocabulary: createdAt
range: dateTime

ContractorCompany
type: Class
title: ContractorCompany
supported property: SupportedProperty
  property: ContractorCompany/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/address
  title: address
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/city
  title: city
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/zipCode
  title: zipCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/logo
  title: logo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/adders
  title: adders
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/districts
  title: districts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/users
  title: users
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ContractorCompany/deleted
  title: deleted
  required: false
  readable: true
  writeable: false
  description: Check if the entity has been soft deleted.
supported operation: Operation
  type: FindAction
  description: Retrieves a ContractorCompany resource.
  method: GET
  returns: owl:Nothing
  title: getContractorCompany

ContractorCompany/name
type: Property
domain: ContractorCompany
the hydra core vocabulary: name
range: string

ContractorCompany/address
type: Property
domain: ContractorCompany
the hydra core vocabulary: address
range: string

ContractorCompany/city
type: Property
domain: ContractorCompany
the hydra core vocabulary: city
range: string

ContractorCompany/state
type: Property
domain: ContractorCompany
the hydra core vocabulary: state
range: string

ContractorCompany/zipCode
type: Property
domain: ContractorCompany
the hydra core vocabulary: zipCode
range: string

ContractorCompany/logo
type: Property
domain: ContractorCompany
the hydra core vocabulary: logo
range: string

ContractorCompany/adders
type: Link
domain: ContractorCompany
the hydra core vocabulary: adders
range: Adder

ContractorCompany/districts
type: Link
domain: ContractorCompany
the hydra core vocabulary: districts
range: District

ContractorCompany/users
type: Link
domain: ContractorCompany
the hydra core vocabulary: users
range: User

ContractorCompany/updatedAt
type: Property
domain: ContractorCompany
the hydra core vocabulary: updatedAt
range: dateTime

ContractorCompany/createdBy
type: Property
domain: ContractorCompany
the hydra core vocabulary: createdBy
range: string

ContractorCompany/updatedBy
type: Property
domain: ContractorCompany
the hydra core vocabulary: updatedBy
range: string

ContractorCompany/createdAt
type: Property
domain: ContractorCompany
the hydra core vocabulary: createdAt
range: dateTime

ContractorCompany/deletedAt
type: Property
domain: ContractorCompany
the hydra core vocabulary: deletedAt
range: dateTime

ContractorCompany/deleted
type: Property
domain: ContractorCompany
the hydra core vocabulary: deleted
range: boolean

District
type: Class
title: District
supported property: SupportedProperty
  property: District/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: District/taxRate
  title: taxRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: District/materialFactor
  title: materialFactor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: District/adders
  title: adders
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: District/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: District/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: District/users
  title: users
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: District/contractorCompanies
  title: contractorCompanies
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: District/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: District/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: District/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: District/multiplier
  title: multiplier
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a District resource.
  method: GET
  returns: owl:Nothing
  title: getDistrict

District/name
type: Property
domain: District
the hydra core vocabulary: name
range: string

District/taxRate
type: Property
domain: District
the hydra core vocabulary: taxRate
range: string

District/materialFactor
type: Property
domain: District
the hydra core vocabulary: materialFactor
range: string

District/adders
type: Link
domain: District
the hydra core vocabulary: adders
range: Adder

District/updatedAt
type: Property
domain: District
the hydra core vocabulary: updatedAt
range: dateTime

District/createdBy
type: Property
domain: District
the hydra core vocabulary: createdBy
range: string

District/users
type: Link
domain: District
the hydra core vocabulary: users
range: User

District/contractorCompanies
type: Link
domain: District
the hydra core vocabulary: contractorCompanies
range: ContractorCompany

District/code
type: Property
domain: District
the hydra core vocabulary: code
range: string

District/updatedBy
type: Property
domain: District
the hydra core vocabulary: updatedBy
range: string

District/createdAt
type: Property
domain: District
the hydra core vocabulary: createdAt
range: dateTime

District/multiplier
type: Property
domain: District
the hydra core vocabulary: multiplier
range: decimal

Estimate
type: Class
title: Estimate
supported property: SupportedProperty
  property: Estimate/sharedUsers
  title: sharedUsers
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: Estimate/district
  title: district
  required: true
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/contractorCompany
  title: contractorCompany
  required: true
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/owner
  title: owner
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/mca
  title: mca
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Estimate/jobName
  title: jobName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Estimate/laborEstimateAmount
  title: laborEstimateAmount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Estimate/overheadAmount
  title: overheadAmount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Estimate/taxSubtotalAmount
  title: taxSubtotalAmount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Estimate/materialAdjustment
  title: materialAdjustment
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Estimate/trafficControl
  title: trafficControl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Estimate/workOrderNumber
  title: workOrderNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Estimate/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/mcaStartDate
  title: mcaStartDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/documentAdjustment
  title: documentAdjustment
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/documentNote
  title: documentNote
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Estimate/permitCost
  title: permitCost
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Estimate/laborMains
  title: laborMains
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/laborServices
  title: laborServices
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/laborHydrants
  title: laborHydrants
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/paving
  title: paving
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/masterContractorPrice
  title: masterContractorPrice
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/estimatedMaterialPrice
  title: estimatedMaterialPrice
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/grandTotal
  title: grandTotal
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/shared
  title: shared
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/preparedBy
  title: preparedBy
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Estimate/ownerIsContractor
  title: ownerIsContractor
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Estimate resource.
  method: GET
  returns: Estimate
  title: getEstimate
supported operation: Operation
  description: Updates the Estimate resource.
  expects: Estimate
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Estimate
  title: patchEstimate
supported operation: Operation
  type: FindAction
  description: Retrieves a Estimate resource.
  method: GET
  returns: Estimate
  title: getEstimate
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Estimate resource.
  expects: Estimate
  method: PUT
  returns: Estimate
  title: putEstimate
supported operation: Operation
  type: DeleteAction
  description: Deletes the Estimate resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteEstimate

Estimate/sharedUsers
type: Property
domain: Estimate
the hydra core vocabulary: sharedUsers
range: User

Estimate/district
type: Property
domain: Estimate
the hydra core vocabulary: district
max cardinality: 1
range: District

Estimate/contractorCompany
type: Property
domain: Estimate
the hydra core vocabulary: contractorCompany
max cardinality: 1
range: ContractorCompany

Estimate/owner
type: Property
domain: Estimate
the hydra core vocabulary: owner
max cardinality: 1
range: User

Estimate/mca
type: Property
domain: Estimate
the hydra core vocabulary: mca
range: string

Estimate/jobName
type: Property
domain: Estimate
the hydra core vocabulary: jobName
range: string

Estimate/laborEstimateAmount
type: Property
domain: Estimate
the hydra core vocabulary: laborEstimateAmount
range: string

Estimate/overheadAmount
type: Property
domain: Estimate
the hydra core vocabulary: overheadAmount
range: string

Estimate/taxSubtotalAmount
type: Property
domain: Estimate
the hydra core vocabulary: taxSubtotalAmount
range: string

Estimate/materialAdjustment
type: Property
domain: Estimate
the hydra core vocabulary: materialAdjustment
range: string

Estimate/trafficControl
type: Property
domain: Estimate
the hydra core vocabulary: trafficControl
range: string

Estimate/workOrderNumber
type: Property
domain: Estimate
the hydra core vocabulary: workOrderNumber
range: string

Estimate/updatedAt
type: Property
domain: Estimate
the hydra core vocabulary: updatedAt
range: dateTime

Estimate/createdBy
type: Property
domain: Estimate
the hydra core vocabulary: createdBy
range: string

Estimate/mcaStartDate
type: Property
domain: Estimate
the hydra core vocabulary: mcaStartDate
range: dateTime

Estimate/documentAdjustment
type: Property
domain: Estimate
the hydra core vocabulary: documentAdjustment
range: string

Estimate/documentNote
type: Property
domain: Estimate
the hydra core vocabulary: documentNote
range: string

Estimate/permitCost
type: Property
domain: Estimate
the hydra core vocabulary: permitCost
range: string

Estimate/laborMains
type: Property
domain: Estimate
the hydra core vocabulary: laborMains
range: decimal

Estimate/laborServices
type: Property
domain: Estimate
the hydra core vocabulary: laborServices
range: decimal

Estimate/laborHydrants
type: Property
domain: Estimate
the hydra core vocabulary: laborHydrants
range: decimal

Estimate/paving
type: Property
domain: Estimate
the hydra core vocabulary: paving
range: decimal

Estimate/masterContractorPrice
type: Property
domain: Estimate
the hydra core vocabulary: masterContractorPrice
range: decimal

Estimate/estimatedMaterialPrice
type: Property
domain: Estimate
the hydra core vocabulary: estimatedMaterialPrice
range: decimal

Estimate/grandTotal
type: Property
domain: Estimate
the hydra core vocabulary: grandTotal
range: decimal

Estimate/shared
type: Property
domain: Estimate
the hydra core vocabulary: shared
range: boolean

Estimate/preparedBy
type: Property
domain: Estimate
the hydra core vocabulary: preparedBy
range: string

Estimate/ownerIsContractor
type: Property
domain: Estimate
the hydra core vocabulary: ownerIsContractor
range: boolean

EstimateLine
type: Class
title: EstimateLine
supported property: SupportedProperty
  property: EstimateLine/estimate
  title: estimate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EstimateLine/linePrice
  title: linePrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EstimateLine/adder
  title: adder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EstimateLine/quantity
  title: quantity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EstimateLine/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EstimateLine/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EstimateLine/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EstimateLine/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EstimateLine/extendedPrice
  title: extendedPrice
  required: false
  readable: true
  writeable: false
  description: fancy name for get line total multiplier = 1 + multiplication_factor extended_price = ((amount + fixed_amount) * quantity) * multiplier
supported property: SupportedProperty
  property: EstimateLine/lineCategoryNames
  title: lineCategoryNames
  required: false
  readable: true
  writeable: false
supported operation: Operation
  description: Updates the EstimateLine resource.
  expects: EstimateLine
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: EstimateLine
  title: patchEstimateLine
supported operation: Operation
  type: ReplaceAction
  description: Replaces the EstimateLine resource.
  expects: EstimateLine
  method: PUT
  returns: EstimateLine
  title: putEstimateLine
supported operation: Operation
  type: DeleteAction
  description: Deletes the EstimateLine resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteEstimateLine
supported property: SupportedProperty
  property: EstimateLine/linePrice
  title: linePrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EstimateLine/adder
  title: adder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EstimateLine/quantity
  title: quantity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EstimateLine/extendedPrice
  title: extendedPrice
  required: false
  readable: true
  writeable: false
  description: fancy name for get line total multiplier = 1 + multiplication_factor extended_price = ((amount + fixed_amount) * quantity) * multiplier
supported property: SupportedProperty
  property: EstimateLine/lineCategoryNames
  title: lineCategoryNames
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a EstimateLine resource.
  method: GET
  returns: owl:Nothing
  title: getEstimateLine

EstimateLine/estimate
type: Link
domain: EstimateLine
the hydra core vocabulary: estimate
max cardinality: 1
range: Estimate

EstimateLine/linePrice
type: Link
domain: EstimateLine
the hydra core vocabulary: linePrice
max cardinality: 1
range: LinePrice
type: Property

EstimateLine/adder
type: Link
domain: EstimateLine
the hydra core vocabulary: adder
max cardinality: 1
range: Adder
type: Property

EstimateLine/quantity
type: Property
domain: EstimateLine
the hydra core vocabulary: quantity
range: string

EstimateLine/updatedAt
type: Property
domain: EstimateLine
the hydra core vocabulary: updatedAt
range: dateTime

EstimateLine/createdBy
type: Property
domain: EstimateLine
the hydra core vocabulary: createdBy
range: string

EstimateLine/updatedBy
type: Property
domain: EstimateLine
the hydra core vocabulary: updatedBy
range: string

EstimateLine/createdAt
type: Property
domain: EstimateLine
the hydra core vocabulary: createdAt
range: dateTime

EstimateLine/extendedPrice
type: Property
domain: EstimateLine
the hydra core vocabulary: extendedPrice
range: decimal

EstimateLine/lineCategoryNames
type: Property
domain: EstimateLine
the hydra core vocabulary: lineCategoryNames

LinePrice
type: Class
title: LinePrice
supported property: SupportedProperty
  property: LinePrice/number
  title: number
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/typeOfCharge
  title: typeOfCharge
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/unitOfMeasure
  title: unitOfMeasure
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/size
  title: size
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/material
  title: material
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/categories
  title: categories
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/amount
  title: amount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/salesTaxAmount
  title: salesTaxAmount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/startDate
  title: startDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/endDate
  title: endDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/district
  title: district
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/contractorCompany
  title: contractorCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: LinePrice/shortSummaryInformation
  title: shortSummaryInformation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LinePrice/categoryNames
  title: categoryNames
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: LinePrice/salesTax
  title: salesTax
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a LinePrice resource.
  method: GET
  returns: LinePrice
  title: getLinePrice

LinePrice/number
type: Property
domain: LinePrice
the hydra core vocabulary: number
range: integer

LinePrice/description
type: Property
domain: LinePrice
the hydra core vocabulary: description
range: string

LinePrice/typeOfCharge
type: Property
domain: LinePrice
the hydra core vocabulary: typeOfCharge
range: string

LinePrice/unitOfMeasure
type: Property
domain: LinePrice
the hydra core vocabulary: unitOfMeasure
range: string

LinePrice/size
type: Property
domain: LinePrice
the hydra core vocabulary: size
range: string

LinePrice/material
type: Property
domain: LinePrice
the hydra core vocabulary: material
range: string

LinePrice/categories
type: Link
domain: LinePrice
the hydra core vocabulary: categories
range: Category

LinePrice/amount
type: Property
domain: LinePrice
the hydra core vocabulary: amount
range: string

LinePrice/salesTaxAmount
type: Property
domain: LinePrice
the hydra core vocabulary: salesTaxAmount
range: string

LinePrice/startDate
type: Property
domain: LinePrice
the hydra core vocabulary: startDate
range: dateTime

LinePrice/endDate
type: Property
domain: LinePrice
the hydra core vocabulary: endDate
range: dateTime

LinePrice/updatedAt
type: Property
domain: LinePrice
the hydra core vocabulary: updatedAt
range: dateTime

LinePrice/createdBy
type: Property
domain: LinePrice
the hydra core vocabulary: createdBy
range: string

LinePrice/district
type: Link
domain: LinePrice
the hydra core vocabulary: district
max cardinality: 1
range: District

LinePrice/contractorCompany
type: Link
domain: LinePrice
the hydra core vocabulary: contractorCompany
max cardinality: 1
range: ContractorCompany

LinePrice/updatedBy
type: Property
domain: LinePrice
the hydra core vocabulary: updatedBy
range: string

LinePrice/createdAt
type: Property
domain: LinePrice
the hydra core vocabulary: createdAt
range: dateTime

LinePrice/shortSummaryInformation
type: Property
domain: LinePrice
the hydra core vocabulary: shortSummaryInformation
range: string

LinePrice/categoryNames
type: Property
domain: LinePrice
the hydra core vocabulary: categoryNames
range: string

LinePrice/salesTax
type: Property
domain: LinePrice
the hydra core vocabulary: salesTax
range: boolean

User
type: Class
title: User
supported property: SupportedProperty
  property: User/firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/username
  title: username
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/fullName
  title: fullName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/username
  title: username
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/fullName
  title: fullName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/username
  title: username
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/password
  title: password
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/lastLogin
  title: lastLogin
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/estimates
  title: estimates
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/districts
  title: districts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/contractorCompanies
  title: contractorCompanies
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/forcePasswordChange
  title: forcePasswordChange
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/passwordResetToken
  title: passwordResetToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/salt
  title: salt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/userIdentifier
  title: userIdentifier
  required: false
  readable: true
  writeable: false
  description: A visual identifier that represents this user.
supported property: SupportedProperty
  property: User/fullName
  title: fullName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/email
  title: email
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/contractor
  title: contractor
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/deleted
  title: deleted
  required: false
  readable: true
  writeable: false
  description: Check if the entity has been soft deleted.
supported operation: Operation

User/firstName
type: Property
domain: User
the hydra core vocabulary: firstName
range: string

User/lastName
type: Property
domain: User
the hydra core vocabulary: lastName
range: string

User/username
type: Property
domain: User
the hydra core vocabulary: username
range: string

User/phoneNumber
type: Property
domain: User
the hydra core vocabulary: phoneNumber
range: string

User/fullName
type: Property
domain: User
the hydra core vocabulary: fullName
range: string

User/password
type: Property
domain: User
the hydra core vocabulary: password
range: string

User/lastLogin
type: Property
domain: User
the hydra core vocabulary: lastLogin
range: dateTime

User/roles
type: Property
domain: User
the hydra core vocabulary: roles

User/updatedAt
type: Property
domain: User
the hydra core vocabulary: updatedAt
range: dateTime

User/createdBy
type: Property
domain: User
the hydra core vocabulary: createdBy
range: string

User/estimates
type: Link
domain: User
the hydra core vocabulary: estimates
range: Estimate

User/districts
type: Link
domain: User
the hydra core vocabulary: districts
range: District

User/contractorCompanies
type: Link
domain: User
the hydra core vocabulary: contractorCompanies
range: ContractorCompany

User/forcePasswordChange
type: Property
domain: User
the hydra core vocabulary: forcePasswordChange
range: boolean

User/passwordResetToken
type: Property
domain: User
the hydra core vocabulary: passwordResetToken
range: string

User/salt
type: Property
domain: User
the hydra core vocabulary: salt
range: string

User/updatedBy
type: Property
domain: User
the hydra core vocabulary: updatedBy
range: string

User/createdAt
type: Property
domain: User
the hydra core vocabulary: createdAt
range: dateTime

User/deletedAt
type: Property
domain: User
the hydra core vocabulary: deletedAt
range: dateTime

User/userIdentifier
type: Property
domain: User
the hydra core vocabulary: userIdentifier
range: string

User/email
type: Property
domain: User
the hydra core vocabulary: email
range: string

User/contractor
type: Property
domain: User
the hydra core vocabulary: contractor

User/deleted
type: Property
domain: User
the hydra core vocabulary: deleted
range: boolean

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/adder
  title: getAdderCollection
  description: The collection of Adder resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/category
  title: getCategoryCollection
  description: The collection of Category resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/contractorCompany
  title: getContractorCompanyCollection
  description: The collection of ContractorCompany resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/district
  title: getDistrictCollection
  description: The collection of District resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/estimate
  title: getEstimateCollection
  description: The collection of Estimate resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/estimateLine
  title: getEstimateLineCollection
  description: The collection of EstimateLine resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/estimateLine
  title: getEstimateLineCollection
  description: The collection of EstimateLine resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/linePrice
  title: getLinePriceCollection
  description: The collection of LinePrice resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/user
  title: getUserCollection
  description: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/user
  title: getUserCollection
  description: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/user
  title: getUserCollection
  description: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/user
  title: getUserCollection
  description: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/user
  title: getUserCollection
  description: The collection of User resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

Entrypoint/adder
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Adder
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Adder resources.
  method: GET
  returns: Collection
  title: getAdderCollection

Entrypoint/category
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Category
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Category resources.
  method: GET
  returns: Collection
  title: getCategoryCollection

Entrypoint/contractorCompany
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ContractorCompany
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ContractorCompany resources.
  method: GET
  returns: Collection
  title: getContractorCompanyCollection

Entrypoint/district
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: District
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of District resources.
  method: GET
  returns: Collection
  title: getDistrictCollection

Entrypoint/estimate
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Estimate
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Estimate resources.
  method: GET
  returns: Collection
  title: getEstimateCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Estimate resource.
  expects: Estimate
  method: POST
  returns: Estimate
  title: postEstimate
supported operation: Operation
  type: CreateAction
  description: Creates a Estimate resource.
  expects: Estimate
  method: POST
  returns: Estimate
  title: postEstimate
supported operation: Operation
  type: CreateAction
  description: Creates a Estimate resource.
  expects: Estimate
  method: POST
  returns: Estimate
  title: postEstimate

Entrypoint/estimateLine
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: EstimateLine
supported operation: Operation
  type: CreateAction
  description: Creates a EstimateLine resource.
  expects: EstimateLine
  method: POST
  returns: EstimateLine
  title: postEstimateLine
range:
  equivalent class:
    on property: member
    all values from: EstimateLine
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of EstimateLine resources.
  method: GET
  returns: Collection
  title: getEstimateLineCollection

Entrypoint/linePrice
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: LinePrice
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of LinePrice resources.
  method: GET
  returns: Collection
  title: getLinePriceCollection
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of LinePrice resources.
  method: GET
  returns: Collection
  title: getLinePriceCollection

Entrypoint/user
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of User resources.
  method: GET
  returns: Collection
  title: getUserCollection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of User resources.
  method: GET
  returns: Collection
  title: getUserCollection
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of User resources.
  method: GET
  returns: Collection
  title: getUserCollection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: owl:Nothing
  title: postUser
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: owl:Nothing
  title: postUser
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: owl:Nothing
  title: postUser

ConstraintViolationList
type: Class
title: ConstraintViolationList
description: A constraint violation List.
supported property: SupportedProperty
  property: ConstraintViolationList/propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolationList/message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

ConstraintViolationList/propertyPath
type: Property
label: propertyPath
domain: ConstraintViolationList
range: string

ConstraintViolationList/message
type: Property
label: message
domain: ConstraintViolationList
range: string

SupportedProperty
property: User/firstName
title: firstName
required: false
readable: true
writeable: true

SupportedProperty
property: User/lastName
title: lastName
required: false
readable: true
writeable: true

SupportedProperty
property: User/username
title: username
required: false
readable: true
writeable: true

SupportedProperty
property: User/password
title: password
required: false
readable: true
writeable: true

SupportedProperty
property: User/lastLogin
title: lastLogin
required: false
readable: true
writeable: true

SupportedProperty
property: User/roles
title: roles
required: false
readable: true
writeable: true

SupportedProperty
property: User/updatedAt
title: updatedAt
required: false
readable: true
writeable: true

SupportedProperty
property: User/createdBy
title: createdBy
required: false
readable: true
writeable: true

SupportedProperty
property: User/estimates
title: estimates
required: false
readable: true
writeable: false

SupportedProperty
property: User/districts
title: districts
required: false
readable: true
writeable: true

SupportedProperty
property: User/contractorCompanies
title: contractorCompanies
required: false
readable: true
writeable: true

SupportedProperty
property: User/forcePasswordChange
title: forcePasswordChange
required: false
readable: true
writeable: true

SupportedProperty
property: User/passwordResetToken
title: passwordResetToken
required: false
readable: true
writeable: true

SupportedProperty
property: User/phoneNumber
title: phoneNumber
required: false
readable: true
writeable: true

SupportedProperty
property: User/salt
title: salt
required: false
readable: true
writeable: true

SupportedProperty
property: User/updatedBy
title: updatedBy
required: false
readable: true
writeable: true

SupportedProperty
property: User/createdAt
title: createdAt
required: false
readable: true
writeable: true

SupportedProperty
property: User/deletedAt
title: deletedAt
required: false
readable: true
writeable: true

SupportedProperty
property: User/userIdentifier
title: userIdentifier
required: false
readable: true
writeable: false
description: A visual identifier that represents this user.

SupportedProperty
property: User/fullName
title: fullName
required: false
readable: true
writeable: false

SupportedProperty
property: User/email
title: email
required: false
readable: true
writeable: false

SupportedProperty
property: User/contractor
title: contractor
required: false
readable: true
writeable: false

SupportedProperty
property: User/deleted
title: deleted
required: false
readable: true
writeable: false
description: Check if the entity has been soft deleted.

SupportedProperty
property: User/firstName
title: firstName
required: false
readable: true
writeable: true

SupportedProperty
property: User/lastName
title: lastName
required: false
readable: true
writeable: true

SupportedProperty
property: User/username
title: username
required: false
readable: true
writeable: true

SupportedProperty
property: User/password
title: password
required: false
readable: true
writeable: true

SupportedProperty
property: User/lastLogin
title: lastLogin
required: false
readable: true
writeable: true

SupportedProperty
property: User/roles
title: roles
required: false
readable: true
writeable: true

SupportedProperty
property: User/updatedAt
title: updatedAt
required: false
readable: true
writeable: true

SupportedProperty
property: User/createdBy
title: createdBy
required: false
readable: true
writeable: true

SupportedProperty
property: User/estimates
title: estimates
required: false
readable: true
writeable: false

SupportedProperty
property: User/districts
title: districts
required: false
readable: true
writeable: true

SupportedProperty
property: User/contractorCompanies
title: contractorCompanies
required: false
readable: true
writeable: true

SupportedProperty
property: User/forcePasswordChange
title: forcePasswordChange
required: false
readable: true
writeable: true

SupportedProperty
property: User/passwordResetToken
title: passwordResetToken
required: false
readable: true
writeable: true

SupportedProperty
property: User/phoneNumber
title: phoneNumber
required: false
readable: true
writeable: true

SupportedProperty
property: User/salt
title: salt
required: false
readable: true
writeable: true

SupportedProperty
property: User/updatedBy
title: updatedBy
required: false
readable: true
writeable: true

SupportedProperty
property: User/createdAt
title: createdAt
required: false
readable: true
writeable: true

SupportedProperty
property: User/deletedAt
title: deletedAt
required: false
readable: true
writeable: true

SupportedProperty
property: User/userIdentifier
title: userIdentifier
required: false
readable: true
writeable: false
description: A visual identifier that represents this user.

SupportedProperty
property: User/fullName
title: fullName
required: false
readable: true
writeable: false

SupportedProperty
property: User/email
title: email
required: false
readable: true
writeable: false

SupportedProperty
property: User/contractor
title: contractor
required: false
readable: true
writeable: false

SupportedProperty
property: User/deleted
title: deleted
required: false
readable: true
writeable: false
description: Check if the entity has been soft deleted.

Operation
type: FindAction
description: Retrieves a User resource.
method: GET
returns: owl:Nothing
title: getUser

Operation
description: Updates the User resource.
expects: User
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: owl:Nothing
title: patchUser