Version: iGovPortal v9.0

Configuration API (v9.1)

Download OpenAPI specification:Download

Artionet: support@artionet.com URL: https://www.artionet.ch/

Welcome to the Configuration API documentation.

You can try out the API using Swagger.

You can find a detailed documentation by following this link.

Current Configured Levels

To get the context regarding this section please follow this link.

Entity Keys

To get the context regarding this section please follow this link.

Entity Key	DTOs
`colorPalette`	`UiColorPaletteDto`
`link`	`UiLinkDto`
`logo`	`UiLogoDto`
`socialNetwork`	`UiSocialNetworkDto`
`uiTemplate`	`UiTemplateDto`

UiTemplates

Get a list of UI Templates

Allows to retrieve a list of UI Templates according to certain criteria.

query Parameters

SenderIdentifier	string or null <= 200 characters Filters settings on the `SenderIdentifier` list field (CI match)
Limited	integer or null <int32>
Select	Array of strings or null
PageNumber	integer <int32> Page number (index, 1-based)
PageSize	integer <int32> Number of items per page. Using value `-1` disable pagination and gives all results at once.
OrderBy	string Sorting option. Ascending is the default direction when omitted. Usage : `orderBy=[property] [asc,desc],[property] [asc,desc],...` Example : `orderBy=person.maritalstatus.name desc`

Responses

Response samples

Content type

application/json

[{"name": "string",
"displayName": "string",
"description": "string",
"svgCssFilter": "string",
"colorPalette": {"primaryColor": "string",
"primaryColorText": "string",
"primaryColorPill": "string",
"secondaryColor": "string",
"secondaryColorLightOne": "string",
"secondaryColorLightTwo": "string",
"tertiaryColor": "string"
},
"headerLogo": {"source": "string",
"heightDesktop": 0,
"heightMobile": 0
},
"footerLogo": {"source": "string",
"heightDesktop": 0,
"heightMobile": 0
},
"links": [{"name": "string",
"displayName": "string",
"description": "string",
"redirectUrl": "string",
"isNewTab": true
}
],
"socialNetworks": [{"name": "string",
"displayName": "string",
"description": "string",
"redirectUrl": "string",
"icon": "string"
}
],
"senderIdentifiers": ["string"
],
"id": 0,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}
]

Add a new UI Template

Allows to create a new UI Template.

Request Body schema: application/json

name required	string [ 1 .. 100 ] characters Unique code name used as the template identifier
displayName required	string [ 1 .. 255 ] characters Name that will be used for display purpose (translation term)
description	string or null <= 255 characters Quick description (not shown to citizen)
svgCssFilter	string or null <= 2000 characters CSS filter applied on the SVG images to adapt their color. See https://codepen.io/sosuke/pen/Pjoqqp
required	object Colors data
required	object Header logo data
required	object Footer logo data
	Array of objects or null (CreateUiTemplateLink) List of links displayed in the footer
	Array of objects or null (CreateUiTemplateSocialNetwork) List of social networks displayed in the footer
senderIdentifiers required	Array of strings or null List of unique SenderIds related to a template.
createdBy required	string [ 1 .. 100 ] characters Requester of the creation

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"displayName": "string",
"description": "string",
"svgCssFilter": "string",
"colorPalette": {"primaryColor": "string",
"primaryColorText": "string",
"primaryColorPill": "string",
"secondaryColor": "string",
"secondaryColorLightOne": "string",
"secondaryColorLightTwo": "string",
"tertiaryColor": "string"
},
"headerLogo": {"source": "string",
"heightDesktop": 0,
"heightMobile": 0
},
"footerLogo": {"source": "string",
"heightDesktop": 0,
"heightMobile": 0
},
"links": [{"name": "string",
"displayName": "string",
"description": "string",
"redirectUrl": "string",
"isNewTab": true
}
],
"socialNetworks": [{"name": "string",
"displayName": "string",
"description": "string",
"redirectUrl": "string",
"icon": "string"
}
],
"senderIdentifiers": ["string"
],
"createdBy": "string"
}

Response samples

Content type

application/json

{"name": "string",
"displayName": "string",
"description": "string",
"svgCssFilter": "string",
"colorPalette": {"primaryColor": "string",
"primaryColorText": "string",
"primaryColorPill": "string",
"secondaryColor": "string",
"secondaryColorLightOne": "string",
"secondaryColorLightTwo": "string",
"tertiaryColor": "string"
},
"headerLogo": {"source": "string",
"heightDesktop": 0,
"heightMobile": 0
},
"footerLogo": {"source": "string",
"heightDesktop": 0,
"heightMobile": 0
},
"links": [{"name": "string",
"displayName": "string",
"description": "string",
"redirectUrl": "string",
"isNewTab": true
}
],
"socialNetworks": [{"name": "string",
"displayName": "string",
"description": "string",
"redirectUrl": "string",
"icon": "string"
}
],
"senderIdentifiers": ["string"
],
"id": 0,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Get the specified UI Template

Allows to retrieve a specific UI Template identified by its Name.

path Parameters

uiTemplateName

required

string

Responses

Response samples

Content type

application/json

{"name": "string",
"displayName": "string",
"description": "string",
"svgCssFilter": "string",
"colorPalette": {"primaryColor": "string",
"primaryColorText": "string",
"primaryColorPill": "string",
"secondaryColor": "string",
"secondaryColorLightOne": "string",
"secondaryColorLightTwo": "string",
"tertiaryColor": "string"
},
"headerLogo": {"source": "string",
"heightDesktop": 0,
"heightMobile": 0
},
"footerLogo": {"source": "string",
"heightDesktop": 0,
"heightMobile": 0
},
"links": [{"name": "string",
"displayName": "string",
"description": "string",
"redirectUrl": "string",
"isNewTab": true
}
],
"socialNetworks": [{"name": "string",
"displayName": "string",
"description": "string",
"redirectUrl": "string",
"icon": "string"
}
],
"senderIdentifiers": ["string"
],
"id": 0,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Update the specified UI Template

Allows to update an existing UI Template identified by its Id.

path Parameters

uiTemplateName

required

string

Request Body schema: application/json

displayName required	string [ 1 .. 255 ] characters Name that will be used for display purpose (translation term)
description	string or null <= 255 characters Quick description (not shown to citizen)
svgCssFilter	string or null <= 2000 characters CSS filter applied on the SVG images to adapt their color. See https://codepen.io/sosuke/pen/Pjoqqp
required	object Colors data
required	object Header logo data
required	object Footer logo data
	Array of objects or null (UpdateUiTemplateLink) List of links displayed in the footer
	Array of objects or null (UpdateUiTemplateSocialNetwork) List of social networks displayed in the footer
senderIdentifiers required	Array of strings or null List of unique SenderIds related to a template.
updatedBy required	string [ 1 .. 100 ] characters Requester of the update

Responses

Request samples

Payload

Content type

application/json

{"displayName": "string",
"description": "string",
"svgCssFilter": "string",
"colorPalette": {"primaryColor": "string",
"primaryColorText": "string",
"primaryColorPill": "string",
"secondaryColor": "string",
"secondaryColorLightOne": "string",
"secondaryColorLightTwo": "string",
"tertiaryColor": "string"
},
"headerLogo": {"source": "string",
"heightDesktop": 0,
"heightMobile": 0
},
"footerLogo": {"source": "string",
"heightDesktop": 0,
"heightMobile": 0
},
"links": [{"name": "string",
"displayName": "string",
"description": "string",
"redirectUrl": "string",
"isNewTab": true
}
],
"socialNetworks": [{"name": "string",
"displayName": "string",
"description": "string",
"redirectUrl": "string",
"icon": "string"
}
],
"senderIdentifiers": ["string"
],
"updatedBy": "string"
}

Response samples

Content type

application/json

{"name": "string",
"displayName": "string",
"description": "string",
"svgCssFilter": "string",
"colorPalette": {"primaryColor": "string",
"primaryColorText": "string",
"primaryColorPill": "string",
"secondaryColor": "string",
"secondaryColorLightOne": "string",
"secondaryColorLightTwo": "string",
"tertiaryColor": "string"
},
"headerLogo": {"source": "string",
"heightDesktop": 0,
"heightMobile": 0
},
"footerLogo": {"source": "string",
"heightDesktop": 0,
"heightMobile": 0
},
"links": [{"name": "string",
"displayName": "string",
"description": "string",
"redirectUrl": "string",
"isNewTab": true
}
],
"socialNetworks": [{"name": "string",
"displayName": "string",
"description": "string",
"redirectUrl": "string",
"icon": "string"
}
],
"senderIdentifiers": ["string"
],
"id": 0,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Delete the specified UI Template

Allows to delete an existing UI Template identified by its Name.

path Parameters

uiTemplateName

required

string

Responses

Response samples

Content type

application/json

{"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}