Configurazione

Risorse per la configurazione dei template e placeholders

Create a new template.

Create a new template for sending messages to the govio services.

POSThttp://localhost:10001/templates

Body

application/json

name*string

Example: "Spedizione Messaggio CIE"

Pattern: .*

descriptionstring

Example: "Segnala la scadenza della proprià C.I.E."

Pattern: [\s\S]*

subject*string

Example: "Scadenza CIE n. ${cie.uppercase}"

Pattern: .+

message_body*string

Example: "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}."

Pattern: [\s\S]+

has_payment*boolean

has_due_date*boolean

Response

201400401403429503default

Successful operation.

Body

application/hal+json

name*string

Example: "Spedizione Messaggio CIE"

Pattern: .*

descriptionstring

Example: "Segnala la scadenza della proprià C.I.E."

Pattern: [\s\S]*

subject*string

Example: "Scadenza CIE n. ${cie.uppercase}"

Pattern: .+

message_body*string

Example: "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}."

Pattern: [\s\S]+

has_payment*boolean

has_due_date*boolean

idGovioTemplateId (integer (int64))

GovIO Template Id.

Example: 1

_linksobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/templates', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Spedizione Messaggio CIE",
      "subject": "Scadenza CIE n. ${cie.uppercase}",
      "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
      "has_payment": false,
      "has_due_date": false
    }),
});
const data = await response.json();

Response

201400401403429503default

{
  "name": "Spedizione Messaggio CIE",
  "description": "Segnala la scadenza della proprià C.I.E.",
  "subject": "Scadenza CIE n. ${cie.uppercase}",
  "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
  "has_payment": false,
  "has_due_date": false,
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/templates/1"
    },
    "placeholders": {
      "href": "https://govhub.it/govio/templates/1/placeholders"
    }
  }
}

List the templates.

List the templates used for sending messages to the govio services,sorted by name.

GEThttp://localhost:10001/templates

Query parameters

Response

200400401403429503default

Successful operation.

Body

application/hal+json

page*PageInfo (object)

items*array of GovioTemplate (all of)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/templates?sort_direction=asc', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403429503default

{
  "page": {
    "offset": 20,
    "limit": 25,
    "total": 32
  },
  "items": [
    {
      "name": "Spedizione Messaggio CIE",
      "description": "Segnala la scadenza della proprià C.I.E.",
      "subject": "Scadenza CIE n. ${cie.uppercase}",
      "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
      "has_payment": false,
      "has_due_date": false,
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/templates/1"
        },
        "placeholders": {
          "href": "https://govhub.it/govio/templates/1/placeholders"
        }
      }
    }
  ]
}

Reads a service template.

Reads a service template.

GEThttp://localhost:10001/templates/{id}

Response

200400401403404429503default

Successful operation.

Body

application/hal+json

name*string

Example: "Spedizione Messaggio CIE"

Pattern: .*

descriptionstring

Example: "Segnala la scadenza della proprià C.I.E."

Pattern: [\s\S]*

subject*string

Example: "Scadenza CIE n. ${cie.uppercase}"

Pattern: .+

message_body*string

Example: "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}."

Pattern: [\s\S]+

has_payment*boolean

has_due_date*boolean

idGovioTemplateId (integer (int64))

GovIO Template Id.

Example: 1

_linksobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/templates/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404429503default

{
  "name": "Spedizione Messaggio CIE",
  "description": "Segnala la scadenza della proprià C.I.E.",
  "subject": "Scadenza CIE n. ${cie.uppercase}",
  "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
  "has_payment": false,
  "has_due_date": false,
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/templates/1"
    },
    "placeholders": {
      "href": "https://govhub.it/govio/templates/1/placeholders"
    }
  }
}

Update template data.

Update template data.

PATCHhttp://localhost:10001/templates/{id}

Path parameters

id*GovioTemplateId (integer (int64))

GovIO Template Id.

Example: 1

Body

application/json-patch+json

op*enum

Specified operation.

Example: "add"

addremovereplace

path*string

jsonPath of the mutating object.

Example: "/organizations"

Pattern: ^.*$

valueobject

updating value.

Response

200400401403404429503default

Succsessful operation.

Body

application/hal+json

name*string

Example: "Spedizione Messaggio CIE"

Pattern: .*

descriptionstring

Example: "Segnala la scadenza della proprià C.I.E."

Pattern: [\s\S]*

subject*string

Example: "Scadenza CIE n. ${cie.uppercase}"

Pattern: .+

message_body*string

Example: "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}."

Pattern: [\s\S]+

has_payment*boolean

has_due_date*boolean

idGovioTemplateId (integer (int64))

GovIO Template Id.

Example: 1

_linksobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/templates/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify([
      {
        "op": "add",
        "path": "/name",
        "value": "Comune1"
      }
    ]),
});
const data = await response.json();

Response

200400401403404429503default

{
  "name": "Spedizione Messaggio CIE",
  "description": "Segnala la scadenza della proprià C.I.E.",
  "subject": "Scadenza CIE n. ${cie.uppercase}",
  "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
  "has_payment": false,
  "has_due_date": false,
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/templates/1"
    },
    "placeholders": {
      "href": "https://govhub.it/govio/templates/1/placeholders"
    }
  }
}

Assign a placeholder to a template.

Associate a placeholder to a template.

POSThttp://localhost:10001/templates/{id}/placeholders

Query parameters

Body

application/json

mandatory*boolean

position*integer (int32)

Response

201400401403404409429503default

Successful operation.

Body

application/hal+json

mandatory*boolean

position*integer (int32)

placeholder_idGovioPlaceholderId (integer (int64))

GovIO Placeholder Id.

Example: 1

_linksobject

_embeddedobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/templates/{id}/placeholders?placeholder_id=1', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "mandatory": false
    }),
});
const data = await response.json();

Response

201400401403404409429503default

{
  "mandatory": false,
  "placeholder_id": 1,
  "_links": {
    "placeholder": {
      "href": "https://govhub.it/govio/placeholders/1"
    },
    "template": {
      "href": "https://govhub.it/govio/templates/1"
    }
  },
  "_embedded": {
    "placeholder": {
      "name": "cie",
      "description": "Numero carta d'identità elettronica.",
      "example": "CA000000AA",
      "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
      "type": "string",
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/placeholders/1"
        }
      }
    },
    "template": {
      "name": "Spedizione Messaggio CIE",
      "description": "Segnala la scadenza della proprià C.I.E.",
      "subject": "Scadenza CIE n. ${cie.uppercase}",
      "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
      "has_payment": false,
      "has_due_date": false,
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/templates/1"
        },
        "placeholders": {
          "href": "https://govhub.it/govio/templates/1/placeholders"
        }
      }
    }
  }
}

List the template placeholders.

List the template associated placeholders.

GEThttp://localhost:10001/templates/{id}/placeholders

Query parameters

Response

200400401403404429503default

Successful operation.

Body

application/hal+json

itemsarray of GovioTemplatePlaceholder (all of)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/templates/{id}/placeholders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404429503default

{
  "items": [
    {
      "mandatory": false,
      "placeholder_id": 1,
      "_links": {
        "placeholder": {
          "href": "https://govhub.it/govio/placeholders/1"
        },
        "template": {
          "href": "https://govhub.it/govio/templates/1"
        }
      },
      "_embedded": {
        "placeholder": {
          "name": "cie",
          "description": "Numero carta d'identità elettronica.",
          "example": "CA000000AA",
          "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
          "type": "string",
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/placeholders/1"
            }
          }
        },
        "template": {
          "name": "Spedizione Messaggio CIE",
          "description": "Segnala la scadenza della proprià C.I.E.",
          "subject": "Scadenza CIE n. ${cie.uppercase}",
          "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
          "has_payment": false,
          "has_due_date": false,
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/templates/1"
            },
            "placeholders": {
              "href": "https://govhub.it/govio/templates/1/placeholders"
            }
          }
        }
      }
    }
  ]
}

Update the template placeholders.

Updates the whole template placeholder list.

PUThttp://localhost:10001/templates/{id}/placeholders

Path parameters

id*GovioTemplateId (integer (int64))

GovIO Template Id.

Example: 1

Body

application/json

itemsarray of GovioTemplatePlaceholderUpdateItem (all of)

Response

201400401403404429503default

Successful operation.

Body

application/hal+json

itemsarray of GovioTemplatePlaceholder (all of)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/templates/{id}/placeholders', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "items": [
        {
          "mandatory": false,
          "position": 0,
          "placeholder_id": 1
        },
        {
          "mandatory": false,
          "position": 1,
          "placeholder_id": 10
        },
        {
          "mandatory": true,
          "position": 4,
          "placeholder_id": 2
        }
      ]
    }),
});
const data = await response.json();

Response

201400401403404429503default

{
  "items": [
    {
      "mandatory": false,
      "placeholder_id": 1,
      "_links": {
        "placeholder": {
          "href": "https://govhub.it/govio/placeholders/1"
        },
        "template": {
          "href": "https://govhub.it/govio/templates/1"
        }
      },
      "_embedded": {
        "placeholder": {
          "name": "cie",
          "description": "Numero carta d'identità elettronica.",
          "example": "CA000000AA",
          "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
          "type": "string",
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/placeholders/1"
            }
          }
        },
        "template": {
          "name": "Spedizione Messaggio CIE",
          "description": "Segnala la scadenza della proprià C.I.E.",
          "subject": "Scadenza CIE n. ${cie.uppercase}",
          "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
          "has_payment": false,
          "has_due_date": false,
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/templates/1"
            },
            "placeholders": {
              "href": "https://govhub.it/govio/templates/1/placeholders"
            }
          }
        }
      }
    }
  ]
}

Removes the placeholder from the template.

Removes the placeholder from the template.

DELETEhttp://localhost:10001/templates/{template_id}/placeholders/{placeholder_id}

Path parameters

template_id*GovioTemplateId (integer (int64))

GovIO Template Id.

Example: 1

placeholder_id*GovioPlaceholderId (integer (int64))

GovIO Placeholder Id.

Example: 1

Response

200400401403404429503default

Successful operation.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/templates/{template_id}/placeholders/{placeholder_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404429503default

{
  "detail": "Connection to database timed out",
  "instance": "https://example.com",
  "status": 503,
  "title": "Service Unavailable",
  "type": "https://tools.ietf.org/html/rfc7231#section-6.6.4"
}

List the placeholders.

Placeholders can be reused across templates, this endpoints allows to list them.

GEThttp://localhost:10001/placeholders

Query parameters

Response

200400401403429503default

Successful operation.

Body

application/hal+json

page*PageInfo (object)

items*array of GovioPlaceholder (all of)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/placeholders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403429503default

{
  "page": {
    "offset": 20,
    "limit": 25,
    "total": 32
  },
  "items": [
    {
      "name": "cie",
      "description": "Numero carta d'identità elettronica.",
      "example": "CA000000AA",
      "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
      "type": "string",
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/placeholders/1"
        }
      }
    }
  ]
}

Create a new template placeholder.

Placeholders can be reused across templates, this endpoints allows to create one.

POSThttp://localhost:10001/placeholders

Body

application/json

name*string

Example: "cie"

Pattern: .+

descriptionstring

Example: "Numero carta d'identità elettronica."

Pattern: [\s\S]*

example*string

Example: "CA000000AA"

Pattern: [\s\S]+

patternstring

Example: "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]"

Pattern: [\s\S]*

type*GovioPlaceholderType (enum)

stringdatedatetime

Response

201400401403409429503default

Successful operation.

Body

application/hal+json

name*string

Example: "cie"

Pattern: .+

descriptionstring

Example: "Numero carta d'identità elettronica."

Pattern: [\s\S]*

example*string

Example: "CA000000AA"

Pattern: [\s\S]+

patternstring

Example: "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]"

Pattern: [\s\S]*

type*GovioPlaceholderType (enum)

stringdatedatetime

id*GovioPlaceholderId (integer (int64))

GovIO Placeholder Id.

Example: 1

_linksobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/placeholders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "cie",
      "example": "CA000000AA",
      "type": "string"
    }),
});
const data = await response.json();

Response

201400401403409429503default

{
  "name": "cie",
  "description": "Numero carta d'identità elettronica.",
  "example": "CA000000AA",
  "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
  "type": "string",
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/placeholders/1"
    }
  }
}

Read the specified placeholder.

Placeholders can be reused across templates, this endpoints allows to read one of them.

GEThttp://localhost:10001/placeholders/{id}

Response

200400401403404429503default

Successful operation.

Body

application/hal+json

name*string

Example: "cie"

Pattern: .+

descriptionstring

Example: "Numero carta d'identità elettronica."

Pattern: [\s\S]*

example*string

Example: "CA000000AA"

Pattern: [\s\S]+

patternstring

Example: "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]"

Pattern: [\s\S]*

type*GovioPlaceholderType (enum)

stringdatedatetime

id*GovioPlaceholderId (integer (int64))

GovIO Placeholder Id.

Example: 1

_linksobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/placeholders/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404429503default

{
  "name": "cie",
  "description": "Numero carta d'identità elettronica.",
  "example": "CA000000AA",
  "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
  "type": "string",
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/placeholders/1"
    }
  }
}

Update placeholder data.

Update placeholder data.

PATCHhttp://localhost:10001/placeholders/{id}

Path parameters

id*GovioPlaceholderId (integer (int64))

GovIO Placeholder Id.

Example: 1

Body

application/json-patch+json

op*enum

Specified operation.

Example: "add"

addremovereplace

path*string

jsonPath of the mutating object.

Example: "/organizations"

Pattern: ^.*$

valueobject

updating value.

Response

200400401403404429503default

Succsessful operation.

Body

application/hal+json

name*string

Example: "cie"

Pattern: .+

descriptionstring

Example: "Numero carta d'identità elettronica."

Pattern: [\s\S]*

example*string

Example: "CA000000AA"

Pattern: [\s\S]+

patternstring

Example: "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]"

Pattern: [\s\S]*

type*GovioPlaceholderType (enum)

stringdatedatetime

id*GovioPlaceholderId (integer (int64))

GovIO Placeholder Id.

Example: 1

_linksobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/placeholders/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify([
      {
        "op": "add",
        "path": "/name",
        "value": "cie"
      }
    ]),
});
const data = await response.json();

Response

200400401403404429503default

{
  "name": "cie",
  "description": "Numero carta d'identità elettronica.",
  "example": "CA000000AA",
  "pattern": "[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]",
  "type": "string",
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/placeholders/1"
    }
  }
}

List Govio Service Instances

Read and Filter the Govio Service Instanes

GEThttp://localhost:10001/service-instances

Query parameters

Response

200400401403429503default

Successful operation.

Body

application/hal+json

page*PageInfo (object)

items*array of GovioServiceInstance (all of)

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/service-instances?sort_direction=asc', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403429503default

{
  "page": {
    "offset": 20,
    "limit": 25,
    "total": 32
  },
  "items": [
    {
      "service_id": 1,
      "organization_id": 1,
      "template_id": 1,
      "enabled": true,
      "io_service_id": "text",
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/service-instances/1"
        },
        "service": {
          "href": "https://govhub.it/govio/services/1"
        },
        "organization": {
          "href": "https://govhub.it/govio/organizations/1"
        },
        "template": {
          "href": "https://govhub.it/govio/templates/1"
        }
      },
      "_embedded": {
        "service": {
          "id": 1,
          "service_name": "SUAP-Integrazione",
          "description": "Service for customer management.",
          "_links": {
            "self": {
              "href": "https://govhub.it/govregistry/services/1"
            },
            "logo": {
              "href": "https://govhub.it/govregistry/services/1/logo"
            },
            "logo_miniature": {
              "href": "https://govhub.it/govregistry/services/logo_miniature"
            }
          }
        },
        "organization": {
          "id": 1,
          "legal_name": "Giletti S.R.L.",
          "tax_code": "01234567890",
          "_links": {
            "self": {
              "href": "https://govhub.it/govregistry/organizations/1"
            },
            "logo": {
              "href": "https://govhub.it/govregistry/organizations/1/logo"
            },
            "logo_miniature": {
              "href": "https://govhub.it/govregistry/organizations/logo_miniature"
            }
          }
        },
        "template": {
          "name": "Spedizione Messaggio CIE",
          "description": "Segnala la scadenza della proprià C.I.E.",
          "subject": "Scadenza CIE n. ${cie.uppercase}",
          "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
          "has_payment": false,
          "has_due_date": false,
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/templates/1"
            },
            "placeholders": {
              "href": "https://govhub.it/govio/templates/1/placeholders"
            }
          }
        }
      }
    }
  ]
}

Creates a new Service Instance.

An organization can subscribe to a service multiple times, each time with a different message template, then the clients can send messages to the IO service using the service instance.

POSThttp://localhost:10001/service-instances

Body

application/json

service_id*ServiceId (integer (int64))

Service identifier.

Example: 1

organization_id*OrganizationId (integer (int64))

Organization identifier.

Example: 1

template_id*GovioTemplateId (integer (int64))

GovIO Template Id.

Example: 1

enabled*boolean

io_service_id*IOServiceId (string)

apiKey*string

Pattern: [\s\S]*

Response

200400401403404429503default

Successful operation.

Body

application/hal+json

service_id*ServiceId (integer (int64))

Service identifier.

Example: 1

organization_id*OrganizationId (integer (int64))

Organization identifier.

Example: 1

template_id*GovioTemplateId (integer (int64))

GovIO Template Id.

Example: 1

enabled*boolean

io_service_id*IOServiceId (string)

apiKey*string

Pattern: [\s\S]*

id*GovioServiceInstanceId (integer (int64))

Govio Service Instance Id.

Example: 1

_linksobject

_embeddedobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/service-instances', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "service_id": 1,
      "organization_id": 1,
      "template_id": 1,
      "enabled": true,
      "io_service_id": "text",
      "apiKey": "text"
    }),
});
const data = await response.json();

Response

200400401403404429503default

{
  "service_id": 1,
  "organization_id": 1,
  "template_id": 1,
  "enabled": true,
  "io_service_id": "text",
  "apiKey": "text",
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/service-instances/1"
    },
    "service": {
      "href": "https://govhub.it/govio/services/1"
    },
    "organization": {
      "href": "https://govhub.it/govio/organizations/1"
    },
    "template": {
      "href": "https://govhub.it/govio/templates/1"
    }
  },
  "_embedded": {
    "service": {
      "id": 1,
      "service_name": "SUAP-Integrazione",
      "description": "Service for customer management.",
      "_links": {
        "self": {
          "href": "https://govhub.it/govregistry/services/1"
        },
        "logo": {
          "href": "https://govhub.it/govregistry/services/1/logo"
        },
        "logo_miniature": {
          "href": "https://govhub.it/govregistry/services/logo_miniature"
        }
      }
    },
    "organization": {
      "id": 1,
      "legal_name": "Giletti S.R.L.",
      "tax_code": "01234567890",
      "_links": {
        "self": {
          "href": "https://govhub.it/govregistry/organizations/1"
        },
        "logo": {
          "href": "https://govhub.it/govregistry/organizations/1/logo"
        },
        "logo_miniature": {
          "href": "https://govhub.it/govregistry/organizations/logo_miniature"
        }
      }
    },
    "template": {
      "name": "Spedizione Messaggio CIE",
      "description": "Segnala la scadenza della proprià C.I.E.",
      "subject": "Scadenza CIE n. ${cie.uppercase}",
      "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
      "has_payment": false,
      "has_due_date": false,
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/templates/1"
        },
        "placeholders": {
          "href": "https://govhub.it/govio/templates/1/placeholders"
        }
      }
    }
  }
}

Retrieve a service instance.

Returns the specified service instance.

GEThttp://localhost:10001/service-instances/{id}

Response

200400401403404429503default

Successful operation.

Body

application/hal+json

service_id*ServiceId (integer (int64))

Service identifier.

Example: 1

organization_id*OrganizationId (integer (int64))

Organization identifier.

Example: 1

template_id*GovioTemplateId (integer (int64))

GovIO Template Id.

Example: 1

enabled*boolean

io_service_id*IOServiceId (string)

apiKey*string

Pattern: [\s\S]*

id*GovioServiceInstanceId (integer (int64))

Govio Service Instance Id.

Example: 1

_linksobject

_embeddedobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/service-instances/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404429503default

{
  "service_id": 1,
  "organization_id": 1,
  "template_id": 1,
  "enabled": true,
  "io_service_id": "text",
  "apiKey": "text",
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/service-instances/1"
    },
    "service": {
      "href": "https://govhub.it/govio/services/1"
    },
    "organization": {
      "href": "https://govhub.it/govio/organizations/1"
    },
    "template": {
      "href": "https://govhub.it/govio/templates/1"
    }
  },
  "_embedded": {
    "service": {
      "id": 1,
      "service_name": "SUAP-Integrazione",
      "description": "Service for customer management.",
      "_links": {
        "self": {
          "href": "https://govhub.it/govregistry/services/1"
        },
        "logo": {
          "href": "https://govhub.it/govregistry/services/1/logo"
        },
        "logo_miniature": {
          "href": "https://govhub.it/govregistry/services/logo_miniature"
        }
      }
    },
    "organization": {
      "id": 1,
      "legal_name": "Giletti S.R.L.",
      "tax_code": "01234567890",
      "_links": {
        "self": {
          "href": "https://govhub.it/govregistry/organizations/1"
        },
        "logo": {
          "href": "https://govhub.it/govregistry/organizations/1/logo"
        },
        "logo_miniature": {
          "href": "https://govhub.it/govregistry/organizations/logo_miniature"
        }
      }
    },
    "template": {
      "name": "Spedizione Messaggio CIE",
      "description": "Segnala la scadenza della proprià C.I.E.",
      "subject": "Scadenza CIE n. ${cie.uppercase}",
      "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
      "has_payment": false,
      "has_due_date": false,
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/templates/1"
        },
        "placeholders": {
          "href": "https://govhub.it/govio/templates/1/placeholders"
        }
      }
    }
  }
}

Update the service instance.

Only the apiKey can be modified by this operation.

PATCHhttp://localhost:10001/service-instances/{id}

Path parameters

id*GovioServiceInstanceId (integer (int64))

Govio Service Instance Id.

Example: 1

Body

application/json-patch+json

op*enum

Specified operation.

Example: "add"

addremovereplace

path*string

jsonPath of the mutating object.

Example: "/organizations"

Pattern: ^.*$

valueobject

updating value.

Response

200400401403404409429503default

Succsessful operation.

Body

application/hal+json

service_id*ServiceId (integer (int64))

Service identifier.

Example: 1

organization_id*OrganizationId (integer (int64))

Organization identifier.

Example: 1

template_id*GovioTemplateId (integer (int64))

GovIO Template Id.

Example: 1

enabled*boolean

io_service_id*IOServiceId (string)

apiKey*string

Pattern: [\s\S]*

id*GovioServiceInstanceId (integer (int64))

Govio Service Instance Id.

Example: 1

_linksobject

_embeddedobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:10001/service-instances/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify([
      {
        "op": "add",
        "path": "/organizations"
      }
    ]),
});
const data = await response.json();

Response

200400401403404409429503default

{
  "service_id": 1,
  "organization_id": 1,
  "template_id": 1,
  "enabled": true,
  "io_service_id": "text",
  "apiKey": "text",
  "id": 1,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/service-instances/1"
    },
    "service": {
      "href": "https://govhub.it/govio/services/1"
    },
    "organization": {
      "href": "https://govhub.it/govio/organizations/1"
    },
    "template": {
      "href": "https://govhub.it/govio/templates/1"
    }
  },
  "_embedded": {
    "service": {
      "id": 1,
      "service_name": "SUAP-Integrazione",
      "description": "Service for customer management.",
      "_links": {
        "self": {
          "href": "https://govhub.it/govregistry/services/1"
        },
        "logo": {
          "href": "https://govhub.it/govregistry/services/1/logo"
        },
        "logo_miniature": {
          "href": "https://govhub.it/govregistry/services/logo_miniature"
        }
      }
    },
    "organization": {
      "id": 1,
      "legal_name": "Giletti S.R.L.",
      "tax_code": "01234567890",
      "_links": {
        "self": {
          "href": "https://govhub.it/govregistry/organizations/1"
        },
        "logo": {
          "href": "https://govhub.it/govregistry/organizations/1/logo"
        },
        "logo_miniature": {
          "href": "https://govhub.it/govregistry/organizations/logo_miniature"
        }
      }
    },
    "template": {
      "name": "Spedizione Messaggio CIE",
      "description": "Segnala la scadenza della proprià C.I.E.",
      "subject": "Scadenza CIE n. ${cie.uppercase}",
      "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
      "has_payment": false,
      "has_due_date": false,
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/templates/1"
        },
        "placeholders": {
          "href": "https://govhub.it/govio/templates/1/placeholders"
        }
      }
    }
  }
}