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

Customerrandfieldvalue

Operations

Customerrandfieldinclusion

Operations

Customerrandfieldtype

Operations

Externalsupplier

Operations

Update 'Externalsupplier'

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
namestring<= 255 charactersrequired
errands_emailstring(email)<= 254 charactersrequired
invoice_addressobject or null(Address)
org_nostring or null(luhn)[ 10 .. 11 ] characters
contact_last_namestring or null<= 255 characters
receive_sms_notificationsboolean
organizationobject or null(Organization)
errands_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
contact_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
contact_emailstring or null(email)<= 254 characters
contact_first_namestring or null<= 255 characters
receive_email_notificationsboolean
custom_idstring or null<= 128 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/errands/suppliers/externalsupplier/{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 '{
    "name": "string",
    "invoice_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "org_no": "stringstri",
    "contact_last_name": "string",
    "receive_sms_notifications": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "errands_phone_number": "string",
    "contact_phone_number": "string",
    "contact_email": "user@example.com",
    "errands_email": "user@example.com",
    "contact_first_name": "string",
    "receive_email_notifications": true,
    "custom_id": "string"
  }'

Responses

Successful update

Bodyapplication/json
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

errands_emailstring(email)<= 254 charactersrequired
invoice_addressobject or null(Address)
created_atstring(date-time)read-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
contact_last_namestring or null<= 255 characters
receive_sms_notificationsboolean
organizationobject or null(Organization)
errands_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
contact_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
pending_monitor_approval_amountanyread-only
contact_emailstring or null(email)<= 254 characters
contact_first_namestring or null<= 255 characters
receive_email_notificationsboolean
custom_idstring or null<= 128 characters
Response
application/json
{
  "name": "string",
  "invoice_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "org_no": "stringstri",
  "contact_last_name": "string",
  "receive_sms_notifications": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "errands_phone_number": "string",
  "contact_phone_number": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pending_monitor_approval_amount": null,
  "contact_email": "user@example.com",
  "errands_email": "user@example.com",
  "contact_first_name": "string",
  "receive_email_notifications": true,
  "custom_id": "string"
}

Delete 'Externalsupplier'

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/suppliers/externalsupplier/{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

Get 'Externalsupplier'

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/suppliers/externalsupplier/{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
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

errands_emailstring(email)<= 254 charactersrequired
invoice_addressobject or null(Address)
created_atstring(date-time)read-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
contact_last_namestring or null<= 255 characters
receive_sms_notificationsboolean
organizationobject or null(Organization)
errands_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
contact_phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
pending_monitor_approval_amountanyread-only
contact_emailstring or null(email)<= 254 characters
contact_first_namestring or null<= 255 characters
receive_email_notificationsboolean
custom_idstring or null<= 128 characters
Response
application/json
{
  "name": "string",
  "invoice_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "org_no": "stringstri",
  "contact_last_name": "string",
  "receive_sms_notifications": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "errands_phone_number": "string",
  "contact_phone_number": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pending_monitor_approval_amount": null,
  "contact_email": "user@example.com",
  "errands_email": "user@example.com",
  "contact_first_name": "string",
  "receive_email_notifications": true,
  "custom_id": "string"
}

Erranddelegationoffer

Operations

Erranddelegationinstruction

Operations

Errandcost

Operations
© Pigello. All rights reserved.