Skip to content

Create 'Roundingoccurrence'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/json
scheduled_forstring, (date)required
settingobjectrequired
titlestring, <= 255 charactersrequired
statusinteger, (int32), [ -2147483648 .. 2147483647 ]required

Additional Validation Information:

Enum Descriptions:

  • 0 - Created

  • 1 - Accepted

  • 2 - Started

  • 3 - Paused

  • 4 - Completed

Enum:01234
custom_idstring or null, <= 128 characters
annulledboolean
disable_auto_delegationboolean
organizationobject or null(Organization)
planned_done_timestring or null, (date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: planned_start_time

invoicing_statusinteger or null, (int32), [ -2147483648 .. 2147483647 ]

Additional Validation Information:

Enum Descriptions:

  • 0 - Missing Costs

  • 1 - Pending Errand Cost Data

  • 2 - Pending Invoice Creation

  • 3 - Pending Invoice Attest

  • 4 - Pending Partly Invoice Attest

  • 5 - All Invoices Attested

Enum:012345
planned_start_timestring or null, (date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: planned_done_time

spent_minutesinteger or null, (int32), [ 1 .. 2147483647 ]
protocol_fileobject or null
id_numberstring or null
actual_done_timestring or null, (date-time)
POST
/errands/inspectionrounds/rounds/reporting/roundingoccurrence/
import requests

environment = "dev.api"
url = "https://" + environment + ".pigello.io/errands/inspectionrounds/rounds/reporting/roundingoccurrence/"

payload = {
  "custom_id": "string",
  "scheduled_for": "2019-08-24",
  "setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "annulled": True,
  "title": "string",
  "disable_auto_delegation": True,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "planned_done_time": "2019-08-24T14:15:22Z",
  "invoicing_status": 0,
  "planned_start_time": "2019-08-24T14:15:22Z",
  "spent_minutes": 1,
  "protocol_file": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": {
      "url": "string",
      "fields": {}
    }
  },
  "id_number": "string",
  "status": 0,
  "actual_done_time": "2019-08-24T14:15:22Z"
}

headers = {
  "Content-Type": "application/json",
  "X-PIGELLO-CUSTOMER-ID": "YOUR_API_KEY_HERE",
  "X-PIGELLO-APPLICATION-ID": "YOUR_API_KEY_HERE",
  "X-PIGELLO-SERVICE-ID": "YOUR_API_KEY_HERE",
  "X-PIGELLO-SERVICE-VERSION-ID": "YOUR_API_KEY_HERE",
  "X-PIGELLO-CLIENT-CT": "YOUR_API_KEY_HERE",
  "X-PIGELLO-CLIENT-ENTITY": "YOUR_API_KEY_HERE",
  "X-PIGELLO-CLIENT-SECRET": "YOUR_API_KEY_HERE"
}

response = requests.post(url, json=payload, headers=headers)

data = response.json()
print(data)

Responses

Successful creation

Bodyapplication/json
scheduled_forstring, (date)required
settingobjectrequired
idstring, (uuid)read-onlyrequired

Additional Validation Information:

Must be unique

titlestring, <= 255 charactersrequired
validity_statusinteger, (int32), [ -2147483648 .. 2147483647 ]read-onlyrequired

Additional Validation Information:

Enum Descriptions:

  • 0 - Valid

  • 1 - Invalid

Enum:01
statusinteger, (int32), [ -2147483648 .. 2147483647 ]required

Additional Validation Information:

Enum Descriptions:

  • 0 - Created

  • 1 - Accepted

  • 2 - Started

  • 3 - Paused

  • 4 - Completed

Enum:01234
custom_idstring or null, <= 128 characters
annulledboolean
disable_auto_delegationboolean
organizationobject or null(Organization)
customer_columnsanyread-only
created_atstring, (date-time)read-only
planned_done_timestring or null, (date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: planned_start_time

created_byobject or null(Organizationuser)read-only
tagsanyread-only
invoicing_statusinteger or null, (int32), [ -2147483648 .. 2147483647 ]

Additional Validation Information:

Enum Descriptions:

  • 0 - Missing Costs

  • 1 - Pending Errand Cost Data

  • 2 - Pending Invoice Creation

  • 3 - Pending Invoice Attest

  • 4 - Pending Partly Invoice Attest

  • 5 - All Invoices Attested

Enum:012345
id_number_orderinteger or null, (int32), [ -2147483648 .. 2147483647 ]read-only
planned_start_timestring or null, (date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: planned_done_time

spent_minutesinteger or null, (int32), [ 1 .. 2147483647 ]
protocol_fileobject or null
id_numberstring or null
actual_done_timestring or null, (date-time)
Response
{
  "custom_id": "string",
  "scheduled_for": "2019-08-24",
  "setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "annulled": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "title": "string",
  "disable_auto_delegation": true,
  "validity_status": 0,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "created_at": "2019-08-24T14:15:22Z",
  "planned_done_time": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tags": null,
  "invoicing_status": 0,
  "id_number_order": -2147483648,
  "planned_start_time": "2019-08-24T14:15:22Z",
  "spent_minutes": 1,
  "protocol_file": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "id_number": "string",
  "status": 0,
  "actual_done_time": "2019-08-24T14:15:22Z"
}
© Pigello. All rights reserved.