• Current Configured Levels
• Entity Keys
• Endpoints
  • IdentificationLevels
    • getGet a list of Identification Levels
    • postAdd a new Identification Level
    • getGet the specified Identification Level
    • putUpdate the specified Identification Level
    • delDelete the specified Identification Level
  • Identities
    • getGet a list of Identities
  • IdentityProviders
    • getGet a list of Identity Providers
    • postAdd a new Identity Provider
    • getGet the specified Identity Provider
    • putUpdate the specified Identity Provider
    • delDelete the specified Identity Provider
  • LegalForms
    • getGet a list of Legal Forms
    • postAdd a new Legal Form
    • getGet the specified Legal Form
    • putUpdate the specified Legal Form
    • delDelete the specified Legal Form
  • MaritalStatuses
    • getGet a list of Marital Statuses
    • postAdd an new Marital Status
    • getGet the specified Marital Status
    • putUpdate a the specified Marital Status
    • delDelete the specified Marital Status
  • OrgCategories
    • getGet a list of OrgCategories
    • postAdd a new OrgCategory
    • getGet the specified OrgCategory
    • putUpdate the specified OrgCategory
    • delDelete the specified OrgCategory
    • getGet the list of Roles for the specified OrgCategory
    • putAdd/update the relation between the specified Role and OrgCategory
    • getGet a specific Role within a specific OrgCategory
    • delDelete the relation between the specified Role and OrgCategory
  • OrgIdentificationLevels
    • getGet a list of Identification Levels
    • postAdd a new Identification Level
    • getGet the specified Identification Level
    • putUpdate the specified Identification Level
    • delDelete the specified Identification Level
  • Profiles
    • headGet a list of Profiles (headers only)
    • getGet a list of Profiles
    • postAdd a new Profile
    • delDelete filtered profiles
    • getGet the specified Profile
    • patchUpdate partially the specified Profile
    • delDelete the specified Profile
    • putAdd/update the relation between the specified Identity Provider and Profile
    • delDelete the relation between the specified Identity Provider and Profile
    • getGet the list of Roles for the specified Profile
    • putAdd/update the relation between the specified Role and Profile
    • getGet a specific Role within a specific Profile
    • delDelete the relation between the specified Role and Profile
    • getGet the list of Services for the specified Profile
    • getGet the the specified Service for the specified Profile
    • getGet the list of agreed Services for the specified Profile's Outbound Procuration
    • putAdd all missing possible Service relations (ProcurationService) for the specified Procuration
    • getGet the list of accessible Services for the specified Profile's Inbound Procuration
    • getGet the Agreed Service for the specified Outbound Procuration and Service
    • putAdd/update the relation (ProcurationService) between the specified Service and Procuration
    • delDelete the relation (ProcurationService) between the specified Outbound Procuration and Service
    • getGet the accessible Service for the specified inbound Procuration and Service
    • getGet the list of Themes for the specified Profile's Services
    • getGet the list of configured Service Settings (and their Values) for the specified Profile
    • getGet the configured Service Setting (and its Value) for the specified Profile
    • putAdd/update the specified Service Setting Value for the specified Profile
    • delDelete the specified Service Setting Value from the specified Profile
    • postCreate a new Procuration (outbound) from the specified Profile (principal) with another specified Profile (representative)
    • putAdd/update the specified Oubtbound Procuration for the specified Profile with another Profile
    • patchUpdate partially a specific outbound Procuration
    • delDelete the specified Outbound Procuration for the specified Profile with another Profile
    • getGet the Profile's Outbound Procuration with the specified other Profile
    • patchUpdate partially a specific inbound Procuration
    • delDelete the specified Inbound Procuration for the specified Profile with another Profile
    • getGet the Profile's Inbound Procuration with the specified other Profile
    • getGet the list of Profile's Inbound Procurations
    • getGet the list of Profile's Outbound Procurations
    • postCreate a new Procuration Invite (outbound) from the specified Profile (principal)
    • getGet a specific outbound Procuration Invite
    • delDelete a specific outbound Procuration Invite
    • patchUpdate partially a specific outbound Procuration Invite
    • getGet the list of Profile's outbound Procuration Invites
    • postConsume an existing Procuration Invite (inbound) within the specified Profile (representative)
    • getGet a specific inbound Procuration Invite
    • delDelete a specific inbound Procuration Invite
    • patchUpdate partially a specific inbound Procuration Invite
    • getGet the list of Profile's inbound Procuration Invites
    • getGet the the Profile Picture of the specified Profile
    • putUpdate the Profile Picture of the specified Profile
    • delDelete the Custom Profile Picture of the specified Profile
    • getGet the survey status of the specified Profile and Service
    • postCreate a survey entry for the specified Profile and Service Survey
    • patchPatch the last survey entry for the specified Profile and Service Survey
    • getGet the list of accessible Widgets for the specified Profile
    • getGet list of accessible Widgets for the specified Profile's Inbound Procuration
    • putAdd/update a Widget as favorite for the specified Profile
    • delDelete a Widget from the favorites of the specified Profile
    • putAdd/update a Widget as favorite for the specified Profile's Inbound Procuration
    • delDelete a Widget from the favorites of the specified Profile's Inbound Procuration
    • delDelete a Service from the favorites of the specified Profile
    • putAdd/update a Service as favorite for the specified Profile
    • delDelete a Service from the favorites of the specified Profile's Inbound Procuration
    • putAdd/update a Service as favorite for the specified Profile's Inbound Procuration
  • Roles
    • getGet a list of Roles
    • postAdd a new Role
    • getGet the specified Role
    • putUpdate the specified Role
    • delDelete the specified Role
    • getGet the list of Profiles for the specified Role
  • Services
    • headGet a list of Services (headers only)
    • getGet a list of Services
    • postAdd a new Service
    • getGet the specified Service
    • putUpdate the specified Service
    • delDelete the specified Service
    • getGet the list of Profiles for the specified Service
    • putAdd/update the relation between the specified Role and Service
    • delDelete the relation between the specified Role and Service
    • getGet the the specified Role within the Service
    • getGet the list of Roles for the specified Service
    • getGet the list of Clients for the specified Service
    • getGet the the specified Client within the Service
    • putAdd/update the relation between the specified Client and Service
    • delDelete the relation between the specified Client and Service
    • getGet the list of Service Settings for the specified Service
    • postAdd an new Service Setting to the specified Service
    • getGet the specified Service Setting for the specified Service
    • putUpdate the specified Service Setting for the specified Service
    • delDelete the specified Service Setting for the specified Service
    • getGet the list of Service Steps for the specified Service
    • postAdd an new Service Step to the specified Service
    • getGet the specified Service Step for the specified Service
    • putUpdate the specified Service Step for the specified Service
    • delDelete the specified Service Step for the specified Service
    • putCreate or update the Survey for the specified Service
    • getGet the Survey for the specified Service
    • delDelete the Survey for the specified Service
    • getGet a list of available ChartTypes for widgets
    • postCreate a new Widget for the specified Service
    • getGet a list of Widget for the specified Service
    • getGet a specific Widget for the specified Service
    • putUpdate a specific Widget for the specified Service
    • delDelete a specific Widget for the specified Service
  • ServiceThemes
    • getGet a list of Themes
    • postAdd an new Theme
    • getGet the specified Theme
    • putUpdate a the specified Theme
    • delDelete the specified Theme

API docs by Redocly

Profiles API (v9.1)

Download OpenAPI specification:Download

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

Welcome to the Profile API documentation.

You can try out the API using Swagger.

You can find a detailed documentation by following this link.

Current Configured Levels

Level 1

Role : ProfileApi_Low
Properties per entity :

Entity Key	Available Properties
profile	email person organization
person	firstname lastname
organization	name uid
service	name displayName

Level 2

Role : ProfileApi_Medium
Properties per entity :

Entity Key	Available Properties
profile	isEnabled email phone person organization
person	firstname lastname birthdate gender account
account	sessionDuration hasSeenOwnProfile
organization	No property limitation for this entity.
service	name displayName url

Level 9

Role : ProfileApi_Max
Properties per entity :

No property limitation for this level.

Entity Keys

Each entity has a specific value to refer to it either in the configuration (EntityKey) or with the Select query string attribute.

Entity Key	DTOs
role	RoleDto RoleByProfileDto RoleByServiceDto
service	ServiceDto ServiceByProfileDto ExpandableServiceDto ServiceByProcurationDto
serviceSetting	ServiceSettingDto ServiceSettingByProfileDto
widget	WidgetDto WidgetByProfileDto ExpandableWidgetDto
account	AccountDto ExpandableAccountDto
identity	IdentityDto ExpandableIdentityDto
organization	OrganizationDto ExpandableOrganizationDto
person	PersonDto ExpandablePersonDto
procuration	ProcurationDto ExpandableProcurationDto
procuration-invite	ExpandableProcurationInviteDto
profile	ProfileDto ExpandableProfileDto
chartType	ChartTypeDto
client	ClientDto
favoriteService	FavoriteServiceDto
favoriteWidget	FavoriteWidgetDto
identificationLevel	IdentificationLevelDto
identityProvider	IdentityProviderDto
legalForm	LegalFormDto
maritalStatus	MaritalStatusDto
orgCategory	OrgCategoryDto
orgCategoryRole	OrgCategoryRoleDto
orgIdentificationLevel	OrgIdentificationLevelDto
orgSignatory	OrgSignatoryDto
procurationInvite	ProcurationInviteDto
procurationService	ProcurationServiceDto
profilePicture	ProfilePictureDto
profileRole	ProfileRoleDto
serviceClient	ServiceClientDto
serviceRole	ServiceRoleDto
serviceSettingValue	ServiceSettingValueDto
serviceStep	ServiceStepDto
serviceTheme	ServiceThemeDto
survey	SurveyDto
surveyEntry	SurveyEntryDto

IdentificationLevels

Get a list of Identification Levels

Allows to retrieve a list of Identification Levels according to certain criteria.

query Parameters

IsForServicesCatalog	boolean Filters identification levels to keep only the ones that are related to at least one service that has the given value for the field IsShownInCatalog and are within a visible theme
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/identification-levels

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "levelOfTrust": 0

  }

]

Add a new Identification Level

Allows to create a new Identification Level.

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
description	string or null Quick description (not shown to citizen)
levelOfTrust	integer <int32> Level value of the identification level

Responses

https://api.egov4.ch/profiles/demo/v9-1/identification-levels

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "levelOfTrust": 0

}

Response samples

• 201
• 400

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "levelOfTrust": 0

}

Get the specified Identification Level

Allows to retrieve a specific Identification Level identified by its Id.

path Parameters

identificationLevelId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/identification-levels/{identificationLevelId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "levelOfTrust": 0

}

Update the specified Identification Level

Allows to update an existing Identification Level identified by its Id.

path Parameters

identificationLevelId required

integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
description	string or null Quick description (not shown to citizen)
levelOfTrust	integer <int32> Level value of the identification level

Responses

https://api.egov4.ch/profiles/demo/v9-1/identification-levels/{identificationLevelId}

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "levelOfTrust": 0

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "levelOfTrust": 0

}

Delete the specified Identification Level

Allows to delete an existing Identification Level identified by its Id.

Deletion is only possible when the targeted identification level is not in use by any Service or Identity.

path Parameters

identificationLevelId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/identification-levels/{identificationLevelId}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Identities

Get a list of Identities

Allows to retrieve a list of Identities according to certain criteria.

query Parameters

ExternalId	string Filters identites on the ExternalId field (exact match)
IdpName	string Filters identities on the IdentityProvider Name field (CI match)
Expand	Array of strings (IdentitiesExpand) Items Enum: "Account" "IdentificationLevel"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/identities

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "identityProviderId": 0,
  • "accountId": 0,
  • "identificationLevelId": 0,
  • "externalId": "string",
  • "profileId": 0,
  • "metadata": {

    • "property1": "string",
    • "property2": "string"

    },
  • "identificationLevel": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "levelOfTrust": 0

    },
  • "account": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "username": "string",
    • "password": "string",
    • "sessionDuration": 0,
    • "isSignupComplete": true,
    • "isLocal": true,
    • "hasSeenOwnProfile": true

    }

  }

]

IdentityProviders

Get a list of Identity Providers

Allows to retrieve a list of Identity Providers according to certain criteria.

query Parameters

IsEnabled	boolean Filters IdentityProviders on the IsEnabled field
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/identity-providers

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "typeName": "string",
  • "isDefault": true,
  • "isEnabled": true,
  • "data": "string"

  }

]

Add a new Identity Provider

Allows to create a new Identity Provider.

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
typeName	string Name of the binary related to this provider
isDefault	boolean Default: false Defines if the provider will be used by default
isEnabled	boolean Default: false Defines if the provider is enabled
data	string or null Contains specific data used by the provider

Responses

https://api.egov4.ch/profiles/demo/v9-1/identity-providers

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "name": "string",
• "displayName": "string",
• "typeName": "string",
• "isDefault": false,
• "isEnabled": false,
• "data": "string"

}

Response samples

• 201
• 400

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "typeName": "string",
• "isDefault": true,
• "isEnabled": true,
• "data": "string"

}

Get the specified Identity Provider

Allows to retrieve a specific Identity Provider identified by its Id.

path Parameters

identityProviderId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/identity-providers/{identityProviderId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "typeName": "string",
• "isDefault": true,
• "isEnabled": true,
• "data": "string"

}

Update the specified Identity Provider

Allows to update an existing Identity Provider identified by its Id.

path Parameters

identityProviderId required

integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
typeName	string Name of the binary related to this provider
isDefault	boolean Default: false Defines if the provider will be used by default
isEnabled	boolean Default: false Defines if the provider is enabled
data	string or null Contains specific data used by the provider

Responses

https://api.egov4.ch/profiles/demo/v9-1/identity-providers/{identityProviderId}

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "name": "string",
• "displayName": "string",
• "typeName": "string",
• "isDefault": false,
• "isEnabled": false,
• "data": "string"

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "typeName": "string",
• "isDefault": true,
• "isEnabled": true,
• "data": "string"

}

Delete the specified Identity Provider

Allows to delete an existing Identity Provider identified by its Id.

path Parameters

identityProviderId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/identity-providers/{identityProviderId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

LegalForms

Get a list of Legal Forms

Allows to retrieve a list of Legal Forms according to certain criteria.

query Parameters

Code	string Filters LegalForms on the Code field (CI match)
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/legal-forms

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "code": "string",
  • "description": "string",
  • "isOrgDeletableByOwner": true

  }

]

Add a new Legal Form

Allows to create a new Legal Form.

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
code	string or null Unique code used during organization registration to know if self-registration is possible. Cannot contain the character '_'.
description	string or null Quick description (not shown to citizen)
isOrgDeletableByOwner	boolean Default: true Indicates if affiliated organizations can be deleted by one of their owners

Responses

https://api.egov4.ch/profiles/demo/v9-1/legal-forms

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "name": "string",
• "displayName": "string",
• "code": "string",
• "description": "string",
• "isOrgDeletableByOwner": true

}

Response samples

• 201
• 400

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "code": "string",
• "description": "string",
• "isOrgDeletableByOwner": true

}

Get the specified Legal Form

Allows to retrieve a specific Legal Form identified by its Id.

path Parameters

legalFormId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/legal-forms/{legalFormId}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "code": "string",
• "description": "string",
• "isOrgDeletableByOwner": true

}

Update the specified Legal Form

Allows to update an existing Legal Form identified by its Id.

path Parameters

legalFormId required

integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
code	string or null Unique code used during organization registration to know if self-registration is possible Cannot contain the character '_'.
description	string or null Quick description (not shown to citizen)
isOrgDeletableByOwner	boolean Default: true Indicates if affiliated organizations can be deleted by one of their owners

Responses

https://api.egov4.ch/profiles/demo/v9-1/legal-forms/{legalFormId}

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "name": "string",
• "displayName": "string",
• "code": "string",
• "description": "string",
• "isOrgDeletableByOwner": true

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "code": "string",
• "description": "string",
• "isOrgDeletableByOwner": true

}

Delete the specified Legal Form

Allows to delete an existing Legal Form identified by its Id.

Deletion is only possible when the targeted legal form is not in use by any Organization.

path Parameters

legalFormId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/legal-forms/{legalFormId}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

MaritalStatuses

Get a list of Marital Statuses

Allows to retrieve a list of Marital Statuses according to certain criteria.

query Parameters

IsEnabled	boolean Filters marital statuses on the IsEnabled field
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/marital-statuses

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "isEnabled": true,
  • "sortOrder": 0

  }

]

Add an new Marital Status

Allows to create a new Marital Status.

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
isEnabled	boolean Default: true Indicates if the marital status is usable by the citizen
sortOrder	integer <int32> Value on which the marital statuses will be sorted (asc) for display to the citizen When omitted, the higher value + 1 is used by default.

Responses

https://api.egov4.ch/profiles/demo/v9-1/marital-statuses

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "name": "string",
• "displayName": "string",
• "isEnabled": true,
• "sortOrder": 0

}

Response samples

• 201
• 400

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "isEnabled": true,
• "sortOrder": 0

}

Get the specified Marital Status

Allows to retrieve a specific Marital Status identified by its Id.

path Parameters

maritalStatusId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/marital-statuses/{maritalStatusId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "isEnabled": true,
• "sortOrder": 0

}

Update a the specified Marital Status

Allows to update an existing Marital Status identified by its Id.

path Parameters

maritalStatusId required

integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
isEnabled	boolean Default: true Indicates if the marital status is usable by the citizen
sortOrder	integer <int32> Value on which the marital statuses will be sorted (asc) for display to the citizen When omitted, the higher value + 1 is used by default.

Responses

https://api.egov4.ch/profiles/demo/v9-1/marital-statuses/{maritalStatusId}

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "name": "string",
• "displayName": "string",
• "isEnabled": true,
• "sortOrder": 0

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "isEnabled": true,
• "sortOrder": 0

}

Delete the specified Marital Status

Allows to delete an existing Marital Status identified by its Id.

path Parameters

maritalStatusId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/marital-statuses/{maritalStatusId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

OrgCategories

Get a list of OrgCategories

Allows to retrieve a list of OrgCategories according to certain criteria.

query Parameters

Code	string Filters categories on the Code field (CI match)
IsVisible	boolean Filters categories on the IsVisible field
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/organization-categories

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "code": "string",
  • "description": "string",
  • "isVisible": true,
  • "isOrgDeletableByOwner": true,
  • "profilePictureUrl": "string",
  • "smallProfilePictureUrl": "string",
  • "daysUntilFirstDeletionReminder": 0,
  • "daysUntilSecondDeletionReminder": 0,
  • "daysUntilDeletion": 0

  }

]

Add a new OrgCategory

Allows to create a new OrgCategory.

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
code	string or null Unique code used during registration to know if self-registration is possible Cannot contain the character '_'.
description	string or null Quick description (not shown to citizen)
isVisible	boolean Default: true Indicates if the category is shown in the organization registration form
isOrgDeletableByOwner	boolean Default: true Indicates if affiliated organizations can be deleted by one of their owners
profilePictureUrl	string or null Url of the default profile picture for organizations belonging to this category
smallProfilePictureUrl	string or null Url of the default profile picture (small version) for organizations belonging to this category
daysUntilFirstDeletionReminder	integer or null <int32> Number of days until the first deletion reminder should be sent
daysUntilSecondDeletionReminder	integer or null <int32> Number of days until the second deletion reminder should be sent
daysUntilDeletion	integer or null <int32> Number of days until the deletion reminder should be sent

Responses

https://api.egov4.ch/profiles/demo/v9-1/organization-categories

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "name": "string",
• "displayName": "string",
• "code": "string",
• "description": "string",
• "isVisible": true,
• "isOrgDeletableByOwner": true,
• "profilePictureUrl": "string",
• "smallProfilePictureUrl": "string",
• "daysUntilFirstDeletionReminder": 0,
• "daysUntilSecondDeletionReminder": 0,
• "daysUntilDeletion": 0

}

Response samples

• 201
• 400

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "code": "string",
• "description": "string",
• "isVisible": true,
• "isOrgDeletableByOwner": true,
• "profilePictureUrl": "string",
• "smallProfilePictureUrl": "string",
• "daysUntilFirstDeletionReminder": 0,
• "daysUntilSecondDeletionReminder": 0,
• "daysUntilDeletion": 0

}

Get the specified OrgCategory

Allows to retrieve a specific OrgCategory identified by its Id.

path Parameters

orgCategoryId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/organization-categories/{orgCategoryId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "code": "string",
• "description": "string",
• "isVisible": true,
• "isOrgDeletableByOwner": true,
• "profilePictureUrl": "string",
• "smallProfilePictureUrl": "string",
• "daysUntilFirstDeletionReminder": 0,
• "daysUntilSecondDeletionReminder": 0,
• "daysUntilDeletion": 0

}

Update the specified OrgCategory

Allows to update an existing OrgCategory identified by its Id.

path Parameters

orgCategoryId required

integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
code	string or null Unique code used during registration to know if self-registration is possible Cannot contain the character '_'.
description	string or null Quick description (not shown to citizen)
isVisible	boolean Default: true Indicates if the category is shown in the organization registration form
isOrgDeletableByOwner	boolean Default: true Indicates if affiliated organizations can be deleted by one of their owners
profilePictureUrl	string or null Url of the default profile picture for organizations belonging to this category
smallProfilePictureUrl	string or null Url of the default profile picture (small version) for organizations belonging to this category
daysUntilFirstDeletionReminder	integer or null <int32> Number of days until the first deletion reminder should be sent
daysUntilSecondDeletionReminder	integer or null <int32> Number of days until the second deletion reminder should be sent
daysUntilDeletion	integer or null <int32> Number of days until the deletion reminder should be sent

Responses

https://api.egov4.ch/profiles/demo/v9-1/organization-categories/{orgCategoryId}

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "name": "string",
• "displayName": "string",
• "code": "string",
• "description": "string",
• "isVisible": true,
• "isOrgDeletableByOwner": true,
• "profilePictureUrl": "string",
• "smallProfilePictureUrl": "string",
• "daysUntilFirstDeletionReminder": 0,
• "daysUntilSecondDeletionReminder": 0,
• "daysUntilDeletion": 0

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "code": "string",
• "description": "string",
• "isVisible": true,
• "isOrgDeletableByOwner": true,
• "profilePictureUrl": "string",
• "smallProfilePictureUrl": "string",
• "daysUntilFirstDeletionReminder": 0,
• "daysUntilSecondDeletionReminder": 0,
• "daysUntilDeletion": 0

}

Delete the specified OrgCategory

Allows to delete an existing OrgCategory identified by its Id.

Deletion is only possible when the targeted organization category is not in use by any Organization.

path Parameters

orgCategoryId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/organization-categories/{orgCategoryId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get the list of Roles for the specified OrgCategory

Allows to retrieve a list of OrgCategory's roles according to certain criteria.

path Parameters

orgCategoryId required

integer <int32>

query Parameters

Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/organization-categories/{orgCategoryId}/roles

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string"

  }

]

Add/update the relation between the specified Role and OrgCategory

Allows to create or update a OrgCategory-Role relation.

The specified Role will also be added (if not already present) to all Organizations within the specified Category.
Triggers an automated update of related procuration services.

path Parameters

orgCategoryId required	integer <int32>
roleId required	integer <int32>

Request Body schema: application/json

createdBy required

string [ 1 .. 100 ] characters Requester of the creation

Responses

https://api.egov4.ch/profiles/demo/v9-1/organization-categories/{orgCategoryId}/roles/{roleId}

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string"

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "orgCategoryId": 0,
• "roleId": 0

}

Get a specific Role within a specific OrgCategory

Allows to retrieve a specific Role and its relation with a specific OrgCategory

path Parameters

orgCategoryId required	integer <int32>
roleId required	integer <int32>

query Parameters

Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/organization-categories/{orgCategoryId}/roles/{roleId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string"

}

Delete the relation between the specified Role and OrgCategory

Allows to delete an existing OrgCategory-Role identified by its OrgCategory and Role identifiers.

The specified Role will also be removed from all Organizations within the specified Category.
Triggers an automated update of related procuration services.

path Parameters

orgCategoryId required	integer <int32>
roleId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/organization-categories/{orgCategoryId}/roles/{roleId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

OrgIdentificationLevels

Get a list of Identification Levels

Allows to retrieve a list of Identification Levels according to certain criteria.

query Parameters

IsForServicesCatalog	boolean Filters identification levels to keep only the ones that are related to at least one service that has the given value for the field IsShownInCatalog and are within a visible theme
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/organization-identification-levels

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "levelOfTrust": 0,
  • "elevationServiceId": 0

  }

]

Add a new Identification Level

Allows to create a new Identification Level.

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
description	string or null Quick description (not shown to citizen)
levelOfTrust	integer <int32> Level value of the identification level
elevationServiceId	integer or null <int32> Identifier of the service designed to elevate an organization profile to this identification level

Responses

https://api.egov4.ch/profiles/demo/v9-1/organization-identification-levels

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "levelOfTrust": 0,
• "elevationServiceId": 0

}

Response samples

• 201
• 400

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "levelOfTrust": 0,
• "elevationServiceId": 0

}

Get the specified Identification Level

Allows to retrieve a specific Identification Level identified by its Id.

path Parameters

identificationLevelId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/organization-identification-levels/{identificationLevelId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "levelOfTrust": 0,
• "elevationServiceId": 0

}

Update the specified Identification Level

Allows to update an existing Identification Level identified by its Id.

path Parameters

identificationLevelId required

integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
description	string or null Quick description (not shown to citizen)
levelOfTrust	integer <int32> Level value of the identification level
elevationServiceId	integer or null <int32> Identifier of the service designed to elevate an organization profile to this identification level

Responses

https://api.egov4.ch/profiles/demo/v9-1/organization-identification-levels/{identificationLevelId}

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "levelOfTrust": 0,
• "elevationServiceId": 0

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "levelOfTrust": 0,
• "elevationServiceId": 0

}

Delete the specified Identification Level

Allows to delete an existing Identification Level identified by its Id.

path Parameters

identificationLevelId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/organization-identification-levels/{identificationLevelId}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Profiles

Get a list of Profiles (headers only)

Allows to retrieve a list of Profiles (headers only) according to certain criteria.

query Parameters

Expand	Array of strings (ProfilesExpand) Items Enum: "Person" "Person_MaritalStatus" "Person_Account" "Person_Account_Identities" "Organization" "Organization_LegalForm" "Organization_Category" "Organization_IdentificationLevel" "Organization_Signatories" "ProfilePicture"
HeadersOnly	boolean Default: false Defines if the response will only contains headers
ProfileType	string (ProfileType) Enum: "Person" "Organization" Filters profiles bye their type (person-type or organization-type)
Ids	Array of integers <int32> [ items <int32 > ] Filters profiles to match a list of ids
IsEnabled	boolean Filters profiles on the IsEnabled field
ExternalKey	string Filters profiles on the ExternalKey field (exact match)
Keyword	string Filters profiles on the following fields : Id (exact match), ZipCode, City (CI, contains) Person.Firstname, Person.Lastname (CI, contains) Organization.Name (CI, contains)
EmailContains	string Filters profiles on the Email field (CI, contains)
ZipCodeContains	string Filters profiles on the ZipCode field (CI, contains)
CityContains	string Filters profiles on the City field (CI, contains)
MinLastLoginStamp	string <date-time> Filters profiles on the LastLoginStamp field with a minimum or equal value
MaxLastLoginStamp	string <date-time> Filters profiles on the LastLoginStamp field with a maximum or equal value
IsInGracePeriod	boolean Filters profiles on the GracePeriodEndDate field
IsFlaggedForDeletion	boolean Filters profiles on the IsFlaggedForDeletion field
OrganizationId	integer <int32> Filters profiles on the Organization.Id field
OrganizationUid	string Filters profiles on the Organization.Uid field (CI match)
OrganizationName	string Filters profiles on the Organization.Name field (CI match)
OrganizationNameContains	string Filters profiles on the Organization.Name field (CI, contains)
OrganizationIsPending	boolean Filters profiles on the Organization.IsPending field
OrganizationCategoryCode	string Filters profiles on the Organization.Category.Code field
OrganizationValidationPerimeter	Array of strings Filters profiles on codes combinations for legal forms and categories with a CI match Format : LegalFormCode_CategoryCode Wildcards : all available for both codes
OrganizationFsoId	integer <int32> Filters profiles on the Organization.FsoId field
PersonId	integer <int32> Filters profiles on the Person.Id field
PersonFirstNameContains	string Filters profiles on the Person.Firstname field (CI, contains)
PersonLastnameContains	string Filters profiles on the Person.Lastname field (CI, contains)
PersonAhvNumber	string Filters profiles on the Person.AhvNumber field (exact match)
HasToBeProcessedForInactivity	string (InactivityState) Enum: "Active" "InactiveLevelOne" "InactiveLevelTwo" "InactiveLevelThree" Filters profiles based on their current activity state and their last login stamp
IncludeCustomImageBytes	boolean
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles

Response samples

• 400

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Get a list of Profiles

Allows to retrieve a list of Profiles according to certain criteria.

query Parameters

Expand	Array of strings (ProfilesExpand) Items Enum: "Person" "Person_MaritalStatus" "Person_Account" "Person_Account_Identities" "Organization" "Organization_LegalForm" "Organization_Category" "Organization_IdentificationLevel" "Organization_Signatories" "ProfilePicture"
HeadersOnly	boolean Default: false Defines if the response will only contains headers
ProfileType	string (ProfileType) Enum: "Person" "Organization" Filters profiles bye their type (person-type or organization-type)
Ids	Array of integers <int32> [ items <int32 > ] Filters profiles to match a list of ids
IsEnabled	boolean Filters profiles on the IsEnabled field
ExternalKey	string Filters profiles on the ExternalKey field (exact match)
Keyword	string Filters profiles on the following fields : Id (exact match), ZipCode, City (CI, contains) Person.Firstname, Person.Lastname (CI, contains) Organization.Name (CI, contains)
EmailContains	string Filters profiles on the Email field (CI, contains)
ZipCodeContains	string Filters profiles on the ZipCode field (CI, contains)
CityContains	string Filters profiles on the City field (CI, contains)
MinLastLoginStamp	string <date-time> Filters profiles on the LastLoginStamp field with a minimum or equal value
MaxLastLoginStamp	string <date-time> Filters profiles on the LastLoginStamp field with a maximum or equal value
IsInGracePeriod	boolean Filters profiles on the GracePeriodEndDate field
IsFlaggedForDeletion	boolean Filters profiles on the IsFlaggedForDeletion field
OrganizationId	integer <int32> Filters profiles on the Organization.Id field
OrganizationUid	string Filters profiles on the Organization.Uid field (CI match)
OrganizationName	string Filters profiles on the Organization.Name field (CI match)
OrganizationNameContains	string Filters profiles on the Organization.Name field (CI, contains)
OrganizationIsPending	boolean Filters profiles on the Organization.IsPending field
OrganizationCategoryCode	string Filters profiles on the Organization.Category.Code field
OrganizationValidationPerimeter	Array of strings Filters profiles on codes combinations for legal forms and categories with a CI match Format : LegalFormCode_CategoryCode Wildcards : all available for both codes
OrganizationFsoId	integer <int32> Filters profiles on the Organization.FsoId field
PersonId	integer <int32> Filters profiles on the Person.Id field
PersonFirstNameContains	string Filters profiles on the Person.Firstname field (CI, contains)
PersonLastnameContains	string Filters profiles on the Person.Lastname field (CI, contains)
PersonAhvNumber	string Filters profiles on the Person.AhvNumber field (exact match)
HasToBeProcessedForInactivity	string (InactivityState) Enum: "Active" "InactiveLevelOne" "InactiveLevelTwo" "InactiveLevelThree" Filters profiles based on their current activity state and their last login stamp
IncludeCustomImageBytes	boolean
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  }

]

Add a new Profile

Allows to create a new Profile (+person +account / +organization).

• Citizen role is automatically added for person profiles.
• Category roles are automatically added for organization profiles.

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
isEnabled	boolean Default: true Indicates if the profile is enabled (usable)
externalKey	string or null External unique key
email	string Contact email
language	string or null Preferred language (e.g. : EN)
phone	string or null Phone number
fax	string or null Fax number
address	string or null Address (with house number)
zipCode	string or null ZipCode of the city
city	string or null City
countryCode	string or null Country code (e.g. : CH)
acceptsAdvertisement	boolean Default: true Indicates if the profile accepts to receive advertisement
	object or null
	object or null

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "isEnabled": true,
• "externalKey": "string",
• "email": "string",
• "language": "string",
• "phone": "string",
• "fax": "string",
• "address": "string",
• "zipCode": "string",
• "city": "string",
• "countryCode": "string",
• "acceptsAdvertisement": true,
• "person": {

  • "firstname": "string",
  • "lastname": "string",
  • "gender": "Unknown",
  • "ahvNumber": "string",
  • "mobilePhone": "string",
  • "birthdate": "2019-08-24T14:15:22Z",
  • "maritalStatusId": 0,
  • "account": {

    • "username": "string",
    • "password": "string"

    }

  },
• "organization": {

  • "name": "string",
  • "uid": "string",
  • "fsoId": 0,
  • "website": "string",
  • "orgCategoryId": 0,
  • "legalFormId": 0,
  • "orgIdentificationLevelId": 0,
  • "identificationProcess": "string",
  • "isSelfRegistration": false,
  • "createdByProfileId": 0,
  • "isPending": true,
  • "signatureType": "Single",
  • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
  • "signatories": [

    • {

      • "isRequester": true,
      • "type": "Signer",
      • "position": "string",
      • "gender": "Unknown",
      • "firstname": "string",
      • "lastname": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "email": "string",
      • "ahvNumber": "string",
      • "identityNumber": "string",
      • "address": "string",
      • "zipCode": "string",
      • "city": "string",
      • "origin": "string"

      }

    ]

  }

}

Response samples

• 201
• 400

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "personId": 0,
• "organizationId": 0,
• "isEnabled": true,
• "externalKey": "string",
• "language": "string",
• "email": "string",
• "phone": "string",
• "fax": "string",
• "address": "string",
• "zipCode": "string",
• "city": "string",
• "countryCode": "string",
• "acceptsAdvertisement": true,
• "lastLoginStamp": "2019-08-24T14:15:22Z",
• "loginCount": 0,
• "inactivityState": "Active",
• "isFlaggedForDeletion": true,
• "gracePeriodEndDate": "2019-08-24T14:15:22Z",
• "person": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "accountId": 0,
  • "firstname": "string",
  • "lastname": "string",
  • "gender": "Unknown",
  • "ahvNumber": "string",
  • "mobilePhone": "string",
  • "birthdate": "2019-08-24T14:15:22Z",
  • "maritalStatusId": 0,
  • "maritalStatus": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "isEnabled": true,
    • "sortOrder": 0

    },
  • "account": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "username": "string",
    • "password": "string",
    • "sessionDuration": 0,
    • "isSignupComplete": true,
    • "isLocal": true,
    • "hasSeenOwnProfile": true,
    • "identities": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "identityProviderId": 0,
        • "accountId": 0,
        • "identificationLevelId": 0,
        • "externalId": "string",
        • "profileId": 0,
        • "metadata": {

          • "property1": "string",
          • "property2": "string"

          }

        }

      ]

    }

  },
• "organization": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "uid": "string",
  • "fsoId": 0,
  • "website": "string",
  • "isSelfRegistration": true,
  • "identificationProcess": "string",
  • "isPending": true,
  • "createdByProfileId": 0,
  • "signatureType": "Unknown",
  • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
  • "orgCategoryId": 0,
  • "legalFormId": 0,
  • "orgIdentificationLevelId": 0,
  • "isDeletableByOwner": true,
  • "legalForm": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "code": "string",
    • "description": "string",
    • "isOrgDeletableByOwner": true

    },
  • "category": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "code": "string",
    • "description": "string",
    • "isVisible": true,
    • "isOrgDeletableByOwner": true,
    • "profilePictureUrl": "string",
    • "smallProfilePictureUrl": "string",
    • "daysUntilFirstDeletionReminder": 0,
    • "daysUntilSecondDeletionReminder": 0,
    • "daysUntilDeletion": 0

    },
  • "identificationLevel": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "levelOfTrust": 0,
    • "elevationServiceId": 0

    },
  • "signatories": [

    • {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "organizationId": 0,
      • "isRequester": true,
      • "type": "Signer",
      • "position": "string",
      • "gender": "Unknown",
      • "firstname": "string",
      • "lastname": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "email": "string",
      • "ahvNumber": "string",
      • "identityNumber": "string",
      • "address": "string",
      • "zipCode": "string",
      • "city": "string",
      • "origin": "string"

      }

    ]

  },
• "profilePicture": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "profileId": 0,
  • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
  • "customImageType": "string",
  • "customImageBytesEncoded": "string",
  • "defaultImageUrl": "string",
  • "defaultSmallImageUrl": "string"

  }

}

Delete filtered profiles

Allows to delete existing Profiles according to the selected filters.

Request Body schema:

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

obsoleteOlderThanNDays required

integer <int32> Number of days at which an obsolete profile should be removed

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles

Request samples

• Payload

Content type

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

{

• "obsoleteOlderThanNDays": 0

}

Get the specified Profile

Allows to retrieve a specific Profile identified by its Id.

path Parameters

profileId required

integer <int32>

query Parameters

IncludeCustomImageBytes	boolean
Expand	Array of strings (ProfileByIdExpand) Items Enum: "Person" "Person_MaritalStatus" "Person_Account" "Person_Account_Identities" "Organization" "Organization_LegalForm" "Organization_Category" "Organization_IdentificationLevel" "Organization_Signatories" "ProfilePicture"
Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "personId": 0,
• "organizationId": 0,
• "isEnabled": true,
• "externalKey": "string",
• "language": "string",
• "email": "string",
• "phone": "string",
• "fax": "string",
• "address": "string",
• "zipCode": "string",
• "city": "string",
• "countryCode": "string",
• "acceptsAdvertisement": true,
• "lastLoginStamp": "2019-08-24T14:15:22Z",
• "loginCount": 0,
• "inactivityState": "Active",
• "isFlaggedForDeletion": true,
• "gracePeriodEndDate": "2019-08-24T14:15:22Z",
• "person": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "accountId": 0,
  • "firstname": "string",
  • "lastname": "string",
  • "gender": "Unknown",
  • "ahvNumber": "string",
  • "mobilePhone": "string",
  • "birthdate": "2019-08-24T14:15:22Z",
  • "maritalStatusId": 0,
  • "maritalStatus": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "isEnabled": true,
    • "sortOrder": 0

    },
  • "account": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "username": "string",
    • "password": "string",
    • "sessionDuration": 0,
    • "isSignupComplete": true,
    • "isLocal": true,
    • "hasSeenOwnProfile": true,
    • "identities": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "identityProviderId": 0,
        • "accountId": 0,
        • "identificationLevelId": 0,
        • "externalId": "string",
        • "profileId": 0,
        • "metadata": {

          • "property1": "string",
          • "property2": "string"

          }

        }

      ]

    }

  },
• "organization": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "uid": "string",
  • "fsoId": 0,
  • "website": "string",
  • "isSelfRegistration": true,
  • "identificationProcess": "string",
  • "isPending": true,
  • "createdByProfileId": 0,
  • "signatureType": "Unknown",
  • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
  • "orgCategoryId": 0,
  • "legalFormId": 0,
  • "orgIdentificationLevelId": 0,
  • "isDeletableByOwner": true,
  • "legalForm": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "code": "string",
    • "description": "string",
    • "isOrgDeletableByOwner": true

    },
  • "category": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "code": "string",
    • "description": "string",
    • "isVisible": true,
    • "isOrgDeletableByOwner": true,
    • "profilePictureUrl": "string",
    • "smallProfilePictureUrl": "string",
    • "daysUntilFirstDeletionReminder": 0,
    • "daysUntilSecondDeletionReminder": 0,
    • "daysUntilDeletion": 0

    },
  • "identificationLevel": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "levelOfTrust": 0,
    • "elevationServiceId": 0

    },
  • "signatories": [

    • {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "organizationId": 0,
      • "isRequester": true,
      • "type": "Signer",
      • "position": "string",
      • "gender": "Unknown",
      • "firstname": "string",
      • "lastname": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "email": "string",
      • "ahvNumber": "string",
      • "identityNumber": "string",
      • "address": "string",
      • "zipCode": "string",
      • "city": "string",
      • "origin": "string"

      }

    ]

  },
• "profilePicture": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "profileId": 0,
  • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
  • "customImageType": "string",
  • "customImageBytesEncoded": "string",
  • "defaultImageUrl": "string",
  • "defaultSmallImageUrl": "string"

  }

}

Update partially the specified Profile

Allows to update partially an existing Profile (+person +account / +organization) identified by its Id.

When altering the category of an organization profile :

• Roles of the old category are removed from the organization profile
• Roles of the new category are added to the organization profile
• Roles that are both in the old and the new category are not affected for the organization profile
• Triggers an automated update of procuration services.

path Parameters

profileId required

integer <int32>

Request Body schema: application/merge-patch+json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
isEnabled	boolean Indicates if the profile is enabled (usable)
externalKey	string or null External unique key
email	string Contact email
language	string or null Preferred language (e.g. : EN)
phone	string or null Phone number
fax	string or null Fax number
address	string or null Address (with house number)
zipCode	string or null ZipCode of the city
city	string or null City
countryCode	string or null Country code (e.g. : CH)
acceptsAdvertisement	boolean Indicates if the profile accepts to receive advertisement
lastLoginStamp	string <date-time> Date and time of the last login
hasLoggedIn	boolean Indicates the user has logged in
inactivityState	string (InactivityState) Enum: "Active" "InactiveLevelOne" "InactiveLevelTwo" "InactiveLevelThree" State of inactivity of the profile
isFlaggedForDeletion	boolean Indicates if the profile is marked for deletion
gracePeriodEndDate	string or null <date-time> Date of the last day of the grace period
	object or null
	object or null

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}

Request samples

• Payload

Content type

application/merge-patch+json

{

• "updatedBy": "string",
• "isEnabled": true,
• "externalKey": "string",
• "email": "string",
• "language": "string",
• "phone": "string",
• "fax": "string",
• "address": "string",
• "zipCode": "string",
• "city": "string",
• "countryCode": "string",
• "acceptsAdvertisement": true,
• "lastLoginStamp": "2019-08-24T14:15:22Z",
• "hasLoggedIn": true,
• "inactivityState": "Active",
• "isFlaggedForDeletion": true,
• "gracePeriodEndDate": "2019-08-24T14:15:22Z",
• "person": {

  • "firstname": "string",
  • "lastname": "string",
  • "gender": "Unknown",
  • "ahvNumber": "string",
  • "mobilePhone": "string",
  • "birthdate": "2019-08-24T14:15:22Z",
  • "maritalStatusId": 0,
  • "account": {

    • "username": "string",
    • "password": "string",
    • "sessionDuration": 0,
    • "isSignupComplete": true,
    • "isLocal": true,
    • "hasSeenOwnProfile": true

    }

  },
• "organization": {

  • "name": "string",
  • "uid": "string",
  • "fsoId": 0,
  • "website": "string",
  • "orgCategoryId": 0,
  • "orgIdentificationLevelId": 0,
  • "identificationProcess": "string",
  • "legalFormId": 0,
  • "isSelfRegistration": true,
  • "createdByProfileId": 0,
  • "isPending": true,
  • "signatureType": "Unknown",
  • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf"

  }

}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Delete the specified Profile

Allows to delete an existing Profile identified by its Id.

path Parameters

profileId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Add/update the relation between the specified Identity Provider and Profile

Allows to create or update an Identity (relation between a person Profile and an Identity Provider).

path Parameters

profileId required	integer <int32>
identityProviderId required	integer <int32>

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
identificationLevelId	integer <int32> Id of the IdentificationLevel of this identity
externalId	string ExternalId given by the IDP (must be unique per IDP)
	object or null Dictionary of additional data

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/identity-providers/{identityProviderId}

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "identificationLevelId": 0,
• "externalId": "string",
• "metadata": {

  • "property1": "string",
  • "property2": "string"

  }

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "identityProviderId": 0,
• "accountId": 0,
• "identificationLevelId": 0,
• "externalId": "string",
• "profileId": 0,
• "metadata": {

  • "property1": "string",
  • "property2": "string"

  }

}

Delete the relation between the specified Identity Provider and Profile

Allows to delete an existing Identity identified by its Profile and Identity Provider identifiers.

path Parameters

profileId required	integer <int32>
identityProviderId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/identity-providers/{identityProviderId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get the list of Roles for the specified Profile

Allows to retrieve a list of Profile's Roles according to certain criteria.

path Parameters

profileId required

integer <int32>

query Parameters

Expand	Array of strings (RolesByProfileExpand) Items Value: "ProfileRole"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/roles

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "profileRole": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "roleId": 0,
    • "validityStartStamp": "2019-08-24T14:15:22Z"

    }

  }

]

Add/update the relation between the specified Role and Profile

Allows to create or update a Profile-Role relation.

Triggers an automated update of related procuration services.

path Parameters

profileId required	integer <int32>
roleId required	integer <int32>

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
validityStartStamp	string <date-time> Date indicating since when this relation is valid. Default value is now.

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/roles/{roleId}

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "validityStartStamp": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "profileId": 0,
• "roleId": 0,
• "validityStartStamp": "2019-08-24T14:15:22Z"

}

Get a specific Role within a specific Profile

Allows to retrieve a specific Role and its relation with a specific Profile

path Parameters

profileId required	integer <int32>
roleId required	integer <int32>

query Parameters

Expand	Array of strings (RoleByProfileAndIdExpand) Items Value: "ProfileRole"
Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/roles/{roleId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "profileRole": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "profileId": 0,
  • "roleId": 0,
  • "validityStartStamp": "2019-08-24T14:15:22Z"

  }

}

Delete the relation between the specified Role and Profile

Allows to delete an existing Profile-Role identified by its Profile and Role identifiers.

Triggers an automated update of related procuration services.

path Parameters

profileId required	integer <int32>
roleId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/roles/{roleId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get the list of Services for the specified Profile

Allows to retrieve the list of Services accessible (by rights) to a Profile according to certain criteria.

path Parameters

profileId required

integer <int32>

query Parameters

Ids	Array of integers <int32> [ items <int32 > ] Filters services on the Id field to match the provided ids
ServiceThemeId	integer <int32> Filters services on the ServiceThemeId field
ExternalId	string Filters services on the ExternalId field (exact match)
IsShownInCatalog	boolean Filters services on the IsShownInCatalog field
IsForProcurationManagementView	boolean Filters services on the IsProcurationAvailable field and also disable the anonymous role access path
IsNew	boolean Filters services on the IsNew field
UrlContains	string Filters services on the Url field (CI, contains)
HasVisibleServiceRole	boolean Filters services to keep only the ones that are accessible to the profile within a service-role with given IsVisible value
HasVisibleTheme	boolean Filters services on the ServiceTheme.IsVisible field
IsFavorite	boolean Filters services according if set or not as favourite by this profile
Expand	Array of strings (ServicesByProfileExpand) Items Enum: "ServiceTheme" "IdentificationLevel" "OrgIdentificationLevel" "ProfileRoles" "ServiceClients" "Survey" "FavoriteService"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/services

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "name": "string",
  • "displayName": "string",
  • "identificationLevelId": 0,
  • "orgIdentificationLevelId": 0,
  • "serviceThemeId": 0,
  • "iconPath": "string",
  • "cssClass": "string",
  • "url": "string",
  • "urlTarget": "Self",
  • "jiraProjectId": "string",
  • "isProcurationAvailable": true,
  • "isInMaintenance": true,
  • "isShownInCatalog": true,
  • "isExternal": true,
  • "isAccessible": true,
  • "isResponsive": true,
  • "isNew": true,
  • "isNavigationShown": true,
  • "isSupportAvailable": true,
  • "subThemeKey": "string",
  • "isProfileManagerAvailable": true,
  • "daysUntilReminder": 0,
  • "serviceTheme": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "isVisible": true,
    • "sortOrder": 0

    },
  • "serviceClients": [

    • {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "serviceId": 0,
      • "clientId": 0

      }

    ],
  • "identificationLevel": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "levelOfTrust": 0

    },
  • "orgIdentificationLevel": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "levelOfTrust": 0,
    • "elevationServiceId": 0

    },
  • "survey": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "serviceId": 0,
    • "surveyUrl": "string",
    • "isRandomFeedbackEnabled": true,
    • "isSpontaneousFeedbackEnabled": true,
    • "rF_ActivationChance": 0,
    • "rF_MinDaysAfterRefused": 0,
    • "rF_MinDaysAfterAccepted": 0,
    • "sF_MinDaysAfterAccepted": 0

    },
  • "profileRoles": [

    • {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "profileId": 0,
      • "roleId": 0,
      • "validityStartStamp": "2019-08-24T14:15:22Z"

      }

    ],
  • "favoriteService": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "representativeProfileId": 0,
    • "delegatorProfileId": 0,
    • "serviceId": 0,
    • "sortOrder": 0

    }

  }

]

Get the the specified Service for the specified Profile

Allows to retrieve a specific Service when it is accessible (by rights) by the specified Profile.

path Parameters

profileId required	integer <int32>
serviceId required	integer <int32>

query Parameters

Expand	Array of strings (ServiceByProfileExpand) Items Enum: "ServiceTheme" "IdentificationLevel" "OrgIdentificationLevel" "ProfileRoles" "ServiceClients" "Survey"
Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/services/{serviceId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "externalId": "string",
• "name": "string",
• "displayName": "string",
• "identificationLevelId": 0,
• "orgIdentificationLevelId": 0,
• "serviceThemeId": 0,
• "iconPath": "string",
• "cssClass": "string",
• "url": "string",
• "urlTarget": "Self",
• "jiraProjectId": "string",
• "isProcurationAvailable": true,
• "isInMaintenance": true,
• "isShownInCatalog": true,
• "isExternal": true,
• "isAccessible": true,
• "isResponsive": true,
• "isNew": true,
• "isNavigationShown": true,
• "isSupportAvailable": true,
• "subThemeKey": "string",
• "isProfileManagerAvailable": true,
• "daysUntilReminder": 0,
• "serviceTheme": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "isVisible": true,
  • "sortOrder": 0

  },
• "serviceClients": [

  • {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "serviceId": 0,
    • "clientId": 0

    }

  ],
• "identificationLevel": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "levelOfTrust": 0

  },
• "orgIdentificationLevel": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "levelOfTrust": 0,
  • "elevationServiceId": 0

  },
• "survey": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "serviceId": 0,
  • "surveyUrl": "string",
  • "isRandomFeedbackEnabled": true,
  • "isSpontaneousFeedbackEnabled": true,
  • "rF_ActivationChance": 0,
  • "rF_MinDaysAfterRefused": 0,
  • "rF_MinDaysAfterAccepted": 0,
  • "sF_MinDaysAfterAccepted": 0

  },
• "profileRoles": [

  • {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "roleId": 0,
    • "validityStartStamp": "2019-08-24T14:15:22Z"

    }

  ],
• "favoriteService": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "profileId": 0,
  • "representativeProfileId": 0,
  • "delegatorProfileId": 0,
  • "serviceId": 0,
  • "sortOrder": 0

  }

}

Get the list of agreed Services for the specified Profile's Outbound Procuration

Allows to retrieve a list of Agreed Services within a Profile's Outbound Procuration according to certain criteria.

path Parameters

principalProfileId required	integer <int32>
representativeProfileId required	integer <int32>

query Parameters

DelegatorProfileId	integer <int32> Id of the profile who delegated the procuration
Ids	Array of integers <int32> [ items <int32 > ] Filters services on the Id field to match the provided ids
ServiceThemeId	integer <int32> Filters services on the ServiceThemeId field
ExternalId	string Filters services on the ExternalId field (exact match)
UrlContains	string Filters services on the Url field (CI, contains)
HasVisibleTheme	boolean Filters services on the ServiceTheme.IsVisible field
IsShownInCatalog	boolean Filters services on the IsShownInCatalog field
IsNew	boolean Filters services on the IsNew field
IsFavorite	boolean Filters services according if set or not as favourite by this procuration
HasVisibleServiceRole	boolean Filters services to keep only the ones that are accessible to the principal profile within a service-role with given IsVisible value
Expand	Array of strings (ServicesByProcurationKeysExpand) Items Enum: "ServiceTheme" "IdentificationLevel" "OrgIdentificationLevel" "ProcurationService" "ServiceClients" "Survey" "FavoriteService"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles/{principalProfileId}/outbound-procurations/to/{representativeProfileId}/services

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "name": "string",
  • "displayName": "string",
  • "identificationLevelId": 0,
  • "orgIdentificationLevelId": 0,
  • "serviceThemeId": 0,
  • "iconPath": "string",
  • "cssClass": "string",
  • "url": "string",
  • "urlTarget": "Self",
  • "jiraProjectId": "string",
  • "isProcurationAvailable": true,
  • "isInMaintenance": true,
  • "isShownInCatalog": true,
  • "isExternal": true,
  • "isAccessible": true,
  • "isResponsive": true,
  • "isNew": true,
  • "isNavigationShown": true,
  • "isSupportAvailable": true,
  • "subThemeKey": "string",
  • "isProfileManagerAvailable": true,
  • "daysUntilReminder": 0,
  • "serviceTheme": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "isVisible": true,
    • "sortOrder": 0

    },
  • "serviceClients": [

    • {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "serviceId": 0,
      • "clientId": 0

      }

    ],
  • "identificationLevel": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "levelOfTrust": 0

    },
  • "orgIdentificationLevel": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "levelOfTrust": 0,
    • "elevationServiceId": 0

    },
  • "survey": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "serviceId": 0,
    • "surveyUrl": "string",
    • "isRandomFeedbackEnabled": true,
    • "isSpontaneousFeedbackEnabled": true,
    • "rF_ActivationChance": 0,
    • "rF_MinDaysAfterRefused": 0,
    • "rF_MinDaysAfterAccepted": 0,
    • "sF_MinDaysAfterAccepted": 0

    },
  • "procurationService": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "procurationId": 0,
    • "serviceId": 0,
    • "validityStartStamp": "2019-08-24T14:15:22Z"

    },
  • "favoriteService": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "representativeProfileId": 0,
    • "delegatorProfileId": 0,
    • "serviceId": 0,
    • "sortOrder": 0

    }

  }

]

Add all missing possible Service relations (ProcurationService) for the specified Procuration

Allows to create all missing Procuration-Service links for the specified Procuration.

path Parameters

principalProfileId required	integer <int32> Id of the principal profile linked to the procuration
representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration

Request Body schema: application/json

Item options

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
validityStartStamp	string <date-time> Date indicating since when this relation is valid. Default value is now.

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{principalProfileId}/outbound-procurations/to/{representativeProfileId}/services

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "validityStartStamp": "2019-08-24T14:15:22Z"

}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Get the list of accessible Services for the specified Profile's Inbound Procuration

Allows to retrieve a list of accessible (by rights) Services within a Profile's Inbound Procuration according to certain criteria.

path Parameters

representativeProfileId required	integer <int32>
principalProfileId required	integer <int32>

query Parameters

DelegatorProfileId	integer <int32> Id of the profile who delegated the procuration
Ids	Array of integers <int32> [ items <int32 > ] Filters services on the Id field to match the provided ids
ServiceThemeId	integer <int32> Filters services on the ServiceThemeId field
ExternalId	string Filters services on the ExternalId field (exact match)
UrlContains	string Filters services on the Url field (CI, contains)
HasVisibleTheme	boolean Filters services on the ServiceTheme.IsVisible field
IsShownInCatalog	boolean Filters services on the IsShownInCatalog field
IsNew	boolean Filters services on the IsNew field
IsFavorite	boolean Filters services according if set or not as favourite by this procuration
HasVisibleServiceRole	boolean Filters services to keep only the ones that are accessible to the principal profile within a service-role with given IsVisible value
Expand	Array of strings (ServicesByProcurationKeysExpand) Items Enum: "ServiceTheme" "IdentificationLevel" "OrgIdentificationLevel" "ProcurationService" "ServiceClients" "Survey" "FavoriteService"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles/{representativeProfileId}/inbound-procurations/from/{principalProfileId}/services

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "name": "string",
  • "displayName": "string",
  • "identificationLevelId": 0,
  • "orgIdentificationLevelId": 0,
  • "serviceThemeId": 0,
  • "iconPath": "string",
  • "cssClass": "string",
  • "url": "string",
  • "urlTarget": "Self",
  • "jiraProjectId": "string",
  • "isProcurationAvailable": true,
  • "isInMaintenance": true,
  • "isShownInCatalog": true,
  • "isExternal": true,
  • "isAccessible": true,
  • "isResponsive": true,
  • "isNew": true,
  • "isNavigationShown": true,
  • "isSupportAvailable": true,
  • "subThemeKey": "string",
  • "isProfileManagerAvailable": true,
  • "daysUntilReminder": 0,
  • "serviceTheme": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "isVisible": true,
    • "sortOrder": 0

    },
  • "serviceClients": [

    • {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "serviceId": 0,
      • "clientId": 0

      }

    ],
  • "identificationLevel": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "levelOfTrust": 0

    },
  • "orgIdentificationLevel": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "levelOfTrust": 0,
    • "elevationServiceId": 0

    },
  • "survey": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "serviceId": 0,
    • "surveyUrl": "string",
    • "isRandomFeedbackEnabled": true,
    • "isSpontaneousFeedbackEnabled": true,
    • "rF_ActivationChance": 0,
    • "rF_MinDaysAfterRefused": 0,
    • "rF_MinDaysAfterAccepted": 0,
    • "sF_MinDaysAfterAccepted": 0

    },
  • "procurationService": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "procurationId": 0,
    • "serviceId": 0,
    • "validityStartStamp": "2019-08-24T14:15:22Z"

    },
  • "favoriteService": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "representativeProfileId": 0,
    • "delegatorProfileId": 0,
    • "serviceId": 0,
    • "sortOrder": 0

    }

  }

]

Get the Agreed Service for the specified Outbound Procuration and Service

Allows to retrieve a specific Agreed Service identified by its Outbound Procuration and Service identifiers.

path Parameters

principalProfileId required	integer <int32>
representativeProfileId required	integer <int32>
serviceId required	integer <int32>

query Parameters

DelegatorProfileId	integer <int32> Id of the profile who delegated the procuration
Expand	Array of strings (ServiceByProcurationAndServiceExpand) Items Enum: "ServiceTheme" "IdentificationLevel" "OrgIdentificationLevel" "ProcurationService" "ServiceClients" "Survey"
Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{principalProfileId}/outbound-procurations/to/{representativeProfileId}/services/{serviceId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "externalId": "string",
• "name": "string",
• "displayName": "string",
• "identificationLevelId": 0,
• "orgIdentificationLevelId": 0,
• "serviceThemeId": 0,
• "iconPath": "string",
• "cssClass": "string",
• "url": "string",
• "urlTarget": "Self",
• "jiraProjectId": "string",
• "isProcurationAvailable": true,
• "isInMaintenance": true,
• "isShownInCatalog": true,
• "isExternal": true,
• "isAccessible": true,
• "isResponsive": true,
• "isNew": true,
• "isNavigationShown": true,
• "isSupportAvailable": true,
• "subThemeKey": "string",
• "isProfileManagerAvailable": true,
• "daysUntilReminder": 0,
• "serviceTheme": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "isVisible": true,
  • "sortOrder": 0

  },
• "serviceClients": [

  • {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "serviceId": 0,
    • "clientId": 0

    }

  ],
• "identificationLevel": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "levelOfTrust": 0

  },
• "orgIdentificationLevel": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "levelOfTrust": 0,
  • "elevationServiceId": 0

  },
• "survey": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "serviceId": 0,
  • "surveyUrl": "string",
  • "isRandomFeedbackEnabled": true,
  • "isSpontaneousFeedbackEnabled": true,
  • "rF_ActivationChance": 0,
  • "rF_MinDaysAfterRefused": 0,
  • "rF_MinDaysAfterAccepted": 0,
  • "sF_MinDaysAfterAccepted": 0

  },
• "procurationService": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "procurationId": 0,
  • "serviceId": 0,
  • "validityStartStamp": "2019-08-24T14:15:22Z"

  },
• "favoriteService": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "profileId": 0,
  • "representativeProfileId": 0,
  • "delegatorProfileId": 0,
  • "serviceId": 0,
  • "sortOrder": 0

  }

}

Add/update the relation (ProcurationService) between the specified Service and Procuration

Allows to create or update a Procuration-Service link.

path Parameters

principalProfileId required	integer <int32> Id of the principal profile linked to the procuration
representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration
serviceId required	integer <int32> Id of the service to add to the procuration

query Parameters

delegatorProfileId

integer <int32> Id of the delegator profile linked to the procuration

Request Body schema: application/json

Item to create/update

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
validityStartStamp	string <date-time> Date indicating since when this relation is valid. Default value is now.

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{principalProfileId}/outbound-procurations/to/{representativeProfileId}/services/{serviceId}

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "validityStartStamp": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "procurationId": 0,
• "serviceId": 0,
• "validityStartStamp": "2019-08-24T14:15:22Z"

}

Delete the relation (ProcurationService) between the specified Outbound Procuration and Service

Allows to delete an existing Procuration-Service identified by its Outbound Procuration and Service identifiers.

path Parameters

principalProfileId required	integer <int32> Id of the principal profile linked to the procuration
representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration
serviceId required	integer <int32> Id of the service to add to the procuration

query Parameters

delegatorProfileId

integer <int32> Id of the delegator profile linked to the procuration

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{principalProfileId}/outbound-procurations/to/{representativeProfileId}/services/{serviceId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get the accessible Service for the specified inbound Procuration and Service

Allows to retrieve a specific accessible (by rights) Service identified by its Inbound Procuration and Service identifiers.

path Parameters

representativeProfileId required	integer <int32>
principalProfileId required	integer <int32>
serviceId required	integer <int32>

query Parameters

DelegatorProfileId	integer <int32> Id of the profile who delegated the procuration
Expand	Array of strings (ServiceByProcurationAndServiceExpand) Items Enum: "ServiceTheme" "IdentificationLevel" "OrgIdentificationLevel" "ProcurationService" "ServiceClients" "Survey"
Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{representativeProfileId}/inbound-procurations/from/{principalProfileId}/services/{serviceId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "externalId": "string",
• "name": "string",
• "displayName": "string",
• "identificationLevelId": 0,
• "orgIdentificationLevelId": 0,
• "serviceThemeId": 0,
• "iconPath": "string",
• "cssClass": "string",
• "url": "string",
• "urlTarget": "Self",
• "jiraProjectId": "string",
• "isProcurationAvailable": true,
• "isInMaintenance": true,
• "isShownInCatalog": true,
• "isExternal": true,
• "isAccessible": true,
• "isResponsive": true,
• "isNew": true,
• "isNavigationShown": true,
• "isSupportAvailable": true,
• "subThemeKey": "string",
• "isProfileManagerAvailable": true,
• "daysUntilReminder": 0,
• "serviceTheme": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "isVisible": true,
  • "sortOrder": 0

  },
• "serviceClients": [

  • {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "serviceId": 0,
    • "clientId": 0

    }

  ],
• "identificationLevel": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "levelOfTrust": 0

  },
• "orgIdentificationLevel": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "levelOfTrust": 0,
  • "elevationServiceId": 0

  },
• "survey": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "serviceId": 0,
  • "surveyUrl": "string",
  • "isRandomFeedbackEnabled": true,
  • "isSpontaneousFeedbackEnabled": true,
  • "rF_ActivationChance": 0,
  • "rF_MinDaysAfterRefused": 0,
  • "rF_MinDaysAfterAccepted": 0,
  • "sF_MinDaysAfterAccepted": 0

  },
• "procurationService": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "procurationId": 0,
  • "serviceId": 0,
  • "validityStartStamp": "2019-08-24T14:15:22Z"

  },
• "favoriteService": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "profileId": 0,
  • "representativeProfileId": 0,
  • "delegatorProfileId": 0,
  • "serviceId": 0,
  • "sortOrder": 0

  }

}

Get the list of Themes for the specified Profile's Services

Allows to retrieve a list of Profile's Services Themes (by rights) according to certain criteria.

path Parameters

profileId required

integer <int32>

query Parameters

IsVisible	boolean Filters themes on the IsVisible field
IsForProcurationManagementView	boolean Filters services on the IsProcurationAvailable field and also disable the anonymous role access path
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/services/themes

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "isVisible": true,
  • "sortOrder": 0

  }

]

Get the list of configured Service Settings (and their Values) for the specified Profile

Allows to retrieve a list of Profile's configured Service Settings (and their Values) according to certain criteria.

path Parameters

profileId required

integer <int32>

query Parameters

ServiceId	integer <int32> Filters settings on the ServiceId field
Name	string Filters settings on the Name field (CI match)
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/service-settings

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "serviceId": 0,
  • "isSecure": true,
  • "serviceSettingValue": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "serviceSettingId": 0,
    • "value": "string"

    }

  }

]

Get the configured Service Setting (and its Value) for the specified Profile

Allows to retrieve a specific configured Service Setting (and its Value) identified by its Profile and Service Setting identifiers.

path Parameters

profileId required	integer <int32>
settingId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/service-settings/{settingId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "serviceId": 0,
• "isSecure": true,
• "serviceSettingValue": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "profileId": 0,
  • "serviceSettingId": 0,
  • "value": "string"

  }

}

Add/update the specified Service Setting Value for the specified Profile

Allows to create or update a Service Setting Value for a Profile.

path Parameters

profileId required	integer <int32>
settingId required	integer <int32>

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
value	string Value affected to the setting for the profile

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/service-settings/{settingId}

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "value": "string"

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "profileId": 0,
• "serviceSettingId": 0,
• "value": "string"

}

Delete the specified Service Setting Value from the specified Profile

Allows to delete an existing Service Setting Value identified by its Profile and Service Setting identifiers.

path Parameters

profileId required	integer <int32>
settingId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/service-settings/{settingId}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Create a new Procuration (outbound) from the specified Profile (principal) with another specified Profile (representative)

Allows to create a new Outbound Procuration bewteen a Principal Profile and a Representative Profile.

path Parameters

principalProfileId required	integer <int32> Id of the principal profile linked to the procuration to insert
representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration to insert

query Parameters

delegatorProfileId

integer <int32> Id of the delegator profile linked to the procuration to insert

Request Body schema: application/json

Item to create

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
validityStartStamp	string <date-time> Date indicating since when this relation is valid. Default value is now.
personInOrganizationFunction	string or null (OrgFunction) Enum: "Collaborator" "DelegationManager" "Manager" "Owner" Representative's function within the organization. Only usable when the PrincipalProfile is an organization and the RepresentativeProfile is a person within this organization.
isPersonInOrganizationPendingDelete	boolean Default: false Defines if the representative is in the process of being removed from the organization. Only usable when the PrincipalProfile is an organization and the RepresentativeProfile is an owner of the said organization.
representativeEmail	string or null Email to notify the representative in the context of the procuration. Only usable when the PrincipalProfile is an organization and the RepresentativeProfile is a person within this organization.
delegationMode	string or null (DelegationMode) Enum: "Unitary" "Global" Procuration delegation mode to define how rights can be shared with organization members. Only available when RepresentativeProfile is an organization.

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{principalProfileId}/outbound-procurations/to/{representativeProfileId}

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "validityStartStamp": "2019-08-24T14:15:22Z",
• "personInOrganizationFunction": "Collaborator",
• "isPersonInOrganizationPendingDelete": false,
• "representativeEmail": "string",
• "delegationMode": "Unitary"

}

Response samples

• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "principalProfileId": 0,
• "delegatorProfileId": 0,
• "representativeProfileId": 0,
• "validityStartStamp": "2019-08-24T14:15:22Z",
• "validityEndStamp": "2019-08-24T14:15:22Z",
• "renewableFromDate": "2019-08-24T14:15:22Z",
• "removalDate": "2019-08-24T14:15:22Z",
• "renewalState": "Active",
• "isRenewable": true,
• "isUsable": true,
• "representativeEmail": "string",
• "personInOrganizationFunction": "Collaborator",
• "isPersonInOrganizationPendingDelete": true,
• "delegationMode": "Unitary"

}

Add/update the specified Oubtbound Procuration for the specified Profile with another Profile Deprecated

Allows to create/update an Outbound Procuration bewteen a Principal Profile and a Representative Profile.

When representative is set as owner or manager (for org. to private proc. only), triggers an automated update of related procuration services.

path Parameters

principalProfileId required	integer <int32> Id of the principal profile linked to the procuration to insert/update
representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration to insert/update

query Parameters

delegatorProfileId

integer <int32> Id of the delegator profile linked to the procuration to insert/update

Request Body schema: application/json

Item to create/update

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
validityStartStamp	string <date-time> Date indicating since when this relation is valid. Default value is now.
personInOrganizationFunction	string or null (OrgFunction) Enum: "Collaborator" "DelegationManager" "Manager" "Owner" Representative's function within the organization. Only usable when the PrincipalProfile is an organization and the RepresentativeProfile is a person within this organization.
isPersonInOrganizationPendingDelete	boolean Default: false Defines if the representative is in the process of being removed from the organization. Only usable when the PrincipalProfile is an organization and the RepresentativeProfile is an owner of the said organization.
representativeEmail	string or null Email to notify the representative in the context of the procuration. Only usable when the PrincipalProfile is an organization and the RepresentativeProfile is a person within this organization.
delegationMode	string or null (DelegationMode) Enum: "Unitary" "Global" Procuration delegation mode to define how rights can be shared with organization members. Only available when RepresentativeProfile is an organization.

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{principalProfileId}/outbound-procurations/to/{representativeProfileId}

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "validityStartStamp": "2019-08-24T14:15:22Z",
• "personInOrganizationFunction": "Collaborator",
• "isPersonInOrganizationPendingDelete": false,
• "representativeEmail": "string",
• "delegationMode": "Unitary"

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "principalProfileId": 0,
• "delegatorProfileId": 0,
• "representativeProfileId": 0,
• "validityStartStamp": "2019-08-24T14:15:22Z",
• "validityEndStamp": "2019-08-24T14:15:22Z",
• "renewableFromDate": "2019-08-24T14:15:22Z",
• "removalDate": "2019-08-24T14:15:22Z",
• "renewalState": "Active",
• "isRenewable": true,
• "isUsable": true,
• "representativeEmail": "string",
• "personInOrganizationFunction": "Collaborator",
• "isPersonInOrganizationPendingDelete": true,
• "delegationMode": "Unitary"

}

Update partially a specific outbound Procuration

Allows to update partially an existing outbound Procuration bewteen a Principal Profile and a Representative Profile.

path Parameters

principalProfileId required	integer <int32> Id of the principal profile linked to the outbound procuration to update
representativeProfileId required	integer <int32> Id of the representative profile linked to the outbound procuration to update

query Parameters

delegatorProfileId

integer <int32> Id of the delegator profile linked to the outbound procuration to update

Request Body schema: application/merge-patch+json

Update to apply to the procuration

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
validityStartStamp	string <date-time> Date indicating since when this relation is valid. Default value is now.
	object or null Representative's function within the organization. Only usable when the PrincipalProfile is an organization and the RepresentativeProfile is a person within this organization.
isPersonInOrganizationPendingDelete	boolean Defines if the representative is in the process of being removed from the organization. Only usable when the PrincipalProfile is an organization and the RepresentativeProfile is an owner of the said organization.
hasBeenRenewed	boolean Indicates if the procuration has been renewed by the principal to update the renewal stamps (incl. expiration).
	object State of renewal of the procuration

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{principalProfileId}/outbound-procurations/to/{representativeProfileId}

Request samples

• Payload

Content type

application/merge-patch+json

{

• "updatedBy": "string",
• "validityStartStamp": "2019-08-24T14:15:22Z",
• "personInOrganizationFunction": {

  • "isValuePresent": true,
  • "value": "Collaborator"

  },
• "isPersonInOrganizationPendingDelete": true,
• "hasBeenRenewed": true,
• "renewalState": {

  • "isValuePresent": true,
  • "value": "Active"

  }

}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Delete the specified Outbound Procuration for the specified Profile with another Profile

Allows to delete an existing Outbound Procuration identified by its Principal Profile and Representative Profile identifiers.

path Parameters

principalProfileId required	integer <int32> Id of the principal profile linked to the procuration to delete
representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration to delete

query Parameters

delegatorProfileId

integer <int32> Id of the delegator profile linked to the procuration to delete

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{principalProfileId}/outbound-procurations/to/{representativeProfileId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get the Profile's Outbound Procuration with the specified other Profile

Allows to retrieve a specific Procuration identified by its Principal Profile and Representative Profile identifiers.

path Parameters

principalProfileId required	integer <int32> Id of the principal profile linked to the procuration
representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration

query Parameters

DelegatorProfileId	integer <int32> Id of the profile who delegated the procuration
Expand	Array of strings (ProcurationsExpand) Items Enum: "PrincipalProfile" "RepresentativeProfile" "DelegatorProfile" "PrincipalProfile_Person" "RepresentativeProfile_Person" "PrincipalProfile_Organization" "RepresentativeProfile_Organization" "DelegatorProfile_Organization" "PrincipalProfile_ProfilePicture" "RepresentativeProfile_ProfilePicture" "ProcurationServices" "ProcurationInvite"
Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{principalProfileId}/outbound-procurations/to/{representativeProfileId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "principalProfileId": 0,
• "delegatorProfileId": 0,
• "representativeProfileId": 0,
• "validityStartStamp": "2019-08-24T14:15:22Z",
• "validityEndStamp": "2019-08-24T14:15:22Z",
• "renewableFromDate": "2019-08-24T14:15:22Z",
• "removalDate": "2019-08-24T14:15:22Z",
• "renewalState": "Active",
• "isRenewable": true,
• "isUsable": true,
• "representativeEmail": "string",
• "personInOrganizationFunction": "Collaborator",
• "isPersonInOrganizationPendingDelete": true,
• "delegationMode": "Unitary",
• "principalProfile": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  },
• "representativeProfile": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  },
• "delegatorProfile": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  },
• "procurationServices": [

  • {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "procurationId": 0,
    • "serviceId": 0,
    • "validityStartStamp": "2019-08-24T14:15:22Z"

    }

  ],
• "procurationInvite": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "principalProfileId": 0,
  • "representativeProfileId": 0,
  • "description": "string",
  • "token": "string",
  • "expirationStamp": "2019-08-24T14:15:22Z",
  • "consumptionStamp": "2019-08-24T14:15:22Z",
  • "isReadyForApproval": true,
  • "isApproved": true,
  • "approvalStamp": "2019-08-24T14:15:22Z",
  • "messageToPrincipal": "string",
  • "principalBusinessCaseId": "808c1d0d-2079-4fb2-885b-7f647593bcd3",
  • "representativeBusinessCaseId": "b4d6eca0-7435-4b01-8444-d51a1c3eefcd",
  • "representativeEmail": "string",
  • "serviceIds": [

    • 0

    ],
  • "consumerInOrgFirstname": "string",
  • "consumerInOrgLastname": "string",
  • "consumerInOrgProfileId": 0

  }

}

Update partially a specific inbound Procuration

Allows to update partially an existing inbound Procuration bewteen a Principal Profile and a Representative Profile.

path Parameters

principalProfileId required	integer <int32> Id of the principal profile linked to the inbound procuration to update
representativeProfileId required	integer <int32> Id of the representative profile linked to the inbound procuration to update

query Parameters

delegatorProfileId

integer <int32> Id of the delegator profile linked to the inbound procuration to update

Request Body schema: application/merge-patch+json

Update to apply to the procuration

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
representativeEmail	string or null Email to notify the representative in the context of the procuration. Only usable when the PrincipalProfile is an organization and the RepresentativeProfile is a person within this organization.
	object or null Procuration delegation mode to define how rights can be shared with organization members. Only available when RepresentativeProfile is an organization.

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{representativeProfileId}/inbound-procurations/from/{principalProfileId}

Request samples

• Payload

Content type

application/merge-patch+json

{

• "updatedBy": "string",
• "representativeEmail": "string",
• "delegationMode": {

  • "isValuePresent": true,
  • "value": "Unitary"

  }

}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Delete the specified Inbound Procuration for the specified Profile with another Profile

Allows to delete an existing Inbound Procuration identified by its Representative Profile and Principal Profile identifiers.

path Parameters

representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration to delete
principalProfileId required	integer <int32> Id of the principal profile linked to the procuration to delete

query Parameters

delegatorProfileId

integer <int32> Id of the delegator profile linked to the procuration to delete

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{representativeProfileId}/inbound-procurations/from/{principalProfileId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get the Profile's Inbound Procuration with the specified other Profile

Allows to retrieve a specific Procuration identified by its Representative Profile and Principal Profile identifiers.

path Parameters

representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration
principalProfileId required	integer <int32> Id of the principal profile linked to the procuration

query Parameters

DelegatorProfileId	integer <int32> Id of the profile who delegated the procuration
Expand	Array of strings (ProcurationsExpand) Items Enum: "PrincipalProfile" "RepresentativeProfile" "DelegatorProfile" "PrincipalProfile_Person" "RepresentativeProfile_Person" "PrincipalProfile_Organization" "RepresentativeProfile_Organization" "DelegatorProfile_Organization" "PrincipalProfile_ProfilePicture" "RepresentativeProfile_ProfilePicture" "ProcurationServices" "ProcurationInvite"
Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{representativeProfileId}/inbound-procurations/from/{principalProfileId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "principalProfileId": 0,
• "delegatorProfileId": 0,
• "representativeProfileId": 0,
• "validityStartStamp": "2019-08-24T14:15:22Z",
• "validityEndStamp": "2019-08-24T14:15:22Z",
• "renewableFromDate": "2019-08-24T14:15:22Z",
• "removalDate": "2019-08-24T14:15:22Z",
• "renewalState": "Active",
• "isRenewable": true,
• "isUsable": true,
• "representativeEmail": "string",
• "personInOrganizationFunction": "Collaborator",
• "isPersonInOrganizationPendingDelete": true,
• "delegationMode": "Unitary",
• "principalProfile": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  },
• "representativeProfile": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  },
• "delegatorProfile": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  },
• "procurationServices": [

  • {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "procurationId": 0,
    • "serviceId": 0,
    • "validityStartStamp": "2019-08-24T14:15:22Z"

    }

  ],
• "procurationInvite": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "principalProfileId": 0,
  • "representativeProfileId": 0,
  • "description": "string",
  • "token": "string",
  • "expirationStamp": "2019-08-24T14:15:22Z",
  • "consumptionStamp": "2019-08-24T14:15:22Z",
  • "isReadyForApproval": true,
  • "isApproved": true,
  • "approvalStamp": "2019-08-24T14:15:22Z",
  • "messageToPrincipal": "string",
  • "principalBusinessCaseId": "808c1d0d-2079-4fb2-885b-7f647593bcd3",
  • "representativeBusinessCaseId": "b4d6eca0-7435-4b01-8444-d51a1c3eefcd",
  • "representativeEmail": "string",
  • "serviceIds": [

    • 0

    ],
  • "consumerInOrgFirstname": "string",
  • "consumerInOrgLastname": "string",
  • "consumerInOrgProfileId": 0

  }

}

Get the list of Profile's Inbound Procurations

Allows to retrieve a list of Profile's Inbound Procurations according to certain criteria.

path Parameters

profileId required

integer <int32> Id of the representative profile linked to the procurations

query Parameters

PrincipalProfileId	integer <int32> Id of the profile who is represented through the procurations
DelegatorProfileId	integer <int32> Id of the profile who delegated the procurations. When provided, parameter IncludeDelegations is ignored. Value -1 can be used as joker to only keep delegated procurations.
IncludeDelegations	boolean Filters inbound procurations to include/filter out those having or not a delegator profile. By default, delegated procurations are not included and only base procurations are returned.
HasAccessToServiceId	integer <int32> Id of a service to which the procurations must have access
IncludeCustomImageBytes	boolean
Expand	Array of strings (InboundProcurationsByProfileExpand) Items Enum: "PrincipalProfile" "RepresentativeProfile" "DelegatorProfile" "PrincipalProfile_Person" "RepresentativeProfile_Person" "PrincipalProfile_Organization" "RepresentativeProfile_Organization" "DelegatorProfile_Organization" "PrincipalProfile_ProfilePicture" "RepresentativeProfile_ProfilePicture" "ProcurationServices" "ProcurationInvite"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/inbound-procurations

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "principalProfileId": 0,
  • "delegatorProfileId": 0,
  • "representativeProfileId": 0,
  • "validityStartStamp": "2019-08-24T14:15:22Z",
  • "validityEndStamp": "2019-08-24T14:15:22Z",
  • "renewableFromDate": "2019-08-24T14:15:22Z",
  • "removalDate": "2019-08-24T14:15:22Z",
  • "renewalState": "Active",
  • "isRenewable": true,
  • "isUsable": true,
  • "representativeEmail": "string",
  • "personInOrganizationFunction": "Collaborator",
  • "isPersonInOrganizationPendingDelete": true,
  • "delegationMode": "Unitary",
  • "principalProfile": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "personId": 0,
    • "organizationId": 0,
    • "isEnabled": true,
    • "externalKey": "string",
    • "language": "string",
    • "email": "string",
    • "phone": "string",
    • "fax": "string",
    • "address": "string",
    • "zipCode": "string",
    • "city": "string",
    • "countryCode": "string",
    • "acceptsAdvertisement": true,
    • "lastLoginStamp": "2019-08-24T14:15:22Z",
    • "loginCount": 0,
    • "inactivityState": "Active",
    • "isFlaggedForDeletion": true,
    • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
    • "person": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "accountId": 0,
      • "firstname": "string",
      • "lastname": "string",
      • "gender": "Unknown",
      • "ahvNumber": "string",
      • "mobilePhone": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "maritalStatusId": 0,
      • "maritalStatus": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "isEnabled": true,
        • "sortOrder": 0

        },
      • "account": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "username": "string",
        • "password": "string",
        • "sessionDuration": 0,
        • "isSignupComplete": true,
        • "isLocal": true,
        • "hasSeenOwnProfile": true,
        • "identities": [

          • {

            • "id": 0,
            • "createdBy": "string",
            • "createStamp": "2019-08-24T14:15:22Z",
            • "updatedBy": "string",
            • "updateStamp": "2019-08-24T14:15:22Z",
            • "identityProviderId": 0,
            • "accountId": 0,
            • "identificationLevelId": 0,
            • "externalId": "string",
            • "profileId": 0,
            • "metadata": {

              • "property1": "string",
              • "property2": "string"

              }

            }

          ]

        }

      },
    • "organization": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "uid": "string",
      • "fsoId": 0,
      • "website": "string",
      • "isSelfRegistration": true,
      • "identificationProcess": "string",
      • "isPending": true,
      • "createdByProfileId": 0,
      • "signatureType": "Unknown",
      • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
      • "orgCategoryId": 0,
      • "legalFormId": 0,
      • "orgIdentificationLevelId": 0,
      • "isDeletableByOwner": true,
      • "legalForm": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isOrgDeletableByOwner": true

        },
      • "category": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isVisible": true,
        • "isOrgDeletableByOwner": true,
        • "profilePictureUrl": "string",
        • "smallProfilePictureUrl": "string",
        • "daysUntilFirstDeletionReminder": 0,
        • "daysUntilSecondDeletionReminder": 0,
        • "daysUntilDeletion": 0

        },
      • "identificationLevel": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "description": "string",
        • "levelOfTrust": 0,
        • "elevationServiceId": 0

        },
      • "signatories": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "organizationId": 0,
          • "isRequester": true,
          • "type": "Signer",
          • "position": "string",
          • "gender": "Unknown",
          • "firstname": "string",
          • "lastname": "string",
          • "birthdate": "2019-08-24T14:15:22Z",
          • "email": "string",
          • "ahvNumber": "string",
          • "identityNumber": "string",
          • "address": "string",
          • "zipCode": "string",
          • "city": "string",
          • "origin": "string"

          }

        ]

      },
    • "profilePicture": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "profileId": 0,
      • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
      • "customImageType": "string",
      • "customImageBytesEncoded": "string",
      • "defaultImageUrl": "string",
      • "defaultSmallImageUrl": "string"

      }

    },
  • "representativeProfile": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "personId": 0,
    • "organizationId": 0,
    • "isEnabled": true,
    • "externalKey": "string",
    • "language": "string",
    • "email": "string",
    • "phone": "string",
    • "fax": "string",
    • "address": "string",
    • "zipCode": "string",
    • "city": "string",
    • "countryCode": "string",
    • "acceptsAdvertisement": true,
    • "lastLoginStamp": "2019-08-24T14:15:22Z",
    • "loginCount": 0,
    • "inactivityState": "Active",
    • "isFlaggedForDeletion": true,
    • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
    • "person": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "accountId": 0,
      • "firstname": "string",
      • "lastname": "string",
      • "gender": "Unknown",
      • "ahvNumber": "string",
      • "mobilePhone": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "maritalStatusId": 0,
      • "maritalStatus": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "isEnabled": true,
        • "sortOrder": 0

        },
      • "account": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "username": "string",
        • "password": "string",
        • "sessionDuration": 0,
        • "isSignupComplete": true,
        • "isLocal": true,
        • "hasSeenOwnProfile": true,
        • "identities": [

          • {

            • "id": 0,
            • "createdBy": "string",
            • "createStamp": "2019-08-24T14:15:22Z",
            • "updatedBy": "string",
            • "updateStamp": "2019-08-24T14:15:22Z",
            • "identityProviderId": 0,
            • "accountId": 0,
            • "identificationLevelId": 0,
            • "externalId": "string",
            • "profileId": 0,
            • "metadata": {

              • "property1": "string",
              • "property2": "string"

              }

            }

          ]

        }

      },
    • "organization": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "uid": "string",
      • "fsoId": 0,
      • "website": "string",
      • "isSelfRegistration": true,
      • "identificationProcess": "string",
      • "isPending": true,
      • "createdByProfileId": 0,
      • "signatureType": "Unknown",
      • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
      • "orgCategoryId": 0,
      • "legalFormId": 0,
      • "orgIdentificationLevelId": 0,
      • "isDeletableByOwner": true,
      • "legalForm": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isOrgDeletableByOwner": true

        },
      • "category": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isVisible": true,
        • "isOrgDeletableByOwner": true,
        • "profilePictureUrl": "string",
        • "smallProfilePictureUrl": "string",
        • "daysUntilFirstDeletionReminder": 0,
        • "daysUntilSecondDeletionReminder": 0,
        • "daysUntilDeletion": 0

        },
      • "identificationLevel": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "description": "string",
        • "levelOfTrust": 0,
        • "elevationServiceId": 0

        },
      • "signatories": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "organizationId": 0,
          • "isRequester": true,
          • "type": "Signer",
          • "position": "string",
          • "gender": "Unknown",
          • "firstname": "string",
          • "lastname": "string",
          • "birthdate": "2019-08-24T14:15:22Z",
          • "email": "string",
          • "ahvNumber": "string",
          • "identityNumber": "string",
          • "address": "string",
          • "zipCode": "string",
          • "city": "string",
          • "origin": "string"

          }

        ]

      },
    • "profilePicture": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "profileId": 0,
      • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
      • "customImageType": "string",
      • "customImageBytesEncoded": "string",
      • "defaultImageUrl": "string",
      • "defaultSmallImageUrl": "string"

      }

    },
  • "delegatorProfile": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "personId": 0,
    • "organizationId": 0,
    • "isEnabled": true,
    • "externalKey": "string",
    • "language": "string",
    • "email": "string",
    • "phone": "string",
    • "fax": "string",
    • "address": "string",
    • "zipCode": "string",
    • "city": "string",
    • "countryCode": "string",
    • "acceptsAdvertisement": true,
    • "lastLoginStamp": "2019-08-24T14:15:22Z",
    • "loginCount": 0,
    • "inactivityState": "Active",
    • "isFlaggedForDeletion": true,
    • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
    • "person": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "accountId": 0,
      • "firstname": "string",
      • "lastname": "string",
      • "gender": "Unknown",
      • "ahvNumber": "string",
      • "mobilePhone": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "maritalStatusId": 0,
      • "maritalStatus": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "isEnabled": true,
        • "sortOrder": 0

        },
      • "account": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "username": "string",
        • "password": "string",
        • "sessionDuration": 0,
        • "isSignupComplete": true,
        • "isLocal": true,
        • "hasSeenOwnProfile": true,
        • "identities": [

          • {

            • "id": 0,
            • "createdBy": "string",
            • "createStamp": "2019-08-24T14:15:22Z",
            • "updatedBy": "string",
            • "updateStamp": "2019-08-24T14:15:22Z",
            • "identityProviderId": 0,
            • "accountId": 0,
            • "identificationLevelId": 0,
            • "externalId": "string",
            • "profileId": 0,
            • "metadata": {

              • "property1": "string",
              • "property2": "string"

              }

            }

          ]

        }

      },
    • "organization": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "uid": "string",
      • "fsoId": 0,
      • "website": "string",
      • "isSelfRegistration": true,
      • "identificationProcess": "string",
      • "isPending": true,
      • "createdByProfileId": 0,
      • "signatureType": "Unknown",
      • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
      • "orgCategoryId": 0,
      • "legalFormId": 0,
      • "orgIdentificationLevelId": 0,
      • "isDeletableByOwner": true,
      • "legalForm": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isOrgDeletableByOwner": true

        },
      • "category": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isVisible": true,
        • "isOrgDeletableByOwner": true,
        • "profilePictureUrl": "string",
        • "smallProfilePictureUrl": "string",
        • "daysUntilFirstDeletionReminder": 0,
        • "daysUntilSecondDeletionReminder": 0,
        • "daysUntilDeletion": 0

        },
      • "identificationLevel": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "description": "string",
        • "levelOfTrust": 0,
        • "elevationServiceId": 0

        },
      • "signatories": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "organizationId": 0,
          • "isRequester": true,
          • "type": "Signer",
          • "position": "string",
          • "gender": "Unknown",
          • "firstname": "string",
          • "lastname": "string",
          • "birthdate": "2019-08-24T14:15:22Z",
          • "email": "string",
          • "ahvNumber": "string",
          • "identityNumber": "string",
          • "address": "string",
          • "zipCode": "string",
          • "city": "string",
          • "origin": "string"

          }

        ]

      },
    • "profilePicture": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "profileId": 0,
      • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
      • "customImageType": "string",
      • "customImageBytesEncoded": "string",
      • "defaultImageUrl": "string",
      • "defaultSmallImageUrl": "string"

      }

    },
  • "procurationServices": [

    • {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "procurationId": 0,
      • "serviceId": 0,
      • "validityStartStamp": "2019-08-24T14:15:22Z"

      }

    ],
  • "procurationInvite": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "principalProfileId": 0,
    • "representativeProfileId": 0,
    • "description": "string",
    • "token": "string",
    • "expirationStamp": "2019-08-24T14:15:22Z",
    • "consumptionStamp": "2019-08-24T14:15:22Z",
    • "isReadyForApproval": true,
    • "isApproved": true,
    • "approvalStamp": "2019-08-24T14:15:22Z",
    • "messageToPrincipal": "string",
    • "principalBusinessCaseId": "808c1d0d-2079-4fb2-885b-7f647593bcd3",
    • "representativeBusinessCaseId": "b4d6eca0-7435-4b01-8444-d51a1c3eefcd",
    • "representativeEmail": "string",
    • "serviceIds": [

      • 0

      ],
    • "consumerInOrgFirstname": "string",
    • "consumerInOrgLastname": "string",
    • "consumerInOrgProfileId": 0

    }

  }

]

Get the list of Profile's Outbound Procurations

Allows to retrieve a list of Profile's Outbound Procurations according to certain criteria.

path Parameters

profileId required

integer <int32> Id of the principal profile linked to the procurations

query Parameters

RepresentativeProfileId	integer <int32> Id of the profile who is representing the principal through the procurations.
DelegatorProfileId	integer <int32> Id of the profile who delegated the procurations. When provided, parameter IncludeDelegations is ignored. Value -1 can be used as joker to only keep delegated procurations.
IncludeDelegations	boolean Filters outbound procurations to include/filter out those having or not a delegator profile. By default, delegated procurations are not included and only base procurations are returned.
IsOrgOwner	boolean Filters outbound procurations on the PersonInOrganizationFunction field When true, only owners are returned. When false, other members are returned.
IsOrgManagerOrOwner	boolean Filters outbound procurations on the PersonInOrganizationFunction field When true, only owners and managers are returned. When false, other members are returned.
RepresentativeProfileKeyword	string Filters outbound procurations on the following fields of the reprentative profile : Id (exact match), Email (CI, contains) Person.AhvNumber (CI, contains), Person.Firstname (CI, contains), Person.Lastname (CI, contains),
HasAccessToServiceId	integer <int32> Id of a service to which the procurations must have access
IncludeCustomImageBytes	boolean
Expand	Array of strings (OutboundProcurationsByProfileExpand) Items Enum: "PrincipalProfile" "RepresentativeProfile" "DelegatorProfile" "PrincipalProfile_Person" "RepresentativeProfile_Person" "PrincipalProfile_Organization" "RepresentativeProfile_Organization" "DelegatorProfile_Organization" "PrincipalProfile_ProfilePicture" "RepresentativeProfile_ProfilePicture" "ProcurationServices" "ProcurationInvite"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/outbound-procurations

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "principalProfileId": 0,
  • "delegatorProfileId": 0,
  • "representativeProfileId": 0,
  • "validityStartStamp": "2019-08-24T14:15:22Z",
  • "validityEndStamp": "2019-08-24T14:15:22Z",
  • "renewableFromDate": "2019-08-24T14:15:22Z",
  • "removalDate": "2019-08-24T14:15:22Z",
  • "renewalState": "Active",
  • "isRenewable": true,
  • "isUsable": true,
  • "representativeEmail": "string",
  • "personInOrganizationFunction": "Collaborator",
  • "isPersonInOrganizationPendingDelete": true,
  • "delegationMode": "Unitary",
  • "principalProfile": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "personId": 0,
    • "organizationId": 0,
    • "isEnabled": true,
    • "externalKey": "string",
    • "language": "string",
    • "email": "string",
    • "phone": "string",
    • "fax": "string",
    • "address": "string",
    • "zipCode": "string",
    • "city": "string",
    • "countryCode": "string",
    • "acceptsAdvertisement": true,
    • "lastLoginStamp": "2019-08-24T14:15:22Z",
    • "loginCount": 0,
    • "inactivityState": "Active",
    • "isFlaggedForDeletion": true,
    • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
    • "person": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "accountId": 0,
      • "firstname": "string",
      • "lastname": "string",
      • "gender": "Unknown",
      • "ahvNumber": "string",
      • "mobilePhone": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "maritalStatusId": 0,
      • "maritalStatus": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "isEnabled": true,
        • "sortOrder": 0

        },
      • "account": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "username": "string",
        • "password": "string",
        • "sessionDuration": 0,
        • "isSignupComplete": true,
        • "isLocal": true,
        • "hasSeenOwnProfile": true,
        • "identities": [

          • {

            • "id": 0,
            • "createdBy": "string",
            • "createStamp": "2019-08-24T14:15:22Z",
            • "updatedBy": "string",
            • "updateStamp": "2019-08-24T14:15:22Z",
            • "identityProviderId": 0,
            • "accountId": 0,
            • "identificationLevelId": 0,
            • "externalId": "string",
            • "profileId": 0,
            • "metadata": {

              • "property1": "string",
              • "property2": "string"

              }

            }

          ]

        }

      },
    • "organization": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "uid": "string",
      • "fsoId": 0,
      • "website": "string",
      • "isSelfRegistration": true,
      • "identificationProcess": "string",
      • "isPending": true,
      • "createdByProfileId": 0,
      • "signatureType": "Unknown",
      • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
      • "orgCategoryId": 0,
      • "legalFormId": 0,
      • "orgIdentificationLevelId": 0,
      • "isDeletableByOwner": true,
      • "legalForm": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isOrgDeletableByOwner": true

        },
      • "category": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isVisible": true,
        • "isOrgDeletableByOwner": true,
        • "profilePictureUrl": "string",
        • "smallProfilePictureUrl": "string",
        • "daysUntilFirstDeletionReminder": 0,
        • "daysUntilSecondDeletionReminder": 0,
        • "daysUntilDeletion": 0

        },
      • "identificationLevel": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "description": "string",
        • "levelOfTrust": 0,
        • "elevationServiceId": 0

        },
      • "signatories": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "organizationId": 0,
          • "isRequester": true,
          • "type": "Signer",
          • "position": "string",
          • "gender": "Unknown",
          • "firstname": "string",
          • "lastname": "string",
          • "birthdate": "2019-08-24T14:15:22Z",
          • "email": "string",
          • "ahvNumber": "string",
          • "identityNumber": "string",
          • "address": "string",
          • "zipCode": "string",
          • "city": "string",
          • "origin": "string"

          }

        ]

      },
    • "profilePicture": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "profileId": 0,
      • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
      • "customImageType": "string",
      • "customImageBytesEncoded": "string",
      • "defaultImageUrl": "string",
      • "defaultSmallImageUrl": "string"

      }

    },
  • "representativeProfile": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "personId": 0,
    • "organizationId": 0,
    • "isEnabled": true,
    • "externalKey": "string",
    • "language": "string",
    • "email": "string",
    • "phone": "string",
    • "fax": "string",
    • "address": "string",
    • "zipCode": "string",
    • "city": "string",
    • "countryCode": "string",
    • "acceptsAdvertisement": true,
    • "lastLoginStamp": "2019-08-24T14:15:22Z",
    • "loginCount": 0,
    • "inactivityState": "Active",
    • "isFlaggedForDeletion": true,
    • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
    • "person": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "accountId": 0,
      • "firstname": "string",
      • "lastname": "string",
      • "gender": "Unknown",
      • "ahvNumber": "string",
      • "mobilePhone": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "maritalStatusId": 0,
      • "maritalStatus": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "isEnabled": true,
        • "sortOrder": 0

        },
      • "account": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "username": "string",
        • "password": "string",
        • "sessionDuration": 0,
        • "isSignupComplete": true,
        • "isLocal": true,
        • "hasSeenOwnProfile": true,
        • "identities": [

          • {

            • "id": 0,
            • "createdBy": "string",
            • "createStamp": "2019-08-24T14:15:22Z",
            • "updatedBy": "string",
            • "updateStamp": "2019-08-24T14:15:22Z",
            • "identityProviderId": 0,
            • "accountId": 0,
            • "identificationLevelId": 0,
            • "externalId": "string",
            • "profileId": 0,
            • "metadata": {

              • "property1": "string",
              • "property2": "string"

              }

            }

          ]

        }

      },
    • "organization": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "uid": "string",
      • "fsoId": 0,
      • "website": "string",
      • "isSelfRegistration": true,
      • "identificationProcess": "string",
      • "isPending": true,
      • "createdByProfileId": 0,
      • "signatureType": "Unknown",
      • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
      • "orgCategoryId": 0,
      • "legalFormId": 0,
      • "orgIdentificationLevelId": 0,
      • "isDeletableByOwner": true,
      • "legalForm": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isOrgDeletableByOwner": true

        },
      • "category": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isVisible": true,
        • "isOrgDeletableByOwner": true,
        • "profilePictureUrl": "string",
        • "smallProfilePictureUrl": "string",
        • "daysUntilFirstDeletionReminder": 0,
        • "daysUntilSecondDeletionReminder": 0,
        • "daysUntilDeletion": 0

        },
      • "identificationLevel": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "description": "string",
        • "levelOfTrust": 0,
        • "elevationServiceId": 0

        },
      • "signatories": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "organizationId": 0,
          • "isRequester": true,
          • "type": "Signer",
          • "position": "string",
          • "gender": "Unknown",
          • "firstname": "string",
          • "lastname": "string",
          • "birthdate": "2019-08-24T14:15:22Z",
          • "email": "string",
          • "ahvNumber": "string",
          • "identityNumber": "string",
          • "address": "string",
          • "zipCode": "string",
          • "city": "string",
          • "origin": "string"

          }

        ]

      },
    • "profilePicture": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "profileId": 0,
      • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
      • "customImageType": "string",
      • "customImageBytesEncoded": "string",
      • "defaultImageUrl": "string",
      • "defaultSmallImageUrl": "string"

      }

    },
  • "delegatorProfile": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "personId": 0,
    • "organizationId": 0,
    • "isEnabled": true,
    • "externalKey": "string",
    • "language": "string",
    • "email": "string",
    • "phone": "string",
    • "fax": "string",
    • "address": "string",
    • "zipCode": "string",
    • "city": "string",
    • "countryCode": "string",
    • "acceptsAdvertisement": true,
    • "lastLoginStamp": "2019-08-24T14:15:22Z",
    • "loginCount": 0,
    • "inactivityState": "Active",
    • "isFlaggedForDeletion": true,
    • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
    • "person": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "accountId": 0,
      • "firstname": "string",
      • "lastname": "string",
      • "gender": "Unknown",
      • "ahvNumber": "string",
      • "mobilePhone": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "maritalStatusId": 0,
      • "maritalStatus": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "isEnabled": true,
        • "sortOrder": 0

        },
      • "account": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "username": "string",
        • "password": "string",
        • "sessionDuration": 0,
        • "isSignupComplete": true,
        • "isLocal": true,
        • "hasSeenOwnProfile": true,
        • "identities": [

          • {

            • "id": 0,
            • "createdBy": "string",
            • "createStamp": "2019-08-24T14:15:22Z",
            • "updatedBy": "string",
            • "updateStamp": "2019-08-24T14:15:22Z",
            • "identityProviderId": 0,
            • "accountId": 0,
            • "identificationLevelId": 0,
            • "externalId": "string",
            • "profileId": 0,
            • "metadata": {

              • "property1": "string",
              • "property2": "string"

              }

            }

          ]

        }

      },
    • "organization": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "uid": "string",
      • "fsoId": 0,
      • "website": "string",
      • "isSelfRegistration": true,
      • "identificationProcess": "string",
      • "isPending": true,
      • "createdByProfileId": 0,
      • "signatureType": "Unknown",
      • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
      • "orgCategoryId": 0,
      • "legalFormId": 0,
      • "orgIdentificationLevelId": 0,
      • "isDeletableByOwner": true,
      • "legalForm": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isOrgDeletableByOwner": true

        },
      • "category": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isVisible": true,
        • "isOrgDeletableByOwner": true,
        • "profilePictureUrl": "string",
        • "smallProfilePictureUrl": "string",
        • "daysUntilFirstDeletionReminder": 0,
        • "daysUntilSecondDeletionReminder": 0,
        • "daysUntilDeletion": 0

        },
      • "identificationLevel": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "description": "string",
        • "levelOfTrust": 0,
        • "elevationServiceId": 0

        },
      • "signatories": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "organizationId": 0,
          • "isRequester": true,
          • "type": "Signer",
          • "position": "string",
          • "gender": "Unknown",
          • "firstname": "string",
          • "lastname": "string",
          • "birthdate": "2019-08-24T14:15:22Z",
          • "email": "string",
          • "ahvNumber": "string",
          • "identityNumber": "string",
          • "address": "string",
          • "zipCode": "string",
          • "city": "string",
          • "origin": "string"

          }

        ]

      },
    • "profilePicture": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "profileId": 0,
      • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
      • "customImageType": "string",
      • "customImageBytesEncoded": "string",
      • "defaultImageUrl": "string",
      • "defaultSmallImageUrl": "string"

      }

    },
  • "procurationServices": [

    • {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "procurationId": 0,
      • "serviceId": 0,
      • "validityStartStamp": "2019-08-24T14:15:22Z"

      }

    ],
  • "procurationInvite": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "principalProfileId": 0,
    • "representativeProfileId": 0,
    • "description": "string",
    • "token": "string",
    • "expirationStamp": "2019-08-24T14:15:22Z",
    • "consumptionStamp": "2019-08-24T14:15:22Z",
    • "isReadyForApproval": true,
    • "isApproved": true,
    • "approvalStamp": "2019-08-24T14:15:22Z",
    • "messageToPrincipal": "string",
    • "principalBusinessCaseId": "808c1d0d-2079-4fb2-885b-7f647593bcd3",
    • "representativeBusinessCaseId": "b4d6eca0-7435-4b01-8444-d51a1c3eefcd",
    • "representativeEmail": "string",
    • "serviceIds": [

      • 0

      ],
    • "consumerInOrgFirstname": "string",
    • "consumerInOrgLastname": "string",
    • "consumerInOrgProfileId": 0

    }

  }

]

Create a new Procuration Invite (outbound) from the specified Profile (principal)

Allows to create a new Procuration Invite (outbound) from the specified Profile (principal).

path Parameters

profileId required

integer <int32>

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
description	string or null Short description of the procuration case
principalBusinessCaseId	string or null <uuid> Business case ID for the principal side
serviceIds	Array of integers <int32> [ items <int32 > ] Listing of service identifiers that will be part of the procuration when the invitation process is achieved

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/outbound-procuration-invite

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "description": "string",
• "principalBusinessCaseId": "808c1d0d-2079-4fb2-885b-7f647593bcd3",
• "serviceIds": [

  • 0

  ]

}

Response samples

• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "principalProfileId": 0,
• "representativeProfileId": 0,
• "description": "string",
• "token": "string",
• "expirationStamp": "2019-08-24T14:15:22Z",
• "consumptionStamp": "2019-08-24T14:15:22Z",
• "isReadyForApproval": true,
• "isApproved": true,
• "approvalStamp": "2019-08-24T14:15:22Z",
• "messageToPrincipal": "string",
• "principalBusinessCaseId": "808c1d0d-2079-4fb2-885b-7f647593bcd3",
• "representativeBusinessCaseId": "b4d6eca0-7435-4b01-8444-d51a1c3eefcd",
• "representativeEmail": "string",
• "serviceIds": [

  • 0

  ],
• "consumerInOrgFirstname": "string",
• "consumerInOrgLastname": "string",
• "consumerInOrgProfileId": 0

}

Get a specific outbound Procuration Invite

Allows to retrieve a specific Procuration Invite (outbound) from the specified Profile (principal).

path Parameters

profileId required	integer <int32>
inviteId required	integer <int32>

query Parameters

Expand	Array of strings (OutboundProcurationInviteExpand) Items Enum: "PrincipalProfile" "RepresentativeProfile" "PrincipalProfile_Person" "RepresentativeProfile_Person" "PrincipalProfile_Organization" "RepresentativeProfile_Organization"
Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/outbound-procuration-invite/{inviteId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "principalProfileId": 0,
• "representativeProfileId": 0,
• "description": "string",
• "token": "string",
• "expirationStamp": "2019-08-24T14:15:22Z",
• "consumptionStamp": "2019-08-24T14:15:22Z",
• "isReadyForApproval": true,
• "isApproved": true,
• "approvalStamp": "2019-08-24T14:15:22Z",
• "messageToPrincipal": "string",
• "principalBusinessCaseId": "808c1d0d-2079-4fb2-885b-7f647593bcd3",
• "representativeBusinessCaseId": "b4d6eca0-7435-4b01-8444-d51a1c3eefcd",
• "representativeEmail": "string",
• "serviceIds": [

  • 0

  ],
• "consumerInOrgFirstname": "string",
• "consumerInOrgLastname": "string",
• "consumerInOrgProfileId": 0,
• "principalProfile": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  },
• "representativeProfile": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  }

}

Delete a specific outbound Procuration Invite

Allows to delete a specific Procuration Invite (outbound) from the specified Profile (principal).

path Parameters

profileId required	integer <int32>
inviteId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/outbound-procuration-invite/{inviteId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Update partially a specific outbound Procuration Invite

Allows to update partially an existing outbound Procuration Invite identified by its principal profile and its Id.

path Parameters

profileId required	integer <int32>
inviteId required	integer <int32>

Request Body schema: application/merge-patch+json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
isApproved	boolean Indicates the approval decision by the principal. Mandatory when IsReadyForApproval is set to true.
	object Listing of service identifiers that will be part of the procuration when the invitation process is achieved

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/outbound-procuration-invite/{inviteId}

Request samples

• Payload

Content type

application/merge-patch+json

{

• "updatedBy": "string",
• "isApproved": true,
• "serviceIds": {

  • "isValuePresent": true,
  • "value": [

    • 0

    ]

  }

}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Get the list of Profile's outbound Procuration Invites

Allows to retrieve a list of Profile's outbound Procuration Invites according to certain criteria.

path Parameters

profileId required

integer <int32>

query Parameters

IsClosed	boolean Filters procuration invites on the IsApproved field, an invite is closed when IsApproved is not null.
Expand	Array of strings (OutboundProcurationInviteExpand) Items Enum: "PrincipalProfile" "RepresentativeProfile" "PrincipalProfile_Person" "RepresentativeProfile_Person" "PrincipalProfile_Organization" "RepresentativeProfile_Organization"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/outbound-procuration-invites

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "principalProfileId": 0,
  • "representativeProfileId": 0,
  • "description": "string",
  • "token": "string",
  • "expirationStamp": "2019-08-24T14:15:22Z",
  • "consumptionStamp": "2019-08-24T14:15:22Z",
  • "isReadyForApproval": true,
  • "isApproved": true,
  • "approvalStamp": "2019-08-24T14:15:22Z",
  • "messageToPrincipal": "string",
  • "principalBusinessCaseId": "808c1d0d-2079-4fb2-885b-7f647593bcd3",
  • "representativeBusinessCaseId": "b4d6eca0-7435-4b01-8444-d51a1c3eefcd",
  • "representativeEmail": "string",
  • "serviceIds": [

    • 0

    ],
  • "consumerInOrgFirstname": "string",
  • "consumerInOrgLastname": "string",
  • "consumerInOrgProfileId": 0,
  • "principalProfile": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "personId": 0,
    • "organizationId": 0,
    • "isEnabled": true,
    • "externalKey": "string",
    • "language": "string",
    • "email": "string",
    • "phone": "string",
    • "fax": "string",
    • "address": "string",
    • "zipCode": "string",
    • "city": "string",
    • "countryCode": "string",
    • "acceptsAdvertisement": true,
    • "lastLoginStamp": "2019-08-24T14:15:22Z",
    • "loginCount": 0,
    • "inactivityState": "Active",
    • "isFlaggedForDeletion": true,
    • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
    • "person": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "accountId": 0,
      • "firstname": "string",
      • "lastname": "string",
      • "gender": "Unknown",
      • "ahvNumber": "string",
      • "mobilePhone": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "maritalStatusId": 0,
      • "maritalStatus": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "isEnabled": true,
        • "sortOrder": 0

        },
      • "account": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "username": "string",
        • "password": "string",
        • "sessionDuration": 0,
        • "isSignupComplete": true,
        • "isLocal": true,
        • "hasSeenOwnProfile": true,
        • "identities": [

          • {

            • "id": 0,
            • "createdBy": "string",
            • "createStamp": "2019-08-24T14:15:22Z",
            • "updatedBy": "string",
            • "updateStamp": "2019-08-24T14:15:22Z",
            • "identityProviderId": 0,
            • "accountId": 0,
            • "identificationLevelId": 0,
            • "externalId": "string",
            • "profileId": 0,
            • "metadata": {

              • "property1": "string",
              • "property2": "string"

              }

            }

          ]

        }

      },
    • "organization": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "uid": "string",
      • "fsoId": 0,
      • "website": "string",
      • "isSelfRegistration": true,
      • "identificationProcess": "string",
      • "isPending": true,
      • "createdByProfileId": 0,
      • "signatureType": "Unknown",
      • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
      • "orgCategoryId": 0,
      • "legalFormId": 0,
      • "orgIdentificationLevelId": 0,
      • "isDeletableByOwner": true,
      • "legalForm": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isOrgDeletableByOwner": true

        },
      • "category": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isVisible": true,
        • "isOrgDeletableByOwner": true,
        • "profilePictureUrl": "string",
        • "smallProfilePictureUrl": "string",
        • "daysUntilFirstDeletionReminder": 0,
        • "daysUntilSecondDeletionReminder": 0,
        • "daysUntilDeletion": 0

        },
      • "identificationLevel": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "description": "string",
        • "levelOfTrust": 0,
        • "elevationServiceId": 0

        },
      • "signatories": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "organizationId": 0,
          • "isRequester": true,
          • "type": "Signer",
          • "position": "string",
          • "gender": "Unknown",
          • "firstname": "string",
          • "lastname": "string",
          • "birthdate": "2019-08-24T14:15:22Z",
          • "email": "string",
          • "ahvNumber": "string",
          • "identityNumber": "string",
          • "address": "string",
          • "zipCode": "string",
          • "city": "string",
          • "origin": "string"

          }

        ]

      },
    • "profilePicture": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "profileId": 0,
      • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
      • "customImageType": "string",
      • "customImageBytesEncoded": "string",
      • "defaultImageUrl": "string",
      • "defaultSmallImageUrl": "string"

      }

    },
  • "representativeProfile": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "personId": 0,
    • "organizationId": 0,
    • "isEnabled": true,
    • "externalKey": "string",
    • "language": "string",
    • "email": "string",
    • "phone": "string",
    • "fax": "string",
    • "address": "string",
    • "zipCode": "string",
    • "city": "string",
    • "countryCode": "string",
    • "acceptsAdvertisement": true,
    • "lastLoginStamp": "2019-08-24T14:15:22Z",
    • "loginCount": 0,
    • "inactivityState": "Active",
    • "isFlaggedForDeletion": true,
    • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
    • "person": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "accountId": 0,
      • "firstname": "string",
      • "lastname": "string",
      • "gender": "Unknown",
      • "ahvNumber": "string",
      • "mobilePhone": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "maritalStatusId": 0,
      • "maritalStatus": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "isEnabled": true,
        • "sortOrder": 0

        },
      • "account": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "username": "string",
        • "password": "string",
        • "sessionDuration": 0,
        • "isSignupComplete": true,
        • "isLocal": true,
        • "hasSeenOwnProfile": true,
        • "identities": [

          • {

            • "id": 0,
            • "createdBy": "string",
            • "createStamp": "2019-08-24T14:15:22Z",
            • "updatedBy": "string",
            • "updateStamp": "2019-08-24T14:15:22Z",
            • "identityProviderId": 0,
            • "accountId": 0,
            • "identificationLevelId": 0,
            • "externalId": "string",
            • "profileId": 0,
            • "metadata": {

              • "property1": "string",
              • "property2": "string"

              }

            }

          ]

        }

      },
    • "organization": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "uid": "string",
      • "fsoId": 0,
      • "website": "string",
      • "isSelfRegistration": true,
      • "identificationProcess": "string",
      • "isPending": true,
      • "createdByProfileId": 0,
      • "signatureType": "Unknown",
      • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
      • "orgCategoryId": 0,
      • "legalFormId": 0,
      • "orgIdentificationLevelId": 0,
      • "isDeletableByOwner": true,
      • "legalForm": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isOrgDeletableByOwner": true

        },
      • "category": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isVisible": true,
        • "isOrgDeletableByOwner": true,
        • "profilePictureUrl": "string",
        • "smallProfilePictureUrl": "string",
        • "daysUntilFirstDeletionReminder": 0,
        • "daysUntilSecondDeletionReminder": 0,
        • "daysUntilDeletion": 0

        },
      • "identificationLevel": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "description": "string",
        • "levelOfTrust": 0,
        • "elevationServiceId": 0

        },
      • "signatories": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "organizationId": 0,
          • "isRequester": true,
          • "type": "Signer",
          • "position": "string",
          • "gender": "Unknown",
          • "firstname": "string",
          • "lastname": "string",
          • "birthdate": "2019-08-24T14:15:22Z",
          • "email": "string",
          • "ahvNumber": "string",
          • "identityNumber": "string",
          • "address": "string",
          • "zipCode": "string",
          • "city": "string",
          • "origin": "string"

          }

        ]

      },
    • "profilePicture": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "profileId": 0,
      • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
      • "customImageType": "string",
      • "customImageBytesEncoded": "string",
      • "defaultImageUrl": "string",
      • "defaultSmallImageUrl": "string"

      }

    }

  }

]

Consume an existing Procuration Invite (inbound) within the specified Profile (representative)

Allows to consume an existing Procuration Invite (inbound) within the specified Profile (representative).

path Parameters

profileId required

integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
token	string Unique token of the invitation to consume
consumerInOrgProfileId	integer or null <int32> Identifier of the person profile in an organization who consumes the procuration invite

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/inbound-procuration-invite

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "token": "string",
• "consumerInOrgProfileId": 0

}

Response samples

• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "principalProfileId": 0,
• "representativeProfileId": 0,
• "description": "string",
• "token": "string",
• "expirationStamp": "2019-08-24T14:15:22Z",
• "consumptionStamp": "2019-08-24T14:15:22Z",
• "isReadyForApproval": true,
• "isApproved": true,
• "approvalStamp": "2019-08-24T14:15:22Z",
• "messageToPrincipal": "string",
• "principalBusinessCaseId": "808c1d0d-2079-4fb2-885b-7f647593bcd3",
• "representativeBusinessCaseId": "b4d6eca0-7435-4b01-8444-d51a1c3eefcd",
• "representativeEmail": "string",
• "serviceIds": [

  • 0

  ],
• "consumerInOrgFirstname": "string",
• "consumerInOrgLastname": "string",
• "consumerInOrgProfileId": 0

}

Get a specific inbound Procuration Invite

Allows to retrieve a specific Procuration Invite (inbound) from the specified Profile (representative).

path Parameters

profileId required	integer <int32>
inviteId required	integer <int32>

query Parameters

Expand	Array of strings (InboundProcurationInviteExpand) Items Enum: "PrincipalProfile" "RepresentativeProfile" "PrincipalProfile_Person" "RepresentativeProfile_Person" "PrincipalProfile_Organization" "RepresentativeProfile_Organization"
Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/inbound-procuration-invite/{inviteId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "principalProfileId": 0,
• "representativeProfileId": 0,
• "description": "string",
• "token": "string",
• "expirationStamp": "2019-08-24T14:15:22Z",
• "consumptionStamp": "2019-08-24T14:15:22Z",
• "isReadyForApproval": true,
• "isApproved": true,
• "approvalStamp": "2019-08-24T14:15:22Z",
• "messageToPrincipal": "string",
• "principalBusinessCaseId": "808c1d0d-2079-4fb2-885b-7f647593bcd3",
• "representativeBusinessCaseId": "b4d6eca0-7435-4b01-8444-d51a1c3eefcd",
• "representativeEmail": "string",
• "serviceIds": [

  • 0

  ],
• "consumerInOrgFirstname": "string",
• "consumerInOrgLastname": "string",
• "consumerInOrgProfileId": 0,
• "principalProfile": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  },
• "representativeProfile": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  }

}

Delete a specific inbound Procuration Invite

Allows to delete a specific Procuration Invite (inbound) from the specified Profile (representative).

path Parameters

profileId required	integer <int32>
inviteId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/inbound-procuration-invite/{inviteId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Update partially a specific inbound Procuration Invite

Allows to update partially an existing inbound Procuration Invite identified by its representative profile and its Id.

path Parameters

profileId required	integer <int32>
inviteId required	integer <int32>

Request Body schema: application/merge-patch+json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
isReadyForApproval	boolean Indicates whether this invite is ready to be approved back by the principal
messageToPrincipal	string or null Optional message from the representative to the principal
representativeBusinessCaseId	string or null <uuid> Business case ID for the representative side
representativeEmail	string or null Email to notify the representative in the context of the procuration. The principal must be an organization and the representative must be a person.
	object Listing of service identifiers that will be part of the procuration when the invitation process is achieved

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/inbound-procuration-invite/{inviteId}

Request samples

• Payload

Content type

application/merge-patch+json

{

• "updatedBy": "string",
• "isReadyForApproval": true,
• "messageToPrincipal": "string",
• "representativeBusinessCaseId": "b4d6eca0-7435-4b01-8444-d51a1c3eefcd",
• "representativeEmail": "string",
• "serviceIds": {

  • "isValuePresent": true,
  • "value": [

    • 0

    ]

  }

}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Get the list of Profile's inbound Procuration Invites

Allows to retrieve a list of Profile's inbound Procuration Invites according to certain criteria.

path Parameters

profileId required

integer <int32>

query Parameters

IsClosed	boolean Filters procuration invites on the IsApproved field, an invite is closed when IsApproved is not null.
Expand	Array of strings (InboundProcurationInviteExpand) Items Enum: "PrincipalProfile" "RepresentativeProfile" "PrincipalProfile_Person" "RepresentativeProfile_Person" "PrincipalProfile_Organization" "RepresentativeProfile_Organization"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/inbound-procuration-invites

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "principalProfileId": 0,
  • "representativeProfileId": 0,
  • "description": "string",
  • "token": "string",
  • "expirationStamp": "2019-08-24T14:15:22Z",
  • "consumptionStamp": "2019-08-24T14:15:22Z",
  • "isReadyForApproval": true,
  • "isApproved": true,
  • "approvalStamp": "2019-08-24T14:15:22Z",
  • "messageToPrincipal": "string",
  • "principalBusinessCaseId": "808c1d0d-2079-4fb2-885b-7f647593bcd3",
  • "representativeBusinessCaseId": "b4d6eca0-7435-4b01-8444-d51a1c3eefcd",
  • "representativeEmail": "string",
  • "serviceIds": [

    • 0

    ],
  • "consumerInOrgFirstname": "string",
  • "consumerInOrgLastname": "string",
  • "consumerInOrgProfileId": 0,
  • "principalProfile": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "personId": 0,
    • "organizationId": 0,
    • "isEnabled": true,
    • "externalKey": "string",
    • "language": "string",
    • "email": "string",
    • "phone": "string",
    • "fax": "string",
    • "address": "string",
    • "zipCode": "string",
    • "city": "string",
    • "countryCode": "string",
    • "acceptsAdvertisement": true,
    • "lastLoginStamp": "2019-08-24T14:15:22Z",
    • "loginCount": 0,
    • "inactivityState": "Active",
    • "isFlaggedForDeletion": true,
    • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
    • "person": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "accountId": 0,
      • "firstname": "string",
      • "lastname": "string",
      • "gender": "Unknown",
      • "ahvNumber": "string",
      • "mobilePhone": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "maritalStatusId": 0,
      • "maritalStatus": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "isEnabled": true,
        • "sortOrder": 0

        },
      • "account": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "username": "string",
        • "password": "string",
        • "sessionDuration": 0,
        • "isSignupComplete": true,
        • "isLocal": true,
        • "hasSeenOwnProfile": true,
        • "identities": [

          • {

            • "id": 0,
            • "createdBy": "string",
            • "createStamp": "2019-08-24T14:15:22Z",
            • "updatedBy": "string",
            • "updateStamp": "2019-08-24T14:15:22Z",
            • "identityProviderId": 0,
            • "accountId": 0,
            • "identificationLevelId": 0,
            • "externalId": "string",
            • "profileId": 0,
            • "metadata": {

              • "property1": "string",
              • "property2": "string"

              }

            }

          ]

        }

      },
    • "organization": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "uid": "string",
      • "fsoId": 0,
      • "website": "string",
      • "isSelfRegistration": true,
      • "identificationProcess": "string",
      • "isPending": true,
      • "createdByProfileId": 0,
      • "signatureType": "Unknown",
      • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
      • "orgCategoryId": 0,
      • "legalFormId": 0,
      • "orgIdentificationLevelId": 0,
      • "isDeletableByOwner": true,
      • "legalForm": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isOrgDeletableByOwner": true

        },
      • "category": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isVisible": true,
        • "isOrgDeletableByOwner": true,
        • "profilePictureUrl": "string",
        • "smallProfilePictureUrl": "string",
        • "daysUntilFirstDeletionReminder": 0,
        • "daysUntilSecondDeletionReminder": 0,
        • "daysUntilDeletion": 0

        },
      • "identificationLevel": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "description": "string",
        • "levelOfTrust": 0,
        • "elevationServiceId": 0

        },
      • "signatories": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "organizationId": 0,
          • "isRequester": true,
          • "type": "Signer",
          • "position": "string",
          • "gender": "Unknown",
          • "firstname": "string",
          • "lastname": "string",
          • "birthdate": "2019-08-24T14:15:22Z",
          • "email": "string",
          • "ahvNumber": "string",
          • "identityNumber": "string",
          • "address": "string",
          • "zipCode": "string",
          • "city": "string",
          • "origin": "string"

          }

        ]

      },
    • "profilePicture": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "profileId": 0,
      • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
      • "customImageType": "string",
      • "customImageBytesEncoded": "string",
      • "defaultImageUrl": "string",
      • "defaultSmallImageUrl": "string"

      }

    },
  • "representativeProfile": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "personId": 0,
    • "organizationId": 0,
    • "isEnabled": true,
    • "externalKey": "string",
    • "language": "string",
    • "email": "string",
    • "phone": "string",
    • "fax": "string",
    • "address": "string",
    • "zipCode": "string",
    • "city": "string",
    • "countryCode": "string",
    • "acceptsAdvertisement": true,
    • "lastLoginStamp": "2019-08-24T14:15:22Z",
    • "loginCount": 0,
    • "inactivityState": "Active",
    • "isFlaggedForDeletion": true,
    • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
    • "person": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "accountId": 0,
      • "firstname": "string",
      • "lastname": "string",
      • "gender": "Unknown",
      • "ahvNumber": "string",
      • "mobilePhone": "string",
      • "birthdate": "2019-08-24T14:15:22Z",
      • "maritalStatusId": 0,
      • "maritalStatus": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "isEnabled": true,
        • "sortOrder": 0

        },
      • "account": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "username": "string",
        • "password": "string",
        • "sessionDuration": 0,
        • "isSignupComplete": true,
        • "isLocal": true,
        • "hasSeenOwnProfile": true,
        • "identities": [

          • {

            • "id": 0,
            • "createdBy": "string",
            • "createStamp": "2019-08-24T14:15:22Z",
            • "updatedBy": "string",
            • "updateStamp": "2019-08-24T14:15:22Z",
            • "identityProviderId": 0,
            • "accountId": 0,
            • "identificationLevelId": 0,
            • "externalId": "string",
            • "profileId": 0,
            • "metadata": {

              • "property1": "string",
              • "property2": "string"

              }

            }

          ]

        }

      },
    • "organization": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "uid": "string",
      • "fsoId": 0,
      • "website": "string",
      • "isSelfRegistration": true,
      • "identificationProcess": "string",
      • "isPending": true,
      • "createdByProfileId": 0,
      • "signatureType": "Unknown",
      • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
      • "orgCategoryId": 0,
      • "legalFormId": 0,
      • "orgIdentificationLevelId": 0,
      • "isDeletableByOwner": true,
      • "legalForm": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isOrgDeletableByOwner": true

        },
      • "category": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "code": "string",
        • "description": "string",
        • "isVisible": true,
        • "isOrgDeletableByOwner": true,
        • "profilePictureUrl": "string",
        • "smallProfilePictureUrl": "string",
        • "daysUntilFirstDeletionReminder": 0,
        • "daysUntilSecondDeletionReminder": 0,
        • "daysUntilDeletion": 0

        },
      • "identificationLevel": {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "displayName": "string",
        • "description": "string",
        • "levelOfTrust": 0,
        • "elevationServiceId": 0

        },
      • "signatories": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "organizationId": 0,
          • "isRequester": true,
          • "type": "Signer",
          • "position": "string",
          • "gender": "Unknown",
          • "firstname": "string",
          • "lastname": "string",
          • "birthdate": "2019-08-24T14:15:22Z",
          • "email": "string",
          • "ahvNumber": "string",
          • "identityNumber": "string",
          • "address": "string",
          • "zipCode": "string",
          • "city": "string",
          • "origin": "string"

          }

        ]

      },
    • "profilePicture": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "profileId": 0,
      • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
      • "customImageType": "string",
      • "customImageBytesEncoded": "string",
      • "defaultImageUrl": "string",
      • "defaultSmallImageUrl": "string"

      }

    }

  }

]

Get the the Profile Picture of the specified Profile

Allows to retrieve the Profile Picture of the specified Profile.

path Parameters

profileId required

integer <int32>

query Parameters

IncludeCustomImageBytes	boolean
Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/picture

Response samples

• 200

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "profileId": 0,
• "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
• "customImageType": "string",
• "customImageBytesEncoded": "string",
• "defaultImageUrl": "string",
• "defaultSmallImageUrl": "string"

}

Update the Profile Picture of the specified Profile

Allows to update the Profile Picture of the specified Profile

path Parameters

profileId required

integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
customImageType	string MimeType of the custom picture
customImageEncodedBytes	string Base64 encoded bytes of the custom image

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/picture

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "customImageType": "string",
• "customImageEncodedBytes": "string"

}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Delete the Custom Profile Picture of the specified Profile

Allows to delete the Custom Profile Picture for the specified Profile

path Parameters

profileId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/picture

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get the survey status of the specified Profile and Service

Allows to retrieve the survey status of the specified Profile and Service.

path Parameters

profileId required	integer <int32>
serviceId required	integer <int32>

query Parameters

Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/services/{serviceId}/survey

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "surveyId": 0,
• "profileId": 0,
• "serviceId": 0,
• "surveyUrl": "string",
• "isRandomSurveyAvailable": true,
• "isSpontaneousSurveyAvailable": true

}

Create a survey entry for the specified Profile and Service Survey

Allows to create a survey entry for the specified Profile and Service survey

path Parameters

profileId required	integer <int32>
serviceId required	integer <int32>

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
isSpontaneousFeedback	boolean Indicates if the entry is from a spontaneous survey

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/services/{serviceId}/survey/entries

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "isSpontaneousFeedback": true

}

Response samples

• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "surveyId": 0,
• "serviceId": 0,
• "profileId": 0,
• "response": true,
• "isSpontaneousFeedback": true

}

Patch the last survey entry for the specified Profile and Service Survey

Allows to patch the last survey entry for the specified Profile and Service survey

path Parameters

profileId required	integer <int32>
serviceId required	integer <int32>

Request Body schema:

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
response	boolean Response of the survey entry

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/services/{serviceId}/survey/entries/last

Request samples

• Payload

Content type

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

{

• "updatedBy": "string",
• "response": true

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "surveyId": 0,
• "serviceId": 0,
• "profileId": 0,
• "response": true,
• "isSpontaneousFeedback": true

}

Get the list of accessible Widgets for the specified Profile

Allows to retrieve a list of Widgets accessible (by rights) by a specific Profile according to certain criteria.

path Parameters

profileId required

integer <int32>

query Parameters

IsFavorite	boolean Filters widgets according if set or not as favourite by this procuration
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/services/widgets

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "serviceId": 0,
  • "chartTypeId": 0,
  • "name": "string",
  • "displayName": "string",
  • "endpointUrl": "string",
  • "description": "string",
  • "chartType": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "libraryType": "string",
    • "icon": "string"

    },
  • "favoriteWidget": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "representativeProfileId": 0,
    • "delegatorProfileId": 0,
    • "widgetId": 0,
    • "sortOrder": 0

    }

  }

]

Get list of accessible Widgets for the specified Profile's Inbound Procuration

Allows to retrieve a list of accessible (by rights) Widgets within a Profile's Inbound Procuration according to certain criteria.

path Parameters

representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration
principalProfileId required	integer <int32> Id of the principal profile linked to the procuration

query Parameters

delegatorProfileId	integer <int32> Id of the delegator profile linked to the procuration
IsFavorite	boolean Filters widgets according if set or not as favourite by this procuration
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/profiles/{representativeProfileId}/inbound-procurations/from/{principalProfileId}/services/widgets

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "serviceId": 0,
  • "chartTypeId": 0,
  • "name": "string",
  • "displayName": "string",
  • "endpointUrl": "string",
  • "description": "string",
  • "chartType": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "libraryType": "string",
    • "icon": "string"

    },
  • "favoriteWidget": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "representativeProfileId": 0,
    • "delegatorProfileId": 0,
    • "widgetId": 0,
    • "sortOrder": 0

    }

  }

]

Add/update a Widget as favorite for the specified Profile

Allows to create or update a relation of favorite between a specific Widget and a specific Profile.

path Parameters

profileId required	integer <int32>
widgetId required	integer <int32>

Request Body schema:

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
position	integer or null <int32> Tile position (index) in the user dashboard (zero-based)

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/favorites/widgets/{widgetId}

Request samples

• Payload

Content type

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

{

• "createdBy": "string",
• "position": 0

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "profileId": 0,
• "representativeProfileId": 0,
• "delegatorProfileId": 0,
• "widgetId": 0,
• "sortOrder": 0

}

Delete a Widget from the favorites of the specified Profile

Allows to delete an existing relation of favorite between a specific Widget and a specific Profile.

path Parameters

profileId required	integer <int32>
widgetId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/favorites/widgets/{widgetId}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Add/update a Widget as favorite for the specified Profile's Inbound Procuration

Allows to create or update a relation of favorite between a specific Widget and a specific Profile's Inbound Procuration.

path Parameters

representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration
principalProfileId required	integer <int32> Id of the principal profile linked to the procuration
widgetId required	integer <int32> Id of the widget for which a favorite must be created

query Parameters

delegatorProfileId

integer <int32> Id of the delegator profile linked to the procuration

Request Body schema:

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Item to create/update

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
position	integer or null <int32> Tile position (index) in the user dashboard (zero-based)

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{representativeProfileId}/inbound-procurations/from/{principalProfileId}/favorites/widgets/{widgetId}

Request samples

• Payload

Content type

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

{

• "createdBy": "string",
• "position": 0

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "profileId": 0,
• "representativeProfileId": 0,
• "delegatorProfileId": 0,
• "widgetId": 0,
• "sortOrder": 0

}

Delete a Widget from the favorites of the specified Profile's Inbound Procuration

Allows to delete an existing relation of favorite between a specific Widget and a specific Profile's Inbound Procuration.

path Parameters

representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration
principalProfileId required	integer <int32> Id of the principal profile linked to the procuration
widgetId required	integer <int32> Id of the widget for which the favorite must be removed

query Parameters

delegatorProfileId

integer <int32> Id of the delegator profile linked to the procuration

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{representativeProfileId}/inbound-procurations/from/{principalProfileId}/favorites/widgets/{widgetId}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Delete a Service from the favorites of the specified Profile

Allows to delete an existing relation of favorite between a specific Service and a specific Profile.

path Parameters

profileId required	integer <int32>
serviceId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/favorites/services/{serviceId}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Add/update a Service as favorite for the specified Profile

Allows to create or update a relation of favorite between a specific Service and a specific Profile.

path Parameters

profileId required	integer <int32>
serviceId required	integer <int32>

Request Body schema:

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
position	integer or null <int32> Tile position (index) in the user dashboard (zero-based)

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{profileId}/favorites/services/{serviceId}

Request samples

• Payload

Content type

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

{

• "createdBy": "string",
• "position": 0

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "profileId": 0,
• "representativeProfileId": 0,
• "delegatorProfileId": 0,
• "serviceId": 0,
• "sortOrder": 0

}

Delete a Service from the favorites of the specified Profile's Inbound Procuration

Allows to delete an existing relation of favorite between a specific Service and a specific Profile's Inbound Procuration.

path Parameters

representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration
principalProfileId required	integer <int32> Id of the principal profile linked to the procuration
serviceId required	integer <int32> Id of the service for which the favorite must be removed

query Parameters

delegatorProfileId

integer <int32> Id of the delegator profile linked to the procuration

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{representativeProfileId}/inbound-procurations/from/{principalProfileId}/favorites/service/{serviceId}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Add/update a Service as favorite for the specified Profile's Inbound Procuration

Allows to create or update a relation of favorite between a specific Service and a specific Profile's Inbound Procuration.

path Parameters

representativeProfileId required	integer <int32> Id of the representative profile linked to the procuration
principalProfileId required	integer <int32> Id of the principal profile linked to the procuration
serviceId required	integer <int32> Id of the service for which a favorite must be created

query Parameters

delegatorProfileId

integer <int32> Id of the delegator profile linked to the procuration

Request Body schema:

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Item to create/update

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
position	integer or null <int32> Tile position (index) in the user dashboard (zero-based)

Responses

https://api.egov4.ch/profiles/demo/v9-1/profiles/{representativeProfileId}/inbound-procurations/from/{principalProfileId}/favorites/services/{serviceId}

Request samples

• Payload

Content type

application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

{

• "createdBy": "string",
• "position": 0

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "profileId": 0,
• "representativeProfileId": 0,
• "delegatorProfileId": 0,
• "serviceId": 0,
• "sortOrder": 0

}

Roles

Get a list of Roles

Allows to retrieve a list of Roles according to certain criteria.

query Parameters

Name	string Filters settings on the Name field (CI match)
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/roles

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string"

  }

]

Add a new Role

Allows to create a new Role.

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
description	string or null Quick description (not shown to citizen)

Responses

https://api.egov4.ch/profiles/demo/v9-1/roles

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "name": "string",
• "displayName": "string",
• "description": "string"

}

Response samples

• 201
• 400

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string"

}

Get the specified Role

Allows to retrieve a specific Role identified by its Id.

path Parameters

roleId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/roles/{roleId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string"

}

Update the specified Role

Allows to update an existing Role identified by its Id.

path Parameters

roleId required

integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
description	string or null Quick description (not shown to citizen)

Responses

https://api.egov4.ch/profiles/demo/v9-1/roles/{roleId}

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "name": "string",
• "displayName": "string",
• "description": "string"

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string"

}

Delete the specified Role

Allows to delete an existing Role identified by its Id.

path Parameters

roleId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/roles/{roleId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get the list of Profiles for the specified Role

Allows to retrieve a list of Role's Profiles according to certain criteria.

path Parameters

roleId required

integer <int32>

query Parameters

ProfileType	string (ProfileType) Enum: "Person" "Organization" Filters profiles bye their type (person-type or organization-type)
Expand	Array of strings (ProfilesByRoleExpand) Items Enum: "Person" "Organization"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/roles/{roleId}/profiles

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  }

]

Services

Get a list of Services (headers only)

Allows to retrieve a list of Services (headers only) according to certain criteria.

query Parameters

HeadersOnly	boolean Default: false Defines if the response will only contains headers
AsAnonymous	boolean Filters services to only keep the ones that are visible through anonymous role
Ids	Array of integers <int32> [ items <int32 > ] Filters services on the Id field to match the provided ids
ServiceThemeId	integer <int32> Filters services on the ServiceThemeId field
ClientId	integer <int32> Filters services on the ClientId field
ExternalId	string Filters services on the ExternalId field (exact match)
IdentificationLevelId	integer <int32> Filters services on the IdentificationLevelId field
OrgIdentificationLevelId	integer <int32> Filters services on the OrgIdentificationLevelId field
HasAtLeastOneSetting	boolean Filters services to keep only the ones that have at least one setting
IsShownInCatalog	boolean Filters services on the IsShownInCatalog field
IsNew	boolean Filters services on the IsNew field
UrlContains	string Filters services on the Url field (CI, contains)
HasVisibleTheme	boolean Filters services on the ServiceTheme.IsVisible field
Expand	Array of strings (ServicesExpand) Items Enum: "ServiceTheme" "IdentificationLevel" "OrgIdentificationLevel" "ServiceClients" "Survey"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/services

Response samples

• 400

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}

Get a list of Services

Allows to retrieve a list of Services according to certain criteria.

query Parameters

HeadersOnly	boolean Default: false Defines if the response will only contains headers
AsAnonymous	boolean Filters services to only keep the ones that are visible through anonymous role
Ids	Array of integers <int32> [ items <int32 > ] Filters services on the Id field to match the provided ids
ServiceThemeId	integer <int32> Filters services on the ServiceThemeId field
ClientId	integer <int32> Filters services on the ClientId field
ExternalId	string Filters services on the ExternalId field (exact match)
IdentificationLevelId	integer <int32> Filters services on the IdentificationLevelId field
OrgIdentificationLevelId	integer <int32> Filters services on the OrgIdentificationLevelId field
HasAtLeastOneSetting	boolean Filters services to keep only the ones that have at least one setting
IsShownInCatalog	boolean Filters services on the IsShownInCatalog field
IsNew	boolean Filters services on the IsNew field
UrlContains	string Filters services on the Url field (CI, contains)
HasVisibleTheme	boolean Filters services on the ServiceTheme.IsVisible field
Expand	Array of strings (ServicesExpand) Items Enum: "ServiceTheme" "IdentificationLevel" "OrgIdentificationLevel" "ServiceClients" "Survey"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/services

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "name": "string",
  • "displayName": "string",
  • "identificationLevelId": 0,
  • "orgIdentificationLevelId": 0,
  • "serviceThemeId": 0,
  • "iconPath": "string",
  • "cssClass": "string",
  • "url": "string",
  • "urlTarget": "Self",
  • "jiraProjectId": "string",
  • "isProcurationAvailable": true,
  • "isInMaintenance": true,
  • "isShownInCatalog": true,
  • "isExternal": true,
  • "isAccessible": true,
  • "isResponsive": true,
  • "isNew": true,
  • "isNavigationShown": true,
  • "isSupportAvailable": true,
  • "subThemeKey": "string",
  • "isProfileManagerAvailable": true,
  • "daysUntilReminder": 0,
  • "serviceTheme": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "isVisible": true,
    • "sortOrder": 0

    },
  • "serviceClients": [

    • {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "serviceId": 0,
      • "clientId": 0

      }

    ],
  • "identificationLevel": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "levelOfTrust": 0

    },
  • "orgIdentificationLevel": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "description": "string",
    • "levelOfTrust": 0,
    • "elevationServiceId": 0

    },
  • "survey": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "serviceId": 0,
    • "surveyUrl": "string",
    • "isRandomFeedbackEnabled": true,
    • "isSpontaneousFeedbackEnabled": true,
    • "rF_ActivationChance": 0,
    • "rF_MinDaysAfterRefused": 0,
    • "rF_MinDaysAfterAccepted": 0,
    • "sF_MinDaysAfterAccepted": 0

    }

  }

]

Add a new Service

Allows to create a new Service.

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
externalId	string or null External identifier of the service (defined by the canton)
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
identificationLevelId	integer <int32> Identifier of the service's identification level
orgIdentificationLevelId	integer <int32> Identifier of the service's org identification level
serviceThemeId	integer <int32> Identifier of the service's theme
iconPath	string or null Path of the icon to use in the service tile
cssClass	string or null Css classes to apply to the service tile
url	string URL used when the service tile is clicked
urlTarget	string (UrlTarget) Default: "Self" Enum: "Self" "Blank" Type of redirection used when the tile is clicked
jiraProjectId	string or null Identifier of the Jira project related to the service
isProcurationAvailable	boolean Default: false Indicates if this service can be shared using procuration
isInMaintenance	boolean Default: false Indicates if the service is currently available to the citizen. When in maintenance, the service tile indicates that the service is not available due to a maintenance.
isShownInCatalog	boolean Default: true Indicates if the service tile is shown in the service catalog. This value does not affect the service tile visibility in the themes.
isExternal	boolean Default: false Indicates if the service URL refers to an external website
isAccessible	boolean Default: true Indicates if the service follows the web standards in term of accessibility
isResponsive	boolean Default: true Indicates if the service is mobile-friendly
isNew	boolean Default: true Indicates if the service is a fresh addition to the ePortal
isNavigationShown	boolean Default: true Indicates if the navigation panel is opened within the service
isSupportAvailable	boolean Default: true Indicates if the support panel is shown within the service
subThemeKey	string or null Key of the service's sub-theme
isProfileManagerAvailable	boolean Default: false Indicates whether the profile manager (ePM) is available for the service. If the profile manager is available, it will be displayed before accessing the service.
daysUntilReminder	integer or null <int32> Number of days after which a reminder must be sent once the related business case is closed.

Responses

https://api.egov4.ch/profiles/demo/v9-1/services

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "externalId": "string",
• "name": "string",
• "displayName": "string",
• "identificationLevelId": 0,
• "orgIdentificationLevelId": 0,
• "serviceThemeId": 0,
• "iconPath": "string",
• "cssClass": "string",
• "url": "string",
• "urlTarget": "Self",
• "jiraProjectId": "string",
• "isProcurationAvailable": false,
• "isInMaintenance": false,
• "isShownInCatalog": true,
• "isExternal": false,
• "isAccessible": true,
• "isResponsive": true,
• "isNew": true,
• "isNavigationShown": true,
• "isSupportAvailable": true,
• "subThemeKey": "string",
• "isProfileManagerAvailable": false,
• "daysUntilReminder": 0

}

Response samples

• 201
• 400

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "externalId": "string",
• "name": "string",
• "displayName": "string",
• "identificationLevelId": 0,
• "orgIdentificationLevelId": 0,
• "serviceThemeId": 0,
• "iconPath": "string",
• "cssClass": "string",
• "url": "string",
• "urlTarget": "Self",
• "jiraProjectId": "string",
• "isProcurationAvailable": true,
• "isInMaintenance": true,
• "isShownInCatalog": true,
• "isExternal": true,
• "isAccessible": true,
• "isResponsive": true,
• "isNew": true,
• "isNavigationShown": true,
• "isSupportAvailable": true,
• "subThemeKey": "string",
• "isProfileManagerAvailable": true,
• "daysUntilReminder": 0

}

Get the specified Service

Allows to retrieve a specific Service identified by its Id.

path Parameters

serviceId required

integer <int32>

query Parameters

Expand	Array of strings (ServiceByIdExpand) Items Enum: "ServiceTheme" "IdentificationLevel" "OrgIdentificationLevel" "ServiceClients" "Survey"
Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "externalId": "string",
• "name": "string",
• "displayName": "string",
• "identificationLevelId": 0,
• "orgIdentificationLevelId": 0,
• "serviceThemeId": 0,
• "iconPath": "string",
• "cssClass": "string",
• "url": "string",
• "urlTarget": "Self",
• "jiraProjectId": "string",
• "isProcurationAvailable": true,
• "isInMaintenance": true,
• "isShownInCatalog": true,
• "isExternal": true,
• "isAccessible": true,
• "isResponsive": true,
• "isNew": true,
• "isNavigationShown": true,
• "isSupportAvailable": true,
• "subThemeKey": "string",
• "isProfileManagerAvailable": true,
• "daysUntilReminder": 0,
• "serviceTheme": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "isVisible": true,
  • "sortOrder": 0

  },
• "serviceClients": [

  • {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "serviceId": 0,
    • "clientId": 0

    }

  ],
• "identificationLevel": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "levelOfTrust": 0

  },
• "orgIdentificationLevel": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "levelOfTrust": 0,
  • "elevationServiceId": 0

  },
• "survey": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "serviceId": 0,
  • "surveyUrl": "string",
  • "isRandomFeedbackEnabled": true,
  • "isSpontaneousFeedbackEnabled": true,
  • "rF_ActivationChance": 0,
  • "rF_MinDaysAfterRefused": 0,
  • "rF_MinDaysAfterAccepted": 0,
  • "sF_MinDaysAfterAccepted": 0

  }

}

Update the specified Service

Allows to update an existing Service identified by its Id.

When IsProcurationAvailable is toggled, triggers an automated update of related procuration services.

path Parameters

serviceId required

integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
externalId	string or null External identifier of the service (defined by the canton)
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
identificationLevelId	integer <int32> Identifier of the service's identification level
orgIdentificationLevelId	integer <int32> Identifier of the service's org identification level
serviceThemeId	integer <int32> Identifier of the service's theme
iconPath	string or null Path of the icon to use in the service tile
cssClass	string or null Css classes to apply to the service tile
url	string URL used when the service tile is clicked
urlTarget	string (UrlTarget) Default: "Self" Enum: "Self" "Blank" Type of redirection used when the tile is clicked
jiraProjectId	string or null Identifier of the Jira project related to the service
isProcurationAvailable	boolean Default: false Indicates if this service can be shared using procuration
isInMaintenance	boolean Default: false Indicates if the service is currently available to the citizen. When in maintenance, the service tile indicates that the service is not available due to a maintenance.
isShownInCatalog	boolean Default: true Indicates if the service tile is shown in the service catalog. This value does not affect the service tile visibility in the themes.
isExternal	boolean Default: false Indicates if the service URL refers to an external website
isAccessible	boolean Default: true Indicates if the service follows the web standards in term of accessibility
isResponsive	boolean Default: true Indicates if the service is mobile-friendly
isNew	boolean Default: true Indicates if the service is a fresh addition to the ePortal
isNavigationShown	boolean Default: true Indicates if the navigation panel is opened within the service
isSupportAvailable	boolean Default: true Indicates if the support panel is shown within the service
subThemeKey	string or null Key of the service's sub-theme
isProfileManagerAvailable	boolean Default: false Indicates whether the profile manager (ePM) is available for the service. If the profile manager is available, it will be displayed before accessing the service.
daysUntilReminder	integer or null <int32> Number of days after which a reminder must be sent once the related business case is closed.

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "externalId": "string",
• "name": "string",
• "displayName": "string",
• "identificationLevelId": 0,
• "orgIdentificationLevelId": 0,
• "serviceThemeId": 0,
• "iconPath": "string",
• "cssClass": "string",
• "url": "string",
• "urlTarget": "Self",
• "jiraProjectId": "string",
• "isProcurationAvailable": false,
• "isInMaintenance": false,
• "isShownInCatalog": true,
• "isExternal": false,
• "isAccessible": true,
• "isResponsive": true,
• "isNew": true,
• "isNavigationShown": true,
• "isSupportAvailable": true,
• "subThemeKey": "string",
• "isProfileManagerAvailable": false,
• "daysUntilReminder": 0

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "externalId": "string",
• "name": "string",
• "displayName": "string",
• "identificationLevelId": 0,
• "orgIdentificationLevelId": 0,
• "serviceThemeId": 0,
• "iconPath": "string",
• "cssClass": "string",
• "url": "string",
• "urlTarget": "Self",
• "jiraProjectId": "string",
• "isProcurationAvailable": true,
• "isInMaintenance": true,
• "isShownInCatalog": true,
• "isExternal": true,
• "isAccessible": true,
• "isResponsive": true,
• "isNew": true,
• "isNavigationShown": true,
• "isSupportAvailable": true,
• "subThemeKey": "string",
• "isProfileManagerAvailable": true,
• "daysUntilReminder": 0

}

Delete the specified Service

Allows to delete an existing Service identified by its Id.

path Parameters

serviceId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get the list of Profiles for the specified Service

Allows to retrieve a list of Service's Profiles (by rights) according to certain criteria.

path Parameters

serviceId required

integer <int32>

query Parameters

ProfileType	string (ProfileType) Enum: "Person" "Organization" Filters profiles bye their type (person-type or organization-type)
Expand	Array of strings (ProfilesByServiceExpand) Items Enum: "Person" "Organization"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/profiles

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "personId": 0,
  • "organizationId": 0,
  • "isEnabled": true,
  • "externalKey": "string",
  • "language": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "countryCode": "string",
  • "acceptsAdvertisement": true,
  • "lastLoginStamp": "2019-08-24T14:15:22Z",
  • "loginCount": 0,
  • "inactivityState": "Active",
  • "isFlaggedForDeletion": true,
  • "gracePeriodEndDate": "2019-08-24T14:15:22Z",
  • "person": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "accountId": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "gender": "Unknown",
    • "ahvNumber": "string",
    • "mobilePhone": "string",
    • "birthdate": "2019-08-24T14:15:22Z",
    • "maritalStatusId": 0,
    • "maritalStatus": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "isEnabled": true,
      • "sortOrder": 0

      },
    • "account": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "username": "string",
      • "password": "string",
      • "sessionDuration": 0,
      • "isSignupComplete": true,
      • "isLocal": true,
      • "hasSeenOwnProfile": true,
      • "identities": [

        • {

          • "id": 0,
          • "createdBy": "string",
          • "createStamp": "2019-08-24T14:15:22Z",
          • "updatedBy": "string",
          • "updateStamp": "2019-08-24T14:15:22Z",
          • "identityProviderId": 0,
          • "accountId": 0,
          • "identificationLevelId": 0,
          • "externalId": "string",
          • "profileId": 0,
          • "metadata": {

            • "property1": "string",
            • "property2": "string"

            }

          }

        ]

      }

    },
  • "organization": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "uid": "string",
    • "fsoId": 0,
    • "website": "string",
    • "isSelfRegistration": true,
    • "identificationProcess": "string",
    • "isPending": true,
    • "createdByProfileId": 0,
    • "signatureType": "Unknown",
    • "businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
    • "orgCategoryId": 0,
    • "legalFormId": 0,
    • "orgIdentificationLevelId": 0,
    • "isDeletableByOwner": true,
    • "legalForm": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isOrgDeletableByOwner": true

      },
    • "category": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "code": "string",
      • "description": "string",
      • "isVisible": true,
      • "isOrgDeletableByOwner": true,
      • "profilePictureUrl": "string",
      • "smallProfilePictureUrl": "string",
      • "daysUntilFirstDeletionReminder": 0,
      • "daysUntilSecondDeletionReminder": 0,
      • "daysUntilDeletion": 0

      },
    • "identificationLevel": {

      • "id": 0,
      • "createdBy": "string",
      • "createStamp": "2019-08-24T14:15:22Z",
      • "updatedBy": "string",
      • "updateStamp": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "displayName": "string",
      • "description": "string",
      • "levelOfTrust": 0,
      • "elevationServiceId": 0

      },
    • "signatories": [

      • {

        • "id": 0,
        • "createdBy": "string",
        • "createStamp": "2019-08-24T14:15:22Z",
        • "updatedBy": "string",
        • "updateStamp": "2019-08-24T14:15:22Z",
        • "organizationId": 0,
        • "isRequester": true,
        • "type": "Signer",
        • "position": "string",
        • "gender": "Unknown",
        • "firstname": "string",
        • "lastname": "string",
        • "birthdate": "2019-08-24T14:15:22Z",
        • "email": "string",
        • "ahvNumber": "string",
        • "identityNumber": "string",
        • "address": "string",
        • "zipCode": "string",
        • "city": "string",
        • "origin": "string"

        }

      ]

    },
  • "profilePicture": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "profileId": 0,
    • "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    • "customImageType": "string",
    • "customImageBytesEncoded": "string",
    • "defaultImageUrl": "string",
    • "defaultSmallImageUrl": "string"

    }

  }

]

Add/update the relation between the specified Role and Service

Allows to create or update a Service-Role relation.

Triggers an automated update of related procuration services.

path Parameters

serviceId required	integer <int32>
roleId required	integer <int32>

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
isVisible	boolean Default: true Indicates if the service tile in the ePortal is visible within this relation. Does not affect the service catalog.

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/roles/{roleId}

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "isVisible": true

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "serviceId": 0,
• "roleId": 0,
• "isVisible": true

}

Delete the relation between the specified Role and Service

Allows to delete an existing Service-Role identified by its Service and Role identifiers.

Triggers an automated update of related procuration services.

path Parameters

serviceId required	integer <int32>
roleId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/roles/{roleId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get the the specified Role within the Service

Allows to retrieve a specific Role (and its relation) within a Service

path Parameters

serviceId required	integer <int32>
roleId required	integer <int32>

query Parameters

Expand	Array of strings (RoleByServiceAndIdExpand) Items Value: "ServiceRole"
Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/roles/{roleId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "serviceRole": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "serviceId": 0,
  • "roleId": 0,
  • "isVisible": true

  }

}

Get the list of Roles for the specified Service

Allows to retrieve a list of Service's Roles (and their relations) according to certain criteria.

path Parameters

serviceId required

integer <int32>

query Parameters

Expand	Array of strings (RolesByServiceExpand) Items Value: "ServiceRole"
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/roles

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "serviceRole": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "serviceId": 0,
    • "roleId": 0,
    • "isVisible": true

    }

  }

]

Get the list of Clients for the specified Service

Allows to retrieve a list of Service's Clients according to certain criteria.

path Parameters

serviceId required

integer <int32>

query Parameters

Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/clients

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string"

  }

]

Get the the specified Client within the Service

Allows to retrieve a specific Client within a Service

path Parameters

serviceId required	integer <int32>
clientId required	integer <int32>

query Parameters

Limited	integer <int32>
Select	Array of strings

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/clients/{clientId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string"

}

Add/update the relation between the specified Client and Service

Allows to create or update a Service-Client relation.

path Parameters

serviceId required	integer <int32>
clientId required	integer <int32>

Request Body schema: application/json

createdBy required

string [ 1 .. 100 ] characters Requester of the creation

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/clients/{clientId}

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string"

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "serviceId": 0,
• "clientId": 0

}

Delete the relation between the specified Client and Service

Allows to delete an existing Service-Client identified by its Service and Client identifiers.

path Parameters

serviceId required	integer <int32>
clientId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/clients/{clientId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get the list of Service Settings for the specified Service

Allows to retrieve a list of Service's Settings according to certain criteria.

path Parameters

serviceId required

integer <int32>

query Parameters

Name	string Filters settings on the Name field (CI match)
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/settings

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "serviceId": 0,
  • "isSecure": true

  }

]

Add an new Service Setting to the specified Service

Allows to create a new Service Setting for the given Service.

path Parameters

serviceId required

integer <int32>

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
name	string Unique-per-service code name
displayName	string Name that will be used for display purpose (translation term)
description	string or null Quick description (not shown to citizen)
isSecure	boolean Default: false Indicates if the value of the setting is considered sensitive. Affects the way the value is displayed in the back-office.

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/settings

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "isSecure": false

}

Response samples

• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "serviceId": 0,
• "isSecure": true

}

Get the specified Service Setting for the specified Service

Allows to retrieve a specific Service Setting identified by its Service and Service Setting identifiers.

path Parameters

serviceId required	integer <int32>
settingId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/settings/{settingId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "serviceId": 0,
• "isSecure": true

}

Update the specified Service Setting for the specified Service

Allows to update an existing Service Setting identified by its Service and Service Setting identifiers.

path Parameters

serviceId required	integer <int32>
settingId required	integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
id	integer <int32> Id of the setting to update
name	string Unique-per-service code name
displayName	string Name that will be used for display purpose (translation term)
description	string or null Quick description (not shown to citizen)
isSecure	boolean Default: false Indicates if the value of the setting is considered sensitive. Affects the way the value is displayed in the back-office.

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/settings/{settingId}

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "id": 0,
• "name": "string",
• "displayName": "string",
• "description": "string",
• "isSecure": false

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "serviceId": 0,
• "isSecure": true

}

Delete the specified Service Setting for the specified Service

Allows to delete an existing Service Setting identified by its Service and Service Setting identifiers.

path Parameters

serviceId required	integer <int32>
settingId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/settings/{settingId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get the list of Service Steps for the specified Service

Allows to retrieve a list of Service's Steps according to certain criteria.

path Parameters

serviceId required

integer <int32>

query Parameters

Name	string Filters steps on the Name field (CI match)
MinSortOrder	integer <int32> Filters steps on the SortOrder field
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/steps

Response samples

• 200
• 400
• 404

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "text": "string",
  • "redirectUrl": "string",
  • "iconPath": "string",
  • "processingTimeInHours": 0,
  • "sortOrder": 0,
  • "serviceId": 0

  }

]

Add an new Service Step to the specified Service

Allows to create a new Service Step for the given Service.

path Parameters

serviceId required

integer <int32>

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
name	string Unique-per-service code name
displayName	string Name that will be used for display purpose (translation term)
description	string or null Quick description (not shown to citizen)
text	string or null Translation term containing the text
redirectUrl	string or null Redirect URL related to the step
iconPath	string or null Relative system file path to an icon
processingTimeInHours	integer or null <int32> Estimated time in hours the step will take to be completed
sortOrder	integer <int32> Value on which the steps will be sorted (asc.) in the navigation panel

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/steps

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "text": "string",
• "redirectUrl": "string",
• "iconPath": "string",
• "processingTimeInHours": 0,
• "sortOrder": 0

}

Response samples

• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "text": "string",
• "redirectUrl": "string",
• "iconPath": "string",
• "processingTimeInHours": 0,
• "sortOrder": 0,
• "serviceId": 0

}

Get the specified Service Step for the specified Service

Allows to retrieve a specific Service Step identified by its Service and Service Step identifiers.

path Parameters

serviceId required	integer <int32>
stepId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/steps/{stepId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "text": "string",
• "redirectUrl": "string",
• "iconPath": "string",
• "processingTimeInHours": 0,
• "sortOrder": 0,
• "serviceId": 0

}

Update the specified Service Step for the specified Service

Allows to update an existing Service Step identified by its Service and Service Step identifiers.

path Parameters

serviceId required	integer <int32>
stepId required	integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
id	integer <int32> Id of the setting to update
name	string Unique-per-service code name
displayName	string Name that will be used for display purpose (translation term)
description	string or null Quick description (not shown to citizen)
text	string or null Translation term containing the text
redirectUrl	string or null Redirect URL related to the step
iconPath	string or null Relative system file path to an icon
processingTimeInHours	integer or null <int32> Estimated time in hours the step will take to be completed
sortOrder	integer <int32> Value on which the steps will be sorted (asc.) in the navigation panel

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/steps/{stepId}

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "id": 0,
• "name": "string",
• "displayName": "string",
• "description": "string",
• "text": "string",
• "redirectUrl": "string",
• "iconPath": "string",
• "processingTimeInHours": 0,
• "sortOrder": 0

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "text": "string",
• "redirectUrl": "string",
• "iconPath": "string",
• "processingTimeInHours": 0,
• "sortOrder": 0,
• "serviceId": 0

}

Delete the specified Service Step for the specified Service

Allows to delete an existing Service Step identified by its Service and Service Step identifiers.

path Parameters

serviceId required	integer <int32>
stepId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/steps/{stepId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Create or update the Survey for the specified Service

Allows to create or update an existing Survey identified by its Service identifier.

path Parameters

serviceId required

integer <int32>

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
surveyUrl	string Url of the survey
isRandomFeedbackEnabled	boolean Indicates if the survey is a random survey
isSpontaneousFeedbackEnabled	boolean Indicates if the survey can be a spontanous survey
rF_ActivationChance	integer <int32> Activation chance of the random survey
rF_MinDaysAfterRefused	integer <int32> Number of waiting days before a random survey reponse can be supplied again after a dismiss or a denial
rF_MinDaysAfterAccepted	integer <int32> Number of waiting days before a random survey reponse can be supplied again after a participation
sF_MinDaysAfterAccepted	integer <int32> Number of waiting days before a spontaneous survey reponse can be supplied again after a participation

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/survey

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "surveyUrl": "string",
• "isRandomFeedbackEnabled": true,
• "isSpontaneousFeedbackEnabled": true,
• "rF_ActivationChance": 0,
• "rF_MinDaysAfterRefused": 0,
• "rF_MinDaysAfterAccepted": 0,
• "sF_MinDaysAfterAccepted": 0

}

Response samples

• 200
• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "serviceId": 0,
• "surveyUrl": "string",
• "isRandomFeedbackEnabled": true,
• "isSpontaneousFeedbackEnabled": true,
• "rF_ActivationChance": 0,
• "rF_MinDaysAfterRefused": 0,
• "rF_MinDaysAfterAccepted": 0,
• "sF_MinDaysAfterAccepted": 0

}

Get the Survey for the specified Service

Allows to retrieve a specific Survey identified by its Service identifier.

path Parameters

serviceId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/survey

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "serviceId": 0,
• "surveyUrl": "string",
• "isRandomFeedbackEnabled": true,
• "isSpontaneousFeedbackEnabled": true,
• "rF_ActivationChance": 0,
• "rF_MinDaysAfterRefused": 0,
• "rF_MinDaysAfterAccepted": 0,
• "sF_MinDaysAfterAccepted": 0

}

Delete the Survey for the specified Service

Allows to delete an existing Survey identified by its Service identifier.

path Parameters

serviceId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/survey

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

Get a list of available ChartTypes for widgets

Allows to retrieve a list of available Widget ChartTypes.

query Parameters

Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/services/widgets/types

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "libraryType": "string",
  • "icon": "string"

  }

]

Create a new Widget for the specified Service

Allows to create a Widget for the given Service

path Parameters

serviceId required

integer <int32>

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
chartTypeId	integer <int32> Related chart type id
name	string Name of the widget
displayName	string Name that will be used for display purpose (translation term)
endpointUrl	string EndpointUrl
description	string or null Quick description

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/widgets

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "chartTypeId": 0,
• "name": "string",
• "displayName": "string",
• "endpointUrl": "string",
• "description": "string"

}

Response samples

• 201
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "serviceId": 0,
• "chartTypeId": 0,
• "name": "string",
• "displayName": "string",
• "endpointUrl": "string",
• "description": "string"

}

Get a list of Widget for the specified Service

Allows to retrieve a list of Service's Widgets according to certain criteria.

path Parameters

serviceId required

integer <int32>

query Parameters

Limited	integer <int32>
Select	Array of strings
Expand	Array of strings (WidgetsByServiceExpand) Items Value: "ChartType"
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

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/widgets

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "serviceId": 0,
  • "chartTypeId": 0,
  • "name": "string",
  • "displayName": "string",
  • "endpointUrl": "string",
  • "description": "string",
  • "chartType": {

    • "id": 0,
    • "createdBy": "string",
    • "createStamp": "2019-08-24T14:15:22Z",
    • "updatedBy": "string",
    • "updateStamp": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "displayName": "string",
    • "libraryType": "string",
    • "icon": "string"

    }

  }

]

Get a specific Widget for the specified Service

Allows to retrieve a specific Widget identified by its Service and Widget identifiers.

path Parameters

serviceId required	integer <int32>
widgetId required	integer <int32>

query Parameters

Limited	integer <int32>
Select	Array of strings
Expand	Array of strings (WidgetByIdAndServiceExpand) Items Value: "ChartType"

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/widgets/{widgetId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "serviceId": 0,
• "chartTypeId": 0,
• "name": "string",
• "displayName": "string",
• "endpointUrl": "string",
• "description": "string",
• "chartType": {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "libraryType": "string",
  • "icon": "string"

  }

}

Update a specific Widget for the specified Service

Allows to update an existing Widget identified by its Service and Widget identifiers.

path Parameters

serviceId required	integer <int32>
widgetId required	integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
chartTypeId	integer <int32> Related chart type id
name	string Name of the widget
displayName	string Name that will be used for display purpose (translation term)
endpointUrl	string EndpointUrl
description	string or null Quick description

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/widgets/{widgetId}

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "chartTypeId": 0,
• "name": "string",
• "displayName": "string",
• "endpointUrl": "string",
• "description": "string"

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "serviceId": 0,
• "chartTypeId": 0,
• "name": "string",
• "displayName": "string",
• "endpointUrl": "string",
• "description": "string"

}

Delete a specific Widget for the specified Service

Allows to delete an existing Widget identified by its Service and Widget identifiers.

path Parameters

serviceId required	integer <int32>
widgetId required	integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/services/{serviceId}/widgets/{widgetId}

Response samples

• 404

Content type

application/json

{

• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}

ServiceThemes

Get a list of Themes

Allows to retrieve a list of Service Themes according to certain criteria.

query Parameters

AsAnonymous	boolean Filters themes to keep only the ones that are visible through the anonymous role
IsVisible	boolean Filters themes on the IsVisible field
HasServiceShownInCatalog	boolean Filters themes to keep only the ones that are related to at least one service that has the given value for the field IsShownInCatalog
Limited	integer <int32>
Select	Array of strings
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

https://api.egov4.ch/profiles/demo/v9-1/themes

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "id": 0,
  • "createdBy": "string",
  • "createStamp": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updateStamp": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "isVisible": true,
  • "sortOrder": 0

  }

]

Add an new Theme

Allows to create a new Service Theme.

Request Body schema: application/json

createdBy required	string [ 1 .. 100 ] characters Requester of the creation
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
description	string or null Quick description (not shown to citizen)
isVisible	boolean Default: true Indicates if the theme menu is visible within the navigation panel.
sortOrder	integer <int32> Value on which the themes will be sorted (asc.) in the navigation panel When omitted, the higher value + 1 is used by default.

Responses

https://api.egov4.ch/profiles/demo/v9-1/themes

Request samples

• Payload

Content type

application/json

{

• "createdBy": "string",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "isVisible": true,
• "sortOrder": 0

}

Response samples

• 201
• 400

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "isVisible": true,
• "sortOrder": 0

}

Get the specified Theme

Allows to retrieve a specific Service Theme identified by its Id.

path Parameters

themeId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/themes/{themeId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "isVisible": true,
• "sortOrder": 0

}

Update a the specified Theme

Allows to update an existing Service Theme identified by its Id.

path Parameters

themeId required

integer <int32>

Request Body schema: application/json

updatedBy required	string [ 1 .. 100 ] characters Requester of the update
name	string Unique code name
displayName	string Name that will be used for display purpose (translation term)
description	string or null Quick description (not shown to citizen)
isVisible	boolean Default: true Indicates if the theme menu is visible within the navigation panel.
sortOrder	integer <int32> Value on which the themes will be sorted (asc.) in the navigation panel When omitted, the higher value + 1 is used by default.

Responses

https://api.egov4.ch/profiles/demo/v9-1/themes/{themeId}

Request samples

• Payload

Content type

application/json

{

• "updatedBy": "string",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "isVisible": true,
• "sortOrder": 0

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "id": 0,
• "createdBy": "string",
• "createStamp": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updateStamp": "2019-08-24T14:15:22Z",
• "name": "string",
• "displayName": "string",
• "description": "string",
• "isVisible": true,
• "sortOrder": 0

}

Delete the specified Theme

Allows to delete an existing Service Theme identified by its Id.

Deletion is only possible when the targeted service theme is not in use by any Service.

path Parameters

themeId required

integer <int32>

Responses

https://api.egov4.ch/profiles/demo/v9-1/themes/{themeId}

Response samples

• 400
• 404

Content type

application/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "instance": "string",
• "property1": null,
• "property2": null

}