Simployer API documentation

Welcome to our API documentation!

Simployer API Doc

This page contains information about our REST endpoints and details regarding webhook endpoints. We are currently in a phase where we will replace our existing WCF’s with REST and will continuously publish new endpoints on this page.

Not a developer?

Please visit our webpage to learn more about our products.

Simployer Access and SSO

Looking for our SSO options? Please look here for product description.

Webhook Integration

From January 2021 Simployer will offer webhook integrations. To get access to the webhook admin UI please send an email to api@simployer.com

Webhook admin UI

Get an overview of your webhook configurations:

Simployer API Doc

Create new webhook configurations:

Simployer API Doc

Get webhook statuses:

Simployer API Doc

When are events triggered from Simployer

Person

When	Event	Description
Creating a person	personCreated
Changing a persons name	personNameChanged
Deleting a person	personDeleted
Adding email to a person	personEmailAdded
Changing email for a person	personEmailChanged
Delete email from a person	personEmailDeleted
Adding phone to a person	personPhoneAdded
Changing phone for a person	personPhoneChanged
Delete phone from a person	personPhoneDeleted

Group

When	Event	Description
Creating a group	unitCreated	unitTypeKind = 'Group'
Deleting a group	unitDeleted
Changing a groups name	unitNameChanged
Changing a groups code	unitAliasChanged

Unit (Department/Group)

When	Event	Description
Creating a department	unitCreated	unitTypeKind = 'Department'
Creating a group	unitCreated	unitTypeKind = 'Group'
Deleting a department	unitDeleted
Deleting a group	unitDeleted
Changing a departments code	unitAliasChanged
Changing a groups code	unitAliasChanged
Changing a departments name	unitNameChanged
Changing a group name	unitNameChanged

LegalUnit

When	Event	Description
Creating a legal unit	legalUnitCreated	Creating a Simployer unit with type legal unit
Deleting a legal unit	legalUnitDeleted
Changing a legal unit name	legalUnitNameChanged
Changing a legal unit org. number	legalUnitOrganizationNumberChanged

Group membership

When	Event	Description
Adding a person as a direct member to a group	personAddedToUnit	If no group relationship allready exist
Removing a person (direct member) from a group	personRemovedFromUnit	If this is the only group relationship
Adding a position group relation	personAddedToUnit	For all persons with this active position, if the person does not allready have a membership
Removing a position group relation	personRemovedFromUnit	For all persons where this relationship is the only way for the group membership
Adding a position to a person	personAddedToUnit	If the position is bound and the person does not allready have a membership
Removing a position from a person	personRemovedFromUnit	If the position is bound to a group and this relationship is the only one giving the person membership
Adding a person as an indirect member to a group (through department)	personAddedToUnit	If no group relationship allready exist
Removing a person (indirect member) from a group	personRemovedFromUnit	If this is the only group relationship

Webhook Callback API v0.2.5

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This defines the contract an external system have to fulfill when being the target of the Simployer Webhook Integration. The URL and exact endpoint can be defined when setting up the integration within Simployer. This documentation uses /callback as the endpoint, but any endpoint can be used.

IMPORTANT: This definition is still a work in progress and changes may occur at any time.

Base URLs:

https://user-defined-custom.domain.com

Authentication

HTTP Authentication, scheme: basic Basic authentication
API Key (apiKeyAuth)
- Parameter Name: X-API-KEY, in: header. API Key authentication
oAuth2 authentication. OAuth 2.0 authentication
- Flow: clientCredentials
- Token URL = https://user-defined-authorization.domain.com/custom/url

Scope	Scope Description
write:events	write events to the callback

Callback

postEvents

Code samples

## You can also use wget
curl -X POST https://user-defined-custom.domain.com/callback \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://user-defined-custom.domain.com/callback', headers = headers)

print(r.json())

POST /callback

This endpoint is called by Simployer to deliver events. The name of the endpoint can be anything. /callback is used as an example.

The webhook must respond to the POST request within 10 seconds (TBD). Otherwise, Simployer will assume a 599 Network connect timeout error response.

Body parameter

[
  {
    "tenantId": "67cdd743-a83f-404b-93ef-29dfe5bc2e31",
    "eventId": "83e0e090-e16f-48ab-910e-96d5f3f1dd14",
    "timestamp": "2019-08-24T14:15:22Z",
    "topic": "Person",
    "kind": "Simployer.Person.Events.PersonCreated",
    "body": {
      "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
      "firstName": "Kim",
      "lastName": "Smith"
    }
  }
]

Parameters

Name	In	Type	Required	Description
body	body	payload	true	The events. Maximum size is 256kB (TBD).

Example responses

4xx Response

{
  "code": "string",
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	All events in array received OK	None
4xx	Client Error	An error occured. Simployer will try to send all events again.	error

Schemas

payload

[
  {
    "tenantId": "67cdd743-a83f-404b-93ef-29dfe5bc2e31",
    "eventId": "83e0e090-e16f-48ab-910e-96d5f3f1dd14",
    "timestamp": "2019-08-24T14:15:22Z",
    "topic": "Person",
    "kind": "Simployer.Person.Events.PersonCreated",
    "body": {
      "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
      "firstName": "Kim",
      "lastName": "Smith"
    }
  }
]

An array of eventEnvelope.

Properties

Name	Type	Required	Restrictions	Description
anonymous	[eventEnvelope]	false	none	An array of `eventEnvelope`.

eventEnvelope

{
  "tenantId": "67cdd743-a83f-404b-93ef-29dfe5bc2e31",
  "eventId": "83e0e090-e16f-48ab-910e-96d5f3f1dd14",
  "timestamp": "2019-08-24T14:15:22Z",
  "topic": "Person",
  "kind": "Simployer.Person.Events.PersonCreated",
  "body": {
    "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
    "firstName": "Kim",
    "lastName": "Smith"
  }
}

Properties

Name	Type	Required	Restrictions	Description
tenantId	string(uuid)	true	none	none
eventId	string(uuid)	true	none	none
timestamp	string(date-time)	true	none	none
topic	string	true	none	Values: * `Person` * `LegalUnit` * `Unit` * `UnitMembership` * `Tenant`
kind	string	true	none	TO BE DEFINED. Describes the schema of the `Body` property
body	any	true	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	personCreated	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	personDeleted	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	personEmailAdded	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	personEmailChanged	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	personEmailDeleted	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	personNameChanged	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	personPhoneAdded	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	personPhoneChanged	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	personPhoneDeleted	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	personRequestedGDPRDeletion	false	none	TO BE IMPLEMENTED - The person requested their right to be deleted as per GDPR article 17.

xor

Name	Type	Required	Restrictions	Description
» anonymous	unitCreated	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	unitDeleted	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	unitNameChanged	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	unitAliasChanged	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	unitTypeIdChanged	false	none	The Unit has changed type (not to be confused with the type itself changing in any way).

xor

Name	Type	Required	Restrictions	Description
» anonymous	unitTypeCreated	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	unitTypeDeleted	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	unitTypeNameChanged	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	legalUnitCreated	false	none	TO BE DEFINED AND IMPLEMENTED

xor

Name	Type	Required	Restrictions	Description
» anonymous	legalUnitDeleted	false	none	TO BE DEFINED AND IMPLEMENTED

xor

Name	Type	Required	Restrictions	Description
» anonymous	legalUnitNameChanged	false	none	TO BE DEFINED AND IMPLEMENTED

xor

Name	Type	Required	Restrictions	Description
» anonymous	legalUnitOrganizationNumberChanged	false	none	TO BE DEFINED AND IMPLEMENTED

xor

Name	Type	Required	Restrictions	Description
» anonymous	personAddedToUnit	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	personRemovedFromUnit	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	tenantCreated	false	none	TO BE IMPLEMENTED

xor

Name	Type	Required	Restrictions	Description
» anonymous	tenantDeleted	false	none	TO BE IMPLEMENTED

xor

Name	Type	Required	Restrictions	Description
» anonymous	tenantNameChanged	false	none	TO BE IMPLEMENTED

Enumerated Values

Property	Value
topic	Person
topic	LegalUnit
topic	Unit
topic	UnitMembership
topic	Tenant
kind	Simployer.Person.Events.PersonCreated
kind	Simployer.Person.Events.PersonDeleted
kind	Simployer.Person.Events.PersonEmailAdded
kind	Simployer.Person.Events.PersonEmailChanged
kind	Simployer.Person.Events.PersonEmailDeleted
kind	Simployer.Person.Events.PersonNameChanged
kind	Simployer.Person.Events.PersonPhoneAdded
kind	Simployer.Person.Events.PersonPhoneChanged
kind	Simployer.Person.Events.PersonPhoneDeleted
kind	Simployer.Person.Events.PersonRequestedGDPRDeletion
kind	Simployer.Unit.Events.UnitCreated
kind	Simployer.Unit.Events.UnitDeleted
kind	Simployer.Unit.Events.UnitNameChanged
kind	Simployer.Unit.Events.UnitAliasChanged
kind	Simployer.Unit.Events.UnitTypeIdChanged
kind	Simployer.Unit.Events.UnitTypeCreated
kind	Simployer.Unit.Events.UnitTypeDeleted
kind	Simployer.Unit.Events.UnitTypeNameChanged
kind	Simployer.Unit.Events.LegalUnitCreated
kind	Simployer.Unit.Events.LegalUnitDeleted
kind	Simployer.Unit.Events.LegalUnitNameChanged
kind	Simployer.Unit.Events.LegalUnitOrganizationNumberChanged
kind	Simployer.Core.Events.PersonAddedToUnit
kind	Simployer.Core.Events.PersonRemovedFromUnit
kind	Simployer.Tenant.Events.TenantCreated
kind	Simployer.Tenant.Events.TenantDeleted
kind	Simployer.Tenant.Events.TenantNameChanged

personCreated

{
  "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
  "firstName": "Kim",
  "lastName": "Smith"
}

Properties

Name	Type	Required	Restrictions	Description
personId	string(uuid)	true	none	none
firstName	string	true	none	none
lastName	string	true	none	none

personDeleted

{
  "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec"
}

Properties

Name	Type	Required	Restrictions	Description
personId	string(uuid)	true	none	none

personEmailAdded

{
  "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
  "emailId": "0b470856-6b9d-43ea-b49b-377be18fa249",
  "emailTypeId": "26ae6698-25c1-4945-a1e0-a58629b1dcc2",
  "emailTypeKind": "2dd993f6-562c-4575-82b3-11750c6c8d82",
  "emailAddress": "user@example.com"
}

Properties

Name	Type	Required	Restrictions	Description
personId	string(uuid)	true	none	none
emailId	string(uuid)	true	none	none
emailTypeId	string(uuid)	true	none	none
emailTypeKind	string(uuid)	true	none	Types: * `2dd993f6-562c-4575-82b3-11750c6c8d82` - Work * `d0d62c34-ca62-4281-bef9-96763103550b` - Private
emailAddress	string(email)	true	none	none

Enumerated Values

Property	Value
emailTypeKind	2dd993f6-562c-4575-82b3-11750c6c8d82
emailTypeKind	d0d62c34-ca62-4281-bef9-96763103550b

personEmailChanged

{
  "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
  "emailId": "0b470856-6b9d-43ea-b49b-377be18fa249",
  "emailTypeId": "26ae6698-25c1-4945-a1e0-a58629b1dcc2",
  "emailTypeKind": "2dd993f6-562c-4575-82b3-11750c6c8d82",
  "emailAddress": "user@example.com"
}

Properties

Name	Type	Required	Restrictions	Description
personId	string(uuid)	true	none	none
emailId	string(uuid)	true	none	none
emailTypeId	string(uuid)	true	none	none
emailTypeKind	string(uuid)	true	none	Types: * `2dd993f6-562c-4575-82b3-11750c6c8d82` - Work * `d0d62c34-ca62-4281-bef9-96763103550b` - Private
emailAddress	string(email)	true	none	none

Enumerated Values

Property	Value
emailTypeKind	2dd993f6-562c-4575-82b3-11750c6c8d82
emailTypeKind	d0d62c34-ca62-4281-bef9-96763103550b

personEmailDeleted

{
  "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
  "emailId": "0b470856-6b9d-43ea-b49b-377be18fa249"
}

Properties

Name	Type	Required	Restrictions	Description
personId	string(uuid)	true	none	none
emailId	string(uuid)	true	none	none

personNameChanged

{
  "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
  "firstName": "Alex",
  "lastName": "Smith"
}

Properties

Name	Type	Required	Restrictions	Description
personId	string(uuid)	true	none	none
firstName	string	false	none	none
lastName	string	false	none	none

personPhoneAdded

{
  "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
  "phoneId": "8b2bf589-2a8b-421d-af43-eb40c9ec8a70",
  "phoneTypeId": "26ae6698-25c1-4945-a1e0-a58629b1dcc2",
  "phoneTypeKind": "c62d9463-8632-4f83-a1ba-fff64146552c",
  "number": "+4799999999"
}

Properties

Name	Type	Required	Restrictions	Description
personId	string(uuid)	true	none	none
phoneId	string(uuid)	true	none	none
phoneTypeId	string(uuid)	true	none	none
phoneTypeKind	string(uuid)	true	none	Types: * `c4f39a38-838d-48c9-8ed1-3b06e1e7c0d9` - Home * `e7e17a2f-3ea4-4cc0-9b8f-e9c9acc091d8` - Centralboard * `9cda516f-c578-4f2f-bf54-2627f4427a00` - Direct * `16b19ab9-56e3-4fa8-a68a-10b35fa1ddf0` - Mobile * `9c1981e3-fc45-423a-b8b4-2050119c4f25` - Fax * `5d727065-3129-4f2f-89e5-ec797b5ae265` - Mobile alternative
number	string	true	none	none

Enumerated Values

Property	Value
phoneTypeKind	c4f39a38-838d-48c9-8ed1-3b06e1e7c0d9
phoneTypeKind	e7e17a2f-3ea4-4cc0-9b8f-e9c9acc091d8
phoneTypeKind	9cda516f-c578-4f2f-bf54-2627f4427a00
phoneTypeKind	16b19ab9-56e3-4fa8-a68a-10b35fa1ddf0
phoneTypeKind	9c1981e3-fc45-423a-b8b4-2050119c4f25
phoneTypeKind	5d727065-3129-4f2f-89e5-ec797b5ae265

personPhoneChanged

{
  "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
  "phoneId": "8b2bf589-2a8b-421d-af43-eb40c9ec8a70",
  "phoneTypeId": "26ae6698-25c1-4945-a1e0-a58629b1dcc2",
  "phoneTypeKind": "c62d9463-8632-4f83-a1ba-fff64146552c",
  "number": "+4799999999"
}

Properties

Name	Type	Required	Restrictions	Description
personId	string(uuid)	true	none	none
phoneId	string(uuid)	true	none	none
phoneTypeId	string(uuid)	true	none	none
phoneTypeKind	string(uuid)	true	none	Types: * `c4f39a38-838d-48c9-8ed1-3b06e1e7c0d9` - Home * `e7e17a2f-3ea4-4cc0-9b8f-e9c9acc091d8` - Centralboard * `9cda516f-c578-4f2f-bf54-2627f4427a00` - Direct * `16b19ab9-56e3-4fa8-a68a-10b35fa1ddf0` - Mobile * `9c1981e3-fc45-423a-b8b4-2050119c4f25` - Fax * `5d727065-3129-4f2f-89e5-ec797b5ae265` - Mobile alternative
number	string	true	none	none

Enumerated Values

Property	Value
phoneTypeKind	c4f39a38-838d-48c9-8ed1-3b06e1e7c0d9
phoneTypeKind	e7e17a2f-3ea4-4cc0-9b8f-e9c9acc091d8
phoneTypeKind	9cda516f-c578-4f2f-bf54-2627f4427a00
phoneTypeKind	16b19ab9-56e3-4fa8-a68a-10b35fa1ddf0
phoneTypeKind	9c1981e3-fc45-423a-b8b4-2050119c4f25
phoneTypeKind	5d727065-3129-4f2f-89e5-ec797b5ae265

personPhoneDeleted

{
  "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
  "phoneId": "8b2bf589-2a8b-421d-af43-eb40c9ec8a70"
}

Properties

Name	Type	Required	Restrictions	Description
personId	string(uuid)	true	none	none
phoneId	string(uuid)	true	none	none

personRequestedGDPRDeletion

{
  "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec"
}

TO BE IMPLEMENTED - The person requested their right to be deleted as per GDPR article 17.

Properties

Name	Type	Required	Restrictions	Description
personId	string(uuid)	true	none	none

unitCreated

{
  "unitId": "63ec7ae0-14b9-4f8a-b901-1941cdf31cc5",
  "name": "Alpha team",
  "alias": 1337,
  "unitTypeId": "c4e81abe-2c9c-4887-8ffb-95c19b2b59e2",
  "unitTypeKind": "9ccedd3d-3f2e-4405-8aee-76302a379602"
}

Properties

Name	Type	Required	Restrictions	Description
unitId	string(uuid)	true	none	none
name	string	true	none	none
alias	string	true	none	none
unitTypeId	string(uuid)	true	none	none
unitTypeKind	string(uuid)¦null	true	none	Types: * `9ccedd3d-3f2e-4405-8aee-76302a379602` - Department * `0119a842-4470-452a-b383-0c34d5aaaaf8` - Corporation * `55ed1c5f-24ac-43a3-8c9e-5bfe844523d5` - Legal unit * `caed9ede-ff6b-4805-bfb1-9975cd69fde3` - Group

Enumerated Values

Property	Value
unitTypeKind	9ccedd3d-3f2e-4405-8aee-76302a379602
unitTypeKind	0119a842-4470-452a-b383-0c34d5aaaaf8
unitTypeKind	55ed1c5f-24ac-43a3-8c9e-5bfe844523d
unitTypeKind	caed9ede-ff6b-4805-bfb1-9975cd69fde3
unitTypeKind	null

unitDeleted

{
  "unitId": "63ec7ae0-14b9-4f8a-b901-1941cdf31cc5"
}

Properties

Name	Type	Required	Restrictions	Description
unitId	string(uuid)	true	none	none

unitNameChanged

{
  "unitId": "63ec7ae0-14b9-4f8a-b901-1941cdf31cc5",
  "name": "Alpha team"
}

Properties

Name	Type	Required	Restrictions	Description
unitId	string(uuid)	true	none	none
name	string	true	none	none

unitAliasChanged

{
  "unitId": "63ec7ae0-14b9-4f8a-b901-1941cdf31cc5",
  "alias": 1337
}

Properties

Name	Type	Required	Restrictions	Description
unitId	string(uuid)	true	none	none
alias	string	true	none	none

unitTypeIdChanged

{
  "unitId": "63ec7ae0-14b9-4f8a-b901-1941cdf31cc5",
  "unitTypeId": "c4e81abe-2c9c-4887-8ffb-95c19b2b59e2",
  "unitTypeKind": "9ccedd3d-3f2e-4405-8aee-76302a379602"
}

The Unit has changed type (not to be confused with the type itself changing in any way).

Properties

Name	Type	Required	Restrictions	Description
unitId	string(uuid)	true	none	none
unitTypeId	string(uuid)	true	none	none
unitTypeKind	string(uuid)¦null	true	none	Types: * `9ccedd3d-3f2e-4405-8aee-76302a379602` - Department * `0119a842-4470-452a-b383-0c34d5aaaaf8` - Corporation * `55ed1c5f-24ac-43a3-8c9e-5bfe844523d5` - Legal unit * `caed9ede-ff6b-4805-bfb1-9975cd69fde3` - Group

Enumerated Values

Property	Value
unitTypeKind	9ccedd3d-3f2e-4405-8aee-76302a379602
unitTypeKind	0119a842-4470-452a-b383-0c34d5aaaaf8
unitTypeKind	55ed1c5f-24ac-43a3-8c9e-5bfe844523d
unitTypeKind	caed9ede-ff6b-4805-bfb1-9975cd69fde3
unitTypeKind	null

unitTypeCreated

{
  "unitTypeId": "c4e81abe-2c9c-4887-8ffb-95c19b2b59e2",
  "unitTypeKind": "9ccedd3d-3f2e-4405-8aee-76302a379602",
  "name": "Team"
}

Properties

Name	Type	Required	Restrictions	Description
unitTypeId	string(uuid)	true	none	none
unitTypeKind	string(uuid)	true	none	Types: * `9ccedd3d-3f2e-4405-8aee-76302a379602` - Department * `0119a842-4470-452a-b383-0c34d5aaaaf8` - Corporation * `55ed1c5f-24ac-43a3-8c9e-5bfe844523d5` - Legal unit * `caed9ede-ff6b-4805-bfb1-9975cd69fde3` - Group
name	string	true	none	none

Enumerated Values

Property	Value
unitTypeKind	9ccedd3d-3f2e-4405-8aee-76302a379602
unitTypeKind	0119a842-4470-452a-b383-0c34d5aaaaf8
unitTypeKind	55ed1c5f-24ac-43a3-8c9e-5bfe844523d
unitTypeKind	caed9ede-ff6b-4805-bfb1-9975cd69fde3

unitTypeDeleted

{
  "unitTypeId": "c4e81abe-2c9c-4887-8ffb-95c19b2b59e2"
}

Properties

Name	Type	Required	Restrictions	Description
unitTypeId	string(uuid)	true	none	none

unitTypeNameChanged

{
  "unitTypeId": "c4e81abe-2c9c-4887-8ffb-95c19b2b59e2",
  "name": "Team"
}

Properties

Name	Type	Required	Restrictions	Description
unitTypeId	string(uuid)	true	none	none
name	string	true	none	none

legalUnitCreated

{
  "legalUnitId": "5469e1c4-33c4-4d9c-9da9-2d5ec4f6fc48",
  "name": "The Company",
  "organizationNumber": "123456789",
  "unitId": "1fa3c045-cf5b-4ce2-801b-d58f721febc9"
}

TO BE DEFINED AND IMPLEMENTED

Properties

Name	Type	Required	Restrictions	Description
legalUnitId	string(uuid)	true	none	none
name	string	true	none	none
organizationNumber	string	true	none	none
unitId	string(uuid)	true	none	none

legalUnitDeleted

{
  "legalUnitId": "5469e1c4-33c4-4d9c-9da9-2d5ec4f6fc48"
}

TO BE DEFINED AND IMPLEMENTED

Properties

Name	Type	Required	Restrictions	Description
legalUnitId	string(uuid)	true	none	none

legalUnitNameChanged

{
  "legalUnitId": "5469e1c4-33c4-4d9c-9da9-2d5ec4f6fc48",
  "name": "The Company"
}

TO BE DEFINED AND IMPLEMENTED

Properties

Name	Type	Required	Restrictions	Description
legalUnitId	string(uuid)	true	none	none
name	string	true	none	none

legalUnitOrganizationNumberChanged

{
  "legalUnitId": "5469e1c4-33c4-4d9c-9da9-2d5ec4f6fc48",
  "organizationNumber": "123456789"
}

TO BE DEFINED AND IMPLEMENTED

Properties

Name	Type	Required	Restrictions	Description
legalUnitId	string(uuid)	true	none	none
organizationNumber	string	true	none	none

personAddedToUnit

{
  "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
  "unitId": "63ec7ae0-14b9-4f8a-b901-1941cdf31cc5"
}

Properties

Name	Type	Required	Restrictions	Description
personId	string(uuid)	true	none	none
unitId	string(uuid)	true	none	none

personRemovedFromUnit

{
  "personId": "39ddea86-03bc-4f36-99f8-55b9981453ec",
  "unitId": "63ec7ae0-14b9-4f8a-b901-1941cdf31cc5"
}

Properties

Name	Type	Required	Restrictions	Description
personId	string(uuid)	true	none	none
unitId	string(uuid)	true	none	none

tenantCreated

{
  "tenantId": "67cdd743-a83f-404b-93ef-29dfe5bc2e31",
  "name": "The customer"
}

TO BE IMPLEMENTED

Properties

Name	Type	Required	Restrictions	Description
tenantId	string(uuid)	true	none	none
name	string	true	none	none

tenantDeleted

{
  "tenantId": "67cdd743-a83f-404b-93ef-29dfe5bc2e31"
}

TO BE IMPLEMENTED

Properties

Name	Type	Required	Restrictions	Description
tenantId	string(uuid)	true	none	none

tenantNameChanged

{
  "tenantId": "67cdd743-a83f-404b-93ef-29dfe5bc2e31",
  "name": "The customer"
}

TO BE IMPLEMENTED

Properties

Name	Type	Required	Restrictions	Description
tenantId	string(uuid)	true	none	none
name	string	true	none	none

error

{
  "code": "string",
  "message": "string"
}

If the callback failes, this error object should be returned. When the Simployer Webhhok Integration delivery state is not OK, Simployer will provide the latest error code and message through the webhook integration management API.

Properties

Name	Type	Required	Restrictions	Description
code	string	false	none	none
message	string	false	none	none

Person API v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://apis.simployer.com
- Host - Default: unknown

Authentication

API Key (apiKey)
- Parameter Name: X-ApiKey, in: header. API Key Authentication

Person

getPersons

Code samples

## You can also use wget
curl -X GET https:///v1/person \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/person', headers = headers)

print(r.json())

GET /v1/person

Example responses

200 Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "firstname": "string",
    "lastname": "string",
    "shortname": "string",
    "birthdate": "2019-08-24T14:15:22Z",
    "gender": {
      "label": "string",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "nationality": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>00000000-0000-0000-0000-000000000000</id>
<firstname>string</firstname>
<lastname>string</lastname>
<shortname>string</shortname>
<birthdate>2019-08-24T14:15:22Z</birthdate>
<gender>
  <label>string</label>
  <id>00000000-0000-0000-0000-000000000000</id>
</gender>
<nationality>string</nationality>

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Person]	false	none	none
» id	string(uuid)	false	none	none
» firstname	string	false	none	none
» lastname	string	false	none	none
» shortname	string	false	none	none
» birthdate	string(date-time)	false	none	none
» gender	Gender	false	none	none
»» label	string	false	none	none
»» id	string(uuid)	false	none	none
» nationality	string	false	none	none

getPersonById

Code samples

## You can also use wget
curl -X GET https:///v1/person/{id} \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/person/{id}', headers = headers)

print(r.json())

GET /v1/person/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	none

Example responses

200 Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "firstname": "string",
  "lastname": "string",
  "shortname": "string",
  "birthdate": "2019-08-24T14:15:22Z",
  "gender": {
    "label": "string",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "nationality": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<Person>
  <id>00000000-0000-0000-0000-000000000000</id>
  <firstname>string</firstname>
  <lastname>string</lastname>
  <shortname>string</shortname>
  <birthdate>2019-08-24T14:15:22Z</birthdate>
  <gender>
    <label>string</label>
    <id>00000000-0000-0000-0000-000000000000</id>
  </gender>
  <nationality>string</nationality>
</Person>

Responses

Status	Meaning	Description	Schema
200	OK	OK	Person

PersonAddress

getPersonAddresses

Code samples

## You can also use wget
curl -X GET https:///v1/person/{personId}/address \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/person/{personId}/address', headers = headers)

print(r.json())

GET /v1/person/{personId}/address

Parameters

Name	In	Type	Required	Description
personId	path	string(uuid)	true	none

Example responses

200 Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "label": "string",
    "isPrimary": true,
    "countryCode": "string",
    "streetName1": "string",
    "streetName2": "string",
    "streetName3": "string",
    "postalCode": "string",
    "postalPlace": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>00000000-0000-0000-0000-000000000000</id>
<label>string</label>
<isPrimary>true</isPrimary>
<countryCode>string</countryCode>
<streetName1>string</streetName1>
<streetName2>string</streetName2>
<streetName3>string</streetName3>
<postalCode>string</postalCode>
<postalPlace>string</postalPlace>

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[PersonAddress]	false	none	none
» id	string(uuid)	false	none	none
» label	string	false	none	none
» isPrimary	boolean	false	none	none
» countryCode	string	false	none	none
» streetName1	string	false	none	none
» streetName2	string	false	none	none
» streetName3	string	false	none	none
» postalCode	string	false	none	none
» postalPlace	string	false	none	none

getPersonAddressById

Code samples

## You can also use wget
curl -X GET https:///v1/person/{personId}/address/{addressId} \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/person/{personId}/address/{addressId}', headers = headers)

print(r.json())

GET /v1/person/{personId}/address/{addressId}

Parameters

Name	In	Type	Required	Description
personId	path	string(uuid)	true	none
addressId	path	string(uuid)	true	none

Example responses

200 Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "label": "string",
  "isPrimary": true,
  "countryCode": "string",
  "streetName1": "string",
  "streetName2": "string",
  "streetName3": "string",
  "postalCode": "string",
  "postalPlace": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<PersonAddress>
  <id>00000000-0000-0000-0000-000000000000</id>
  <label>string</label>
  <isPrimary>true</isPrimary>
  <countryCode>string</countryCode>
  <streetName1>string</streetName1>
  <streetName2>string</streetName2>
  <streetName3>string</streetName3>
  <postalCode>string</postalCode>
  <postalPlace>string</postalPlace>
</PersonAddress>

Responses

Status	Meaning	Description	Schema
200	OK	OK	PersonAddress

PersonElectronicAddress

getPersonEmailAddresses

Code samples

## You can also use wget
curl -X GET https:///v1/person/{personId}/email \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/person/{personId}/email', headers = headers)

print(r.json())

GET /v1/person/{personId}/email

Parameters

Name	In	Type	Required	Description
personId	path	string(uuid)	true	none

Example responses

200 Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "label": "string",
    "isPrimary": true,
    "address": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>00000000-0000-0000-0000-000000000000</id>
<label>string</label>
<isPrimary>true</isPrimary>
<address>string</address>

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[PersonElectronicAddress]	false	none	none
» id	string(uuid)	false	none	none
» label	string	false	none	none
» isPrimary	boolean	false	none	none
» address	string	false	none	none

getPersonEmailAddressById

Code samples

## You can also use wget
curl -X GET https:///v1/person/{personId}/email/{emailId} \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/person/{personId}/email/{emailId}', headers = headers)

print(r.json())

GET /v1/person/{personId}/email/{emailId}

Parameters

Name	In	Type	Required	Description
personId	path	string(uuid)	true	none
emailId	path	string(uuid)	true	none

Example responses

200 Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "label": "string",
  "isPrimary": true,
  "address": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<PersonElectronicAddress>
  <id>00000000-0000-0000-0000-000000000000</id>
  <label>string</label>
  <isPrimary>true</isPrimary>
  <address>string</address>
</PersonElectronicAddress>

Responses

Status	Meaning	Description	Schema
200	OK	OK	PersonElectronicAddress

PersonPhone

getPersonPhones

Code samples

## You can also use wget
curl -X GET https:///v1/person/{personId}/phone \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/person/{personId}/phone', headers = headers)

print(r.json())

GET /v1/person/{personId}/phone

Parameters

Name	In	Type	Required	Description
personId	path	string(uuid)	true	none

Example responses

200 Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "label": "string",
    "isPrimary": true,
    "number": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>00000000-0000-0000-0000-000000000000</id>
<label>string</label>
<isPrimary>true</isPrimary>
<number>string</number>

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[PersonPhone]	false	none	none
» id	string(uuid)	false	none	none
» label	string	false	none	none
» isPrimary	boolean	false	none	none
» number	string	false	none	none

getPersonPhoneById

Code samples

## You can also use wget
curl -X GET https:///v1/person/{personId}/phone/{phoneId} \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/person/{personId}/phone/{phoneId}', headers = headers)

print(r.json())

GET /v1/person/{personId}/phone/{phoneId}

Parameters

Name	In	Type	Required	Description
personId	path	string(uuid)	true	none
phoneId	path	string(uuid)	true	none

Example responses

200 Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "label": "string",
  "isPrimary": true,
  "number": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<PersonPhone>
  <id>00000000-0000-0000-0000-000000000000</id>
  <label>string</label>
  <isPrimary>true</isPrimary>
  <number>string</number>
</PersonPhone>

Responses

Status	Meaning	Description	Schema
200	OK	OK	PersonPhone

Schemas

Person

{
  "id": "00000000-0000-0000-0000-000000000000",
  "firstname": "string",
  "lastname": "string",
  "shortname": "string",
  "birthdate": "2019-08-24T14:15:22Z",
  "gender": {
    "label": "string",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "nationality": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
firstname	string	false	none	none
lastname	string	false	none	none
shortname	string	false	none	none
birthdate	string(date-time)	false	none	none
gender	Gender	false	none	none
nationality	string	false	none	none

Gender

{
  "label": "string",
  "id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name	Type	Required	Restrictions	Description
label	string	false	none	none
id	string(uuid)	false	none	none

PersonAddress

{
  "id": "00000000-0000-0000-0000-000000000000",
  "label": "string",
  "isPrimary": true,
  "countryCode": "string",
  "streetName1": "string",
  "streetName2": "string",
  "streetName3": "string",
  "postalCode": "string",
  "postalPlace": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
label	string	false	none	none
isPrimary	boolean	false	none	none
countryCode	string	false	none	none
streetName1	string	false	none	none
streetName2	string	false	none	none
streetName3	string	false	none	none
postalCode	string	false	none	none
postalPlace	string	false	none	none

PersonElectronicAddress

{
  "id": "00000000-0000-0000-0000-000000000000",
  "label": "string",
  "isPrimary": true,
  "address": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
label	string	false	none	none
isPrimary	boolean	false	none	none
address	string	false	none	none

PersonPhone

{
  "id": "00000000-0000-0000-0000-000000000000",
  "label": "string",
  "isPrimary": true,
  "number": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
label	string	false	none	none
isPrimary	boolean	false	none	none
number	string	false	none	none

Unit API v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://apis.simployer.com
- Host - Default: unknown

Authentication

API Key (apiKey)
- Parameter Name: X-ApiKey, in: header. API Key Authentication

LegalUnit

getLegalUnits

Code samples

## You can also use wget
curl -X GET https:///v1/legalunit \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/legalunit', headers = headers)

print(r.json())

GET /v1/legalunit

Example responses

200 Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "organizationNumber": "string",
    "name": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>00000000-0000-0000-0000-000000000000</id>
<organizationNumber>string</organizationNumber>
<name>string</name>

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[LegalUnit]	false	none	none
» id	string(uuid)	false	none	none
» organizationNumber	string	false	none	none
» name	string	false	none	none

getLegalUnitById

Code samples

## You can also use wget
curl -X GET https:///v1/legalunit/{id} \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/legalunit/{id}', headers = headers)

print(r.json())

GET /v1/legalunit/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	none

Example responses

200 Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organizationNumber": "string",
  "name": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<LegalUnit>
  <id>00000000-0000-0000-0000-000000000000</id>
  <organizationNumber>string</organizationNumber>
  <name>string</name>
</LegalUnit>

Responses

Status	Meaning	Description	Schema
200	OK	OK	LegalUnit

Unit

getUnits

Code samples

## You can also use wget
curl -X GET https:///v1/unit \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/unit', headers = headers)

print(r.json())

GET /v1/unit

Example responses

200 Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "label": "string",
    "name": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>00000000-0000-0000-0000-000000000000</id>
<label>string</label>
<name>string</name>

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Unit]	false	none	none
» id	string(uuid)	false	none	none
» label	string	false	none	none
» name	string	false	none	none

getUnitById

Code samples

## You can also use wget
curl -X GET https:///v1/unit/{id} \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/unit/{id}', headers = headers)

print(r.json())

GET /v1/unit/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	none

Example responses

200 Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "label": "string",
  "name": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<Unit>
  <id>00000000-0000-0000-0000-000000000000</id>
  <label>string</label>
  <name>string</name>
</Unit>

Responses

Status	Meaning	Description	Schema
200	OK	OK	Unit

UnitAddress

getUnitAddresses

Code samples

## You can also use wget
curl -X GET https:///v1/unit/{unitId}/address \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/unit/{unitId}/address', headers = headers)

print(r.json())

GET /v1/unit/{unitId}/address

Parameters

Name	In	Type	Required	Description
unitId	path	string(uuid)	true	none

Example responses

200 Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "isPrimary": true,
    "label": "string",
    "countryCode": "string",
    "streetName1": "string",
    "streetName2": "string",
    "streetName3": "string",
    "postalCode": "string",
    "postalPlace": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>00000000-0000-0000-0000-000000000000</id>
<isPrimary>true</isPrimary>
<label>string</label>
<countryCode>string</countryCode>
<streetName1>string</streetName1>
<streetName2>string</streetName2>
<streetName3>string</streetName3>
<postalCode>string</postalCode>
<postalPlace>string</postalPlace>

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[UnitAddress]	false	none	none
» id	string(uuid)	false	none	none
» isPrimary	boolean	false	none	none
» label	string	false	none	none
» countryCode	string	false	none	none
» streetName1	string	false	none	none
» streetName2	string	false	none	none
» streetName3	string	false	none	none
» postalCode	string	false	none	none
» postalPlace	string	false	none	none

getUnitAddressById

Code samples

## You can also use wget
curl -X GET https:///v1/unit/{unitId}/address/{addressId} \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/unit/{unitId}/address/{addressId}', headers = headers)

print(r.json())

GET /v1/unit/{unitId}/address/{addressId}

Parameters

Name	In	Type	Required	Description
unitId	path	string(uuid)	true	none
addressId	path	string(uuid)	true	none

Example responses

200 Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "isPrimary": true,
  "label": "string",
  "countryCode": "string",
  "streetName1": "string",
  "streetName2": "string",
  "streetName3": "string",
  "postalCode": "string",
  "postalPlace": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<UnitAddress>
  <id>00000000-0000-0000-0000-000000000000</id>
  <isPrimary>true</isPrimary>
  <label>string</label>
  <countryCode>string</countryCode>
  <streetName1>string</streetName1>
  <streetName2>string</streetName2>
  <streetName3>string</streetName3>
  <postalCode>string</postalCode>
  <postalPlace>string</postalPlace>
</UnitAddress>

Responses

Status	Meaning	Description	Schema
200	OK	OK	UnitAddress

UnitElectronicAddress

getUnitEmailAddresses

Code samples

## You can also use wget
curl -X GET https:///v1/unit/{unitId}/email \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/unit/{unitId}/email', headers = headers)

print(r.json())

GET /v1/unit/{unitId}/email

Parameters

Name	In	Type	Required	Description
unitId	path	string(uuid)	true	none

Example responses

200 Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "label": "string",
    "isPrimary": true,
    "address": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>00000000-0000-0000-0000-000000000000</id>
<label>string</label>
<isPrimary>true</isPrimary>
<address>string</address>

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[UnitElectronicAddress]	false	none	none
» id	string(uuid)	false	none	none
» label	string	false	none	none
» isPrimary	boolean	false	none	none
» address	string	false	none	none

getUnitEmailAddressById

Code samples

## You can also use wget
curl -X GET https:///v1/unit/{unitId}/email/{emailId} \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/unit/{unitId}/email/{emailId}', headers = headers)

print(r.json())

GET /v1/unit/{unitId}/email/{emailId}

Parameters

Name	In	Type	Required	Description
unitId	path	string(uuid)	true	none
emailId	path	string(uuid)	true	none

Example responses

200 Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "label": "string",
  "isPrimary": true,
  "address": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<UnitElectronicAddress>
  <id>00000000-0000-0000-0000-000000000000</id>
  <label>string</label>
  <isPrimary>true</isPrimary>
  <address>string</address>
</UnitElectronicAddress>

Responses

Status	Meaning	Description	Schema
200	OK	OK	UnitElectronicAddress

UnitPhone

getUnitPhones

Code samples

## You can also use wget
curl -X GET https:///v1/unit/{unitId}/phone \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/unit/{unitId}/phone', headers = headers)

print(r.json())

GET /v1/unit/{unitId}/phone

Parameters

Name	In	Type	Required	Description
unitId	path	string(uuid)	true	none

Example responses

200 Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "isPrimary": true,
    "label": "string",
    "number": "string"
  }
]

<?xml version="1.0" encoding="UTF-8" ?>
<id>00000000-0000-0000-0000-000000000000</id>
<isPrimary>true</isPrimary>
<label>string</label>
<number>string</number>

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[UnitPhone]	false	none	none
» id	string(uuid)	false	none	none
» isPrimary	boolean	false	none	none
» label	string	false	none	none
» number	string	false	none	none

getUnitPhoneById

Code samples

## You can also use wget
curl -X GET https:///v1/unit/{unitId}/phone/{phoneId} \
  -H 'Accept: application/json' \
  -H 'X-ApiKey: API_KEY'

import requests
headers = {
  'Accept': 'application/json',
  'X-ApiKey': 'API_KEY'
}

r = requests.get('https://apis.simployer.com/v1/unit/{unitId}/phone/{phoneId}', headers = headers)

print(r.json())

GET /v1/unit/{unitId}/phone/{phoneId}

Parameters

Name	In	Type	Required	Description
unitId	path	string(uuid)	true	none
phoneId	path	string(uuid)	true	none

Example responses

200 Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "isPrimary": true,
  "label": "string",
  "number": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<UnitPhone>
  <id>00000000-0000-0000-0000-000000000000</id>
  <isPrimary>true</isPrimary>
  <label>string</label>
  <number>string</number>
</UnitPhone>

Responses

Status	Meaning	Description	Schema
200	OK	OK	UnitPhone

Schemas

LegalUnit

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organizationNumber": "string",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
organizationNumber	string	false	none	none
name	string	false	none	none

Unit

{
  "id": "00000000-0000-0000-0000-000000000000",
  "label": "string",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
label	string	false	none	none
name	string	false	none	none

UnitAddress

{
  "id": "00000000-0000-0000-0000-000000000000",
  "isPrimary": true,
  "label": "string",
  "countryCode": "string",
  "streetName1": "string",
  "streetName2": "string",
  "streetName3": "string",
  "postalCode": "string",
  "postalPlace": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
isPrimary	boolean	false	none	none
label	string	false	none	none
countryCode	string	false	none	none
streetName1	string	false	none	none
streetName2	string	false	none	none
streetName3	string	false	none	none
postalCode	string	false	none	none
postalPlace	string	false	none	none

UnitElectronicAddress

{
  "id": "00000000-0000-0000-0000-000000000000",
  "label": "string",
  "isPrimary": true,
  "address": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
label	string	false	none	none
isPrimary	boolean	false	none	none
address	string	false	none	none

UnitPhone

{
  "id": "00000000-0000-0000-0000-000000000000",
  "isPrimary": true,
  "label": "string",
  "number": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
isPrimary	boolean	false	none	none
label	string	false	none	none
number	string	false	none	none