CASAIAM v1.0.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.

CASAIAM service provides data and functionality around our Customers identities. It serves as our CRM to handle companies and their contracts with our products. Also to handle the detailed authentication of Employees in those companies with their roles in our products.

Base URLs:

Authentication

oAuth2 authentication. OAuth 2.0 client credentials Grant
- Flow: clientCredentials
- Token URL = https://admin-console.test.casasoft.com/realms/casasoft/protocol/openid-connect/token

Scope	Scope Description

Company

api_v1companies_get_collection

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/companies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/companies HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/companies

Retrieves the collection of Company resources.

Retrieves the collection of Company resources.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
page	query	integer	false	The collection page number
page_size	query	integer	false	The number of items per page
pagination	query	boolean	false	Enable or disable pagination
allowRelationship	query	boolean	false	none
contracts.billedBySmg	query	boolean	false	none
order[id]	query	string	false	none
order[legalName]	query	string	false	none
order[address.locality]	query	string	false	none
order[address.street]	query	string	false	none
order[created]	query	string	false	none
ids	query	string	false	none
entity_types	query	string	false	none
regions	query	string	false	none
status	query	string	false	none
plan	query	string	false	none
customDomain	query	string	false	none
products	query	string	false	none
active_products	query	string	false	none
s	query	string	false	none

Enumerated Values

Parameter	Value
order[id]	asc
order[id]	desc
order[legalName]	asc
order[legalName]	desc
order[address.locality]	asc
order[address.locality]	desc
order[address.street]	asc
order[address.street]	desc
order[created]	asc
order[created]	desc

Example responses

200 Response

{
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "string"
        }
      },
      "id": "string",
      "sfAccountId": null,
      "address": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "legalName": null,
      "legalForm": null,
      "entityType": null,
      "email": null,
      "phone": null,
      "mobile": null,
      "fax": null,
      "slogan": null,
      "twitter": null,
      "linkedin": null,
      "facebook": null,
      "pinterest": null,
      "instagram": null,
      "websiteUrl": null,
      "logo": null,
      "logoInv": null,
      "logoBw": null,
      "logoBwInv": null,
      "uid": null,
      "vat": null,
      "options": null,
      "addition": null,
      "internalNotes": null,
      "abacusCustomerId": null,
      "allowRelationship": true,
      "zefixMutations": null,
      "zefixLastUpdateDate": null,
      "companyContents": [
        {
          "id": 0,
          "lang": "de",
          "openingHours": null,
          "slogan": null,
          "description": null,
          "projectDisclaimer": null,
          "dossierDisclaimer": null,
          "virtualTourDisclaimer": null,
          "created": "2023-10-12T07:10:17Z",
          "updated": "2023-10-12T07:10:17Z"
        }
      ],
      "companyRelations": [
        {
          "created": "2023-10-12T07:10:17Z",
          "updated": "2023-10-12T07:10:17Z"
        }
      ],
      "contracts": [
        {
          "id": 0,
          "sfOpportunityId": null,
          "billingAddress": null,
          "shippingAddress": null,
          "addressBilling": {
            "id": 0,
            "country": null,
            "locality": null,
            "region": null,
            "postalCode": null,
            "postOfficeBoxNumber": null,
            "street": null,
            "streetNumber": null,
            "streetAddition": null,
            "lat": null,
            "lng": null,
            "created": "2023-10-12T07:10:17Z",
            "updated": "2023-10-12T07:10:17Z"
          },
          "addressShipping": {
            "id": 0,
            "country": null,
            "locality": null,
            "region": null,
            "postalCode": null,
            "postOfficeBoxNumber": null,
            "street": null,
            "streetNumber": null,
            "streetAddition": null,
            "lat": null,
            "lng": null,
            "created": "2023-10-12T07:10:17Z",
            "updated": "2023-10-12T07:10:17Z"
          },
          "options": null,
          "customFieldsSchema": {},
          "status": "active",
          "abacusProjectId": null,
          "billedBySmg": null,
          "contractDate": null,
          "startDate": null,
          "cancellationDate": null,
          "trainingDate": null,
          "noTrainingWanted": null,
          "noCharge": null,
          "product": "casaframe",
          "created": "2023-10-12T07:10:17Z",
          "updated": "2023-10-12T07:10:17Z"
        }
      ],
      "userRoles": [
        {
          "created": "2023-10-12T07:10:17Z",
          "updated": "2023-10-12T07:10:17Z"
        }
      ],
      "legalPerson": {
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "totalItems": 0,
  "itemsPerPage": 0,
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Company collection	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» _embedded	[Company.jsonhal-read.Company_timestampable]	true	none	none
»» _links	object	false	none	none
»»» self	object	false	none	none
»»»» href	string(iri-reference)	false	none	none
»» id	string	false	none	none
»» sfAccountId	string,null	false	none	none
»» address	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	Address.jsonhal-read.Company_timestampable	false	none	none
»»»» id	integer	false	read-only	none
»»»» country	string,null	false	none	none
»»»» locality	string,null	false	none	none
»»»» region	string,null	false	none	none
»»»» postalCode	integer,null	false	none	none
»»»» postOfficeBoxNumber	string,null	false	none	none
»»»» street	string,null	false	none	none
»»»» streetNumber	string,null	false	none	none
»»»» streetAddition	string,null	false	none	none
»»»» lat	string,null	false	none	none
»»»» lng	string,null	false	none	none
»»»» created	string(date-time)	false	none	Get created.
»»»» updated	string(date-time)	false	none	Get updated.

Name	Type	Required	Restrictions	Description
»»» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
»» legalName	string,null	false	none	none
»» legalForm	string,null	false	none	none
»» entityType	string,null	false	none	none
»» email	string,null	false	none	none
»» phone	string,null	false	none	none
»» mobile	string,null	false	none	none
»» fax	string,null	false	none	none
»» slogan	string,null	false	none	none
»» twitter	string,null	false	none	none
»» linkedin	string,null	false	none	none
»» facebook	string,null	false	none	none
»» pinterest	string,null	false	none	none
»» instagram	string,null	false	none	none
»» websiteUrl	string,null	false	none	none
»» logo	string,null	false	none	none
»» logoInv	string,null	false	none	none
»» logoBw	string,null	false	none	none
»» logoBwInv	string,null	false	none	none
»» uid	string,null	false	none	none
»» vat	integer,null	false	none	none
»» options	object,null	false	none	none
»» addition	string,null	false	none	none
»» internalNotes	string,null	false	none	none
»» abacusCustomerId	integer,null	false	none	none
»» allowRelationship	boolean	false	none	none
»» zefixMutations	object,null	false	none	none
»» zefixLastUpdateDate	string,null(date-time)	false	none	none
»» companyContents	[CompanyContent.jsonhal-read.Company_timestampable]	false	none	none
»»» id	integer	false	read-only	none
»»» lang	string	false	none	none
»»» openingHours	string,null	false	none	none
»»» slogan	string,null	false	none	none
»»» description	string,null	false	none	none
»»» projectDisclaimer	string,null	false	none	none
»»» dossierDisclaimer	string,null	false	none	none
»»» virtualTourDisclaimer	string,null	false	none	none
»»» created	string(date-time)	false	none	Get created.
»»» updated	string(date-time)	false	none	Get updated.
»» companyRelations	[CompanyRelation.jsonhal-read.Company_timestampable]	false	none	none
»»» created	string(date-time)	false	none	Get created.
»»» updated	string(date-time)	false	none	Get updated.
»» contracts	[Contract.jsonhal-read.Company_timestampable]	false	none	none
»»» id	integer	false	read-only	none
»»» sfOpportunityId	string,null	false	none	none
»»» billingAddress	string,null	false	none	none
»»» shippingAddress	string,null	false	none	none
»»» addressBilling	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	Address.jsonhal-read.Company_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
»»»» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
»»» addressShipping	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	Address.jsonhal-read.Company_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
»»»» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
»»» options	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	App\Dto\Request\Message\Options\CasaframeOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»»» anonymous	App\Dto\Request\Message\Options\CasaoneProjectOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»»» anonymous	App\Dto\Request\Message\Options\CasaoneOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»»» anonymous	App\Dto\Request\Message\Options\CasaoneWebsiteOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»»» anonymous	App\Dto\Request\Message\Options\CasatourOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»»» anonymous	App\Dto\Request\Message\Options\HostingOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»»» anonymous	App\Dto\Request\Message\Options\IcasaOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»»» anonymous	App\Dto\Request\Message\Options\PropertyManagementOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»»» anonymous	App\Dto\Request\Message\Options\RepublishOptionsDto	false	none	none

continued

Name	Type	Required	Restrictions	Description
»»» customFieldsSchema	object	false	none	none
»»» status	string	false	none	none
»»» abacusProjectId	integer,null	false	none	none
»»» billedBySmg	boolean,null	false	none	none
»»» contractDate	string,null(date-time)	false	none	none
»»» startDate	string,null(date-time)	false	none	none
»»» cancellationDate	string,null(date-time)	false	none	none
»»» trainingDate	string,null(date-time)	false	none	none
»»» noTrainingWanted	boolean,null	false	none	none
»»» noCharge	boolean,null	false	none	none
»»» product	string	false	none	none
»»» created	string(date-time)	false	none	Get created.
»»» updated	string(date-time)	false	none	Get updated.
»» userRoles	[UserRole.jsonhal-read.Company_timestampable]	false	none	none
»»» created	string(date-time)	false	none	Get created.
»»» updated	string(date-time)	false	none	Get updated.
»» legalPerson	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	Employee.jsonhal-read.Company_timestampable	false	none	none
»»»» created	string(date-time)	false	none	Get created.
»»»» updated	string(date-time)	false	none	Get updated.

Name	Type	Required	Restrictions	Description
»»» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
»» created	string(date-time)	false	none	Get created.
»» updated	string(date-time)	false	none	Get updated.
» totalItems	integer	false	none	none
» itemsPerPage	integer	false	none	none
» _links	object	true	none	none
»» self	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» first	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» last	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» next	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» previous	object	false	none	none
»»» href	string(iri-reference)	false	none	none

Enumerated Values

Property	Value
status	active
status	demo
status	inactive
product	casaframe
product	casagateway
product	casaone
product	casaone-project
product	casaone-website
product	casascreen
product	casatour
product	casawebsite
product	hosting
product	icasa
product	luxuryestate
product	property-management-software
product	republish-service

api_v1companies_post

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null
    }
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null
    }
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/companies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/companies HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

POST /api/v1/companies

Creates a Company resource.

Creates a Company resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null
    }
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
body	body	Company.jsonhal-write.Company	true	The new Company resource

Example responses

201 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "id": 0,
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "companyRelations": [
    {
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "contracts": [
    {
      "id": 0,
      "sfOpportunityId": null,
      "billingAddress": null,
      "shippingAddress": null,
      "addressBilling": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "addressShipping": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "options": null,
      "customFieldsSchema": {},
      "status": "active",
      "abacusProjectId": null,
      "billedBySmg": null,
      "contractDate": null,
      "startDate": null,
      "cancellationDate": null,
      "trainingDate": null,
      "noTrainingWanted": null,
      "noCharge": null,
      "product": "casaframe",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "userRoles": [
    {
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "legalPerson": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	Company resource created	Company.jsonhal-read.Company_timestampable
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1companies_id_get

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/companies/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/companies/{id} HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/companies/{id}

Retrieves a Company resource.

Retrieves a Company resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	Company identifier

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "id": 0,
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "companyRelations": [
    {
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "contracts": [
    {
      "id": 0,
      "sfOpportunityId": null,
      "billingAddress": null,
      "shippingAddress": null,
      "addressBilling": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "addressShipping": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "options": null,
      "customFieldsSchema": {},
      "status": "active",
      "abacusProjectId": null,
      "billedBySmg": null,
      "contractDate": null,
      "startDate": null,
      "cancellationDate": null,
      "trainingDate": null,
      "noTrainingWanted": null,
      "noCharge": null,
      "product": "casaframe",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "userRoles": [
    {
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "legalPerson": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Company resource	Company.jsonhal-read.Company_timestampable
404	Not Found	Resource not found	None

api_v1companies_id_put

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null
    }
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null
    }
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/companies/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /api/v1/companies/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PUT /api/v1/companies/{id}

Replaces the Company resource.

Replaces the Company resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null
    }
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	Company identifier
body	body	Company.jsonhal-write.Company	true	The updated Company resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "id": 0,
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "companyRelations": [
    {
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "contracts": [
    {
      "id": 0,
      "sfOpportunityId": null,
      "billingAddress": null,
      "shippingAddress": null,
      "addressBilling": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "addressShipping": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "options": null,
      "customFieldsSchema": {},
      "status": "active",
      "abacusProjectId": null,
      "billedBySmg": null,
      "contractDate": null,
      "startDate": null,
      "cancellationDate": null,
      "trainingDate": null,
      "noTrainingWanted": null,
      "noCharge": null,
      "product": "casaframe",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "userRoles": [
    {
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "legalPerson": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Company resource updated	Company.jsonhal-read.Company_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1companies_id_delete

Code samples


const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/companies/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /api/v1/companies/{id} HTTP/1.1

X-Requested-With-User-Token: string

DELETE /api/v1/companies/{id}

Removes the Company resource.

Removes the Company resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	Company identifier

Responses

Status	Meaning	Description	Schema
204	No Content	Company resource deleted	None
404	Not Found	Resource not found	None

api_v1companies_id_patch

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null
    }
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null
    }
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/api/v1/companies/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH /api/v1/companies/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PATCH /api/v1/companies/{id}

Updates the Company resource.

Updates the Company resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null
    }
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	Company identifier
body	body	Company.jsonhal-write.Company	true	The updated Company resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "id": 0,
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "companyRelations": [
    {
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "contracts": [
    {
      "id": 0,
      "sfOpportunityId": null,
      "billingAddress": null,
      "shippingAddress": null,
      "addressBilling": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "addressShipping": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "options": null,
      "customFieldsSchema": {},
      "status": "active",
      "abacusProjectId": null,
      "billedBySmg": null,
      "contractDate": null,
      "startDate": null,
      "cancellationDate": null,
      "trainingDate": null,
      "noTrainingWanted": null,
      "noCharge": null,
      "product": "casaframe",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "userRoles": [
    {
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "legalPerson": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Company resource updated	Company.jsonhal-read.Company_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

CompaniesWithoutLogo

api_v1companies-without-logo_get

Code samples


const headers = {
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies-without-logo',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/companies-without-logo',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/companies-without-logo', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/companies-without-logo HTTP/1.1

Accept: application/json
X-Requested-With-User-Token: string

GET /api/v1/companies-without-logo

retrieves companies that are missing their logo

retrieves companies that are missing their logo

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user

Example responses

200 Response

{
  "result": {
    "items": [
      {
        "legalName": "string",
        "slug": "string",
        "product": "string",
        "contractDate": "string"
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	CompaniesWithoutLogo resource	CompaniesWithoutLogo.CompanyWithoutLogoDto
404	Not Found	Resource not found	None

CompanyExists

api_v1company-exists_post

Code samples

const inputBody = '{
  "slug": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company-exists',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "slug": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company-exists',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/company-exists', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/company-exists HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/company-exists

checks if a company with that slug already exists

checks if a company with that slug already exists

Body parameter

{
  "slug": "string"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	CompanyExists	true	The new CompanyExists resource

Example responses

200 Response

{
  "result": {
    "companyExists": true
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	CompanyExists resource created	CompanyExists.CompanyExistsDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

CompanyExportList

api_v1company-export-list_get

Code samples


const headers = {
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company-export-list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company-export-list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/company-export-list', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/company-export-list HTTP/1.1

Accept: application/json
X-Requested-With-User-Token: string

GET /api/v1/company-export-list

exporting a list of companies in either json or csv format

exporting a list of companies in either json or csv format

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
active_products	query	string	false	filter companies with active contracts for the passed products
products	query	string	false	filter companies with contracts with passed products
plan	query	string	false	filter companies with contracts for the passed plan
billedBySmg	query	boolean	false	filter companies with contracts that are billed by smg
status	query	string	false	filter companies with contracts with the passed status
customDomain	query	string	false	filter companies with contracts with a custom domain
regions	query	string	false	filter companies where the address is in the passed region
ids	query	string	false	filter companies that are exactly matching passed comma separated company slugs e.g. id
entity_types	query	string	false	filter for companies that are matching passed entityTypes
allow_relationship	query	boolean	false	filter for companies that allow relationships
order_by	query	string	false	order companies by passed field
order_dir	query	string	false	define order direction of companies
s	query	string	false	search string for companies
q	query	array[string]	false	define the query parameters

Enumerated Values

Parameter	Value
status	active
status	inactive
status	demo
entity_types	individual
entity_types	company
order_dir	desc
order_dir	asc

Example responses

200 Response

{
  "result": {
    "companies": {
      "Slug": "string",
      "Rechtsform": "string",
      "Firma / Organisation": "string",
      "Zusatz": "string",
      "Slogan": "string",
      "Strasse": "string",
      "Nr.": "string",
      "Postfach": "string",
      "PLZ": 0,
      "Ort": "string",
      "Kanton": "string",
      "Land": "string",
      "Telefon": "string",
      "Fax": "string",
      "Mobile": "string",
      "E-Mail": "string",
      "Website": "string",
      "UID": "string",
      "Erfasst": "string"
    }
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	CompanyExportList resource	CompanyExportList.CompanyExportListDto
404	Not Found	no company found	None

CompanyLogoUpload

api_v1company-logo-upload_post

Code samples

const inputBody = '{
  "companyId": "string",
  "logo": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company-logo-upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "companyId": "string",
  "logo": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company-logo-upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/company-logo-upload', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/company-logo-upload HTTP/1.1

Content-Type: multipart/form-data
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/company-logo-upload

saves the company logo for the passed company

saves the company logo in sgv format in the filesystem, assigning it to the passed company and clearing the cache

Body parameter

companyId: string
logo: string

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	object	true	upload of a logo for a company
» companyId	body	string	true	company slug/id the uploaded logo should be assigned to
» logo	body	string(binary)	true	svg file

Example responses

201 Response

{
  "result": null,
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
201	Created	CompanyLogoUpload resource created	CompanyLogoUpload.BaseResponseData
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

CompanySlugsToNames

api_v1company-slugs-to-names_get

Code samples


const headers = {
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company-slugs-to-names?slugs=dev%2Ctest-company',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company-slugs-to-names?slugs=dev%2Ctest-company',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/company-slugs-to-names', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/company-slugs-to-names?slugs=dev%2Ctest-company HTTP/1.1

Accept: application/json
X-Requested-With-User-Token: string

GET /api/v1/company-slugs-to-names

returning the names for the passed company slugs

returning the names for the passed company slugs

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
slugs	query	string	true	company slugs separated with comma to get names for

Example responses

200 Response

{
  "result": {
    "result": [
      {
        "companySlug": "string",
        "companyName": "string"
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	CompanySlugsToNames resource	CompanySlugsToNames.CompanySlugToNamesDto
404	Not Found	Resource not found	None

CompanyContent

api_v1company_contents_get_collection

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_contents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_contents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/company_contents', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/company_contents HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/company_contents

Retrieves the collection of CompanyContent resources.

Retrieves the collection of CompanyContent resources.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
page	query	integer	false	The collection page number
page_size	query	integer	false	The number of items per page
pagination	query	boolean	false	Enable or disable pagination
order[id]	query	string	false	none
order[lang]	query	string	false	none
order[openingHours]	query	string	false	none
order[slogan]	query	string	false	none
order[description]	query	string	false	none
order[projectDisclaimer]	query	string	false	none
order[dossierDisclaimer]	query	string	false	none
order[virtualTourDisclaimer]	query	string	false	none
order[created]	query	string	false	none
order[updated]	query	string	false	none
company.id	query	string	false	none
company.id[]	query	array[string]	false	none

Enumerated Values

Parameter	Value
order[id]	asc
order[id]	desc
order[lang]	asc
order[lang]	desc
order[openingHours]	asc
order[openingHours]	desc
order[slogan]	asc
order[slogan]	desc
order[description]	asc
order[description]	desc
order[projectDisclaimer]	asc
order[projectDisclaimer]	desc
order[dossierDisclaimer]	asc
order[dossierDisclaimer]	desc
order[virtualTourDisclaimer]	asc
order[virtualTourDisclaimer]	desc
order[created]	asc
order[created]	desc
order[updated]	asc
order[updated]	desc

Example responses

200 Response

{
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "string"
        }
      },
      "id": 0,
      "company": {
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "totalItems": 0,
  "itemsPerPage": 0,
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	CompanyContent collection	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» _embedded	[CompanyContent.jsonhal-read.CompanyContent_timestampable]	true	none	none
»» _links	object	false	none	none
»»» self	object	false	none	none
»»»» href	string(iri-reference)	false	none	none
»» id	integer	false	read-only	none
»» company	Company.jsonhal-read.CompanyContent_timestampable	false	none	none
»»» created	string(date-time)	false	none	Get created.
»»» updated	string(date-time)	false	none	Get updated.
»» lang	string	false	none	none
»» openingHours	string,null	false	none	none
»» slogan	string,null	false	none	none
»» description	string,null	false	none	none
»» projectDisclaimer	string,null	false	none	none
»» dossierDisclaimer	string,null	false	none	none
»» virtualTourDisclaimer	string,null	false	none	none
»» created	string(date-time)	false	none	Get created.
»» updated	string(date-time)	false	none	Get updated.
» totalItems	integer	false	none	none
» itemsPerPage	integer	false	none	none
» _links	object	true	none	none
»» self	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» first	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» last	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» next	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» previous	object	false	none	none
»»» href	string(iri-reference)	false	none	none

api_v1company_contents_post

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": "https://example.com/",
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_contents',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": "https://example.com/",
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_contents',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/company_contents', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/company_contents HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

POST /api/v1/company_contents

Creates a CompanyContent resource.

Creates a CompanyContent resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": "https://example.com/",
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
body	body	CompanyContent.jsonhal	true	The new CompanyContent resource

Example responses

201 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	CompanyContent resource created	CompanyContent.jsonhal-read.CompanyContent_timestampable
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1company_contents_id_get

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_contents/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_contents/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/company_contents/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/company_contents/{id} HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/company_contents/{id}

Retrieves a CompanyContent resource.

Retrieves a CompanyContent resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	CompanyContent identifier

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	CompanyContent resource	CompanyContent.jsonhal-read.CompanyContent_timestampable
404	Not Found	Resource not found	None

api_v1company_contents_id_put

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": "https://example.com/",
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_contents/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": "https://example.com/",
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_contents/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/company_contents/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /api/v1/company_contents/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PUT /api/v1/company_contents/{id}

Replaces the CompanyContent resource.

Replaces the CompanyContent resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": "https://example.com/",
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	CompanyContent identifier
body	body	CompanyContent.jsonhal	true	The updated CompanyContent resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	CompanyContent resource updated	CompanyContent.jsonhal-read.CompanyContent_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1company_contents_id_delete

Code samples


const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_contents/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_contents/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/company_contents/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /api/v1/company_contents/{id} HTTP/1.1

X-Requested-With-User-Token: string

DELETE /api/v1/company_contents/{id}

Removes the CompanyContent resource.

Removes the CompanyContent resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	CompanyContent identifier

Responses

Status	Meaning	Description	Schema
204	No Content	CompanyContent resource deleted	None
404	Not Found	Resource not found	None

api_v1company_contents_id_patch

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": "https://example.com/",
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_contents/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": "https://example.com/",
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_contents/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/api/v1/company_contents/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH /api/v1/company_contents/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PATCH /api/v1/company_contents/{id}

Updates the CompanyContent resource.

Updates the CompanyContent resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": "https://example.com/",
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	CompanyContent identifier
body	body	CompanyContent.jsonhal	true	The updated CompanyContent resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	CompanyContent resource updated	CompanyContent.jsonhal-read.CompanyContent_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

CompanyRelation

api_v1company_relations_get_collection

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_relations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_relations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/company_relations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/company_relations HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/company_relations

Retrieves the collection of CompanyRelation resources.

Retrieves the collection of CompanyRelation resources.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
page	query	integer	false	The collection page number
page_size	query	integer	false	The number of items per page
pagination	query	boolean	false	Enable or disable pagination
order[id]	query	string	false	none
order[type]	query	string	false	none
order[created]	query	string	false	none
order[updated]	query	string	false	none
relationFrom.id	query	string	false	none
relationFrom.id[]	query	array[string]	false	none

Enumerated Values

Parameter	Value
order[id]	asc
order[id]	desc
order[type]	asc
order[type]	desc
order[created]	asc
order[created]	desc
order[updated]	asc
order[updated]	desc

Example responses

200 Response

{
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "string"
        }
      },
      "id": 0,
      "relationTo": {
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "type": "string",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "totalItems": 0,
  "itemsPerPage": 0,
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	CompanyRelation collection	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» _embedded	[CompanyRelation.jsonhal-read.CompanyRelation_timestampable]	true	none	none
»» _links	object	false	none	none
»»» self	object	false	none	none
»»»» href	string(iri-reference)	false	none	none
»» id	integer	false	read-only	none
»» relationTo	Company.jsonhal-read.CompanyRelation_timestampable	false	none	none
»»» created	string(date-time)	false	none	Get created.
»»» updated	string(date-time)	false	none	Get updated.
»» type	string	false	none	none
»» created	string(date-time)	false	none	Get created.
»» updated	string(date-time)	false	none	Get updated.
» totalItems	integer	false	none	none
» itemsPerPage	integer	false	none	none
» _links	object	true	none	none
»» self	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» first	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» last	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» next	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» previous	object	false	none	none
»»» href	string(iri-reference)	false	none	none

api_v1company_relations_post

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "relationFrom": "https://example.com/",
  "relationTo": "https://example.com/",
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_relations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "relationFrom": "https://example.com/",
  "relationTo": "https://example.com/",
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_relations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/company_relations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/company_relations HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

POST /api/v1/company_relations

Creates a CompanyRelation resource.

Creates a CompanyRelation resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "relationFrom": "https://example.com/",
  "relationTo": "https://example.com/",
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	CompanyRelation.jsonhal	true	The new CompanyRelation resource

Example responses

201 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "relationTo": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	CompanyRelation resource created	CompanyRelation.jsonhal-read.CompanyRelation_timestampable
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1company_relations_id_get

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_relations/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_relations/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/company_relations/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/company_relations/{id} HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/company_relations/{id}

Retrieves a CompanyRelation resource.

Retrieves a CompanyRelation resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	CompanyRelation identifier

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "relationTo": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	CompanyRelation resource	CompanyRelation.jsonhal-read.CompanyRelation_timestampable
404	Not Found	Resource not found	None

api_v1company_relations_id_put

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "relationFrom": "https://example.com/",
  "relationTo": "https://example.com/",
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_relations/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "relationFrom": "https://example.com/",
  "relationTo": "https://example.com/",
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_relations/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/company_relations/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /api/v1/company_relations/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PUT /api/v1/company_relations/{id}

Replaces the CompanyRelation resource.

Replaces the CompanyRelation resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "relationFrom": "https://example.com/",
  "relationTo": "https://example.com/",
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	CompanyRelation identifier
body	body	CompanyRelation.jsonhal	true	The updated CompanyRelation resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "relationTo": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	CompanyRelation resource updated	CompanyRelation.jsonhal-read.CompanyRelation_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1company_relations_id_delete

Code samples


const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_relations/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_relations/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/company_relations/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /api/v1/company_relations/{id} HTTP/1.1

X-Requested-With-User-Token: string

DELETE /api/v1/company_relations/{id}

Removes the CompanyRelation resource.

Removes the CompanyRelation resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	CompanyRelation identifier

Responses

Status	Meaning	Description	Schema
204	No Content	CompanyRelation resource deleted	None
404	Not Found	Resource not found	None

api_v1company_relations_id_patch

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "relationFrom": "https://example.com/",
  "relationTo": "https://example.com/",
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_relations/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "relationFrom": "https://example.com/",
  "relationTo": "https://example.com/",
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/company_relations/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/api/v1/company_relations/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH /api/v1/company_relations/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PATCH /api/v1/company_relations/{id}

Updates the CompanyRelation resource.

Updates the CompanyRelation resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "relationFrom": "https://example.com/",
  "relationTo": "https://example.com/",
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	CompanyRelation identifier
body	body	CompanyRelation.jsonhal	true	The updated CompanyRelation resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "relationTo": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	CompanyRelation resource updated	CompanyRelation.jsonhal-read.CompanyRelation_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

ComparisBlacklist

api_v1comparis-blacklist_get

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/comparis-blacklist',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/comparis-blacklist',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/comparis-blacklist', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/comparis-blacklist HTTP/1.1

Accept: application/json

GET /api/v1/comparis-blacklist

returning a list of companies that should not be synced to comparis

returning a list of companies that should not be synced to comparis. If a company has a contract with the republishing service and has the option to be blacklisted set true, then it will appear in this list.

Example responses

200 Response

{
  "result": {
    "companies": [
      "string"
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ComparisBlacklist resource	ComparisBlacklist.ComparisBlacklistDto
404	Not Found	Resource not found	None

ContractCounts

api_v1contract-counts_post

Code samples

const inputBody = '{
  "startDate": null,
  "endDate": null,
  "products": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract-counts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "startDate": null,
  "endDate": null,
  "products": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract-counts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/contract-counts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/contract-counts HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/contract-counts

returning a list of counts of contracts grouped by product and plan

returning a list of counts of contracts grouped by product and plan. The list can be filtered by comma separated products passed in the products body parameter. The list can also be limited with a start and end date, passed in the startDate and endDate body parameter

Body parameter

{
  "startDate": null,
  "endDate": null,
  "products": null
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	ContractCounts	true	The new ContractCounts resource

Example responses

200 Response

{
  "result": {
    "items": [
      {
        "product": "string",
        "count": 0,
        "sort": 0
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ContractCounts resource created	ContractCounts.ContractCountsDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

ContractEntriesForCasaoneProject

api_v1contract-entries-for-casaone-project_post

Code samples

const inputBody = '{
  "startDate": "string",
  "endDate": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract-entries-for-casaone-project',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "startDate": "string",
  "endDate": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract-entries-for-casaone-project',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/contract-entries-for-casaone-project', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/contract-entries-for-casaone-project HTTP/1.1

Content-Type: application/json
Accept: application/json

POST /api/v1/contract-entries-for-casaone-project

returning a list of casaone-project contracts that are within the specified start and endDates

returning a list of casaone-project contracts that are within the specified start and endDates. Each item will have the contractId, the companyId, the customDomain and the number of days the project was online.

Body parameter

{
  "startDate": "string",
  "endDate": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ContractEntriesForCasaoneProject	true	The new ContractEntriesForCasaoneProject resource

Example responses

200 Response

{
  "result": [
    {
      "contractId": "string",
      "companyId": "string",
      "customDomain": "string",
      "noOfDays": "string"
    }
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ContractEntriesForCasaoneProject resource created	ContractEntriesForCasaoneProject.ContractEntriesForCasaoneProjectDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

ContractEntry

api_v1contract_entries_get_collection

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract_entries',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract_entries',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/contract_entries', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/contract_entries HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/contract_entries

Retrieves the collection of ContractEntry resources.

Retrieves the collection of ContractEntry resources.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
page	query	integer	false	The collection page number
page_size	query	integer	false	The number of items per page
pagination	query	boolean	false	Enable or disable pagination
order[id]	query	string	false	none
order[status]	query	string	false	none
order[action]	query	string	false	none
order[messengerType]	query	string	false	none
order[externalIdentifier]	query	string	false	none
order[messenger]	query	string	false	none
order[transcript]	query	string	false	none
order[duration]	query	string	false	none
order[start]	query	string	false	none
order[end]	query	string	false	none
order[created]	query	string	false	none
order[updated]	query	string	false	none
action	query	string	false	none
contract	query	string	false	none
ids	query	string	false	none
status	query	string	false	none
status[]	query	array[string]	false	none

Enumerated Values

Parameter	Value
order[id]	asc
order[id]	desc
order[status]	asc
order[status]	desc
order[action]	asc
order[action]	desc
order[messengerType]	asc
order[messengerType]	desc
order[externalIdentifier]	asc
order[externalIdentifier]	desc
order[messenger]	asc
order[messenger]	desc
order[transcript]	asc
order[transcript]	desc
order[duration]	asc
order[duration]	desc
order[start]	asc
order[start]	desc
order[end]	asc
order[end]	desc
order[created]	asc
order[created]	desc
order[updated]	asc
order[updated]	desc

Example responses

200 Response

{
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "string"
        }
      },
      "id": 0,
      "status": "new",
      "contract": {
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "action": null,
      "messengerType": null,
      "externalIdentifier": null,
      "messenger": null,
      "transcript": null,
      "duration": null,
      "start": null,
      "end": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "totalItems": 0,
  "itemsPerPage": 0,
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	ContractEntry collection	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» _embedded	[ContractEntry.jsonhal-read.ContractEntry_timestampable]	true	none	none
»» _links	object	false	none	none
»»» self	object	false	none	none
»»»» href	string(iri-reference)	false	none	none
»» id	integer	false	read-only	none
»» status	string,null	false	none	none
»» contract	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	Contract.jsonhal-read.ContractEntry_timestampable	false	none	none
»»»» created	string(date-time)	false	none	Get created.
»»»» updated	string(date-time)	false	none	Get updated.

Name	Type	Required	Restrictions	Description
»»» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
»» action	string,null	false	none	none
»» messengerType	string,null	false	none	none
»» externalIdentifier	string,null	false	none	none
»» messenger	string,null	false	none	none
»» transcript	string,null	false	none	none
»» duration	integer,null	false	none	none
»» start	string,null(date-time)	false	none	none
»» end	string,null(date-time)	false	none	none
»» created	string(date-time)	false	none	Get created.
»» updated	string(date-time)	false	none	Get updated.
» totalItems	integer	false	none	none
» itemsPerPage	integer	false	none	none
» _links	object	true	none	none
»» self	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» first	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» last	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» next	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» previous	object	false	none	none
»»» href	string(iri-reference)	false	none	none

api_v1contract_entries_post

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "contract": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract_entries',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "contract": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract_entries',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/contract_entries', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/contract_entries HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

POST /api/v1/contract_entries

Creates a ContractEntry resource.

Creates a ContractEntry resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "contract": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	ContractEntry.jsonhal	true	The new ContractEntry resource

Example responses

201 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "status": "new",
  "contract": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	ContractEntry resource created	ContractEntry.jsonhal-read.ContractEntry_timestampable
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1contract_entries_id_get

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract_entries/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract_entries/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/contract_entries/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/contract_entries/{id} HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/contract_entries/{id}

Retrieves a ContractEntry resource.

Retrieves a ContractEntry resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	ContractEntry identifier

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "status": "new",
  "contract": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	ContractEntry resource	ContractEntry.jsonhal-read.ContractEntry_timestampable
404	Not Found	Resource not found	None

api_v1contract_entries_id_put

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "contract": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract_entries/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "contract": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract_entries/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/contract_entries/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /api/v1/contract_entries/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PUT /api/v1/contract_entries/{id}

Replaces the ContractEntry resource.

Replaces the ContractEntry resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "contract": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	ContractEntry identifier
body	body	ContractEntry.jsonhal	true	The updated ContractEntry resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "status": "new",
  "contract": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	ContractEntry resource updated	ContractEntry.jsonhal-read.ContractEntry_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1contract_entries_id_delete

Code samples


const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract_entries/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract_entries/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/contract_entries/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /api/v1/contract_entries/{id} HTTP/1.1

X-Requested-With-User-Token: string

DELETE /api/v1/contract_entries/{id}

Removes the ContractEntry resource.

Removes the ContractEntry resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	ContractEntry identifier

Responses

Status	Meaning	Description	Schema
204	No Content	ContractEntry resource deleted	None
404	Not Found	Resource not found	None

api_v1contract_entries_id_patch

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "contract": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract_entries/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "contract": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contract_entries/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/api/v1/contract_entries/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH /api/v1/contract_entries/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PATCH /api/v1/contract_entries/{id}

Updates the ContractEntry resource.

Updates the ContractEntry resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "contract": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	ContractEntry identifier
body	body	ContractEntry.jsonhal	true	The updated ContractEntry resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "status": "new",
  "contract": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	ContractEntry resource updated	ContractEntry.jsonhal-read.ContractEntry_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

Contract

api_v1contracts_get_collection

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/contracts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/contracts HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/contracts

Retrieves the collection of Contract resources.

Retrieves the collection of Contract resources.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
page	query	integer	false	The collection page number
page_size	query	integer	false	The number of items per page
pagination	query	boolean	false	Enable or disable pagination
company.id	query	string	false	none
company.id[]	query	array[string]	false	none
product.name	query	string	false	none
product.id	query	string	false	none
product.id[]	query	array[string]	false	none
s	query	string	false	none
plan	query	string	false	none
customDomain	query	string	false	none
projectId	query	string	false	none
order[status]	query	string	false	none
order[created]	query	string	false	none
order[updated]	query	string	false	none
order[product.name]	query	string	false	none

Enumerated Values

Parameter	Value
order[status]	asc
order[status]	desc
order[created]	asc
order[created]	desc
order[updated]	asc
order[updated]	desc
order[product.name]	asc
order[product.name]	desc

Example responses

200 Response

{
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "string"
        }
      },
      "id": 0,
      "sfOpportunityId": null,
      "company": {
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "billingAddress": null,
      "shippingAddress": null,
      "addressBilling": {
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "addressShipping": {
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "options": null,
      "customFieldsSchema": {},
      "status": "active",
      "abacusProjectId": null,
      "billedBySmg": null,
      "contractDate": null,
      "startDate": null,
      "cancellationDate": null,
      "trainingDate": null,
      "noTrainingWanted": null,
      "noCharge": null,
      "product": "casaframe",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "totalItems": 0,
  "itemsPerPage": 0,
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Contract collection	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» _embedded	[Contract.jsonhal-read.Contract_timestampable]	true	none	[A contract defines the relation between a company and a product. Contracts are used to specify configurations for a company regarding a product. These contracts are then used to allow a company and its employees access to products, charge the company for usage, customize the products functionality and looks for a company.]
»» _links	object	false	none	none
»»» self	object	false	none	none
»»»» href	string(iri-reference)	false	none	none
»» id	integer	false	read-only	none
»» sfOpportunityId	string,null	false	none	none
»» company	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	Company.jsonhal-read.Contract_timestampable	false	none	none
»»»» created	string(date-time)	false	none	Get created.
»»»» updated	string(date-time)	false	none	Get updated.

Name	Type	Required	Restrictions	Description
»»» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
»» billingAddress	string,null	false	none	none
»» shippingAddress	string,null	false	none	none
»» addressBilling	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	Address.jsonhal-read.Contract_timestampable	false	none	none
»»»» created	string(date-time)	false	none	Get created.
»»»» updated	string(date-time)	false	none	Get updated.

Name	Type	Required	Restrictions	Description
»»» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
»» addressShipping	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	Address.jsonhal-read.Contract_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
»» options	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	App\Dto\Request\Message\Options\CasaframeOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	App\Dto\Request\Message\Options\CasaoneProjectOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	App\Dto\Request\Message\Options\CasaoneOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	App\Dto\Request\Message\Options\CasaoneWebsiteOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	App\Dto\Request\Message\Options\CasatourOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	App\Dto\Request\Message\Options\HostingOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	App\Dto\Request\Message\Options\IcasaOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	App\Dto\Request\Message\Options\PropertyManagementOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	App\Dto\Request\Message\Options\RepublishOptionsDto	false	none	none

continued

Name	Type	Required	Restrictions	Description
»» customFieldsSchema	object	false	none	none
»» status	string	false	none	none
»» abacusProjectId	integer,null	false	none	none
»» billedBySmg	boolean,null	false	none	none
»» contractDate	string,null(date-time)	false	none	none
»» startDate	string,null(date-time)	false	none	none
»» cancellationDate	string,null(date-time)	false	none	none
»» trainingDate	string,null(date-time)	false	none	none
»» noTrainingWanted	boolean,null	false	none	none
»» noCharge	boolean,null	false	none	none
»» product	string	false	none	none
»» created	string(date-time)	false	none	Get created.
»» updated	string(date-time)	false	none	Get updated.
» totalItems	integer	false	none	none
» itemsPerPage	integer	false	none	none
» _links	object	true	none	none
»» self	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» first	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» last	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» next	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» previous	object	false	none	none
»»» href	string(iri-reference)	false	none	none

Enumerated Values

Property	Value
status	active
status	demo
status	inactive
product	casaframe
product	casagateway
product	casaone
product	casaone-project
product	casaone-website
product	casascreen
product	casatour
product	casawebsite
product	hosting
product	icasa
product	luxuryestate
product	property-management-software
product	republish-service

api_v1contracts_post

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "sfOpportunityId": null,
  "company": "https://example.com/",
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "sfOpportunityId": null,
  "company": "https://example.com/",
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/contracts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/contracts HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

POST /api/v1/contracts

Creates a Contract resource.

Creates a Contract resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "sfOpportunityId": null,
  "company": "https://example.com/",
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
body	body	Contract.jsonhal	true	The new Contract resource

Example responses

201 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "sfOpportunityId": null,
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "casaframe",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	Contract resource created	Contract.jsonhal-read.Contract_timestampable
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1contracts_id_get

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/contracts/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/contracts/{id} HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/contracts/{id}

Retrieves a Contract resource.

Retrieves a Contract resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	Contract identifier

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "sfOpportunityId": null,
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "casaframe",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Contract resource	Contract.jsonhal-read.Contract_timestampable
404	Not Found	Resource not found	None

api_v1contracts_id_put

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "sfOpportunityId": null,
  "company": "https://example.com/",
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "sfOpportunityId": null,
  "company": "https://example.com/",
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/contracts/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /api/v1/contracts/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PUT /api/v1/contracts/{id}

Replaces the Contract resource.

Replaces the Contract resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "sfOpportunityId": null,
  "company": "https://example.com/",
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	Contract identifier
body	body	Contract.jsonhal	true	The updated Contract resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "sfOpportunityId": null,
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "casaframe",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Contract resource updated	Contract.jsonhal-read.Contract_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1contracts_id_delete

Code samples


const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/contracts/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /api/v1/contracts/{id} HTTP/1.1

X-Requested-With-User-Token: string

DELETE /api/v1/contracts/{id}

Removes the Contract resource.

Removes the Contract resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	Contract identifier

Responses

Status	Meaning	Description	Schema
204	No Content	Contract resource deleted	None
404	Not Found	Resource not found	None

api_v1contracts_id_patch

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "sfOpportunityId": null,
  "company": "https://example.com/",
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "sfOpportunityId": null,
  "company": "https://example.com/",
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/api/v1/contracts/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH /api/v1/contracts/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PATCH /api/v1/contracts/{id}

Updates the Contract resource.

Updates the Contract resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "sfOpportunityId": null,
  "company": "https://example.com/",
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	Contract identifier
body	body	Contract.jsonhal	true	The updated Contract resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "sfOpportunityId": null,
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "casaframe",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Contract resource updated	Contract.jsonhal-read.Contract_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

ContractsForIcasaPremiumProfile

api_v1contracts-for-icasa-premium-profile_post

Code samples

const inputBody = '{
  "startDate": "string",
  "endDate": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts-for-icasa-premium-profile',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "startDate": "string",
  "endDate": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts-for-icasa-premium-profile',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/contracts-for-icasa-premium-profile', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/contracts-for-icasa-premium-profile HTTP/1.1

Content-Type: application/json
Accept: application/json

POST /api/v1/contracts-for-icasa-premium-profile

returning a list of icasa premium contract ids in relation with a company slug

returning a list of icasa premium contract ids in relation with a company slug. Meaning that the contract option premium is set true. Also if a start and endDate are provided it will provide the number of days the contract is/was running for. As well as the start date of the contract

Body parameter

{
  "startDate": "string",
  "endDate": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ContractsForIcasaPremiumProfile	true	The new ContractsForIcasaPremiumProfile resource

Example responses

200 Response

{
  "result": [
    {
      "contractId": 0,
      "companyId": "string",
      "startDate": "2023-10-12T07:10:17Z",
      "noOfDays": 0
    }
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ContractsForIcasaPremiumProfile resource created	ContractsForIcasaPremiumProfile.ContractsForIcasaPremiumProfileDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

ContractsTermination

api_v1contracts-termination_post

Code samples

const inputBody = '{
  "products": "casaframe",
  "status": "active"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts-termination',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "products": "casaframe",
  "status": "active"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts-termination',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/contracts-termination', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/contracts-termination HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/contracts-termination

returning a list of contract entities that have a cancellationDate set

returning a list of contract entities that have a cancellationDate set. If passed the result can be filtered by comma separated product slugs and comma separated status

Body parameter

{
  "products": "casaframe",
  "status": "active"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	ContractsTermination	true	The new ContractsTermination resource

Example responses

200 Response

{
  "result": {
    "items": [
      {
        "id": 0,
        "companySlug": "string",
        "legalName": null,
        "productSlug": "string",
        "productName": "string",
        "premium": null,
        "plan": null,
        "status": "string",
        "abacusProjectId": null,
        "contractDate": null,
        "startDate": null,
        "cancellationDate": null,
        "trainingDate": null
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ContractsTermination resource created	ContractsTermination.ContractsTerminationDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

ContractsWithContinuousPropertyImportFtp

api_v1contracts-with-continuous-property-import-ftp_post

Code samples

const inputBody = '{
  "status": "active"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts-with-continuous-property-import-ftp',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "status": "active"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts-with-continuous-property-import-ftp',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/contracts-with-continuous-property-import-ftp', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/contracts-with-continuous-property-import-ftp HTTP/1.1

Content-Type: application/json
Accept: application/json

POST /api/v1/contracts-with-continuous-property-import-ftp

returning a list of contract entities with the product property-management-software

returning a list of contract entities with the product property-management-software and FTP settings in it.

Body parameter

{
  "status": "active"
}

Parameters

Name	In	Type	Required	Description
body	body	ContractsWithContinuousPropertyImportFtp	true	The new ContractsWithContinuousPropertyImportFtp resource

Example responses

200 Response

{
  "result": {
    "items": [
      {
        "id": "string",
        "companySlug": "string",
        "legalName": "string",
        "productSlug": "string",
        "productName": "string",
        "customerFtpServer": [
          "string"
        ],
        "status": "string",
        "contractDate": "2023-10-12T07:10:17Z",
        "startDate": "2023-10-12T07:10:17Z",
        "cancellationDate": "2023-10-12T07:10:17Z"
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ContractsWithContinuousPropertyImportFtp resource created	ContractsWithContinuousPropertyImportFtp.ContractsWithContinuousPropertyImportFtpDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

ContractsWithMissingAbacusCustomerId

api_v1contracts-with-missing-abacus-customer-id_post

Code samples

const inputBody = '{
  "products": "casaframe",
  "status": "active"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts-with-missing-abacus-customer-id',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "products": "casaframe",
  "status": "active"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts-with-missing-abacus-customer-id',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/contracts-with-missing-abacus-customer-id', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/contracts-with-missing-abacus-customer-id HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/contracts-with-missing-abacus-customer-id

returning a list of contract entities where the AbacusCustomerId is missing

returning a list of contract entities where the AbacusCustomerId is missing

Body parameter

{
  "products": "casaframe",
  "status": "active"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	ContractsWithMissingAbacusCustomerId	true	The new ContractsWithMissingAbacusCustomerId resource

Example responses

200 Response

{
  "result": {
    "items": [
      {
        "id": "string",
        "companySlug": "string",
        "legalName": "string",
        "productSlug": "string",
        "productName": "string",
        "premium": "string",
        "plan": "string",
        "status": "string",
        "abacusProjectId": "string",
        "contractDate": "2023-10-12T07:10:17Z",
        "startDate": "2023-10-12T07:10:17Z",
        "cancellationDate": "2023-10-12T07:10:17Z",
        "trainingDate": "2023-10-12T07:10:17Z"
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ContractsWithMissingAbacusCustomerId resource created	ContractsWithMissingAbacusCustomerId.ContractsWithMissingAbacusCustomerIdDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

ContractsWithMissingAbacusId

api_v1contracts-with-missing-abacus-id_post

Code samples

const inputBody = '{
  "products": "casaframe",
  "status": "active"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts-with-missing-abacus-id',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "products": "casaframe",
  "status": "active"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts-with-missing-abacus-id',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/contracts-with-missing-abacus-id', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/contracts-with-missing-abacus-id HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/contracts-with-missing-abacus-id

returning a list of contract entities where the AbacusId is missing

returning a list of contract entities where the AbacusId is missing

Body parameter

{
  "products": "casaframe",
  "status": "active"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	ContractsWithMissingAbacusId	true	The new ContractsWithMissingAbacusId resource

Example responses

200 Response

{
  "result": {
    "items": [
      {
        "id": "string",
        "companySlug": "string",
        "legalName": "string",
        "productSlug": "string",
        "productName": "string",
        "premium": "string",
        "plan": "string",
        "status": "string",
        "abacusProjectId": "string",
        "contractDate": "2023-10-12T07:10:17Z",
        "startDate": "2023-10-12T07:10:17Z",
        "cancellationDate": "2023-10-12T07:10:17Z",
        "trainingDate": "2023-10-12T07:10:17Z",
        "abacusCustomerId": "2023-10-12T07:10:17Z"
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ContractsWithMissingAbacusId resource created	ContractsWithMissingAbacusId.ContractsWithMissingAbacusIdDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

ContractsWithMissingTrainingDate

api_v1contracts-with-missing-training-date_post

Code samples

const inputBody = '{
  "products": "casaframe"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts-with-missing-training-date',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "products": "casaframe"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/contracts-with-missing-training-date',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/contracts-with-missing-training-date', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/contracts-with-missing-training-date HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/contracts-with-missing-training-date

returning a list of contract entities where status is active and the TrainingDate is missing

returning a list of contract entities where status is active and the TrainingDate is missing

Body parameter

{
  "products": "casaframe"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	ContractsWithMissingTrainingDate	true	The new ContractsWithMissingTrainingDate resource

Example responses

200 Response

{
  "result": {
    "items": [
      {
        "id": "string",
        "companySlug": "string",
        "legalName": "string",
        "productSlug": "string",
        "productName": "string",
        "premium": "string",
        "plan": "string",
        "status": "string",
        "abacusProjectId": "string",
        "contractDate": "2023-10-12T07:10:17Z",
        "startDate": "2023-10-12T07:10:17Z",
        "cancellationDate": "2023-10-12T07:10:17Z",
        "trainingDate": "2023-10-12T07:10:17Z"
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ContractsWithMissingTrainingDate resource created	ContractsWithMissingTrainingDate.ContractsWithMissingTrainingDateDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

CreateAndAssignFtpAccess

api_v1create-and-assign-ftp-access_post

Code samples

const inputBody = '{
  "contractId": 0,
  "software": "garaiorem",
  "username": "string",
  "password": "string",
  "activateAllPublicationMedia": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/create-and-assign-ftp-access',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "contractId": 0,
  "software": "garaiorem",
  "username": "string",
  "password": "string",
  "activateAllPublicationMedia": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/create-and-assign-ftp-access',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/create-and-assign-ftp-access', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/create-and-assign-ftp-access HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/create-and-assign-ftp-access

adding ftp settings to property management software contract options

adding ftp settings to property management software contract options. Therefore passed contractId needs to exist and be of a property management software contract.

Body parameter

{
  "contractId": 0,
  "software": "garaiorem",
  "username": "string",
  "password": "string",
  "activateAllPublicationMedia": true
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	CreateAndAssignFtpAccess	true	The new CreateAndAssignFtpAccess resource

Example responses

201 Response

{
  "result": {
    "username": "string",
    "ftpHomeDir": [
      {
        "type": "string",
        "path": "string",
        "visibility": "string",
        "last_modified": "2023-10-12T07:10:17Z",
        "extra_metadata": [
          "string"
        ]
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
201	Created	CreateAndAssignFtpAccess resource created	CreateAndAssignFtpAccess.CreateAndAssignFtpAccessDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

CustomfieldsSchemaUpload

api_v1customfields-schema-upload_post

Code samples

const inputBody = '{
  "customfieldsSchema": {},
  "contractId": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/customfields-schema-upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "customfieldsSchema": {},
  "contractId": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/customfields-schema-upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/customfields-schema-upload', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/customfields-schema-upload HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/customfields-schema-upload

uploads and replaces the customFieldSchema entry in the passed contract

uploads and replaces the customFieldSchema entry in the passed contract

Body parameter

{
  "customfieldsSchema": {},
  "contractId": 0
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	CustomfieldsSchemaUpload	true	The new CustomfieldsSchemaUpload resource

Example responses

201 Response

{
  "result": {
    "contractId": "string",
    "customFieldsSchema": {},
    "oldFileName": "string"
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
201	Created	CustomfieldsSchemaUpload resource created	CustomfieldsSchemaUpload.CustomfieldsSchemaUploadDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

DeleteUserAndRemoveEmployeeUsername

api_v1delete-user-and-remove-employee-username_post

Code samples

const inputBody = '{
  "username": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/delete-user-and-remove-employee-username',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "username": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/delete-user-and-remove-employee-username',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/delete-user-and-remove-employee-username', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/delete-user-and-remove-employee-username HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/delete-user-and-remove-employee-username

removes user from keycloak set the relation in employer relation to null and deletes the user entity

removes user from keycloak set the relation in employer relation to null and deletes the use entity

Body parameter

{
  "username": "string"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	DeleteUserAndRemoveEmployeeUsername	true	The new DeleteUserAndRemoveEmployeeUsername resource

Example responses

200 Response

{
  "result": {
    "message": "string"
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	DeleteUserAndRemoveEmployeeUsername resource created	DeleteUserAndRemoveEmployeeUsername.DeleteUserAndRemoveEmployeeUsernameDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

Employee

api_v1employees_get_collection

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/employees',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/employees',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/employees', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/employees HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/employees

Retrieves the collection of Employee resources.

Retrieves the collection of Employee resources.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
page	query	integer	false	The collection page number
page_size	query	integer	false	The number of items per page
pagination	query	boolean	false	Enable or disable pagination
order[id]	query	string	false	none
order[userResetToken]	query	string	false	none
order[firstName]	query	string	false	none
order[lastName]	query	string	false	none
order[gender]	query	string	false	none
order[lang]	query	string	false	none
order[email]	query	string	false	none
order[phone]	query	string	false	none
order[mobile]	query	string	false	none
order[fax]	query	string	false	none
order[dob]	query	string	false	none
order[function]	query	string	false	none
order[lastClientIp]	query	string	false	none
order[role]	query	string	false	none
order[trusted]	query	string	false	none
order[created]	query	string	false	none
order[updated]	query	string	false	none
s	query	string	false	none
company.id	query	string	false	none
company.id[]	query	array[string]	false	none
user.username	query	string	false	none
user.username[]	query	array[string]	false	none
exists[company]	query	boolean	false	none

Enumerated Values

Parameter	Value
order[id]	asc
order[id]	desc
order[userResetToken]	asc
order[userResetToken]	desc
order[firstName]	asc
order[firstName]	desc
order[lastName]	asc
order[lastName]	desc
order[gender]	asc
order[gender]	desc
order[lang]	asc
order[lang]	desc
order[email]	asc
order[email]	desc
order[phone]	asc
order[phone]	desc
order[mobile]	asc
order[mobile]	desc
order[fax]	asc
order[fax]	desc
order[dob]	asc
order[dob]	desc
order[function]	asc
order[function]	desc
order[lastClientIp]	asc
order[lastClientIp]	desc
order[role]	asc
order[role]	desc
order[trusted]	asc
order[trusted]	desc
order[created]	asc
order[created]	desc
order[updated]	asc
order[updated]	desc

Example responses

200 Response

{
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "string"
        }
      },
      "id": 0,
      "company": {
        "id": "string",
        "sfAccountId": null,
        "address": {
          "id": 0,
          "country": null,
          "locality": null,
          "region": null,
          "postalCode": null,
          "postOfficeBoxNumber": null,
          "street": null,
          "streetNumber": null,
          "streetAddition": null,
          "lat": null,
          "lng": null,
          "created": "2023-10-12T07:10:17Z",
          "updated": "2023-10-12T07:10:17Z"
        },
        "legalName": null,
        "legalForm": null,
        "entityType": null,
        "email": null,
        "phone": null,
        "mobile": null,
        "fax": null,
        "slogan": null,
        "twitter": null,
        "linkedin": null,
        "facebook": null,
        "pinterest": null,
        "instagram": null,
        "websiteUrl": null,
        "logo": null,
        "logoInv": null,
        "logoBw": null,
        "logoBwInv": null,
        "uid": null,
        "vat": null,
        "options": null,
        "addition": null,
        "internalNotes": null,
        "abacusCustomerId": null,
        "allowRelationship": true,
        "zefixMutations": null,
        "zefixLastUpdateDate": null,
        "employees": [
          "https://example.com/"
        ],
        "companyContents": [
          "https://example.com/"
        ],
        "companyRelations": [
          "https://example.com/"
        ],
        "contracts": [
          "https://example.com/"
        ],
        "userRoles": [
          "https://example.com/"
        ],
        "legalPerson": "https://example.com/",
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "userResetToken": null,
      "firstName": null,
      "lastName": null,
      "gender": null,
      "lang": null,
      "email": null,
      "phone": null,
      "mobile": null,
      "fax": null,
      "dob": null,
      "function": null,
      "lastClientIp": null,
      "role": "visitor",
      "trusted": null,
      "user": {
        "username": "string",
        "employee": "https://example.com/",
        "firstName": null,
        "lastName": null,
        "keycloakId": null,
        "userRoles": [
          "https://example.com/"
        ],
        "password": null,
        "roles": [
          "string"
        ],
        "userIdentifier": "string"
      },
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "totalItems": 0,
  "itemsPerPage": 0,
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Employee collection	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» _embedded	[Employee.jsonhal-read.Employee_timestampable]	true	none	none
»» _links	object	false	none	none
»»» self	object	false	none	none
»»»» href	string(iri-reference)	false	none	none
»» id	integer	false	read-only	none
»» company	Company	false	none	none
»»» id	string	false	none	none
»»» sfAccountId	string,null	false	none	none
»»» address	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	Address	false	none	none
»»»»» id	integer	false	read-only	none
»»»»» country	string,null	false	none	none
»»»»» locality	string,null	false	none	none
»»»»» region	string,null	false	none	none
»»»»» postalCode	integer,null	false	none	none
»»»»» postOfficeBoxNumber	string,null	false	none	none
»»»»» street	string,null	false	none	none
»»»»» streetNumber	string,null	false	none	none
»»»»» streetAddition	string,null	false	none	none
»»»»» lat	string,null	false	none	none
»»»»» lng	string,null	false	none	none
»»»»» created	string(date-time)	false	none	Get created.
»»»»» updated	string(date-time)	false	none	Get updated.

Name	Type	Required	Restrictions	Description
»»»» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
»»» legalName	string,null	false	none	none
»»» legalForm	string,null	false	none	none
»»» entityType	string,null	false	none	none
»»» email	string,null	false	none	none
»»» phone	string,null	false	none	none
»»» mobile	string,null	false	none	none
»»» fax	string,null	false	none	none
»»» slogan	string,null	false	none	none
»»» twitter	string,null	false	none	none
»»» linkedin	string,null	false	none	none
»»» facebook	string,null	false	none	none
»»» pinterest	string,null	false	none	none
»»» instagram	string,null	false	none	none
»»» websiteUrl	string,null	false	none	none
»»» logo	string,null	false	none	none
»»» logoInv	string,null	false	none	none
»»» logoBw	string,null	false	none	none
»»» logoBwInv	string,null	false	none	none
»»» uid	string,null	false	none	none
»»» vat	integer,null	false	none	none
»»» options	object,null	false	none	none
»»» addition	string,null	false	none	none
»»» internalNotes	string,null	false	none	none
»»» abacusCustomerId	integer,null	false	none	none
»»» allowRelationship	boolean	false	none	none
»»» zefixMutations	object,null	false	none	none
»»» zefixLastUpdateDate	string,null(date-time)	false	none	none
»»» employees	[string]	false	none	none
»»» companyContents	[string]	false	none	none
»»» companyRelations	[string]	false	none	none
»»» contracts	[string]	false	none	none
»»» userRoles	[string]	false	none	none
»»» legalPerson	string,null(iri-reference)	false	none	none
»»» created	string(date-time)	false	none	Get created.
»»» updated	string(date-time)	false	none	Get updated.
»» userResetToken	string,null	false	none	none
»» firstName	string,null	false	none	none
»» lastName	string,null	false	none	none
»» gender	integer,null	false	none	none
»» lang	string,null	false	none	none
»» email	string,null	false	none	none
»» phone	string,null	false	none	none
»» mobile	string,null	false	none	none
»» fax	string,null	false	none	none
»» dob	string,null(date-time)	false	none	none
»» function	string,null	false	none	none
»» lastClientIp	string,null	false	none	none
»» role	string	false	none	none
»» trusted	boolean,null	false	none	none
»» user	User	false	none	none
»»» username	string	false	none	none
»»» employee	string,null(iri-reference)	false	none	none
»»» firstName	string,null	false	none	none
»»» lastName	string,null	false	none	none
»»» keycloakId	string,null	false	none	none
»»» userRoles	[string]	false	none	none
»»» password	string,null	false	none	none
»»» roles	[string]	false	read-only	USE THIS FOR TESTING ONLY
»»» userIdentifier	string	false	read-only	none
»» created	string(date-time)	false	none	Get created.
»» updated	string(date-time)	false	none	Get updated.
» totalItems	integer	false	none	none
» itemsPerPage	integer	false	none	none
» _links	object	true	none	none
»» self	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» first	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» last	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» next	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» previous	object	false	none	none
»»» href	string(iri-reference)	false	none	none

api_v1employees_post

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/employees',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/employees',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/employees', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/employees HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

POST /api/v1/employees

Creates a Employee resource.

Creates a Employee resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
body	body	Employee.jsonhal	true	The new Employee resource

Example responses

201 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "id": 0,
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null,
    "roles": [
      "string"
    ],
    "userIdentifier": "string"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	Employee resource created	Employee.jsonhal-read.Employee_timestampable
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1employees_id_get

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/employees/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/employees/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/employees/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/employees/{id} HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/employees/{id}

Retrieves a Employee resource.

Retrieves a Employee resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	Employee identifier

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "id": 0,
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null,
    "roles": [
      "string"
    ],
    "userIdentifier": "string"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Employee resource	Employee.jsonhal-read.Employee_timestampable
404	Not Found	Resource not found	None

api_v1employees_id_put

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/employees/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/employees/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/employees/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /api/v1/employees/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PUT /api/v1/employees/{id}

Replaces the Employee resource.

Replaces the Employee resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	Employee identifier
body	body	Employee.jsonhal	true	The updated Employee resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "id": 0,
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null,
    "roles": [
      "string"
    ],
    "userIdentifier": "string"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Employee resource updated	Employee.jsonhal-read.Employee_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1employees_id_delete

Code samples


const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/employees/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/employees/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/employees/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /api/v1/employees/{id} HTTP/1.1

X-Requested-With-User-Token: string

DELETE /api/v1/employees/{id}

Removes the Employee resource.

Removes the Employee resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	Employee identifier

Responses

Status	Meaning	Description	Schema
204	No Content	Employee resource deleted	None
404	Not Found	Resource not found	None

api_v1employees_id_patch

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/employees/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/employees/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/api/v1/employees/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH /api/v1/employees/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PATCH /api/v1/employees/{id}

Updates the Employee resource.

Updates the Employee resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
id	path	string	true	Employee identifier
body	body	Employee.jsonhal	true	The updated Employee resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "id": 0,
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null,
    "roles": [
      "string"
    ],
    "userIdentifier": "string"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Employee resource updated	Employee.jsonhal-read.Employee_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

Entry

api_v1entries_get_collection

Code samples


const headers = {
  'Accept':'application/hal+json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/entries',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/entries',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/entries', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/entries HTTP/1.1

Accept: application/hal+json

GET /api/v1/entries

Retrieves the collection of Entry resources.

Retrieves the collection of Entry resources.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The collection page number
page_size	query	integer	false	The number of items per page
pagination	query	boolean	false	Enable or disable pagination
order[id]	query	string	false	none
order[status]	query	string	false	none
order[action]	query	string	false	none
order[messengerType]	query	string	false	none
order[externalIdentifier]	query	string	false	none
order[messenger]	query	string	false	none
order[transcript]	query	string	false	none
order[duration]	query	string	false	none
order[end]	query	string	false	none
order[created]	query	string	false	none
order[updated]	query	string	false	none
status	query	string	false	none
action	query	string	false	none
company.id	query	string	false	none
company.id[]	query	array[string]	false	none
company.legalName	query	string	false	none

Enumerated Values

Parameter	Value
order[id]	asc
order[id]	desc
order[status]	asc
order[status]	desc
order[action]	asc
order[action]	desc
order[messengerType]	asc
order[messengerType]	desc
order[externalIdentifier]	asc
order[externalIdentifier]	desc
order[messenger]	asc
order[messenger]	desc
order[transcript]	asc
order[transcript]	desc
order[duration]	asc
order[duration]	desc
order[end]	asc
order[end]	desc
order[created]	asc
order[created]	desc
order[updated]	asc
order[updated]	desc

Example responses

200 Response

{
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "string"
        }
      },
      "id": 0,
      "status": "new",
      "company": {
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "action": null,
      "messengerType": null,
      "externalIdentifier": null,
      "messenger": null,
      "transcript": null,
      "duration": null,
      "end": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "totalItems": 0,
  "itemsPerPage": 0,
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Entry collection	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» _embedded	[Entry.jsonhal-read.Entry_timestampable]	true	none	none
»» _links	object	false	none	none
»»» self	object	false	none	none
»»»» href	string(iri-reference)	false	none	none
»» id	integer	false	read-only	none
»» status	string,null	false	none	none
»» company	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	Company.jsonhal-read.Entry_timestampable	false	none	none
»»»» created	string(date-time)	false	none	Get created.
»»»» updated	string(date-time)	false	none	Get updated.

Name	Type	Required	Restrictions	Description
»»» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
»» action	string,null	false	none	none
»» messengerType	string,null	false	none	none
»» externalIdentifier	string,null	false	none	none
»» messenger	string,null	false	none	none
»» transcript	string,null	false	none	none
»» duration	integer,null	false	none	none
»» end	string,null(date-time)	false	none	none
»» created	string(date-time)	false	none	Get created.
»» updated	string(date-time)	false	none	Get updated.
» totalItems	integer	false	none	none
» itemsPerPage	integer	false	none	none
» _links	object	true	none	none
»» self	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» first	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» last	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» next	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» previous	object	false	none	none
»»» href	string(iri-reference)	false	none	none

api_v1entries_post

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "company": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/entries',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "company": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/entries',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/entries', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/entries HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

POST /api/v1/entries

Creates a Entry resource.

Creates a Entry resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "company": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
body	body	Entry.jsonhal	true	The new Entry resource

Example responses

201 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "status": "new",
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	Entry resource created	Entry.jsonhal-read.Entry_timestampable
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1entries_id_get

Code samples


const headers = {
  'Accept':'application/hal+json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/entries/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/entries/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/entries/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/entries/{id} HTTP/1.1

Accept: application/hal+json

GET /api/v1/entries/{id}

Retrieves a Entry resource.

Retrieves a Entry resource.

Parameters

Name	In	Type	Required	Description
id	path	string	true	Entry identifier

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "status": "new",
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Entry resource	Entry.jsonhal-read.Entry_timestampable
404	Not Found	Resource not found	None

api_v1entries_id_put

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "company": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/entries/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "company": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/entries/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/entries/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /api/v1/entries/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

PUT /api/v1/entries/{id}

Replaces the Entry resource.

Replaces the Entry resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "company": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	Entry identifier
body	body	Entry.jsonhal	true	The updated Entry resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "status": "new",
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Entry resource updated	Entry.jsonhal-read.Entry_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1entries_id_delete

Code samples


const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/entries/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/entries/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/entries/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /api/v1/entries/{id} HTTP/1.1

DELETE /api/v1/entries/{id}

Removes the Entry resource.

Removes the Entry resource.

Parameters

Name	In	Type	Required	Description
id	path	string	true	Entry identifier

Responses

Status	Meaning	Description	Schema
204	No Content	Entry resource deleted	None
404	Not Found	Resource not found	None

api_v1entries_id_patch

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "company": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/entries/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "company": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/entries/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/api/v1/entries/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH /api/v1/entries/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

PATCH /api/v1/entries/{id}

Updates the Entry resource.

Updates the Entry resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "status": "new",
  "company": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
id	path	string	true	Entry identifier
body	body	Entry.jsonhal	true	The updated Entry resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "status": "new",
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Entry resource updated	Entry.jsonhal-read.Entry_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

GdprDeletionRequest

api_v1gdpr-deletion-request_post

Code samples

const inputBody = '{
  "companyId": "string",
  "requestId": "string",
  "email": null,
  "phones": null,
  "dryRun": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/gdpr-deletion-request',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "companyId": "string",
  "requestId": "string",
  "email": null,
  "phones": null,
  "dryRun": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/gdpr-deletion-request',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/gdpr-deletion-request', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/gdpr-deletion-request HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/gdpr-deletion-request

anonymizes all data matching with the requested email and phones

anonymizes all data matching with the requested email and phones

Body parameter

{
  "companyId": "string",
  "requestId": "string",
  "email": null,
  "phones": null,
  "dryRun": true
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	GdprDeletionRequest.GdprDeletionRequest	true	The new GdprDeletionRequest resource

Example responses

200 Response

{
  "result": null,
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	GdprDeletionRequest resource created	GdprDeletionRequest.BaseResponseData
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

Identity

identities_read_collection

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identities?companies=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identities?companies=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/identities', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/identities?companies=string HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/identities

Retrieves the collection of Identity resources.

Retrieves the collection of Identity resources.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
page	query	integer	false	The collection page number
page_size	query	integer	false	The number of items per page
pagination	query	boolean	false	Enable or disable pagination
usernames	query	string	false	Filter by username and company. Can be filtered by multiple values, e.g. "?usernames=value1,value2"
companies	query	string	true	Filter by username and company. Can be filtered by multiple values, e.g. "?companies=value1,value2"

Example responses

200 Response

{
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "string"
        }
      },
      "id": 0,
      "user": {
        "username": "string"
      },
      "identityRoles": [
        {
          "id": 0,
          "company": {
            "id": "string",
            "created": "2023-10-12T07:10:17Z",
            "updated": "2023-10-12T07:10:17Z"
          },
          "role": {
            "id": 0,
            "name": "string",
            "created": "2023-10-12T07:10:17Z",
            "updated": "2023-10-12T07:10:17Z"
          },
          "created": "2023-10-12T07:10:17Z",
          "updated": "2023-10-12T07:10:17Z"
        }
      ],
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z",
      "roles": {}
    }
  ],
  "totalItems": 0,
  "itemsPerPage": 0,
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Identity collection	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» _embedded	[Identity.jsonhal-identity.read_timestampable]	true	none	none
»» _links	object	false	none	none
»»» self	object	false	none	none
»»»» href	string(iri-reference)	false	none	none
»» id	integer	false	read-only	none
»» user	User.jsonhal-identity.read_timestampable	false	none	none
»»» username	string	false	none	none
»» identityRoles	[IdentityRole.jsonhal-identity.read_timestampable]	false	none	none
»»» id	integer	false	read-only	none
»»» company	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
»»»» anonymous	Company.jsonhal-identity.read_timestampable	false	none	none
»»»»» id	string	false	none	none
»»»»» created	string(date-time)	false	none	Get created.
»»»»» updated	string(date-time)	false	none	Get updated.

Name	Type	Required	Restrictions	Description
»»»» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
»»» role	Role.jsonhal-identity.read_timestampable	true	none	none
»»»» id	integer	false	read-only	none
»»»» name	string	false	none	none
»»»» created	string(date-time)	false	none	Get created.
»»»» updated	string(date-time)	false	none	Get updated.
»»» created	string(date-time)	false	none	Get created.
»»» updated	string(date-time)	false	none	Get updated.
»» created	string(date-time)	false	none	Get created.
»» updated	string(date-time)	false	none	Get updated.
»» roles	object	false	read-only	none
» totalItems	integer	false	none	none
» itemsPerPage	integer	false	none	none
» _links	object	true	none	none
»» self	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» first	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» last	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» next	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» previous	object	false	none	none
»»» href	string(iri-reference)	false	none	none

identities_edit

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "user": "https://example.com/",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identities',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "user": "https://example.com/",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identities',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/identities', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/identities HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

POST /api/v1/identities

Creates a Identity resource.

Creates a Identity resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "user": "https://example.com/",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	Identity.jsonhal	true	The new Identity resource

Example responses

201 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "user": {
    "username": "string"
  },
  "identityRoles": [
    {
      "id": 0,
      "company": {
        "id": "string",
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "role": {
        "id": 0,
        "name": "string",
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "roles": {}
}

Responses

Status	Meaning	Description	Schema
201	Created	Identity resource created	Identity.jsonhal-identity.read_timestampable
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

identities_read

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identities/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identities/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/identities/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/identities/{id} HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/identities/{id}

Retrieves a Identity resource.

Retrieves a Identity resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	Identity identifier

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "user": {
    "username": "string"
  },
  "identityRoles": [
    {
      "id": 0,
      "company": {
        "id": "string",
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "role": {
        "id": 0,
        "name": "string",
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "roles": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Identity resource	Identity.jsonhal-identity.read_timestampable
404	Not Found	Resource not found	None

identities_delete

Code samples


const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identities/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identities/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/identities/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /api/v1/identities/{id} HTTP/1.1

X-Requested-With-User-Token: string

DELETE /api/v1/identities/{id}

Removes the Identity resource.

Removes the Identity resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	Identity identifier

Responses

Status	Meaning	Description	Schema
204	No Content	Identity resource deleted	None
404	Not Found	Resource not found	None

IdentityRole

api_v1identity_roles_get_collection

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identity_roles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identity_roles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/identity_roles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/identity_roles HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/identity_roles

Retrieves the collection of IdentityRole resources.

Retrieves the collection of IdentityRole resources.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
page	query	integer	false	The collection page number
page_size	query	integer	false	The number of items per page
pagination	query	boolean	false	Enable or disable pagination
identity.user	query	string	false	none
identity.user[]	query	array[string]	false	none
company.id	query	string	false	none
company.id[]	query	array[string]	false	none

Example responses

200 Response

{
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "string"
        }
      },
      "id": 0,
      "identity": "https://example.com/",
      "company": "https://example.com/",
      "role": "https://example.com/",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "totalItems": 0,
  "itemsPerPage": 0,
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	IdentityRole collection	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» _embedded	[IdentityRole.jsonhal]	true	none	none
»» _links	object	false	none	none
»»» self	object	false	none	none
»»»» href	string(iri-reference)	false	none	none
»» id	integer	false	read-only	none
»» identity	string(iri-reference)	true	none	none
»» company	string,null(iri-reference)	false	none	none
»» role	string(iri-reference)	true	none	none
»» created	string(date-time)	false	none	Get created.
»» updated	string(date-time)	false	none	Get updated.
» totalItems	integer	false	none	none
» itemsPerPage	integer	false	none	none
» _links	object	true	none	none
»» self	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» first	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» last	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» next	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» previous	object	false	none	none
»»» href	string(iri-reference)	false	none	none

api_v1identity_roles_post

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "identity": "https://example.com/",
  "company": "https://example.com/",
  "role": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identity_roles',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "identity": "https://example.com/",
  "company": "https://example.com/",
  "role": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identity_roles',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/identity_roles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/identity_roles HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

POST /api/v1/identity_roles

Creates a IdentityRole resource.

Creates a IdentityRole resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "identity": "https://example.com/",
  "company": "https://example.com/",
  "role": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	IdentityRole.jsonhal	true	The new IdentityRole resource

Example responses

201 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "identity": "https://example.com/",
  "company": "https://example.com/",
  "role": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	IdentityRole resource created	IdentityRole.jsonhal
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1identity_roles_id_get

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identity_roles/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identity_roles/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/identity_roles/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/identity_roles/{id} HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/identity_roles/{id}

Retrieves a IdentityRole resource.

Retrieves a IdentityRole resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	IdentityRole identifier

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "identity": "https://example.com/",
  "company": "https://example.com/",
  "role": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	IdentityRole resource	IdentityRole.jsonhal
404	Not Found	Resource not found	None

api_v1identity_roles_id_delete

Code samples


const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identity_roles/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/identity_roles/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/identity_roles/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /api/v1/identity_roles/{id} HTTP/1.1

X-Requested-With-User-Token: string

DELETE /api/v1/identity_roles/{id}

Removes the IdentityRole resource.

Removes the IdentityRole resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	IdentityRole identifier

Responses

Status	Meaning	Description	Schema
204	No Content	IdentityRole resource deleted	None
404	Not Found	Resource not found	None

InterfaceStatus

api_v1interface-status_post

Code samples

const inputBody = '{
  "software": "casaframe"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/interface-status',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "software": "casaframe"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/interface-status',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/interface-status', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/interface-status HTTP/1.1

Content-Type: application/json
Accept: application/json

POST /api/v1/interface-status

returning a list of company interface configurations grouped by errorType

returning a list of company interface configurations grouped by errorType. ErrorTypes are: Connection error to ftp. CompanyPublisherSettings approved is NULL or ftp- server, username, password or port is missing. Missing ftp settings in CompanyPublisherSettings. Missing provider publisher settings.

Body parameter

{
  "software": "casaframe"
}

Parameters

Name	In	Type	Required	Description
body	body	InterfaceStatus	true	The new InterfaceStatus resource

Example responses

200 Response

{
  "result": {
    "items": [
      {
        "missing-setting-connection": {
          "publisherSlug": "string",
          "publisherName": "string",
          "company": "string",
          "companyName": "string"
        },
        "ftp-unstable": {
          "statusKey": "string",
          "ftp-unstable-since": "string",
          "ftp-username": "string",
          "publisherSlug": "string",
          "publisherName": "string",
          "company": "string",
          "companyName": "string"
        },
        "ftp-misconfigured": {
          "statusKey": "string",
          "ftp-unstable-since": "string",
          "ftp-username": "string",
          "publisherSlug": "string",
          "publisherName": "string",
          "company": "string",
          "companyName": "string"
        },
        "ftp-not-configured": {
          "publisherExportProtocol": "string",
          "publisherSlug": "string",
          "publisherName": "string",
          "company": "string",
          "companyName": "string"
        }
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	InterfaceStatus resource created	InterfaceStatus.InterfaceStatusDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

MigrateCrmOnlyContractFields

api_v1migrate-crm-only-contract-fields_post

Code samples

const inputBody = '{
  "sourceContractId": null,
  "targetContractId": null,
  "companySlug": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/migrate-crm-only-contract-fields',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "sourceContractId": null,
  "targetContractId": null,
  "companySlug": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/migrate-crm-only-contract-fields',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/migrate-crm-only-contract-fields', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/migrate-crm-only-contract-fields HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/migrate-crm-only-contract-fields

migrating fields that are only manged in CRM from a sourceContract to a targetContract, returning the resulting targetContract

migrating fields that are only manged in CRM from a sourceContract to a targetContract, returning the resulting targetContract

Body parameter

{
  "sourceContractId": null,
  "targetContractId": null,
  "companySlug": "string"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	MigrateCrmOnlyContractFields	true	The new MigrateCrmOnlyContractFields resource

Example responses

200 Response

{
  "result": {
    "id": 0,
    "sfOpportunityId": null,
    "company": "https://example.com/",
    "billingAddress": null,
    "shippingAddress": null,
    "addressBilling": {
      "id": 0,
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "addressShipping": {
      "id": 0,
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "options": null,
    "customFieldsSchema": {},
    "status": "active",
    "abacusProjectId": null,
    "billedBySmg": null,
    "contractDate": null,
    "startDate": null,
    "cancellationDate": null,
    "trainingDate": null,
    "noTrainingWanted": null,
    "noCharge": null,
    "product": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	MigrateCrmOnlyContractFields resource created	MigrateCrmOnlyContractFields.MigrateCrmOnlyContractFieldsDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

Product

api_v1products_get_collection

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/products',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/products',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/products', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/products HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/products

Retrieves the collection of Product resources.

Retrieves the collection of Product resources.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
page	query	integer	false	The collection page number
page_size	query	integer	false	The number of items per page
pagination	query	boolean	false	Enable or disable pagination
order[id]	query	string	false	none
order[name]	query	string	false	none
order[optionsSchema]	query	string	false	none
order[requiresTraining]	query	string	false	none
order[chargeable]	query	string	false	none
order[created]	query	string	false	none
order[updated]	query	string	false	none

Enumerated Values

Parameter	Value
order[id]	asc
order[id]	desc
order[name]	asc
order[name]	desc
order[optionsSchema]	asc
order[optionsSchema]	desc
order[requiresTraining]	asc
order[requiresTraining]	desc
order[chargeable]	asc
order[chargeable]	desc
order[created]	asc
order[created]	desc
order[updated]	asc
order[updated]	desc

Example responses

200 Response

{
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "string"
        }
      },
      "id": "string",
      "name": null,
      "optionsSchema": null,
      "requiresTraining": null,
      "chargeable": null,
      "admin": "https://example.com/",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "totalItems": 0,
  "itemsPerPage": 0,
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Product collection	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» _embedded	[Product.jsonhal-read.Product_timestampable]	true	none	none
»» _links	object	false	none	none
»»» self	object	false	none	none
»»»» href	string(iri-reference)	false	none	none
»» id	string	false	none	none
»» name	string,null	false	none	none
»» optionsSchema	array,null	false	none	none
»» requiresTraining	boolean,null	false	none	none
»» chargeable	boolean,null	false	none	none
»» admin	string,null(iri-reference)	false	none	none
»» created	string(date-time)	false	none	Get created.
»» updated	string(date-time)	false	none	Get updated.
» totalItems	integer	false	none	none
» itemsPerPage	integer	false	none	none
» _links	object	true	none	none
»» self	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» first	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» last	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» next	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» previous	object	false	none	none
»»» href	string(iri-reference)	false	none	none

api_v1products_post

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/products',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/products',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/products', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/products HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

POST /api/v1/products

Creates a Product resource.

Creates a Product resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	Product.jsonhal	true	The new Product resource

Example responses

201 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	Product resource created	Product.jsonhal-read.Product_timestampable
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1products_id_get

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/products/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/products/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/products/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/products/{id} HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/products/{id}

Retrieves a Product resource.

Retrieves a Product resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	Product identifier

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Product resource	Product.jsonhal-read.Product_timestampable
404	Not Found	Resource not found	None

api_v1products_id_put

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/products/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/products/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/products/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /api/v1/products/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PUT /api/v1/products/{id}

Replaces the Product resource.

Replaces the Product resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	Product identifier
body	body	Product.jsonhal	true	The updated Product resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Product resource updated	Product.jsonhal-read.Product_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1products_id_delete

Code samples


const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/products/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/products/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/products/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /api/v1/products/{id} HTTP/1.1

X-Requested-With-User-Token: string

DELETE /api/v1/products/{id}

Removes the Product resource.

Removes the Product resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	Product identifier

Responses

Status	Meaning	Description	Schema
204	No Content	Product resource deleted	None
404	Not Found	Resource not found	None

api_v1products_id_patch

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/products/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/products/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/api/v1/products/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH /api/v1/products/{id} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PATCH /api/v1/products/{id}

Updates the Product resource.

Updates the Product resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	Product identifier
body	body	Product.jsonhal	true	The updated Product resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Product resource updated	Product.jsonhal-read.Product_timestampable
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

Role

api_v1roles_get_collection

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/roles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/roles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/roles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/roles HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/roles

Retrieves the collection of Role resources.

Retrieves the collection of Role resources.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
page	query	integer	false	The collection page number
page_size	query	integer	false	The number of items per page
pagination	query	boolean	false	Enable or disable pagination
name	query	string	false	none
name[]	query	array[string]	false	none

Example responses

200 Response

{
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "string"
        }
      },
      "id": 0,
      "name": "string",
      "service": "casaone-api",
      "identityRoles": [
        "https://example.com/"
      ],
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "totalItems": 0,
  "itemsPerPage": 0,
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Role collection	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» _embedded	[Role.jsonhal]	true	none	none
»» _links	object	false	none	none
»»» self	object	false	none	none
»»»» href	string(iri-reference)	false	none	none
»» id	integer	false	read-only	none
»» name	string	false	none	none
»» service	string	false	none	none
»» identityRoles	[string]	false	none	none
»» created	string(date-time)	false	none	Get created.
»» updated	string(date-time)	false	none	Get updated.
» totalItems	integer	false	none	none
» itemsPerPage	integer	false	none	none
» _links	object	true	none	none
»» self	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» first	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» last	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» next	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» previous	object	false	none	none
»»» href	string(iri-reference)	false	none	none

Enumerated Values

Property	Value
service	casaone-api
service	casagateway
service	casamail

api_v1roles_post

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "name": "string",
  "service": "casaone-api",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/roles',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "name": "string",
  "service": "casaone-api",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/roles',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/roles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/roles HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

POST /api/v1/roles

Creates a Role resource.

Creates a Role resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "name": "string",
  "service": "casaone-api",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	Role.jsonhal	true	The new Role resource

Example responses

201 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "name": "string",
  "service": "casaone-api",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	Role resource created	Role.jsonhal
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1roles_id_get

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/roles/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/roles/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/roles/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/roles/{id} HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/roles/{id}

Retrieves a Role resource.

Retrieves a Role resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	Role identifier

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "name": "string",
  "service": "casaone-api",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Role resource	Role.jsonhal
404	Not Found	Resource not found	None

api_v1roles_id_delete

Code samples


const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/roles/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/roles/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/roles/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /api/v1/roles/{id} HTTP/1.1

X-Requested-With-User-Token: string

DELETE /api/v1/roles/{id}

Removes the Role resource.

Removes the Role resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
id	path	string	true	Role identifier

Responses

Status	Meaning	Description	Schema
204	No Content	Role resource deleted	None
404	Not Found	Resource not found	None

Salesforce

api_v1salesforce_post

Code samples

const inputBody = '{
  "sfAccountId": "0014I00002OdBFr",
  "contracts": [
    {
      "status": "active",
      "sfOpportunityId": "",
      "abacusProjectId": 110,
      "contractDate": "2023-12-01",
      "cancellationDate": "2023-12-01",
      "startDate": "2023-12-01",
      "created": "2023-10-12T07:10:17Z",
      "trainingDate": "2023-12-01",
      "noCharge": "false",
      "billedBySmg": "true",
      "noTrainingWanted": "true",
      "productId": "hosting",
      "optionsPlan": null
    }
  ],
  "address": {
    "street": "Bahnhofstrasse",
    "streetNumber": "10e",
    "postOfficeBoxNumber": "Postfach 207",
    "postalCode": "8001",
    "locality": "Zurich",
    "region": "ZH",
    "country": "CH"
  },
  "companySlug": "string",
  "legalForm": "sole-enterprise",
  "legalName": "Test Company AG",
  "addition": "something additional about the company",
  "slogan": "We are the best company",
  "phone": "+41 71245847",
  "fax": "+41 71245844",
  "mobile": "+41 76854275",
  "email": "[email protected]",
  "websiteUrl": "https://test-company.com",
  "uid": "CHE-152.155.154",
  "abacusCustomerId": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/salesforce',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "sfAccountId": "0014I00002OdBFr",
  "contracts": [
    {
      "status": "active",
      "sfOpportunityId": "",
      "abacusProjectId": 110,
      "contractDate": "2023-12-01",
      "cancellationDate": "2023-12-01",
      "startDate": "2023-12-01",
      "created": "2023-10-12T07:10:17Z",
      "trainingDate": "2023-12-01",
      "noCharge": "false",
      "billedBySmg": "true",
      "noTrainingWanted": "true",
      "productId": "hosting",
      "optionsPlan": null
    }
  ],
  "address": {
    "street": "Bahnhofstrasse",
    "streetNumber": "10e",
    "postOfficeBoxNumber": "Postfach 207",
    "postalCode": "8001",
    "locality": "Zurich",
    "region": "ZH",
    "country": "CH"
  },
  "companySlug": "string",
  "legalForm": "sole-enterprise",
  "legalName": "Test Company AG",
  "addition": "something additional about the company",
  "slogan": "We are the best company",
  "phone": "+41 71245847",
  "fax": "+41 71245844",
  "mobile": "+41 76854275",
  "email": "[email protected]",
  "websiteUrl": "https://test-company.com",
  "uid": "CHE-152.155.154",
  "abacusCustomerId": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/salesforce',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/salesforce', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/salesforce HTTP/1.1

Content-Type: application/json
Accept: application/json

POST /api/v1/salesforce

handles creation and update requests for company accounts with address and related contracts

handles creation and update requests for company accounts with address and related contracts. It only handles a limited amount of datapoints the rest is still handled by the CRM

Body parameter

{
  "sfAccountId": "0014I00002OdBFr",
  "contracts": [
    {
      "status": "active",
      "sfOpportunityId": "",
      "abacusProjectId": 110,
      "contractDate": "2023-12-01",
      "cancellationDate": "2023-12-01",
      "startDate": "2023-12-01",
      "created": "2023-10-12T07:10:17Z",
      "trainingDate": "2023-12-01",
      "noCharge": "false",
      "billedBySmg": "true",
      "noTrainingWanted": "true",
      "productId": "hosting",
      "optionsPlan": null
    }
  ],
  "address": {
    "street": "Bahnhofstrasse",
    "streetNumber": "10e",
    "postOfficeBoxNumber": "Postfach 207",
    "postalCode": "8001",
    "locality": "Zurich",
    "region": "ZH",
    "country": "CH"
  },
  "companySlug": "string",
  "legalForm": "sole-enterprise",
  "legalName": "Test Company AG",
  "addition": "something additional about the company",
  "slogan": "We are the best company",
  "phone": "+41 71245847",
  "fax": "+41 71245844",
  "mobile": "+41 76854275",
  "email": "[email protected]",
  "websiteUrl": "https://test-company.com",
  "uid": "CHE-152.155.154",
  "abacusCustomerId": null
}

Parameters

Name	In	Type	Required	Description
body	body	Salesforce.RequestSalesforceDto-write.Salesforce	true	The new Salesforce resource

Example responses

201 Response

{}

Responses

Status	Meaning	Description	Schema
201	Created	Salesforce resource created	Salesforce.BaseResponseData-read.Salesforce
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1salesforce_patch

Code samples

const inputBody = '{
  "sfAccountId": "0014I00002OdBFr",
  "contracts": [
    {
      "status": "active",
      "sfOpportunityId": "",
      "abacusProjectId": 110,
      "contractDate": "2023-12-01",
      "cancellationDate": "2023-12-01",
      "startDate": "2023-12-01",
      "created": "2023-10-12T07:10:17Z",
      "trainingDate": "2023-12-01",
      "noCharge": "false",
      "billedBySmg": "true",
      "noTrainingWanted": "true",
      "productId": "hosting",
      "optionsPlan": null
    }
  ],
  "address": {
    "street": "Bahnhofstrasse",
    "streetNumber": "10e",
    "postOfficeBoxNumber": "Postfach 207",
    "postalCode": "8001",
    "locality": "Zurich",
    "region": "ZH",
    "country": "CH"
  },
  "companySlug": "string",
  "legalForm": "sole-enterprise",
  "legalName": "Test Company AG",
  "addition": "something additional about the company",
  "slogan": "We are the best company",
  "phone": "+41 71245847",
  "fax": "+41 71245844",
  "mobile": "+41 76854275",
  "email": "[email protected]",
  "websiteUrl": "https://test-company.com",
  "uid": "CHE-152.155.154",
  "abacusCustomerId": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/salesforce',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "sfAccountId": "0014I00002OdBFr",
  "contracts": [
    {
      "status": "active",
      "sfOpportunityId": "",
      "abacusProjectId": 110,
      "contractDate": "2023-12-01",
      "cancellationDate": "2023-12-01",
      "startDate": "2023-12-01",
      "created": "2023-10-12T07:10:17Z",
      "trainingDate": "2023-12-01",
      "noCharge": "false",
      "billedBySmg": "true",
      "noTrainingWanted": "true",
      "productId": "hosting",
      "optionsPlan": null
    }
  ],
  "address": {
    "street": "Bahnhofstrasse",
    "streetNumber": "10e",
    "postOfficeBoxNumber": "Postfach 207",
    "postalCode": "8001",
    "locality": "Zurich",
    "region": "ZH",
    "country": "CH"
  },
  "companySlug": "string",
  "legalForm": "sole-enterprise",
  "legalName": "Test Company AG",
  "addition": "something additional about the company",
  "slogan": "We are the best company",
  "phone": "+41 71245847",
  "fax": "+41 71245844",
  "mobile": "+41 76854275",
  "email": "[email protected]",
  "websiteUrl": "https://test-company.com",
  "uid": "CHE-152.155.154",
  "abacusCustomerId": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/salesforce',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/api/v1/salesforce', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH /api/v1/salesforce HTTP/1.1

Content-Type: application/json
Accept: application/json

PATCH /api/v1/salesforce

handles creation and update requests for company accounts with address and related contracts

handles creation and update requests for company accounts with address and related contracts. It only handles a limited amount of datapoints the rest is still handled by the CRM

Body parameter

{
  "sfAccountId": "0014I00002OdBFr",
  "contracts": [
    {
      "status": "active",
      "sfOpportunityId": "",
      "abacusProjectId": 110,
      "contractDate": "2023-12-01",
      "cancellationDate": "2023-12-01",
      "startDate": "2023-12-01",
      "created": "2023-10-12T07:10:17Z",
      "trainingDate": "2023-12-01",
      "noCharge": "false",
      "billedBySmg": "true",
      "noTrainingWanted": "true",
      "productId": "hosting",
      "optionsPlan": null
    }
  ],
  "address": {
    "street": "Bahnhofstrasse",
    "streetNumber": "10e",
    "postOfficeBoxNumber": "Postfach 207",
    "postalCode": "8001",
    "locality": "Zurich",
    "region": "ZH",
    "country": "CH"
  },
  "companySlug": "string",
  "legalForm": "sole-enterprise",
  "legalName": "Test Company AG",
  "addition": "something additional about the company",
  "slogan": "We are the best company",
  "phone": "+41 71245847",
  "fax": "+41 71245844",
  "mobile": "+41 76854275",
  "email": "[email protected]",
  "websiteUrl": "https://test-company.com",
  "uid": "CHE-152.155.154",
  "abacusCustomerId": null
}

Parameters

Name	In	Type	Required	Description
body	body	Salesforce.RequestSalesforceDto-write.Salesforce	true	The updated Salesforce resource

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	Salesforce resource updated	Salesforce.BaseResponseData-read.Salesforce
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

Slugs

api_v1slugs_get

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/slugs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/slugs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/slugs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/slugs HTTP/1.1

Accept: application/json

GET /api/v1/slugs

returning a list of all company slugs

returning a list of all company slugs. This is used from CASAGATEWAY and CASAMAIL to keep in sync with existing companies across the services.

Example responses

200 Response

{
  "result": {
    "slugs": [
      "string"
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Slugs resource	Slugs.SlugsDto
404	Not Found	Resource not found	None

UserProfile

api_v1user-actionsprofile_get

Code samples


const headers = {
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/user-actions/profile',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/user-actions/profile',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/user-actions/profile', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/user-actions/profile HTTP/1.1

Accept: application/json
X-Requested-With-User-Token: string

GET /api/v1/user-actions/profile

returning the UserProfile of the authenticated User

returning the UserProfile of the authenticated User, which is essentially the employee entity with all its relations

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user

Example responses

200 Response

{
  "result": {
    "id": 0,
    "company": {
      "id": "string",
      "sfAccountId": null,
      "address": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "legalName": null,
      "legalForm": null,
      "entityType": null,
      "email": null,
      "phone": null,
      "mobile": null,
      "fax": null,
      "slogan": null,
      "twitter": null,
      "linkedin": null,
      "facebook": null,
      "pinterest": null,
      "instagram": null,
      "websiteUrl": null,
      "logo": null,
      "logoInv": null,
      "logoBw": null,
      "logoBwInv": null,
      "uid": null,
      "vat": null,
      "options": null,
      "addition": null,
      "internalNotes": null,
      "abacusCustomerId": null,
      "allowRelationship": true,
      "zefixMutations": null,
      "zefixLastUpdateDate": null,
      "employees": [
        "https://example.com/"
      ],
      "companyContents": [
        "https://example.com/"
      ],
      "companyRelations": [
        "https://example.com/"
      ],
      "contracts": [
        "https://example.com/"
      ],
      "userRoles": [
        "https://example.com/"
      ],
      "legalPerson": "https://example.com/",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "userResetToken": null,
    "firstName": null,
    "lastName": null,
    "gender": null,
    "lang": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "dob": null,
    "function": null,
    "lastClientIp": null,
    "role": "visitor",
    "trusted": null,
    "user": {
      "username": "string",
      "employee": "https://example.com/",
      "firstName": null,
      "lastName": null,
      "keycloakId": null,
      "userRoles": [
        "https://example.com/"
      ],
      "password": null,
      "roles": [
        "string"
      ],
      "userIdentifier": "string"
    },
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	UserProfile resource	UserProfile.UserProfileDto
404	Not Found	Resource not found	None

UserCreationWithIdentityRoles

api_v1user-creation-with-identity-roles_post

Code samples

const inputBody = '{
  "username": "[email protected]",
  "firstName": "Hans",
  "lastName": "Gruber",
  "lang": "de",
  "roles": [
    {
      "name": "ROLE_NAME",
      "serviceId": "casaone-api"
    }
  ],
  "companySlug": "casasoft"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/user-creation-with-identity-roles',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "username": "[email protected]",
  "firstName": "Hans",
  "lastName": "Gruber",
  "lang": "de",
  "roles": [
    {
      "name": "ROLE_NAME",
      "serviceId": "casaone-api"
    }
  ],
  "companySlug": "casasoft"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/user-creation-with-identity-roles',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/user-creation-with-identity-roles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/user-creation-with-identity-roles HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/user-creation-with-identity-roles

Creation of a new user with Identity and IdentityRole collection

Returning the newly created User with its Identity and the collection of IdentityRole objects. This will first check whether Keycloak user, CasaIAM user and Identity exist. If some of those objects is not created, it will be generated.

Body parameter

{
  "username": "[email protected]",
  "firstName": "Hans",
  "lastName": "Gruber",
  "lang": "de",
  "roles": [
    {
      "name": "ROLE_NAME",
      "serviceId": "casaone-api"
    }
  ],
  "companySlug": "casasoft"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	UserCreationWithIdentityRoles.UserCreationWithIdentityRolesInputDto	true	The new UserCreationWithIdentityRoles resource

Example responses

201 Response

{
  "result": {
    "keycloakId": "string",
    "identityId": 0,
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": {}
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
201	Created	UserCreationWithIdentityRoles resource created	UserCreationWithIdentityRoles.UserCreationWithIdentityRolesOutputDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

UserMigration

api_v1user-migration_post

Code samples

const inputBody = '{
  "fromUsername": "[email protected]",
  "toUsername": "[email protected]"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/user-migration',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "fromUsername": "[email protected]",
  "toUsername": "[email protected]"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/user-migration',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/user-migration', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/user-migration HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/user-migration

Migration of an user

Returning the migrated user.

Body parameter

{
  "fromUsername": "[email protected]",
  "toUsername": "[email protected]"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	UserMigration.UserMigrationInputDto	true	The new UserMigration resource

Example responses

201 Response

{
  "result": {
    "id": 0,
    "user": {
      "username": "string"
    },
    "identityRoles": [
      {
        "id": 0,
        "company": {
          "id": "string",
          "created": "2023-10-12T07:10:17Z",
          "updated": "2023-10-12T07:10:17Z"
        },
        "role": {
          "id": 0,
          "name": "string",
          "created": "2023-10-12T07:10:17Z",
          "updated": "2023-10-12T07:10:17Z"
        },
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      }
    ],
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z",
    "roles": {}
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	UserMigration resource created	UserMigration.UserMigrationOutputDto-identity.read_timestampable
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

UserRoleDeletionForCompany

api_v1user-role-deletion-for-company_post

Code samples

const inputBody = '{
  "username": "[email protected]",
  "companySlug": "casasoft"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/user-role-deletion-for-company',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "username": "[email protected]",
  "companySlug": "casasoft"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/user-role-deletion-for-company',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/user-role-deletion-for-company', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/user-role-deletion-for-company HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/user-role-deletion-for-company

User deletion based on company and username

Remove all IdentityRoles for a user in a company. This will not delete the user from the system. User the GDPR endpoint for that.

Body parameter

{
  "username": "[email protected]",
  "companySlug": "casasoft"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	UserRoleDeletionForCompany.UserRoleDeletionForCompanyInputDto	true	The new UserRoleDeletionForCompany resource

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	UserRoleDeletionForCompany resource created	UserRoleDeletionForCompany
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

UserRole

api_v1user_roles_id_get

Code samples


const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/user_roles/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/user_roles/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/user_roles/{id}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/user_roles/{id} HTTP/1.1

GET /api/v1/user_roles/{id}

Please use IdentityRole for interactions with user and roles

Please use IdentityRole for interactions with user and roles

Parameters

Name	In	Type	Required	Description
id	path	string	true	UserRole identifier

Responses

Status	Meaning	Description	Schema
404	Not Found	Resource not found	None

User

api_v1users_get_collection

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/users HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/users

Retrieves the collection of User resources.

Retrieves the collection of User resources.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
page	query	integer	false	The collection page number
page_size	query	integer	false	The number of items per page
pagination	query	boolean	false	Enable or disable pagination
order[username]	query	string	false	none
order[firstName]	query	string	false	none
order[lastName]	query	string	false	none
order[keycloakId]	query	string	false	none
order[password]	query	string	false	none

Enumerated Values

Parameter	Value
order[username]	asc
order[username]	desc
order[firstName]	asc
order[firstName]	desc
order[lastName]	asc
order[lastName]	desc
order[keycloakId]	asc
order[keycloakId]	desc
order[password]	asc
order[password]	desc

Example responses

200 Response

{
  "_embedded": [
    {
      "_links": {
        "self": {
          "href": "string"
        }
      },
      "username": "string",
      "employee": "https://example.com/",
      "firstName": null,
      "lastName": null,
      "keycloakId": null,
      "userRoles": [
        "https://example.com/"
      ]
    }
  ],
  "totalItems": 0,
  "itemsPerPage": 0,
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	User collection	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» _embedded	[User.jsonhal-read.User]	true	none	none
»» _links	object	false	none	none
»»» self	object	false	none	none
»»»» href	string(iri-reference)	false	none	none
»» username	string	false	none	none
»» employee	string,null(iri-reference)	false	none	none
»» firstName	string,null	false	none	none
»» lastName	string,null	false	none	none
»» keycloakId	string,null	false	none	none
»» userRoles	[string]	false	none	none
» totalItems	integer	false	none	none
» itemsPerPage	integer	false	none	none
» _links	object	true	none	none
»» self	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» first	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» last	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» next	object	false	none	none
»»» href	string(iri-reference)	false	none	none
»» previous	object	false	none	none
»»» href	string(iri-reference)	false	none	none

api_v1users_post

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ],
  "password": null
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ],
  "password": null
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/users', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/users HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

POST /api/v1/users

Creates a User resource.

Creates a User resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ],
  "password": null
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
body	body	User.jsonhal	true	The new User resource

Example responses

201 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ]
}

Responses

Status	Meaning	Description	Schema
201	Created	User resource created	User.jsonhal-read.User
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1users_username_get

Code samples


const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/users/{username}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/users/{username}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/users/{username}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/users/{username} HTTP/1.1

Accept: application/hal+json
X-Requested-With-User-Token: string

GET /api/v1/users/{username}

Retrieves a User resource.

Retrieves a User resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
username	path	string	true	User identifier

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	User resource	User.jsonhal-read.User
404	Not Found	Resource not found	None

api_v1users_username_put

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ],
  "password": null
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/users/{username}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ],
  "password": null
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/users/{username}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/users/{username}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /api/v1/users/{username} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PUT /api/v1/users/{username}

Replaces the User resource.

Replaces the User resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ],
  "password": null
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
username	path	string	true	User identifier
body	body	User.jsonhal	true	The updated User resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	User resource updated	User.jsonhal-read.User
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

api_v1users_username_delete

Code samples


const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/users/{username}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/users/{username}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/users/{username}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /api/v1/users/{username} HTTP/1.1

X-Requested-With-User-Token: string

DELETE /api/v1/users/{username}

Removes the User resource.

Removes the User resource.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
username	path	string	true	User identifier

Responses

Status	Meaning	Description	Schema
204	No Content	User resource deleted	None
404	Not Found	Resource not found	None

api_v1users_username_patch

Code samples

const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ],
  "password": null
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/users/{username}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ],
  "password": null
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/users/{username}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/hal+json',
    'Accept' => 'application/hal+json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/api/v1/users/{username}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH /api/v1/users/{username} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
X-Requested-With-User-Token: string

PATCH /api/v1/users/{username}

Updates the User resource.

Updates the User resource.

Body parameter

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ],
  "password": null
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	false	Authorization token of requesting user
username	path	string	true	User identifier
body	body	User.jsonhal	true	The updated User resource

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	User resource updated	User.jsonhal-read.User
400	Bad Request	Invalid input	None
404	Not Found	Resource not found	None
422	Unprocessable Entity	Unprocessable entity	None

ZefixCompaniesAcceptAllChanges

api_v1zefix-companies-accept-all-changes_post

Code samples

const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-companies-accept-all-changes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-companies-accept-all-changes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/zefix-companies-accept-all-changes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/zefix-companies-accept-all-changes HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/zefix-companies-accept-all-changes

all zefix changes for all companies are acknowledged, meaning reset

all zefix changes for all companies are acknowledged, meaning reset

Body parameter

{}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	ZefixCompaniesAcceptAllChanges	true	The new ZefixCompaniesAcceptAllChanges resource

Example responses

200 Response

{
  "result": [
    "string"
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ZefixCompaniesAcceptAllChanges resource created	ZefixCompaniesAcceptAllChanges.ZefixDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

ZefixCompaniesDirty

api_v1zefix-companies-dirty_get

Code samples


const headers = {
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-companies-dirty',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-companies-dirty',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/zefix-companies-dirty', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/zefix-companies-dirty HTTP/1.1

Accept: application/json
X-Requested-With-User-Token: string

GET /api/v1/zefix-companies-dirty

returns a list of company entities that have a zefix change

returns a list of company entities that have a zefix change

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user

Example responses

200 Response

{
  "result": [
    {
      "id": "string",
      "sfAccountId": null,
      "address": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "legalName": null,
      "legalForm": null,
      "entityType": null,
      "email": null,
      "phone": null,
      "mobile": null,
      "fax": null,
      "slogan": null,
      "twitter": null,
      "linkedin": null,
      "facebook": null,
      "pinterest": null,
      "instagram": null,
      "websiteUrl": null,
      "logo": null,
      "logoInv": null,
      "logoBw": null,
      "logoBwInv": null,
      "uid": null,
      "vat": null,
      "options": null,
      "addition": null,
      "internalNotes": null,
      "abacusCustomerId": null,
      "allowRelationship": true,
      "zefixMutations": null,
      "zefixLastUpdateDate": null,
      "employees": [
        "https://example.com/"
      ],
      "companyContents": [
        "https://example.com/"
      ],
      "companyRelations": [
        "https://example.com/"
      ],
      "contracts": [
        "https://example.com/"
      ],
      "userRoles": [
        "https://example.com/"
      ],
      "legalPerson": "https://example.com/",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ZefixCompaniesDirty resource	ZefixCompaniesDirty.ZefixCompaniesDirtyDto
404	Not Found	Resource not found	None

ZefixCompaniesFindChanges

api_v1zefix-companies-find-changes_post

Code samples

const inputBody = '{
  "date": "2024-10-11"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-companies-find-changes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "date": "2024-10-11"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-companies-find-changes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/zefix-companies-find-changes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/zefix-companies-find-changes HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/zefix-companies-find-changes

checks for all companies if there are changes in zefix since provided date

checks for all companies if there are changes in zefix since provided date and assigns them to the company accordingly

Body parameter

{
  "date": "2024-10-11"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	ZefixCompaniesFindChanges	true	The new ZefixCompaniesFindChanges resource

Example responses

200 Response

{
  "result": [
    "string"
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ZefixCompaniesFindChanges resource created	ZefixCompaniesFindChanges.ZefixDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

ZefixCompanyAcceptChanges

api_v1zefix-company-accept-changes_post

Code samples

const inputBody = '{
  "slug": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-company-accept-changes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "slug": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-company-accept-changes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/zefix-company-accept-changes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/zefix-company-accept-changes HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/zefix-company-accept-changes

all zefix changes for provided companySlug are acknowledged, meaning reset

all zefix changes for provided companySlug are acknowledged, meaning reset

Body parameter

{
  "slug": "string"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	ZefixCompanyAcceptChanges	true	The new ZefixCompanyAcceptChanges resource

Example responses

200 Response

{
  "result": [
    "string"
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ZefixCompanyAcceptChanges resource created	ZefixCompanyAcceptChanges.ZefixDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

ZefixCompanyByUid

api_v1zefix-company-by-uid_uid_get

Code samples


const headers = {
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-company-by-uid/{uid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-company-by-uid/{uid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/zefix-company-by-uid/{uid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /api/v1/zefix-company-by-uid/{uid} HTTP/1.1

Accept: application/json
X-Requested-With-User-Token: string

GET /api/v1/zefix-company-by-uid/{uid}

returns a list of zefix companies that match the provided UID

returns a list of zefix companies that match the provided UID. When provided a complete UID this should only be one company. This is used by the frontEnd to get the address when creating a new account.

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
uid	path	string	true	ZefixCompanyByUid identifier

Example responses

200 Response

{
  "result": null,
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ZefixCompanyByUid resource	ZefixCompanyByUid.BaseResponseData
404	Not Found	Resource not found	None

ZefixCompanyCreate

api_v1zefix-company-create_post

Code samples

const inputBody = '{
  "uid": "string",
  "slug": "string",
  "lat": null,
  "lng": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-company-create',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "uid": "string",
  "slug": "string",
  "lat": null,
  "lng": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-company-create',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/zefix-company-create', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/zefix-company-create HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/zefix-company-create

creates a new company with zefix data based on the passed UID

creates a new company with zefix data based on the passed UID

Body parameter

{
  "uid": "string",
  "slug": "string",
  "lat": null,
  "lng": null
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	ZefixCompanyCreate	true	The new ZefixCompanyCreate resource

Example responses

201 Response

{
  "result": [
    "string"
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
201	Created	ZefixCompanyCreate resource created	ZefixCompanyCreate.ZefixDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

ZefixCompanySearch

api_v1zefix-company-search_post

Code samples

const inputBody = '{
  "name": "test"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-company-search',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');
const inputBody = '{
  "name": "test"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Requested-With-User-Token':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('/api/v1/zefix-company-search',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'X-Requested-With-User-Token' => 'string',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/zefix-company-search', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /api/v1/zefix-company-search HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Requested-With-User-Token: string

POST /api/v1/zefix-company-search

searches for companies in zefix with provided name

searches for companies in zefix with provided name

Body parameter

{
  "name": "test"
}

Parameters

Name	In	Type	Required	Description
X-Requested-With-User-Token	header	string	true	Authorization token of requesting user
body	body	ZefixCompanySearch	true	The new ZefixCompanySearch resource

Example responses

200 Response

{
  "result": [
    {
      "company": "string",
      "uid": "string"
    }
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	ZefixCompanySearch resource created	ZefixCompanySearch.ZefixCompanySearchDto
400	Bad Request	Invalid input	None
422	Unprocessable Entity	Unprocessable entity	None

Schemas

Address

{
  "id": 0,
  "country": null,
  "locality": null,
  "region": null,
  "postalCode": null,
  "postOfficeBoxNumber": null,
  "street": null,
  "streetNumber": null,
  "streetAddition": null,
  "lat": null,
  "lng": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
country	string,null	false	none	none
locality	string,null	false	none	none
region	string,null	false	none	none
postalCode	integer,null	false	none	none
postOfficeBoxNumber	string,null	false	none	none
street	string,null	false	none	none
streetNumber	string,null	false	none	none
streetAddition	string,null	false	none	none
lat	string,null	false	none	none
lng	string,null	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Address-write.Company

{
  "country": null,
  "locality": null,
  "region": null,
  "postalCode": null,
  "postOfficeBoxNumber": null,
  "street": null,
  "streetNumber": null,
  "streetAddition": null,
  "lat": null,
  "lng": null
}

Properties

Name	Type	Required	Restrictions	Description
country	string,null	false	none	none
locality	string,null	false	none	none
region	string,null	false	none	none
postalCode	integer,null	false	none	none
postOfficeBoxNumber	string,null	false	none	none
street	string,null	false	none	none
streetNumber	string,null	false	none	none
streetAddition	string,null	false	none	none
lat	string,null	false	none	none
lng	string,null	false	none	none

Address.jsonhal

{
  "id": 0,
  "country": null,
  "locality": null,
  "region": null,
  "postalCode": null,
  "postOfficeBoxNumber": null,
  "street": null,
  "streetNumber": null,
  "streetAddition": null,
  "lat": null,
  "lng": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
country	string,null	false	none	none
locality	string,null	false	none	none
region	string,null	false	none	none
postalCode	integer,null	false	none	none
postOfficeBoxNumber	string,null	false	none	none
street	string,null	false	none	none
streetNumber	string,null	false	none	none
streetAddition	string,null	false	none	none
lat	string,null	false	none	none
lng	string,null	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Address.jsonhal-read.Company_timestampable

{
  "id": 0,
  "country": null,
  "locality": null,
  "region": null,
  "postalCode": null,
  "postOfficeBoxNumber": null,
  "street": null,
  "streetNumber": null,
  "streetAddition": null,
  "lat": null,
  "lng": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
country	string,null	false	none	none
locality	string,null	false	none	none
region	string,null	false	none	none
postalCode	integer,null	false	none	none
postOfficeBoxNumber	string,null	false	none	none
street	string,null	false	none	none
streetNumber	string,null	false	none	none
streetAddition	string,null	false	none	none
lat	string,null	false	none	none
lng	string,null	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Address.jsonhal-read.Contract_timestampable

{
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Address.jsonhal-write.Company

{
  "country": null,
  "locality": null,
  "region": null,
  "postalCode": null,
  "postOfficeBoxNumber": null,
  "street": null,
  "streetNumber": null,
  "streetAddition": null,
  "lat": null,
  "lng": null
}

Properties

Name	Type	Required	Restrictions	Description
country	string,null	false	none	none
locality	string,null	false	none	none
region	string,null	false	none	none
postalCode	integer,null	false	none	none
postOfficeBoxNumber	string,null	false	none	none
street	string,null	false	none	none
streetNumber	string,null	false	none	none
streetAddition	string,null	false	none	none
lat	string,null	false	none	none
lng	string,null	false	none	none

Address.jsonld

{
  "id": 0,
  "country": null,
  "locality": null,
  "region": null,
  "postalCode": null,
  "postOfficeBoxNumber": null,
  "street": null,
  "streetNumber": null,
  "streetAddition": null,
  "lat": null,
  "lng": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
country	string,null	false	none	none
locality	string,null	false	none	none
region	string,null	false	none	none
postalCode	integer,null	false	none	none
postOfficeBoxNumber	string,null	false	none	none
street	string,null	false	none	none
streetNumber	string,null	false	none	none
streetAddition	string,null	false	none	none
lat	string,null	false	none	none
lng	string,null	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Address.jsonld-write.Company

{
  "country": null,
  "locality": null,
  "region": null,
  "postalCode": null,
  "postOfficeBoxNumber": null,
  "street": null,
  "streetNumber": null,
  "streetAddition": null,
  "lat": null,
  "lng": null
}

Properties

Name	Type	Required	Restrictions	Description
country	string,null	false	none	none
locality	string,null	false	none	none
region	string,null	false	none	none
postalCode	integer,null	false	none	none
postOfficeBoxNumber	string,null	false	none	none
street	string,null	false	none	none
streetNumber	string,null	false	none	none
streetAddition	string,null	false	none	none
lat	string,null	false	none	none
lng	string,null	false	none	none

CompaniesWithoutLogo.CompanyWithoutLogoDto

{
  "result": {
    "items": [
      {
        "legalName": "string",
        "slug": "string",
        "product": "string",
        "contractDate": "string"
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	CompanyWithoutLogoResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

Company

{
  "id": "string",
  "sfAccountId": null,
  "address": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "employees": [
    "https://example.com/"
  ],
  "companyContents": [
    "https://example.com/"
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
sfAccountId	string,null	false	none	none
address	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
legalName	string,null	false	none	none
legalForm	string,null	false	none	none
entityType	string,null	false	none	none
email	string,null	false	none	none
phone	string,null	false	none	none
mobile	string,null	false	none	none
fax	string,null	false	none	none
slogan	string,null	false	none	none
twitter	string,null	false	none	none
linkedin	string,null	false	none	none
facebook	string,null	false	none	none
pinterest	string,null	false	none	none
instagram	string,null	false	none	none
websiteUrl	string,null	false	none	none
logo	string,null	false	none	none
logoInv	string,null	false	none	none
logoBw	string,null	false	none	none
logoBwInv	string,null	false	none	none
uid	string,null	false	none	none
vat	integer,null	false	none	none
options	object,null	false	none	none
addition	string,null	false	none	none
internalNotes	string,null	false	none	none
abacusCustomerId	integer,null	false	none	none
allowRelationship	boolean	false	none	none
zefixMutations	object,null	false	none	none
zefixLastUpdateDate	string,null(date-time)	false	none	none
employees	[string]	false	none	none
companyContents	[string]	false	none	none
companyRelations	[string]	false	none	none
contracts	[string]	false	none	none
userRoles	[string]	false	none	none
legalPerson	string,null(iri-reference)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Company-identity.read_timestampable

{
  "id": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Company-write.Company

{
  "id": "string",
  "sfAccountId": null,
  "address": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "id": 0,
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null
    }
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
sfAccountId	string,null	false	none	none
address	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address-write.Company	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
legalName	string,null	false	none	none
legalForm	string,null	false	none	none
entityType	string,null	false	none	none
email	string,null	false	none	none
phone	string,null	false	none	none
mobile	string,null	false	none	none
fax	string,null	false	none	none
slogan	string,null	false	none	none
twitter	string,null	false	none	none
linkedin	string,null	false	none	none
facebook	string,null	false	none	none
pinterest	string,null	false	none	none
instagram	string,null	false	none	none
websiteUrl	string,null	false	none	none
logo	string,null	false	none	none
logoInv	string,null	false	none	none
logoBw	string,null	false	none	none
logoBwInv	string,null	false	none	none
uid	string,null	false	none	none
vat	integer,null	false	none	none
options	object,null	false	none	none
addition	string,null	false	none	none
internalNotes	string,null	false	none	none
abacusCustomerId	integer,null	false	none	none
allowRelationship	boolean	false	none	none
zefixMutations	object,null	false	none	none
zefixLastUpdateDate	string,null(date-time)	false	none	none
companyContents	[CompanyContent-write.Company]	false	none	none
companyRelations	[string]	false	none	none
contracts	[string]	false	none	none
userRoles	[string]	false	none	none
legalPerson	string,null(iri-reference)	false	none	none

Company.jsonhal-identity.read_timestampable

{
  "id": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Company.jsonhal-read.CompanyContent_timestampable

{
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Company.jsonhal-read.CompanyRelation_timestampable

{
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Company.jsonhal-read.Company_timestampable

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "id": 0,
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "companyRelations": [
    {
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "contracts": [
    {
      "id": 0,
      "sfOpportunityId": null,
      "billingAddress": null,
      "shippingAddress": null,
      "addressBilling": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "addressShipping": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "options": null,
      "customFieldsSchema": {},
      "status": "active",
      "abacusProjectId": null,
      "billedBySmg": null,
      "contractDate": null,
      "startDate": null,
      "cancellationDate": null,
      "trainingDate": null,
      "noTrainingWanted": null,
      "noCharge": null,
      "product": "casaframe",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "userRoles": [
    {
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "legalPerson": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	string	false	none	none
sfAccountId	string,null	false	none	none
address	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address.jsonhal-read.Company_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
legalName	string,null	false	none	none
legalForm	string,null	false	none	none
entityType	string,null	false	none	none
email	string,null	false	none	none
phone	string,null	false	none	none
mobile	string,null	false	none	none
fax	string,null	false	none	none
slogan	string,null	false	none	none
twitter	string,null	false	none	none
linkedin	string,null	false	none	none
facebook	string,null	false	none	none
pinterest	string,null	false	none	none
instagram	string,null	false	none	none
websiteUrl	string,null	false	none	none
logo	string,null	false	none	none
logoInv	string,null	false	none	none
logoBw	string,null	false	none	none
logoBwInv	string,null	false	none	none
uid	string,null	false	none	none
vat	integer,null	false	none	none
options	object,null	false	none	none
addition	string,null	false	none	none
internalNotes	string,null	false	none	none
abacusCustomerId	integer,null	false	none	none
allowRelationship	boolean	false	none	none
zefixMutations	object,null	false	none	none
zefixLastUpdateDate	string,null(date-time)	false	none	none
companyContents	[CompanyContent.jsonhal-read.Company_timestampable]	false	none	none
companyRelations	[CompanyRelation.jsonhal-read.Company_timestampable]	false	none	none
contracts	[Contract.jsonhal-read.Company_timestampable]	false	none	none
userRoles	[UserRole.jsonhal-read.Company_timestampable]	false	none	none
legalPerson	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Employee.jsonhal-read.Company_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Company.jsonhal-read.Contract_timestampable

{
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Company.jsonhal-read.Entry_timestampable

{
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Company.jsonhal-write.Company

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "sfAccountId": null,
  "address": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "id": 0,
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null
    }
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	string	false	none	none
sfAccountId	string,null	false	none	none
address	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address.jsonhal-write.Company	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
legalName	string,null	false	none	none
legalForm	string,null	false	none	none
entityType	string,null	false	none	none
email	string,null	false	none	none
phone	string,null	false	none	none
mobile	string,null	false	none	none
fax	string,null	false	none	none
slogan	string,null	false	none	none
twitter	string,null	false	none	none
linkedin	string,null	false	none	none
facebook	string,null	false	none	none
pinterest	string,null	false	none	none
instagram	string,null	false	none	none
websiteUrl	string,null	false	none	none
logo	string,null	false	none	none
logoInv	string,null	false	none	none
logoBw	string,null	false	none	none
logoBwInv	string,null	false	none	none
uid	string,null	false	none	none
vat	integer,null	false	none	none
options	object,null	false	none	none
addition	string,null	false	none	none
internalNotes	string,null	false	none	none
abacusCustomerId	integer,null	false	none	none
allowRelationship	boolean	false	none	none
zefixMutations	object,null	false	none	none
zefixLastUpdateDate	string,null(date-time)	false	none	none
companyContents	[CompanyContent.jsonhal-write.Company]	false	none	none
companyRelations	[string]	false	none	none
contracts	[string]	false	none	none
userRoles	[string]	false	none	none
legalPerson	string,null(iri-reference)	false	none	none

Company.jsonld-write.Company

{
  "id": "string",
  "sfAccountId": null,
  "address": {
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null
  },
  "legalName": null,
  "legalForm": null,
  "entityType": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "slogan": null,
  "twitter": null,
  "linkedin": null,
  "facebook": null,
  "pinterest": null,
  "instagram": null,
  "websiteUrl": null,
  "logo": null,
  "logoInv": null,
  "logoBw": null,
  "logoBwInv": null,
  "uid": null,
  "vat": null,
  "options": null,
  "addition": null,
  "internalNotes": null,
  "abacusCustomerId": null,
  "allowRelationship": true,
  "zefixMutations": null,
  "zefixLastUpdateDate": null,
  "companyContents": [
    {
      "id": 0,
      "lang": "de",
      "openingHours": null,
      "slogan": null,
      "description": null,
      "projectDisclaimer": null,
      "dossierDisclaimer": null,
      "virtualTourDisclaimer": null
    }
  ],
  "companyRelations": [
    "https://example.com/"
  ],
  "contracts": [
    "https://example.com/"
  ],
  "userRoles": [
    "https://example.com/"
  ],
  "legalPerson": "https://example.com/"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
sfAccountId	string,null	false	none	none
address	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address.jsonld-write.Company	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
legalName	string,null	false	none	none
legalForm	string,null	false	none	none
entityType	string,null	false	none	none
email	string,null	false	none	none
phone	string,null	false	none	none
mobile	string,null	false	none	none
fax	string,null	false	none	none
slogan	string,null	false	none	none
twitter	string,null	false	none	none
linkedin	string,null	false	none	none
facebook	string,null	false	none	none
pinterest	string,null	false	none	none
instagram	string,null	false	none	none
websiteUrl	string,null	false	none	none
logo	string,null	false	none	none
logoInv	string,null	false	none	none
logoBw	string,null	false	none	none
logoBwInv	string,null	false	none	none
uid	string,null	false	none	none
vat	integer,null	false	none	none
options	object,null	false	none	none
addition	string,null	false	none	none
internalNotes	string,null	false	none	none
abacusCustomerId	integer,null	false	none	none
allowRelationship	boolean	false	none	none
zefixMutations	object,null	false	none	none
zefixLastUpdateDate	string,null(date-time)	false	none	none
companyContents	[CompanyContent.jsonld-write.Company]	false	none	none
companyRelations	[string]	false	none	none
contracts	[string]	false	none	none
userRoles	[string]	false	none	none
legalPerson	string,null(iri-reference)	false	none	none

CompanyContent

{
  "id": 0,
  "company": "https://example.com/",
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
company	string(iri-reference)	false	none	none
lang	string	false	none	none
openingHours	string,null	false	none	none
slogan	string,null	false	none	none
description	string,null	false	none	none
projectDisclaimer	string,null	false	none	none
dossierDisclaimer	string,null	false	none	none
virtualTourDisclaimer	string,null	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

CompanyContent-write.Company

{
  "id": 0,
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
lang	string	false	none	none
openingHours	string,null	false	none	none
slogan	string,null	false	none	none
description	string,null	false	none	none
projectDisclaimer	string,null	false	none	none
dossierDisclaimer	string,null	false	none	none
virtualTourDisclaimer	string,null	false	none	none

CompanyContent.jsonhal

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "company": "https://example.com/",
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
company	string(iri-reference)	false	none	none
lang	string	false	none	none
openingHours	string,null	false	none	none
slogan	string,null	false	none	none
description	string,null	false	none	none
projectDisclaimer	string,null	false	none	none
dossierDisclaimer	string,null	false	none	none
virtualTourDisclaimer	string,null	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

CompanyContent.jsonhal-read.CompanyContent_timestampable

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
company	Company.jsonhal-read.CompanyContent_timestampable	false	none	none
lang	string	false	none	none
openingHours	string,null	false	none	none
slogan	string,null	false	none	none
description	string,null	false	none	none
projectDisclaimer	string,null	false	none	none
dossierDisclaimer	string,null	false	none	none
virtualTourDisclaimer	string,null	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

CompanyContent.jsonhal-read.Company_timestampable

{
  "id": 0,
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
lang	string	false	none	none
openingHours	string,null	false	none	none
slogan	string,null	false	none	none
description	string,null	false	none	none
projectDisclaimer	string,null	false	none	none
dossierDisclaimer	string,null	false	none	none
virtualTourDisclaimer	string,null	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

CompanyContent.jsonhal-write.Company

{
  "id": 0,
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
lang	string	false	none	none
openingHours	string,null	false	none	none
slogan	string,null	false	none	none
description	string,null	false	none	none
projectDisclaimer	string,null	false	none	none
dossierDisclaimer	string,null	false	none	none
virtualTourDisclaimer	string,null	false	none	none

CompanyContent.jsonld

{
  "id": 0,
  "company": "https://example.com/",
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
company	string(iri-reference)	false	none	none
lang	string	false	none	none
openingHours	string,null	false	none	none
slogan	string,null	false	none	none
description	string,null	false	none	none
projectDisclaimer	string,null	false	none	none
dossierDisclaimer	string,null	false	none	none
virtualTourDisclaimer	string,null	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

CompanyContent.jsonld-write.Company

{
  "id": 0,
  "lang": "de",
  "openingHours": null,
  "slogan": null,
  "description": null,
  "projectDisclaimer": null,
  "dossierDisclaimer": null,
  "virtualTourDisclaimer": null
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
lang	string	false	none	none
openingHours	string,null	false	none	none
slogan	string,null	false	none	none
description	string,null	false	none	none
projectDisclaimer	string,null	false	none	none
dossierDisclaimer	string,null	false	none	none
virtualTourDisclaimer	string,null	false	none	none

CompanyExists

{
  "slug": "string"
}

Properties

Name	Type	Required	Restrictions	Description
slug	string	true	none	none

CompanyExists.CompanyExistsDto

{
  "result": {
    "companyExists": true
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	CompanyExistsResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

CompanyExistsResultDto

{
  "companyExists": true
}

Properties

Name	Type	Required	Restrictions	Description
companyExists	boolean	false	none	none

CompanyExportList.CompanyExportListDto

{
  "result": {
    "companies": {
      "Slug": "string",
      "Rechtsform": "string",
      "Firma / Organisation": "string",
      "Zusatz": "string",
      "Slogan": "string",
      "Strasse": "string",
      "Nr.": "string",
      "Postfach": "string",
      "PLZ": 0,
      "Ort": "string",
      "Kanton": "string",
      "Land": "string",
      "Telefon": "string",
      "Fax": "string",
      "Mobile": "string",
      "E-Mail": "string",
      "Website": "string",
      "UID": "string",
      "Erfasst": "string"
    }
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	CompanyExportListResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

CompanyExportListCompaniesDto

{
  "Slug": "string",
  "Rechtsform": "string",
  "Firma / Organisation": "string",
  "Zusatz": "string",
  "Slogan": "string",
  "Strasse": "string",
  "Nr.": "string",
  "Postfach": "string",
  "PLZ": 0,
  "Ort": "string",
  "Kanton": "string",
  "Land": "string",
  "Telefon": "string",
  "Fax": "string",
  "Mobile": "string",
  "E-Mail": "string",
  "Website": "string",
  "UID": "string",
  "Erfasst": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Slug	string	false	none	none
Rechtsform	string	false	none	none
Firma	string	false	none	none
Zusatz	string	false	none	none
Slogan	string	false	none	none
Strasse	string	false	none	none
Nr.	string	false	none	none
Postfach	string	false	none	none
PLZ	integer	false	none	none
Ort	string	false	none	none
Kanton	string	false	none	none
Land	string	false	none	none
Telefon	string	false	none	none
Fax	string	false	none	none
Mobile	string	false	none	none
E-Mail	string	false	none	none
Website	string	false	none	none
UID	string	false	none	none
Erfasst	string	false	none	none

CompanyExportListResultDto

{
  "companies": {
    "Slug": "string",
    "Rechtsform": "string",
    "Firma / Organisation": "string",
    "Zusatz": "string",
    "Slogan": "string",
    "Strasse": "string",
    "Nr.": "string",
    "Postfach": "string",
    "PLZ": 0,
    "Ort": "string",
    "Kanton": "string",
    "Land": "string",
    "Telefon": "string",
    "Fax": "string",
    "Mobile": "string",
    "E-Mail": "string",
    "Website": "string",
    "UID": "string",
    "Erfasst": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
companies	CompanyExportListCompaniesDto	false	none	none

CompanyLogoUpload.BaseResponseData

{
  "result": null,
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	any	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

CompanyRelation

{
  "id": 0,
  "relationFrom": "https://example.com/",
  "relationTo": "https://example.com/",
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
relationFrom	string(iri-reference)	false	none	none
relationTo	string(iri-reference)	false	none	none
type	string	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

CompanyRelation.jsonhal

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "relationFrom": "https://example.com/",
  "relationTo": "https://example.com/",
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
relationFrom	string(iri-reference)	false	none	none
relationTo	string(iri-reference)	false	none	none
type	string	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

CompanyRelation.jsonhal-read.CompanyRelation_timestampable

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "relationTo": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
relationTo	Company.jsonhal-read.CompanyRelation_timestampable	false	none	none
type	string	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

CompanyRelation.jsonhal-read.Company_timestampable

{
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

CompanyRelation.jsonld

{
  "id": 0,
  "relationFrom": "https://example.com/",
  "relationTo": "https://example.com/",
  "type": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
relationFrom	string(iri-reference)	false	none	none
relationTo	string(iri-reference)	false	none	none
type	string	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

CompanySlugToNamesResultDto

{
  "result": [
    {
      "companySlug": "string",
      "companyName": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	[CompanySlugToNamesResultResultDto]	false	none	none

CompanySlugToNamesResultResultDto

{
  "companySlug": "string",
  "companyName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
companySlug	string	false	none	none
companyName	string	false	none	none

CompanySlugsToNames.CompanySlugToNamesDto

{
  "result": {
    "result": [
      {
        "companySlug": "string",
        "companyName": "string"
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	CompanySlugToNamesResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

CompanyWithoutLogoItemDto

{
  "legalName": "string",
  "slug": "string",
  "product": "string",
  "contractDate": "string"
}

Properties

Name	Type	Required	Restrictions	Description
legalName	string	false	none	none
slug	string	false	none	none
product	string	false	none	none
contractDate	string	false	none	none

CompanyWithoutLogoResultDto

{
  "items": [
    {
      "legalName": "string",
      "slug": "string",
      "product": "string",
      "contractDate": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[CompanyWithoutLogoItemDto]	false	none	none

ComparisBlacklist.ComparisBlacklistDto

{
  "result": {
    "companies": [
      "string"
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	ComparisBlacklistCompanyDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ComparisBlacklistCompanyDto

{
  "companies": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
companies	[string]	false	none	none

Contract

{
  "id": 0,
  "sfOpportunityId": null,
  "company": "https://example.com/",
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

A contract defines the relation between a company and a product. Contracts are used to specify configurations for a company regarding a product. These contracts are then used to allow a company and its employees access to products, charge the company for usage, customize the products functionality and looks for a company.

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
sfOpportunityId	string,null	false	none	none
company	string,null(iri-reference)	false	none	none
billingAddress	string,null	false	none	none
shippingAddress	string,null	false	none	none
addressBilling	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
addressShipping	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
options	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaframeOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneProjectOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneWebsiteOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasatourOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\HostingOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\IcasaOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\PropertyManagementOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\RepublishOptionsDto	false	none	none

continued

Name	Type	Required	Restrictions	Description
customFieldsSchema	object	false	none	none
status	string	false	none	none
abacusProjectId	integer,null	false	none	none
billedBySmg	boolean,null	false	none	none
contractDate	string,null(date-time)	false	none	none
startDate	string,null(date-time)	false	none	none
cancellationDate	string,null(date-time)	false	none	none
trainingDate	string,null(date-time)	false	none	none
noTrainingWanted	boolean,null	false	none	none
noCharge	boolean,null	false	none	none
product	string(iri-reference)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Enumerated Values

Property	Value
status	active
status	demo
status	inactive
product	casaframe
product	casagateway
product	casaone
product	casaone-project
product	casaone-website
product	casascreen
product	casatour
product	casawebsite
product	hosting
product	icasa
product	luxuryestate
product	property-management-software
product	republish-service

Contract.jsonhal

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "sfOpportunityId": null,
  "company": "https://example.com/",
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
sfOpportunityId	string,null	false	none	none
company	string,null(iri-reference)	false	none	none
billingAddress	string,null	false	none	none
shippingAddress	string,null	false	none	none
addressBilling	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address.jsonhal	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
addressShipping	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address.jsonhal	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
options	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaframeOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneProjectOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneWebsiteOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasatourOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\HostingOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\IcasaOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\PropertyManagementOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\RepublishOptionsDto	false	none	none

continued

Name	Type	Required	Restrictions	Description
customFieldsSchema	object	false	none	none
status	string	false	none	none
abacusProjectId	integer,null	false	none	none
billedBySmg	boolean,null	false	none	none
contractDate	string,null(date-time)	false	none	none
startDate	string,null(date-time)	false	none	none
cancellationDate	string,null(date-time)	false	none	none
trainingDate	string,null(date-time)	false	none	none
noTrainingWanted	boolean,null	false	none	none
noCharge	boolean,null	false	none	none
product	string(iri-reference)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Enumerated Values

Property	Value
status	active
status	demo
status	inactive
product	casaframe
product	casagateway
product	casaone
product	casaone-project
product	casaone-website
product	casascreen
product	casatour
product	casawebsite
product	hosting
product	icasa
product	luxuryestate
product	property-management-software
product	republish-service

Contract.jsonhal-read.Company_timestampable

{
  "id": 0,
  "sfOpportunityId": null,
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "casaframe",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
sfOpportunityId	string,null	false	none	none
billingAddress	string,null	false	none	none
shippingAddress	string,null	false	none	none
addressBilling	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address.jsonhal-read.Company_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
addressShipping	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address.jsonhal-read.Company_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
options	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaframeOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneProjectOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneWebsiteOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasatourOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\HostingOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\IcasaOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\PropertyManagementOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\RepublishOptionsDto	false	none	none

continued

Name	Type	Required	Restrictions	Description
customFieldsSchema	object	false	none	none
status	string	false	none	none
abacusProjectId	integer,null	false	none	none
billedBySmg	boolean,null	false	none	none
contractDate	string,null(date-time)	false	none	none
startDate	string,null(date-time)	false	none	none
cancellationDate	string,null(date-time)	false	none	none
trainingDate	string,null(date-time)	false	none	none
noTrainingWanted	boolean,null	false	none	none
noCharge	boolean,null	false	none	none
product	string	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Enumerated Values

Property	Value
status	active
status	demo
status	inactive
product	casaframe
product	casagateway
product	casaone
product	casaone-project
product	casaone-website
product	casascreen
product	casatour
product	casawebsite
product	hosting
product	icasa
product	luxuryestate
product	property-management-software
product	republish-service

Contract.jsonhal-read.ContractEntry_timestampable

{
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Contract.jsonhal-read.Contract_timestampable

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "sfOpportunityId": null,
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "casaframe",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
sfOpportunityId	string,null	false	none	none
company	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Company.jsonhal-read.Contract_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
billingAddress	string,null	false	none	none
shippingAddress	string,null	false	none	none
addressBilling	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address.jsonhal-read.Contract_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
addressShipping	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address.jsonhal-read.Contract_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
options	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaframeOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneProjectOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneWebsiteOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasatourOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\HostingOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\IcasaOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\PropertyManagementOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\RepublishOptionsDto	false	none	none

continued

Name	Type	Required	Restrictions	Description
customFieldsSchema	object	false	none	none
status	string	false	none	none
abacusProjectId	integer,null	false	none	none
billedBySmg	boolean,null	false	none	none
contractDate	string,null(date-time)	false	none	none
startDate	string,null(date-time)	false	none	none
cancellationDate	string,null(date-time)	false	none	none
trainingDate	string,null(date-time)	false	none	none
noTrainingWanted	boolean,null	false	none	none
noCharge	boolean,null	false	none	none
product	string	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Enumerated Values

Property	Value
status	active
status	demo
status	inactive
product	casaframe
product	casagateway
product	casaone
product	casaone-project
product	casaone-website
product	casascreen
product	casatour
product	casawebsite
product	hosting
product	icasa
product	luxuryestate
product	property-management-software
product	republish-service

Contract.jsonld

{
  "id": 0,
  "sfOpportunityId": null,
  "company": "https://example.com/",
  "billingAddress": null,
  "shippingAddress": null,
  "addressBilling": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "addressShipping": {
    "id": 0,
    "country": null,
    "locality": null,
    "region": null,
    "postalCode": null,
    "postOfficeBoxNumber": null,
    "street": null,
    "streetNumber": null,
    "streetAddition": null,
    "lat": null,
    "lng": null,
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "options": null,
  "customFieldsSchema": {},
  "status": "active",
  "abacusProjectId": null,
  "billedBySmg": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null,
  "noTrainingWanted": null,
  "noCharge": null,
  "product": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
sfOpportunityId	string,null	false	none	none
company	string,null(iri-reference)	false	none	none
billingAddress	string,null	false	none	none
shippingAddress	string,null	false	none	none
addressBilling	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address.jsonld	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
addressShipping	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Address.jsonld	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
options	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaframeOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneProjectOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasaoneWebsiteOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\CasatourOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\HostingOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\IcasaOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\PropertyManagementOptionsDto	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	App\Dto\Request\Message\Options\RepublishOptionsDto	false	none	none

continued

Name	Type	Required	Restrictions	Description
customFieldsSchema	object	false	none	none
status	string	false	none	none
abacusProjectId	integer,null	false	none	none
billedBySmg	boolean,null	false	none	none
contractDate	string,null(date-time)	false	none	none
startDate	string,null(date-time)	false	none	none
cancellationDate	string,null(date-time)	false	none	none
trainingDate	string,null(date-time)	false	none	none
noTrainingWanted	boolean,null	false	none	none
noCharge	boolean,null	false	none	none
product	string(iri-reference)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Enumerated Values

Property	Value
status	active
status	demo
status	inactive
product	casaframe
product	casagateway
product	casaone
product	casaone-project
product	casaone-website
product	casascreen
product	casatour
product	casawebsite
product	hosting
product	icasa
product	luxuryestate
product	property-management-software
product	republish-service

ContractCounts

{
  "startDate": null,
  "endDate": null,
  "products": null
}

Properties

Name	Type	Required	Restrictions	Description
startDate	string,null(date-time)	false	none	none
endDate	string,null(date-time)	false	none	none
products	string,null	false	none	none

ContractCounts.ContractCountsDto

{
  "result": {
    "items": [
      {
        "product": "string",
        "count": 0,
        "sort": 0
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	ContractCountsItemDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ContractCountsContractDto

{
  "product": "string",
  "count": 0,
  "sort": 0
}

Properties

Name	Type	Required	Restrictions	Description
product	string	false	none	none
count	integer	false	none	none
sort	integer	false	none	none

ContractCountsItemDto

{
  "items": [
    {
      "product": "string",
      "count": 0,
      "sort": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[ContractCountsContractDto]	false	none	none

ContractEntriesForCasaoneProject

{
  "startDate": "string",
  "endDate": "string"
}

Properties

Name	Type	Required	Restrictions	Description
startDate	string	true	none	A "Y-m-d H:i:s" formatted value
endDate	string	true	none	A "Y-m-d H:i:s" formatted value

ContractEntriesForCasaoneProject.ContractEntriesForCasaoneProjectDto

{
  "result": [
    {
      "contractId": "string",
      "companyId": "string",
      "customDomain": "string",
      "noOfDays": "string"
    }
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	[ContractEntriesForCasaoneProjectResultDto]	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ContractEntriesForCasaoneProjectResultDto

{
  "contractId": "string",
  "companyId": "string",
  "customDomain": "string",
  "noOfDays": "string"
}

Properties

Name	Type	Required	Restrictions	Description
contractId	string	false	none	none
companyId	string	false	none	none
customDomain	string	false	none	none
noOfDays	string	false	none	none

ContractEntry

{
  "id": 0,
  "status": "new",
  "contract": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "statusList": null,
  "actionList": null,
  "messengerTypeList": null
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
status	string,null	false	none	none
contract	string,null(iri-reference)	false	none	none
action	string,null	false	none	none
messengerType	string,null	false	none	none
externalIdentifier	string,null	false	none	none
messenger	string,null	false	none	none
transcript	string,null	false	none	none
duration	integer,null	false	none	none
start	string,null(date-time)	false	none	none
end	string,null(date-time)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.
statusList	any	false	read-only	none
actionList	any	false	read-only	none
messengerTypeList	any	false	read-only	none

ContractEntry.jsonhal

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "status": "new",
  "contract": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "statusList": null,
  "actionList": null,
  "messengerTypeList": null
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
status	string,null	false	none	none
contract	string,null(iri-reference)	false	none	none
action	string,null	false	none	none
messengerType	string,null	false	none	none
externalIdentifier	string,null	false	none	none
messenger	string,null	false	none	none
transcript	string,null	false	none	none
duration	integer,null	false	none	none
start	string,null(date-time)	false	none	none
end	string,null(date-time)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.
statusList	any	false	read-only	none
actionList	any	false	read-only	none
messengerTypeList	any	false	read-only	none

ContractEntry.jsonhal-read.ContractEntry_timestampable

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "status": "new",
  "contract": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
status	string,null	false	none	none
contract	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Contract.jsonhal-read.ContractEntry_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
action	string,null	false	none	none
messengerType	string,null	false	none	none
externalIdentifier	string,null	false	none	none
messenger	string,null	false	none	none
transcript	string,null	false	none	none
duration	integer,null	false	none	none
start	string,null(date-time)	false	none	none
end	string,null(date-time)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

ContractEntry.jsonld

{
  "id": 0,
  "status": "new",
  "contract": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "start": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "statusList": null,
  "actionList": null,
  "messengerTypeList": null
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
status	string,null	false	none	none
contract	string,null(iri-reference)	false	none	none
action	string,null	false	none	none
messengerType	string,null	false	none	none
externalIdentifier	string,null	false	none	none
messenger	string,null	false	none	none
transcript	string,null	false	none	none
duration	integer,null	false	none	none
start	string,null(date-time)	false	none	none
end	string,null(date-time)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.
statusList	any	false	read-only	none
actionList	any	false	read-only	none
messengerTypeList	any	false	read-only	none

ContractsForIcasaPremiumProfile

{
  "startDate": "string",
  "endDate": "string"
}

Properties

Name	Type	Required	Restrictions	Description
startDate	string	true	none	A "Y-m-d H:i:s" formatted value
endDate	string	true	none	A "Y-m-d H:i:s" formatted value

ContractsForIcasaPremiumProfile.ContractsForIcasaPremiumProfileDto

{
  "result": [
    {
      "contractId": 0,
      "companyId": "string",
      "startDate": "2023-10-12T07:10:17Z",
      "noOfDays": 0
    }
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	[ContractsForIcasaPremiumProfileResultDto]	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ContractsForIcasaPremiumProfileResultDto

{
  "contractId": 0,
  "companyId": "string",
  "startDate": "2023-10-12T07:10:17Z",
  "noOfDays": 0
}

Properties

Name	Type	Required	Restrictions	Description
contractId	integer	false	none	none
companyId	string	false	none	none
startDate	string(date-time)	false	none	none
noOfDays	integer	false	none	none

ContractsTermination

{
  "products": "casaframe",
  "status": "active"
}

Properties

Name	Type	Required	Restrictions	Description
products	string	false	none	none
status	string	false	none	none

Enumerated Values

Property	Value
products	casaframe
products	casagateway
products	casaone
products	casaone-project
products	casaone-website
products	casascreen
products	casatour
products	casawebsite
products	hosting
products	icasa
products	luxuryestate
products	property-management-software
products	republish-service
status	active
status	demo
status	inactive

ContractsTermination.ContractsTerminationDto

{
  "result": {
    "items": [
      {
        "id": 0,
        "companySlug": "string",
        "legalName": null,
        "productSlug": "string",
        "productName": "string",
        "premium": null,
        "plan": null,
        "status": "string",
        "abacusProjectId": null,
        "contractDate": null,
        "startDate": null,
        "cancellationDate": null,
        "trainingDate": null
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	ContractsTerminationResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ContractsTerminationItemDto

{
  "id": 0,
  "companySlug": "string",
  "legalName": null,
  "productSlug": "string",
  "productName": "string",
  "premium": null,
  "plan": null,
  "status": "string",
  "abacusProjectId": null,
  "contractDate": null,
  "startDate": null,
  "cancellationDate": null,
  "trainingDate": null
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
companySlug	string	false	none	none
legalName	string,null	false	none	none
productSlug	string	false	none	none
productName	string	false	none	none
premium	string,null	false	none	none
plan	string,null	false	none	none
status	string	false	none	none
abacusProjectId	string,null	false	none	none
contractDate	string,null(date-time)	false	none	none
startDate	string,null(date-time)	false	none	none
cancellationDate	string,null(date-time)	false	none	none
trainingDate	string,null(date-time)	false	none	none

ContractsTerminationResultDto

{
  "items": [
    {
      "id": 0,
      "companySlug": "string",
      "legalName": null,
      "productSlug": "string",
      "productName": "string",
      "premium": null,
      "plan": null,
      "status": "string",
      "abacusProjectId": null,
      "contractDate": null,
      "startDate": null,
      "cancellationDate": null,
      "trainingDate": null
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[ContractsTerminationItemDto]	false	none	none

ContractsWithContinuousPropertyImportFtp

{
  "status": "active"
}

Properties

Name	Type	Required	Restrictions	Description
status	string	false	none	none

Enumerated Values

Property	Value
status	active
status	demo
status	inactive

ContractsWithContinuousPropertyImportFtp.ContractsWithContinuousPropertyImportFtpDto

{
  "result": {
    "items": [
      {
        "id": "string",
        "companySlug": "string",
        "legalName": "string",
        "productSlug": "string",
        "productName": "string",
        "customerFtpServer": [
          "string"
        ],
        "status": "string",
        "contractDate": "2023-10-12T07:10:17Z",
        "startDate": "2023-10-12T07:10:17Z",
        "cancellationDate": "2023-10-12T07:10:17Z"
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	ContractsWithContinuousPropertyImportFtpResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ContractsWithContinuousPropertyImportFtpItemDto

{
  "id": "string",
  "companySlug": "string",
  "legalName": "string",
  "productSlug": "string",
  "productName": "string",
  "customerFtpServer": [
    "string"
  ],
  "status": "string",
  "contractDate": "2023-10-12T07:10:17Z",
  "startDate": "2023-10-12T07:10:17Z",
  "cancellationDate": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
companySlug	string	false	none	none
legalName	string	false	none	none
productSlug	string	false	none	none
productName	string	false	none	none
customerFtpServer	[string]	false	none	none
status	string	false	none	none
contractDate	string(date-time)	false	none	none
startDate	string(date-time)	false	none	none
cancellationDate	string(date-time)	false	none	none

ContractsWithContinuousPropertyImportFtpResultDto

{
  "items": [
    {
      "id": "string",
      "companySlug": "string",
      "legalName": "string",
      "productSlug": "string",
      "productName": "string",
      "customerFtpServer": [
        "string"
      ],
      "status": "string",
      "contractDate": "2023-10-12T07:10:17Z",
      "startDate": "2023-10-12T07:10:17Z",
      "cancellationDate": "2023-10-12T07:10:17Z"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[ContractsWithContinuousPropertyImportFtpItemDto]	false	none	none

ContractsWithMissingAbacusCustomerId

{
  "products": "casaframe",
  "status": "active"
}

Properties

Name	Type	Required	Restrictions	Description
products	string	false	none	none
status	string	false	none	none

Enumerated Values

Property	Value
products	casaframe
products	casagateway
products	casaone
products	casaone-project
products	casaone-website
products	casascreen
products	casatour
products	casawebsite
products	hosting
products	icasa
products	luxuryestate
products	property-management-software
products	republish-service
status	active
status	demo
status	inactive

ContractsWithMissingAbacusCustomerId.ContractsWithMissingAbacusCustomerIdDto

{
  "result": {
    "items": [
      {
        "id": "string",
        "companySlug": "string",
        "legalName": "string",
        "productSlug": "string",
        "productName": "string",
        "premium": "string",
        "plan": "string",
        "status": "string",
        "abacusProjectId": "string",
        "contractDate": "2023-10-12T07:10:17Z",
        "startDate": "2023-10-12T07:10:17Z",
        "cancellationDate": "2023-10-12T07:10:17Z",
        "trainingDate": "2023-10-12T07:10:17Z"
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	ContractsWithMissingAbacusCustomerIdResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ContractsWithMissingAbacusCustomerIdItemDto

{
  "id": "string",
  "companySlug": "string",
  "legalName": "string",
  "productSlug": "string",
  "productName": "string",
  "premium": "string",
  "plan": "string",
  "status": "string",
  "abacusProjectId": "string",
  "contractDate": "2023-10-12T07:10:17Z",
  "startDate": "2023-10-12T07:10:17Z",
  "cancellationDate": "2023-10-12T07:10:17Z",
  "trainingDate": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
companySlug	string	false	none	none
legalName	string	false	none	none
productSlug	string	false	none	none
productName	string	false	none	none
premium	string	false	none	none
plan	string	false	none	none
status	string	false	none	none
abacusProjectId	string	false	none	none
contractDate	string(date-time)	false	none	none
startDate	string(date-time)	false	none	none
cancellationDate	string(date-time)	false	none	none
trainingDate	string(date-time)	false	none	none

ContractsWithMissingAbacusCustomerIdResultDto

{
  "items": [
    {
      "id": "string",
      "companySlug": "string",
      "legalName": "string",
      "productSlug": "string",
      "productName": "string",
      "premium": "string",
      "plan": "string",
      "status": "string",
      "abacusProjectId": "string",
      "contractDate": "2023-10-12T07:10:17Z",
      "startDate": "2023-10-12T07:10:17Z",
      "cancellationDate": "2023-10-12T07:10:17Z",
      "trainingDate": "2023-10-12T07:10:17Z"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[ContractsWithMissingAbacusCustomerIdItemDto]	false	none	none

ContractsWithMissingAbacusId

{
  "products": "casaframe",
  "status": "active"
}

Properties

Name	Type	Required	Restrictions	Description
products	string	false	none	none
status	string	false	none	none

Enumerated Values

Property	Value
products	casaframe
products	casagateway
products	casaone
products	casaone-project
products	casaone-website
products	casascreen
products	casatour
products	casawebsite
products	hosting
products	icasa
products	luxuryestate
products	property-management-software
products	republish-service
status	active
status	demo
status	inactive

ContractsWithMissingAbacusId.ContractsWithMissingAbacusIdDto

{
  "result": {
    "items": [
      {
        "id": "string",
        "companySlug": "string",
        "legalName": "string",
        "productSlug": "string",
        "productName": "string",
        "premium": "string",
        "plan": "string",
        "status": "string",
        "abacusProjectId": "string",
        "contractDate": "2023-10-12T07:10:17Z",
        "startDate": "2023-10-12T07:10:17Z",
        "cancellationDate": "2023-10-12T07:10:17Z",
        "trainingDate": "2023-10-12T07:10:17Z",
        "abacusCustomerId": "2023-10-12T07:10:17Z"
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	ContractsWithMissingAbacusIdResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ContractsWithMissingAbacusIdItemDto

{
  "id": "string",
  "companySlug": "string",
  "legalName": "string",
  "productSlug": "string",
  "productName": "string",
  "premium": "string",
  "plan": "string",
  "status": "string",
  "abacusProjectId": "string",
  "contractDate": "2023-10-12T07:10:17Z",
  "startDate": "2023-10-12T07:10:17Z",
  "cancellationDate": "2023-10-12T07:10:17Z",
  "trainingDate": "2023-10-12T07:10:17Z",
  "abacusCustomerId": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
companySlug	string	false	none	none
legalName	string	false	none	none
productSlug	string	false	none	none
productName	string	false	none	none
premium	string	false	none	none
plan	string	false	none	none
status	string	false	none	none
abacusProjectId	string	false	none	none
contractDate	string(date-time)	false	none	none
startDate	string(date-time)	false	none	none
cancellationDate	string(date-time)	false	none	none
trainingDate	string(date-time)	false	none	none
abacusCustomerId	string(date-time)	false	none	none

ContractsWithMissingAbacusIdResultDto

{
  "items": [
    {
      "id": "string",
      "companySlug": "string",
      "legalName": "string",
      "productSlug": "string",
      "productName": "string",
      "premium": "string",
      "plan": "string",
      "status": "string",
      "abacusProjectId": "string",
      "contractDate": "2023-10-12T07:10:17Z",
      "startDate": "2023-10-12T07:10:17Z",
      "cancellationDate": "2023-10-12T07:10:17Z",
      "trainingDate": "2023-10-12T07:10:17Z",
      "abacusCustomerId": "2023-10-12T07:10:17Z"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[ContractsWithMissingAbacusIdItemDto]	false	none	none

ContractsWithMissingTrainingDate

{
  "products": "casaframe"
}

Properties

Name	Type	Required	Restrictions	Description
products	string	false	none	none

Enumerated Values

Property	Value
products	casaframe
products	casagateway
products	casaone
products	casaone-project
products	casaone-website
products	casascreen
products	casatour
products	casawebsite
products	hosting
products	icasa
products	luxuryestate
products	property-management-software
products	republish-service

ContractsWithMissingTrainingDate.ContractsWithMissingTrainingDateDto

{
  "result": {
    "items": [
      {
        "id": "string",
        "companySlug": "string",
        "legalName": "string",
        "productSlug": "string",
        "productName": "string",
        "premium": "string",
        "plan": "string",
        "status": "string",
        "abacusProjectId": "string",
        "contractDate": "2023-10-12T07:10:17Z",
        "startDate": "2023-10-12T07:10:17Z",
        "cancellationDate": "2023-10-12T07:10:17Z",
        "trainingDate": "2023-10-12T07:10:17Z"
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	ContractsWithMissingTrainingDateResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ContractsWithMissingTrainingDateItemDto

{
  "id": "string",
  "companySlug": "string",
  "legalName": "string",
  "productSlug": "string",
  "productName": "string",
  "premium": "string",
  "plan": "string",
  "status": "string",
  "abacusProjectId": "string",
  "contractDate": "2023-10-12T07:10:17Z",
  "startDate": "2023-10-12T07:10:17Z",
  "cancellationDate": "2023-10-12T07:10:17Z",
  "trainingDate": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
companySlug	string	false	none	none
legalName	string	false	none	none
productSlug	string	false	none	none
productName	string	false	none	none
premium	string	false	none	none
plan	string	false	none	none
status	string	false	none	none
abacusProjectId	string	false	none	none
contractDate	string(date-time)	false	none	none
startDate	string(date-time)	false	none	none
cancellationDate	string(date-time)	false	none	none
trainingDate	string(date-time)	false	none	none

ContractsWithMissingTrainingDateResultDto

{
  "items": [
    {
      "id": "string",
      "companySlug": "string",
      "legalName": "string",
      "productSlug": "string",
      "productName": "string",
      "premium": "string",
      "plan": "string",
      "status": "string",
      "abacusProjectId": "string",
      "contractDate": "2023-10-12T07:10:17Z",
      "startDate": "2023-10-12T07:10:17Z",
      "cancellationDate": "2023-10-12T07:10:17Z",
      "trainingDate": "2023-10-12T07:10:17Z"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[ContractsWithMissingTrainingDateItemDto]	false	none	none

CreateAndAssignFtpAccess

{
  "contractId": 0,
  "software": "garaiorem",
  "username": "string",
  "password": "string",
  "activateAllPublicationMedia": true
}

Properties

Name	Type	Required	Restrictions	Description
contractId	integer	true	none	none
software	string	true	none	none
username	string	true	none	none
password	string	true	none	none
activateAllPublicationMedia	boolean	false	none	none

Enumerated Values

Property	Value
software	garaiorem
software	morlivis
software	rimor4
software	rimor5
software	immotop2
software	abaimmo

CreateAndAssignFtpAccess.CreateAndAssignFtpAccessDto

{
  "result": {
    "username": "string",
    "ftpHomeDir": [
      {
        "type": "string",
        "path": "string",
        "visibility": "string",
        "last_modified": "2023-10-12T07:10:17Z",
        "extra_metadata": [
          "string"
        ]
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	CreateAndAssignFtpAccessResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

CreateAndAssignFtpAccessFtpHomeDirDto

{
  "type": "string",
  "path": "string",
  "visibility": "string",
  "last_modified": "2023-10-12T07:10:17Z",
  "extra_metadata": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	none
path	string	false	none	none
visibility	string	false	none	none
last_modified	string(date-time)	false	none	none
extra_metadata	[string]	false	none	none

CreateAndAssignFtpAccessResultDto

{
  "username": "string",
  "ftpHomeDir": [
    {
      "type": "string",
      "path": "string",
      "visibility": "string",
      "last_modified": "2023-10-12T07:10:17Z",
      "extra_metadata": [
        "string"
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
username	string	false	none	none
ftpHomeDir	[CreateAndAssignFtpAccessFtpHomeDirDto]	false	none	none

CustomfieldsSchemaUpload

{
  "customfieldsSchema": {},
  "contractId": 0
}

Properties

Name	Type	Required	Restrictions	Description
customfieldsSchema	object	true	none	none
contractId	integer	true	none	none

CustomfieldsSchemaUpload.CustomfieldsSchemaUploadDto

{
  "result": {
    "contractId": "string",
    "customFieldsSchema": {},
    "oldFileName": "string"
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	CustomfieldsSchemaUploadResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

CustomfieldsSchemaUploadResultDto

{
  "contractId": "string",
  "customFieldsSchema": {},
  "oldFileName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
contractId	string	false	none	none
customFieldsSchema	object	false	none	none
oldFileName	string	false	none	none

DeleteUserAndRemoveEmployeeUsername

{
  "username": "string"
}

Properties

Name	Type	Required	Restrictions	Description
username	string	true	none	none

DeleteUserAndRemoveEmployeeUsername.DeleteUserAndRemoveEmployeeUsernameDto

{
  "result": {
    "message": "string"
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	DeleteUserAndRemoveEmployeeUsernameResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

DeleteUserAndRemoveEmployeeUsernameResultDto

{
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
message	string	false	none	none

Employee

{
  "id": 0,
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "id": 0,
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null,
    "roles": [
      "string"
    ],
    "userIdentifier": "string"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
company	Company	false	none	none
userResetToken	string,null	false	none	none
firstName	string,null	false	none	none
lastName	string,null	false	none	none
gender	integer,null	false	none	none
lang	string,null	false	none	none
email	string,null	false	none	none
phone	string,null	false	none	none
mobile	string,null	false	none	none
fax	string,null	false	none	none
dob	string,null(date-time)	false	none	none
function	string,null	false	none	none
lastClientIp	string,null	false	none	none
role	string	false	none	none
trusted	boolean,null	false	none	none
user	User	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Employee.jsonhal

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "id": 0,
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null,
    "roles": [
      "string"
    ],
    "userIdentifier": "string"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
company	Company	false	none	none
userResetToken	string,null	false	none	none
firstName	string,null	false	none	none
lastName	string,null	false	none	none
gender	integer,null	false	none	none
lang	string,null	false	none	none
email	string,null	false	none	none
phone	string,null	false	none	none
mobile	string,null	false	none	none
fax	string,null	false	none	none
dob	string,null(date-time)	false	none	none
function	string,null	false	none	none
lastClientIp	string,null	false	none	none
role	string	false	none	none
trusted	boolean,null	false	none	none
user	User	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Employee.jsonhal-read.Company_timestampable

{
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Employee.jsonhal-read.Employee_timestampable

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "id": 0,
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null,
    "roles": [
      "string"
    ],
    "userIdentifier": "string"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
company	Company	false	none	none
userResetToken	string,null	false	none	none
firstName	string,null	false	none	none
lastName	string,null	false	none	none
gender	integer,null	false	none	none
lang	string,null	false	none	none
email	string,null	false	none	none
phone	string,null	false	none	none
mobile	string,null	false	none	none
fax	string,null	false	none	none
dob	string,null(date-time)	false	none	none
function	string,null	false	none	none
lastClientIp	string,null	false	none	none
role	string	false	none	none
trusted	boolean,null	false	none	none
user	User	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Employee.jsonld

{
  "id": 0,
  "company": {
    "id": "string",
    "sfAccountId": null,
    "address": {
      "id": 0,
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "legalName": null,
    "legalForm": null,
    "entityType": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "slogan": null,
    "twitter": null,
    "linkedin": null,
    "facebook": null,
    "pinterest": null,
    "instagram": null,
    "websiteUrl": null,
    "logo": null,
    "logoInv": null,
    "logoBw": null,
    "logoBwInv": null,
    "uid": null,
    "vat": null,
    "options": null,
    "addition": null,
    "internalNotes": null,
    "abacusCustomerId": null,
    "allowRelationship": true,
    "zefixMutations": null,
    "zefixLastUpdateDate": null,
    "employees": [
      "https://example.com/"
    ],
    "companyContents": [
      "https://example.com/"
    ],
    "companyRelations": [
      "https://example.com/"
    ],
    "contracts": [
      "https://example.com/"
    ],
    "userRoles": [
      "https://example.com/"
    ],
    "legalPerson": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "userResetToken": null,
  "firstName": null,
  "lastName": null,
  "gender": null,
  "lang": null,
  "email": null,
  "phone": null,
  "mobile": null,
  "fax": null,
  "dob": null,
  "function": null,
  "lastClientIp": null,
  "role": "visitor",
  "trusted": null,
  "user": {
    "username": "string",
    "employee": "https://example.com/",
    "firstName": null,
    "lastName": null,
    "keycloakId": null,
    "userRoles": [
      "https://example.com/"
    ],
    "password": null,
    "roles": [
      "string"
    ],
    "userIdentifier": "string"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
company	Company	false	none	none
userResetToken	string,null	false	none	none
firstName	string,null	false	none	none
lastName	string,null	false	none	none
gender	integer,null	false	none	none
lang	string,null	false	none	none
email	string,null	false	none	none
phone	string,null	false	none	none
mobile	string,null	false	none	none
fax	string,null	false	none	none
dob	string,null(date-time)	false	none	none
function	string,null	false	none	none
lastClientIp	string,null	false	none	none
role	string	false	none	none
trusted	boolean,null	false	none	none
user	User	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Entry

{
  "id": 0,
  "status": "new",
  "company": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "statusList": null,
  "actionList": null,
  "messengerTypeList": null
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
status	string,null	false	none	none
company	string,null(iri-reference)	false	none	none
action	string,null	false	none	none
messengerType	string,null	false	none	none
externalIdentifier	string,null	false	none	none
messenger	string,null	false	none	none
transcript	string,null	false	none	none
duration	integer,null	false	none	none
end	string,null(date-time)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.
statusList	any	false	read-only	none
actionList	any	false	read-only	none
messengerTypeList	any	false	read-only	none

Entry.jsonhal

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "status": "new",
  "company": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "statusList": null,
  "actionList": null,
  "messengerTypeList": null
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
status	string,null	false	none	none
company	string,null(iri-reference)	false	none	none
action	string,null	false	none	none
messengerType	string,null	false	none	none
externalIdentifier	string,null	false	none	none
messenger	string,null	false	none	none
transcript	string,null	false	none	none
duration	integer,null	false	none	none
end	string,null(date-time)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.
statusList	any	false	read-only	none
actionList	any	false	read-only	none
messengerTypeList	any	false	read-only	none

Entry.jsonhal-read.Entry_timestampable

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "status": "new",
  "company": {
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
status	string,null	false	none	none
company	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Company.jsonhal-read.Entry_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
action	string,null	false	none	none
messengerType	string,null	false	none	none
externalIdentifier	string,null	false	none	none
messenger	string,null	false	none	none
transcript	string,null	false	none	none
duration	integer,null	false	none	none
end	string,null(date-time)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Entry.jsonld

{
  "id": 0,
  "status": "new",
  "company": "https://example.com/",
  "action": null,
  "messengerType": null,
  "externalIdentifier": null,
  "messenger": null,
  "transcript": null,
  "duration": null,
  "end": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "statusList": null,
  "actionList": null,
  "messengerTypeList": null
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
status	string,null	false	none	none
company	string,null(iri-reference)	false	none	none
action	string,null	false	none	none
messengerType	string,null	false	none	none
externalIdentifier	string,null	false	none	none
messenger	string,null	false	none	none
transcript	string,null	false	none	none
duration	integer,null	false	none	none
end	string,null(date-time)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.
statusList	any	false	read-only	none
actionList	any	false	read-only	none
messengerTypeList	any	false	read-only	none

ErrorData

{
  "statusCode": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
statusCode	integer	false	none	none
message	string	false	none	none

GdprDeletionRequest.BaseResponseData

{
  "result": null,
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	any	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

GdprDeletionRequest.GdprDeletionRequest

{
  "companyId": "string",
  "requestId": "string",
  "email": null,
  "phones": null,
  "dryRun": true
}

Properties

Name	Type	Required	Restrictions	Description
companyId	string	true	none	none
requestId	string	true	none	none
email	string,null	false	none	none
phones	array,null	false	none	none
dryRun	boolean	true	none	none

Identity

{
  "id": 0,
  "user": "https://example.com/",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "roles": {}
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
user	string(iri-reference)	false	none	none
identityRoles	[string]	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.
roles	object	false	read-only	none

Identity-identity.read_timestampable

{
  "id": 0,
  "user": {
    "username": "string"
  },
  "identityRoles": [
    {
      "id": 0,
      "company": {
        "id": "string",
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "role": {
        "id": 0,
        "name": "string",
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "roles": {}
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
user	User-identity.read_timestampable	false	none	none
identityRoles	[IdentityRole-identity.read_timestampable]	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.
roles	object	false	read-only	none

Identity.jsonhal

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "user": "https://example.com/",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "roles": {}
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
user	string(iri-reference)	false	none	none
identityRoles	[string]	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.
roles	object	false	read-only	none

Identity.jsonhal-identity.read_timestampable

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "user": {
    "username": "string"
  },
  "identityRoles": [
    {
      "id": 0,
      "company": {
        "id": "string",
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "role": {
        "id": 0,
        "name": "string",
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "roles": {}
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
user	User.jsonhal-identity.read_timestampable	false	none	none
identityRoles	[IdentityRole.jsonhal-identity.read_timestampable]	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.
roles	object	false	read-only	none

Identity.jsonld

{
  "id": 0,
  "user": "https://example.com/",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z",
  "roles": {}
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
user	string(iri-reference)	false	none	none
identityRoles	[string]	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.
roles	object	false	read-only	none

IdentityRole

{
  "id": 0,
  "identity": "https://example.com/",
  "company": "https://example.com/",
  "role": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
identity	string(iri-reference)	true	none	none
company	string,null(iri-reference)	false	none	none
role	string(iri-reference)	true	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

IdentityRole-identity.read_timestampable

{
  "id": 0,
  "company": {
    "id": "string",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "role": {
    "id": 0,
    "name": "string",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
company	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Company-identity.read_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
role	Role-identity.read_timestampable	true	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

IdentityRole.jsonhal

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "identity": "https://example.com/",
  "company": "https://example.com/",
  "role": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
identity	string(iri-reference)	true	none	none
company	string,null(iri-reference)	false	none	none
role	string(iri-reference)	true	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

IdentityRole.jsonhal-identity.read_timestampable

{
  "id": 0,
  "company": {
    "id": "string",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "role": {
    "id": 0,
    "name": "string",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
company	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	Company.jsonhal-identity.read_timestampable	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
role	Role.jsonhal-identity.read_timestampable	true	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

IdentityRole.jsonld

{
  "id": 0,
  "identity": "https://example.com/",
  "company": "https://example.com/",
  "role": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
identity	string(iri-reference)	true	none	none
company	string,null(iri-reference)	false	none	none
role	string(iri-reference)	true	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

InterfaceStatus

{
  "software": "casaframe"
}

Properties

Name	Type	Required	Restrictions	Description
software	string	true	none	none

Enumerated Values

Property	Value
software	casaframe
software	casagateway
software	casaone
software	casaone-project
software	casaone-website
software	casascreen
software	casatour
software	icasa
software	hosting
software	republish-service
software	prestigehome
software	property-management-software
software	luxuryestate
software	casawebsite

InterfaceStatus.InterfaceStatusDto

{
  "result": {
    "items": [
      {
        "missing-setting-connection": {
          "publisherSlug": "string",
          "publisherName": "string",
          "company": "string",
          "companyName": "string"
        },
        "ftp-unstable": {
          "statusKey": "string",
          "ftp-unstable-since": "string",
          "ftp-username": "string",
          "publisherSlug": "string",
          "publisherName": "string",
          "company": "string",
          "companyName": "string"
        },
        "ftp-misconfigured": {
          "statusKey": "string",
          "ftp-unstable-since": "string",
          "ftp-username": "string",
          "publisherSlug": "string",
          "publisherName": "string",
          "company": "string",
          "companyName": "string"
        },
        "ftp-not-configured": {
          "publisherExportProtocol": "string",
          "publisherSlug": "string",
          "publisherName": "string",
          "company": "string",
          "companyName": "string"
        }
      }
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	InterfaceStatusResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

InterfaceStatusFtpMisconfiguredDto

{
  "statusKey": "string",
  "ftp-unstable-since": "string",
  "ftp-username": "string",
  "publisherSlug": "string",
  "publisherName": "string",
  "company": "string",
  "companyName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
statusKey	string	false	none	none
ftp-unstable-since	string	false	none	none
ftp-username	string	false	none	none
publisherSlug	string	false	none	none
publisherName	string	false	none	none
company	string	false	none	none
companyName	string	false	none	none

InterfaceStatusFtpNotConfiguredDto

{
  "publisherExportProtocol": "string",
  "publisherSlug": "string",
  "publisherName": "string",
  "company": "string",
  "companyName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
publisherExportProtocol	string	false	none	none
publisherSlug	string	false	none	none
publisherName	string	false	none	none
company	string	false	none	none
companyName	string	false	none	none

InterfaceStatusFtpUnstableDto

{
  "statusKey": "string",
  "ftp-unstable-since": "string",
  "ftp-username": "string",
  "publisherSlug": "string",
  "publisherName": "string",
  "company": "string",
  "companyName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
statusKey	string	false	none	none
ftp-unstable-since	string	false	none	none
ftp-username	string	false	none	none
publisherSlug	string	false	none	none
publisherName	string	false	none	none
company	string	false	none	none
companyName	string	false	none	none

InterfaceStatusItemDto

{
  "missing-setting-connection": {
    "publisherSlug": "string",
    "publisherName": "string",
    "company": "string",
    "companyName": "string"
  },
  "ftp-unstable": {
    "statusKey": "string",
    "ftp-unstable-since": "string",
    "ftp-username": "string",
    "publisherSlug": "string",
    "publisherName": "string",
    "company": "string",
    "companyName": "string"
  },
  "ftp-misconfigured": {
    "statusKey": "string",
    "ftp-unstable-since": "string",
    "ftp-username": "string",
    "publisherSlug": "string",
    "publisherName": "string",
    "company": "string",
    "companyName": "string"
  },
  "ftp-not-configured": {
    "publisherExportProtocol": "string",
    "publisherSlug": "string",
    "publisherName": "string",
    "company": "string",
    "companyName": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
missing-setting-connection	InterfaceStatusMissingSettingConnectionDto	false	none	none
ftp-unstable	InterfaceStatusFtpUnstableDto	false	none	none
ftp-misconfigured	InterfaceStatusFtpMisconfiguredDto	false	none	none
ftp-not-configured	InterfaceStatusFtpNotConfiguredDto	false	none	none

InterfaceStatusMissingSettingConnectionDto

{
  "publisherSlug": "string",
  "publisherName": "string",
  "company": "string",
  "companyName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
publisherSlug	string	false	none	none
publisherName	string	false	none	none
company	string	false	none	none
companyName	string	false	none	none

InterfaceStatusResultDto

{
  "items": [
    {
      "missing-setting-connection": {
        "publisherSlug": "string",
        "publisherName": "string",
        "company": "string",
        "companyName": "string"
      },
      "ftp-unstable": {
        "statusKey": "string",
        "ftp-unstable-since": "string",
        "ftp-username": "string",
        "publisherSlug": "string",
        "publisherName": "string",
        "company": "string",
        "companyName": "string"
      },
      "ftp-misconfigured": {
        "statusKey": "string",
        "ftp-unstable-since": "string",
        "ftp-username": "string",
        "publisherSlug": "string",
        "publisherName": "string",
        "company": "string",
        "companyName": "string"
      },
      "ftp-not-configured": {
        "publisherExportProtocol": "string",
        "publisherSlug": "string",
        "publisherName": "string",
        "company": "string",
        "companyName": "string"
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
items	[InterfaceStatusItemDto]	false	none	none

MigrateCrmOnlyContractFields

{
  "sourceContractId": null,
  "targetContractId": null,
  "companySlug": "string"
}

Properties

Name	Type	Required	Restrictions	Description
sourceContractId	int	true	none	Get the value of sourceContractId.
targetContractId	int	true	none	Get the value of targetContractId.
companySlug	string	true	none	Get the value of companySlug.

MigrateCrmOnlyContractFields.MigrateCrmOnlyContractFieldsDto

{
  "result": {
    "id": 0,
    "sfOpportunityId": null,
    "company": "https://example.com/",
    "billingAddress": null,
    "shippingAddress": null,
    "addressBilling": {
      "id": 0,
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "addressShipping": {
      "id": 0,
      "country": null,
      "locality": null,
      "region": null,
      "postalCode": null,
      "postOfficeBoxNumber": null,
      "street": null,
      "streetNumber": null,
      "streetAddition": null,
      "lat": null,
      "lng": null,
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "options": null,
    "customFieldsSchema": {},
    "status": "active",
    "abacusProjectId": null,
    "billedBySmg": null,
    "contractDate": null,
    "startDate": null,
    "cancellationDate": null,
    "trainingDate": null,
    "noTrainingWanted": null,
    "noCharge": null,
    "product": "https://example.com/",
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	Contract	false	none	A contract defines the relation between a company and a product. Contracts are used to specify configurations for a company regarding a product. These contracts are then used to allow a company and its employees access to products, charge the company for usage, customize the products functionality and looks for a company.
message	string	false	none	none
errors	[ErrorData]	false	none	none

Product

{
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string,null	false	none	none
optionsSchema	array,null	false	none	none
requiresTraining	boolean,null	false	none	none
chargeable	boolean,null	false	none	none
admin	string,null(iri-reference)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Product.jsonhal

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	string	false	none	none
name	string,null	false	none	none
optionsSchema	array,null	false	none	none
requiresTraining	boolean,null	false	none	none
chargeable	boolean,null	false	none	none
admin	string,null(iri-reference)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Product.jsonhal-read.Product_timestampable

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	string	false	none	none
name	string,null	false	none	none
optionsSchema	array,null	false	none	none
requiresTraining	boolean,null	false	none	none
chargeable	boolean,null	false	none	none
admin	string,null(iri-reference)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Product.jsonld

{
  "id": "string",
  "name": null,
  "optionsSchema": null,
  "requiresTraining": null,
  "chargeable": null,
  "admin": "https://example.com/",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string,null	false	none	none
optionsSchema	array,null	false	none	none
requiresTraining	boolean,null	false	none	none
chargeable	boolean,null	false	none	none
admin	string,null(iri-reference)	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

RequestSalesforceAddressDto-write.Salesforce

{
  "street": "Bahnhofstrasse",
  "streetNumber": "10e",
  "postOfficeBoxNumber": "Postfach 207",
  "postalCode": "8001",
  "locality": "Zurich",
  "region": "ZH",
  "country": "CH"
}

Properties

Name	Type	Required	Restrictions	Description
street	string	false	none	Get the value of street.
streetNumber	string	false	none	Get the value of streetNumber.
postOfficeBoxNumber	string	false	none	Get the value of postOfficeBoxNumber.
postalCode	integer	false	none	Get the value of postalCode.
locality	string	false	none	Get the value of locality.
region	string	false	none	Get the value of region.
country	string	false	none	Get the value of country.

RequestSalesforceContractDto-write.Salesforce

{
  "status": "active",
  "sfOpportunityId": "",
  "abacusProjectId": 110,
  "contractDate": "2023-12-01",
  "cancellationDate": "2023-12-01",
  "startDate": "2023-12-01",
  "created": "2023-10-12T07:10:17Z",
  "trainingDate": "2023-12-01",
  "noCharge": "false",
  "billedBySmg": "true",
  "noTrainingWanted": "true",
  "productId": "hosting",
  "optionsPlan": null
}

Properties

Name	Type	Required	Restrictions	Description
status	string	true	none	Get the value of status.
sfOpportunityId	string	true	none	Get the value of sfOpportunityId.
abacusProjectId	integer	false	none	Get the value of abacusProjectId.
contractDate	string(date)	false	none	Get the value of contractDate.
cancellationDate	string(date)	false	none	Get the value of cancellationDate.
startDate	string(date)	false	none	Get the value of startDate.
created	string(datetime)	true	none	Get the value of created.
trainingDate	string(date)	false	none	Get the value of trainingDate.
noCharge	boolean	false	none	Get the value of noCharge.
billedBySmg	boolean	false	none	Get the value of billedBySmg.
noTrainingWanted	boolean	false	none	Get the value of noTrainingWanted.
productId	string	true	none	Get the value of productId.
optionsPlan	string,null	false	none	Get the value of optionsPlan.

Enumerated Values

Property	Value
status	active
status	demo
status	inactive
productId	casaframe
productId	casaone
productId	casaone-project
productId	hosting
productId	property-management-software

Role

{
  "id": 0,
  "name": "string",
  "service": "casaone-api",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
name	string	false	none	none
service	string	false	none	none
identityRoles	[string]	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Enumerated Values

Property	Value
service	casaone-api
service	casagateway
service	casamail

Role-identity.read_timestampable

{
  "id": 0,
  "name": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
name	string	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Role.jsonhal

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "name": "string",
  "service": "casaone-api",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
name	string	false	none	none
service	string	false	none	none
identityRoles	[string]	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Enumerated Values

Property	Value
service	casaone-api
service	casagateway
service	casamail

Role.jsonhal-identity.read_timestampable

{
  "id": 0,
  "name": "string",
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
name	string	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Role.jsonld

{
  "id": 0,
  "name": "string",
  "service": "casaone-api",
  "identityRoles": [
    "https://example.com/"
  ],
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
name	string	false	none	none
service	string	false	none	none
identityRoles	[string]	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Enumerated Values

Property	Value
service	casaone-api
service	casagateway
service	casamail

Salesforce.BaseResponseData-read.Salesforce

{}

Properties

None

Salesforce.RequestSalesforceDto-write.Salesforce

{
  "sfAccountId": "0014I00002OdBFr",
  "contracts": [
    {
      "status": "active",
      "sfOpportunityId": "",
      "abacusProjectId": 110,
      "contractDate": "2023-12-01",
      "cancellationDate": "2023-12-01",
      "startDate": "2023-12-01",
      "created": "2023-10-12T07:10:17Z",
      "trainingDate": "2023-12-01",
      "noCharge": "false",
      "billedBySmg": "true",
      "noTrainingWanted": "true",
      "productId": "hosting",
      "optionsPlan": null
    }
  ],
  "address": {
    "street": "Bahnhofstrasse",
    "streetNumber": "10e",
    "postOfficeBoxNumber": "Postfach 207",
    "postalCode": "8001",
    "locality": "Zurich",
    "region": "ZH",
    "country": "CH"
  },
  "companySlug": "string",
  "legalForm": "sole-enterprise",
  "legalName": "Test Company AG",
  "addition": "something additional about the company",
  "slogan": "We are the best company",
  "phone": "+41 71245847",
  "fax": "+41 71245844",
  "mobile": "+41 76854275",
  "email": "[email protected]",
  "websiteUrl": "https://test-company.com",
  "uid": "CHE-152.155.154",
  "abacusCustomerId": null
}

Properties

Name	Type	Required	Restrictions	Description
sfAccountId	string	true	none	Get the value of sfAccountId.
contracts	[RequestSalesforceContractDto-write.Salesforce]	false	none	none
address	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	RequestSalesforceAddressDto-write.Salesforce	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
companySlug	string	true	none	Get the value of companySlug.
legalForm	string	false	none	Get the value of legalForm.
legalName	string	false	none	Get the value of legalName.
addition	string	false	none	Get the value of addition.
slogan	string	false	none	Get the value of slogan.
phone	string	false	none	Get the value of phone.
fax	string	false	none	Get the value of fax.
mobile	string	false	none	Get the value of mobile.
email	string	false	none	Get the value of email.
websiteUrl	string	false	none	Get the value of websiteUrl.
uid	string	true	none	Get the value of uid.
abacusCustomerId	integer,null	false	none	Get the value of abacusCustomerId.

Enumerated Values

Property	Value
legalForm	sole-enterprise
legalForm	llc
legalForm	ltd
legalForm	general-partnership
legalForm	foundation
legalForm	branch
legalForm	public-sector-institution
legalForm	cooperative
legalForm	association
legalForm	limited-partnership

Slugs.SlugsDto

{
  "result": {
    "slugs": [
      "string"
    ]
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	SlugsResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

SlugsResultDto

{
  "slugs": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
slugs	[string]	false	none	none

User

{
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ],
  "password": null,
  "roles": [
    "string"
  ],
  "userIdentifier": "string"
}

Properties

Name	Type	Required	Restrictions	Description
username	string	false	none	none
employee	string,null(iri-reference)	false	none	none
firstName	string,null	false	none	none
lastName	string,null	false	none	none
keycloakId	string,null	false	none	none
userRoles	[string]	false	none	none
password	string,null	false	none	none
roles	[string]	false	read-only	USE THIS FOR TESTING ONLY
userIdentifier	string	false	read-only	none

User-identity.read_timestampable

{
  "username": "string"
}

Properties

Name	Type	Required	Restrictions	Description
username	string	false	none	none

User.jsonhal

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ],
  "password": null,
  "roles": [
    "string"
  ],
  "userIdentifier": "string"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
username	string	false	none	none
employee	string,null(iri-reference)	false	none	none
firstName	string,null	false	none	none
lastName	string,null	false	none	none
keycloakId	string,null	false	none	none
userRoles	[string]	false	none	none
password	string,null	false	none	none
roles	[string]	false	read-only	USE THIS FOR TESTING ONLY
userIdentifier	string	false	read-only	none

User.jsonhal-identity.read_timestampable

{
  "username": "string"
}

Properties

Name	Type	Required	Restrictions	Description
username	string	false	none	none

User.jsonhal-read.User

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
username	string	false	none	none
employee	string,null(iri-reference)	false	none	none
firstName	string,null	false	none	none
lastName	string,null	false	none	none
keycloakId	string,null	false	none	none
userRoles	[string]	false	none	none

User.jsonld

{
  "username": "string",
  "employee": "https://example.com/",
  "firstName": null,
  "lastName": null,
  "keycloakId": null,
  "userRoles": [
    "https://example.com/"
  ],
  "password": null,
  "roles": [
    "string"
  ],
  "userIdentifier": "string"
}

Properties

Name	Type	Required	Restrictions	Description
username	string	false	none	none
employee	string,null(iri-reference)	false	none	none
firstName	string,null	false	none	none
lastName	string,null	false	none	none
keycloakId	string,null	false	none	none
userRoles	[string]	false	none	none
password	string,null	false	none	none
roles	[string]	false	read-only	USE THIS FOR TESTING ONLY
userIdentifier	string	false	read-only	none

UserCreationWithIdentityRoles.UserCreationWithIdentityRolesInputDto

{
  "username": "[email protected]",
  "firstName": "Hans",
  "lastName": "Gruber",
  "lang": "de",
  "roles": [
    {
      "name": "ROLE_NAME",
      "serviceId": "casaone-api"
    }
  ],
  "companySlug": "casasoft"
}

Properties

Name	Type	Required	Restrictions	Description
username	string(email)	true	none	none
firstName	string	true	none	none
lastName	string	true	none	none
lang	string	true	none	none
roles	[UserCreationWithIdentityRolesRolesArrayInputDto]	true	none	none
companySlug	string	true	none	none

UserCreationWithIdentityRoles.UserCreationWithIdentityRolesOutputDto

{
  "result": {
    "keycloakId": "string",
    "identityId": 0,
    "username": "string",
    "firstName": "string",
    "lastName": "string",
    "roles": {}
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	UserCreationWithIdentityRolesOutputResultDto	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

UserCreationWithIdentityRolesOutputResultDto

{
  "keycloakId": "string",
  "identityId": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "roles": {}
}

Properties

Name	Type	Required	Restrictions	Description
keycloakId	string	false	none	none
identityId	integer	false	none	none
username	string	false	none	none
firstName	string	false	none	none
lastName	string	false	none	none
roles	object	false	none	none

UserCreationWithIdentityRolesRolesArrayInputDto

{
  "name": "ROLE_NAME",
  "serviceId": "casaone-api"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
serviceId	string	true	none	none

UserMigration.UserMigrationInputDto

{
  "fromUsername": "[email protected]",
  "toUsername": "[email protected]"
}

Properties

Name	Type	Required	Restrictions	Description
fromUsername	string(email)	true	none	none
toUsername	string(email)	true	none	none

UserMigration.UserMigrationOutputDto-identity.read_timestampable

{
  "result": {
    "id": 0,
    "user": {
      "username": "string"
    },
    "identityRoles": [
      {
        "id": 0,
        "company": {
          "id": "string",
          "created": "2023-10-12T07:10:17Z",
          "updated": "2023-10-12T07:10:17Z"
        },
        "role": {
          "id": 0,
          "name": "string",
          "created": "2023-10-12T07:10:17Z",
          "updated": "2023-10-12T07:10:17Z"
        },
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      }
    ],
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z",
    "roles": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
result	Identity-identity.read_timestampable	false	none	none

UserProfile.UserProfileDto

{
  "result": {
    "id": 0,
    "company": {
      "id": "string",
      "sfAccountId": null,
      "address": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "legalName": null,
      "legalForm": null,
      "entityType": null,
      "email": null,
      "phone": null,
      "mobile": null,
      "fax": null,
      "slogan": null,
      "twitter": null,
      "linkedin": null,
      "facebook": null,
      "pinterest": null,
      "instagram": null,
      "websiteUrl": null,
      "logo": null,
      "logoInv": null,
      "logoBw": null,
      "logoBwInv": null,
      "uid": null,
      "vat": null,
      "options": null,
      "addition": null,
      "internalNotes": null,
      "abacusCustomerId": null,
      "allowRelationship": true,
      "zefixMutations": null,
      "zefixLastUpdateDate": null,
      "employees": [
        "https://example.com/"
      ],
      "companyContents": [
        "https://example.com/"
      ],
      "companyRelations": [
        "https://example.com/"
      ],
      "contracts": [
        "https://example.com/"
      ],
      "userRoles": [
        "https://example.com/"
      ],
      "legalPerson": "https://example.com/",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    },
    "userResetToken": null,
    "firstName": null,
    "lastName": null,
    "gender": null,
    "lang": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "dob": null,
    "function": null,
    "lastClientIp": null,
    "role": "visitor",
    "trusted": null,
    "user": {
      "username": "string",
      "employee": "https://example.com/",
      "firstName": null,
      "lastName": null,
      "keycloakId": null,
      "userRoles": [
        "https://example.com/"
      ],
      "password": null,
      "roles": [
        "string"
      ],
      "userIdentifier": "string"
    },
    "created": "2023-10-12T07:10:17Z",
    "updated": "2023-10-12T07:10:17Z"
  },
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	Employee	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

UserRole

{
  "id": 0,
  "username": "https://example.com/",
  "company": "https://example.com/",
  "roles": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	none
username	string(iri-reference)	false	none	none
company	string,null(iri-reference)	false	none	none
roles	array,null	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

UserRole.jsonhal

{
  "_links": {
    "self": {
      "href": "string"
    }
  },
  "id": 0,
  "username": "https://example.com/",
  "company": "https://example.com/",
  "roles": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
_links	object	false	none	none
» self	object	false	none	none
»» href	string(iri-reference)	false	none	none
id	integer	false	read-only	none
username	string(iri-reference)	false	none	none
company	string,null(iri-reference)	false	none	none
roles	array,null	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

UserRole.jsonhal-read.Company_timestampable

{
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

UserRole.jsonld

{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "id": 0,
  "username": "https://example.com/",
  "company": "https://example.com/",
  "roles": null,
  "created": "2023-10-12T07:10:17Z",
  "updated": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
@context	any	false	read-only	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» @vocab	string	true	none	none
»» hydra	string	true	none	none

continued

Name	Type	Required	Restrictions	Description
@id	string	false	read-only	none
@type	string	false	read-only	none
id	integer	false	read-only	none
username	string(iri-reference)	false	none	none
company	string,null(iri-reference)	false	none	none
roles	array,null	false	none	none
created	string(date-time)	false	none	Get created.
updated	string(date-time)	false	none	Get updated.

Enumerated Values

Property	Value
hydra	http://www.w3.org/ns/hydra/core#

UserRoleDeletionForCompany

{}

Properties

None

UserRoleDeletionForCompany.UserRoleDeletionForCompanyInputDto

{
  "username": "[email protected]",
  "companySlug": "casasoft"
}

Properties

Name	Type	Required	Restrictions	Description
username	string(email)	true	none	none
companySlug	string	true	none	none

ZefixCompaniesAcceptAllChanges

{}

Properties

None

ZefixCompaniesAcceptAllChanges.ZefixDto

{
  "result": [
    "string"
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	[string]	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ZefixCompaniesDirty.ZefixCompaniesDirtyDto

{
  "result": [
    {
      "id": "string",
      "sfAccountId": null,
      "address": {
        "id": 0,
        "country": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "postOfficeBoxNumber": null,
        "street": null,
        "streetNumber": null,
        "streetAddition": null,
        "lat": null,
        "lng": null,
        "created": "2023-10-12T07:10:17Z",
        "updated": "2023-10-12T07:10:17Z"
      },
      "legalName": null,
      "legalForm": null,
      "entityType": null,
      "email": null,
      "phone": null,
      "mobile": null,
      "fax": null,
      "slogan": null,
      "twitter": null,
      "linkedin": null,
      "facebook": null,
      "pinterest": null,
      "instagram": null,
      "websiteUrl": null,
      "logo": null,
      "logoInv": null,
      "logoBw": null,
      "logoBwInv": null,
      "uid": null,
      "vat": null,
      "options": null,
      "addition": null,
      "internalNotes": null,
      "abacusCustomerId": null,
      "allowRelationship": true,
      "zefixMutations": null,
      "zefixLastUpdateDate": null,
      "employees": [
        "https://example.com/"
      ],
      "companyContents": [
        "https://example.com/"
      ],
      "companyRelations": [
        "https://example.com/"
      ],
      "contracts": [
        "https://example.com/"
      ],
      "userRoles": [
        "https://example.com/"
      ],
      "legalPerson": "https://example.com/",
      "created": "2023-10-12T07:10:17Z",
      "updated": "2023-10-12T07:10:17Z"
    }
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	[Company]	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ZefixCompaniesFindChanges

{
  "date": "2024-10-11"
}

Properties

Name	Type	Required	Restrictions	Description
date	string(date)	false	none	none

ZefixCompaniesFindChanges.ZefixDto

{
  "result": [
    "string"
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	[string]	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ZefixCompanyAcceptChanges

{
  "slug": "string"
}

Properties

Name	Type	Required	Restrictions	Description
slug	string	true	none	none

ZefixCompanyAcceptChanges.ZefixDto

{
  "result": [
    "string"
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	[string]	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ZefixCompanyByUid.BaseResponseData

{
  "result": null,
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	any	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ZefixCompanyCreate

{
  "uid": "string",
  "slug": "string",
  "lat": null,
  "lng": null
}

Properties

Name	Type	Required	Restrictions	Description
uid	string	true	none	none
slug	string	true	none	none
lat	string,null	false	none	none
lng	string,null	false	none	none

ZefixCompanyCreate.ZefixDto

{
  "result": [
    "string"
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	[string]	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ZefixCompanySearch

{
  "name": "test"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none

ZefixCompanySearch.ZefixCompanySearchDto

{
  "result": [
    {
      "company": "string",
      "uid": "string"
    }
  ],
  "message": "string",
  "errors": [
    {
      "statusCode": 0,
      "message": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
result	[ZefixCompanySearchResultDto]	false	none	none
message	string	false	none	none
errors	[ErrorData]	false	none	none

ZefixCompanySearchResultDto

{
  "company": "string",
  "uid": "string"
}

Properties

Name	Type	Required	Restrictions	Description
company	string	false	none	none
uid	string	false	none	none