Skip to content

Errands (2.0.0)

The 'Errands' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Generalerrandaction

Operations

Generalerranddefaultdescription

Operations

Generalerrandsubtype

Operations

Generalerrandgroup

Operations

Generalerrandtype

Operations

Generalerrandactionfile

Operations

Generalerrandfile

Operations

Componentconditionvalue

Operations

Componentconditionnotation

Operations

Errandactiondefault

Operations

Inspectionerrandfault

Operations

Inspectionerrandsetting

Operations

Inspectionerrand

Operations

Inspectionerrandchecklist

Operations

Inspectionerrandfile

Operations

Inspectionerrandprotocolsetting

Operations

Inspectionerrandnote

Operations

Tenantinspectionassociation

Operations

Get 'Tenantinspectionassociation'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X GET \
  'https://dev.api.pigello.io/errands/inspections/reporting/tenantinspectionassociation/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful selection

Bodyapplication/json
inspection_errandobject(Inspectionerrand)required
inspection_errand.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

categoryinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
tenantobject(Tenant)required
tenant.​idstring(uuid)
delegate_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
delegate_ssnstring or null(luhn)[ 12 .. 13 ] characters
delegate_first_namestring or null<= 255 characters
delegate_titlestring or null<= 255 characters
delegate_last_namestring or null<= 255 characters
was_not_presentboolean
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
delegate_emailstring or null(email)<= 254 characters
Response
application/json
{
  "delegate_phone_number": "string",
  "delegate_ssn": "stringstring",
  "delegate_first_name": "string",
  "inspection_errand": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "delegate_title": "string",
  "delegate_last_name": "string",
  "was_not_present": true,
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "category": 0,
  "delegate_email": "user@example.com",
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Update 'Tenantinspectionassociation'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
Bodyapplication/json
inspection_errandobject(Inspectionerrand)required
inspection_errand.​idstring(uuid)
categoryinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
tenantobject(Tenant)required
tenant.​idstring(uuid)
delegate_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
delegate_ssnstring or null(luhn)[ 12 .. 13 ] characters
delegate_first_namestring or null<= 255 characters
delegate_titlestring or null<= 255 characters
delegate_last_namestring or null<= 255 characters
was_not_presentboolean
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
delegate_emailstring or null(email)<= 254 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/errands/inspections/reporting/tenantinspectionassociation/{pk}/' \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "delegate_phone_number": "string",
    "delegate_ssn": "stringstring",
    "delegate_first_name": "string",
    "inspection_errand": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "delegate_title": "string",
    "delegate_last_name": "string",
    "was_not_present": true,
    "custom_id": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "category": 0,
    "delegate_email": "user@example.com",
    "tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
inspection_errandobject(Inspectionerrand)required
inspection_errand.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

categoryinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
tenantobject(Tenant)required
tenant.​idstring(uuid)
delegate_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
delegate_ssnstring or null(luhn)[ 12 .. 13 ] characters
delegate_first_namestring or null<= 255 characters
delegate_titlestring or null<= 255 characters
delegate_last_namestring or null<= 255 characters
was_not_presentboolean
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
delegate_emailstring or null(email)<= 254 characters
Response
application/json
{
  "delegate_phone_number": "string",
  "delegate_ssn": "stringstring",
  "delegate_first_name": "string",
  "inspection_errand": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "delegate_title": "string",
  "delegate_last_name": "string",
  "was_not_present": true,
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "category": 0,
  "delegate_email": "user@example.com",
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Delete 'Tenantinspectionassociation'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X DELETE \
  'https://dev.api.pigello.io/errands/inspections/reporting/tenantinspectionassociation/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful deletion

Response
No content

Customerrandfieldvalue

Operations

Customerrandfieldinclusion

Operations

Customerrandfieldtype

Operations

Externalsupplier

Operations

Erranddelegationoffer

Operations

Erranddelegationinstruction

Operations

Errandcost

Operations
© Pigello. All rights reserved.