NAV Navigation
Curl JavaScript C#

Overview

The Sweet One API provides access to Sweet Ones CRM entities, as well as information about related metadata entities such users and codes. It allows our customers to provide a REST Api to their customers/partners with their specific setup including customized case management, CRM features and much more.

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

Structure of the API

Entities

The REST API structure provides a range of actions that enable users to manage and manipulate entity data. These actions include:

To perform these actions, users must specify the entity data they wish to work with. This data can encompass any type of data that the API handles, such as companies, activities, or cases.

In addition to these core actions, the API also includes endpoints that support filtering of entity data. These endpoints include:

By utilizing these endpoints, users can more efficiently locate and interact with specific subsets of data that are relevant to their needs.

Overall, the REST API structure is a versatile and powerful set of tools that enable users to perform a wide range of data management tasks. These tools facilitate the addition, modification, and deletion of entity data, as well as the targeted retrieval of data through filtering functionality and specific identifiers.

Relations

The REST API structure allows for the management of relations between entities. Relations can be accessed using routes that include both an entity ID and a relation. The route format is as follows:

In this format, the {Id} parameter specifies the ID of the entity being targeted, while the {Relation} parameter specifies the type of relation being managed.

To interact with relations in the API, the following actions are used:

Note that the specific actions and behaviors of the relation routes may vary depending on the requirements of the API and the type of entities being worked with. However, the overall structure of using the entity ID and relation to access and manage related entities remains consistent.

Metadata

In addition to the endpoints for manipulating entity data, the REST API also includes a set of “metadata” endpoints. These endpoints provide information about the users, inboxes, and codes that are utilized within the API’s broader functionality. The metadata endpoints are as follows:

Filtering/Pagination

Filtering

All Filter endpoints are HTTP POST requests and they require a DataSourceRequest as input. The DataSourceRequest is used in all Sweet APIs. However, some of the features may not be supported by some of the APIs. In such cases, a 400 Bad Request error message will be returned with the name of the unsupported feature. For example, Sweet One API does not support Group, Aggregate or Select operations.

Pagination

This is accomplished by using skip and take on the DataSourceRequest. The max number of items returned can not be more than 100, if so a a 400 Bad Request error message will be returned stating this. If left out default number of items that will be returned is 10

DataSourceRequest Model Documentation

The DataSourceRequest model is used for filtering in Sweet Products’ APIs. However, not all APIs support every feature of the DataSourceRequest model.

This guide outlines the features that are supported by the Sweet One API and the Sweet Automation API, along with examples of how to use each feature.

Note that this part also mention Sweet Automation which is another API with in the Sweet Product Suite.

Paging

Paging is done with take and skip. For example, to get page 2 of a page size of 50, you would pass:

{
"skip": 25,
"take": 25
}

Paging is supported by the Sweet One and Sweet Automation APIs.

Filtering

Filtering is used to filter on fields and supports and/or operators. For example, to get “Mors lilla olle”, you would pass:

{
"skip": 25,
"take": 25,
"filter": {
"logic": "and",
"filters": [
{
"field": "Name",
"operator": "endsWith",
"value": "olle"
},
{
"field": "HasMother",
"operator": "equal",
"value": true
}
]
}
}

Filtering is supported by the Sweet One and Sweet Automation APIs.

Operators

The following operators are supported:

Sorting

Sorting is straightforward and can be done on one or more fields in ascending or descending order. For example:

{
"skip": 25,
"take": 25,
"sort": [
{
"field": "Name",
"dir": "asc"
},
{
"field": "Created",
"dir": "desc"
}]
}

Authentication

API Key

To generate a key you need to have the feature Admin Core, Admin Core: developer or Admin Core: User Manager in the portal.

Rate Limiting

Rate limiting is enabled by default.

The default throttling is 30 requests per second or 1000 requests per minute.

If throttling happens you will be presented with an http status code of 429

Errors

Errors The API returns error codes such as 400, 403, 404, and 500 along with information about the error. Here are some common error responses:

Codegroup

Get codegroups and their codes

Get

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Codegroup \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Codegroup", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Codegroup");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Codegroup

Example responses

200 Response

[
{
"CodeGroupKey": "string",
"Caption": "string"
}
]
<?xml version="1.0" encoding="UTF-8" ?>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>

Responses

Status Meaning Description Schema
200 OK OK Inline
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [CodeGroup] false none none
» CodeGroupKey string false none none
» Caption string false none none

User

Get

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/User/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/User/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/User/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /User/{searchTerm}

Parameters

Name In Type Required Description
searchTerm path string true none

Example responses

200 Response

{
"UserId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"UserName": "string",
"Email": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<User>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<Name>string</Name>
<UserName>string</UserName>
<Email>string</Email>
</User>

Responses

Status Meaning Description Schema
200 OK OK User
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Inbox

Inboxes used by case management

Get

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Inboxes \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Inboxes", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Inboxes");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Inboxes

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<InboxAccount>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Name>string</Name>
</InboxAccount>

Responses

Status Meaning Description Schema
200 OK OK InboxAccount
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Company

The company entity holds information about companies in the system

More information

Retreive filtrable fields and their type for Company

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter Company based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get Company by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Name": "string",
"EmployeeCount": 0,
"CustomerNumber": "string",
"OrganisationalNumber": "string",
"CorporateGroup": "string",
"Unit": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Branch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"OwnBranch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ServiceGrade": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"UnitType": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Active": true,
"Segment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Region": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"EmployeeCountRange": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow1": "string",
"PrimaryAddressRow2": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"IsNew": true,
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"HasDocument": true,
"TagCount": 0,
"Longitude": 0.1,
"Latitude": 0.1,
"LoginStatus": "noLogin",
"UnitNo": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Company>
<Name>string</Name>
<EmployeeCount>0</EmployeeCount>
<CustomerNumber>string</CustomerNumber>
<OrganisationalNumber>string</OrganisationalNumber>
<CorporateGroup>string</CorporateGroup>
<Unit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Unit>
<Branch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Branch>
<OwnBranch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</OwnBranch>
<ServiceGrade>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</ServiceGrade>
<UnitType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</UnitType>
<Active>true</Active>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Segment>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubSegment>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Rating>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Region>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Region>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<EmployeeCountRange>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</EmployeeCountRange>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow1>string</PrimaryAddressRow1>
<PrimaryAddressRow2>string</PrimaryAddressRow2>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<IsNew>true</IsNew>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Responsible>string</Responsible>
<HasDocument>true</HasDocument>
<TagCount>0</TagCount>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<LoginStatus>noLogin</LoginStatus>
<UnitNo>string</UnitNo>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Company>

Responses

Status Meaning Description Schema
200 OK Success Company
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete Company by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Company/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Company/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update Company

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Company \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","EmployeeCount":0,"CustomerNumber":"string","OrganisationalNumber":"string","CorporateGroup":"string","Unit":{"Key":"string","CodeGroupKey":"string"},"Branch":{"Key":"string","CodeGroupKey":"string"},"OwnBranch":{"Key":"string","CodeGroupKey":"string"},"ServiceGrade":{"Key":"string","CodeGroupKey":"string"},"UnitType":{"Key":"string","CodeGroupKey":"string"},"Active":true,"Segment":{"Key":"string","CodeGroupKey":"string"},"SubSegment":{"Key":"string","CodeGroupKey":"string"},"Rating":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Region":{"Key":"string","CodeGroupKey":"string"},"Type":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"EmployeeCountRange":{"Key":"string","CodeGroupKey":"string"},"PrimaryEmailAddress":"string","PrimaryPhoneNumber":"string","WebSite":"string","PrimaryAddressRow":"string","PrimaryCity":"string","PrimaryZipCode":"string","PrimaryCounty":"string","PrimaryCountryId":[0],"PrimaryCommunicationCategory":"unknown","Longitude":0.1,"Latitude":0.1,"UnitNo":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"EmployeeCount\":0,\"CustomerNumber\":\"string\",\"OrganisationalNumber\":\"string\",\"CorporateGroup\":\"string\",\"Unit\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Branch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"OwnBranch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ServiceGrade\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"UnitType\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Active\":true,\"Segment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubSegment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Rating\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Region\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"EmployeeCountRange\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Longitude\":0.1,\"Latitude\":0.1,\"UnitNo\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"EmployeeCount\":0,\"CustomerNumber\":\"string\",\"OrganisationalNumber\":\"string\",\"CorporateGroup\":\"string\",\"Unit\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Branch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"OwnBranch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ServiceGrade\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"UnitType\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Active\":true,\"Segment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubSegment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Rating\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Region\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"EmployeeCountRange\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Longitude\":0.1,\"Latitude\":0.1,\"UnitNo\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Company

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Name": "string",
"EmployeeCount": 0,
"CustomerNumber": "string",
"OrganisationalNumber": "string",
"CorporateGroup": "string",
"Unit": {
"Key": "string",
"CodeGroupKey": "string"
},
"Branch": {
"Key": "string",
"CodeGroupKey": "string"
},
"OwnBranch": {
"Key": "string",
"CodeGroupKey": "string"
},
"ServiceGrade": {
"Key": "string",
"CodeGroupKey": "string"
},
"UnitType": {
"Key": "string",
"CodeGroupKey": "string"
},
"Active": true,
"Segment": {
"Key": "string",
"CodeGroupKey": "string"
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string"
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Region": {
"Key": "string",
"CodeGroupKey": "string"
},
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"EmployeeCountRange": {
"Key": "string",
"CodeGroupKey": "string"
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Longitude": 0.1,
"Latitude": 0.1,
"UnitNo": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
EmployeeCount: 0
CustomerNumber: string
OrganisationalNumber: string
CorporateGroup: string
Unit:
Key: string
CodeGroupKey: string
Branch:
Key: string
CodeGroupKey: string
OwnBranch:
Key: string
CodeGroupKey: string
ServiceGrade:
Key: string
CodeGroupKey: string
UnitType:
Key: string
CodeGroupKey: string
Active: true
Segment:
Key: string
CodeGroupKey: string
SubSegment:
Key: string
CodeGroupKey: string
Rating:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Region:
Key: string
CodeGroupKey: string
Type:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
EmployeeCountRange:
Key: string
CodeGroupKey: string
PrimaryEmailAddress: string
PrimaryPhoneNumber: string
WebSite: string
PrimaryAddressRow: string
PrimaryCity: string
PrimaryZipCode: string
PrimaryCounty: string
PrimaryCountryId:
- 0
PrimaryCommunicationCategory: unknown
Longitude: 0.1
Latitude: 0.1
UnitNo: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Company>
<Name>string</Name>
<EmployeeCount>0</EmployeeCount>
<CustomerNumber>string</CustomerNumber>
<OrganisationalNumber>string</OrganisationalNumber>
<CorporateGroup>string</CorporateGroup>
<Unit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Unit>
<Branch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Branch>
<OwnBranch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</OwnBranch>
<ServiceGrade>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</ServiceGrade>
<UnitType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</UnitType>
<Active>true</Active>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Segment>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</SubSegment>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Rating>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Region>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Region>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<EmployeeCountRange>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</EmployeeCountRange>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<UnitNo>string</UnitNo>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Company>

Parameters

Name In Type Required Description
body body Company true none

Example responses

200 Response

{
"Name": "string",
"EmployeeCount": 0,
"CustomerNumber": "string",
"OrganisationalNumber": "string",
"CorporateGroup": "string",
"Unit": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Branch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"OwnBranch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ServiceGrade": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"UnitType": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Active": true,
"Segment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Region": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"EmployeeCountRange": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow1": "string",
"PrimaryAddressRow2": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"IsNew": true,
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"HasDocument": true,
"TagCount": 0,
"Longitude": 0.1,
"Latitude": 0.1,
"LoginStatus": "noLogin",
"UnitNo": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Company>
<Name>string</Name>
<EmployeeCount>0</EmployeeCount>
<CustomerNumber>string</CustomerNumber>
<OrganisationalNumber>string</OrganisationalNumber>
<CorporateGroup>string</CorporateGroup>
<Unit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Unit>
<Branch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Branch>
<OwnBranch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</OwnBranch>
<ServiceGrade>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</ServiceGrade>
<UnitType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</UnitType>
<Active>true</Active>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Segment>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubSegment>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Rating>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Region>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Region>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<EmployeeCountRange>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</EmployeeCountRange>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow1>string</PrimaryAddressRow1>
<PrimaryAddressRow2>string</PrimaryAddressRow2>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<IsNew>true</IsNew>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Responsible>string</Responsible>
<HasDocument>true</HasDocument>
<TagCount>0</TagCount>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<LoginStatus>noLogin</LoginStatus>
<UnitNo>string</UnitNo>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Company>

Responses

Status Meaning Description Schema
200 OK Entity Updated Company
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create Company

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","EmployeeCount":0,"CustomerNumber":"string","OrganisationalNumber":"string","CorporateGroup":"string","Unit":{"Key":"string","CodeGroupKey":"string"},"Branch":{"Key":"string","CodeGroupKey":"string"},"OwnBranch":{"Key":"string","CodeGroupKey":"string"},"ServiceGrade":{"Key":"string","CodeGroupKey":"string"},"UnitType":{"Key":"string","CodeGroupKey":"string"},"Active":true,"Segment":{"Key":"string","CodeGroupKey":"string"},"SubSegment":{"Key":"string","CodeGroupKey":"string"},"Rating":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Region":{"Key":"string","CodeGroupKey":"string"},"Type":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"EmployeeCountRange":{"Key":"string","CodeGroupKey":"string"},"PrimaryEmailAddress":"string","PrimaryPhoneNumber":"string","WebSite":"string","PrimaryAddressRow":"string","PrimaryCity":"string","PrimaryZipCode":"string","PrimaryCounty":"string","PrimaryCountryId":[0],"PrimaryCommunicationCategory":"unknown","Longitude":0.1,"Latitude":0.1,"UnitNo":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"EmployeeCount\":0,\"CustomerNumber\":\"string\",\"OrganisationalNumber\":\"string\",\"CorporateGroup\":\"string\",\"Unit\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Branch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"OwnBranch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ServiceGrade\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"UnitType\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Active\":true,\"Segment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubSegment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Rating\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Region\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"EmployeeCountRange\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Longitude\":0.1,\"Latitude\":0.1,\"UnitNo\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"EmployeeCount\":0,\"CustomerNumber\":\"string\",\"OrganisationalNumber\":\"string\",\"CorporateGroup\":\"string\",\"Unit\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Branch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"OwnBranch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ServiceGrade\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"UnitType\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Active\":true,\"Segment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubSegment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Rating\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Region\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"EmployeeCountRange\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Longitude\":0.1,\"Latitude\":0.1,\"UnitNo\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company

Body parameter

{
"Name": "string",
"EmployeeCount": 0,
"CustomerNumber": "string",
"OrganisationalNumber": "string",
"CorporateGroup": "string",
"Unit": {
"Key": "string",
"CodeGroupKey": "string"
},
"Branch": {
"Key": "string",
"CodeGroupKey": "string"
},
"OwnBranch": {
"Key": "string",
"CodeGroupKey": "string"
},
"ServiceGrade": {
"Key": "string",
"CodeGroupKey": "string"
},
"UnitType": {
"Key": "string",
"CodeGroupKey": "string"
},
"Active": true,
"Segment": {
"Key": "string",
"CodeGroupKey": "string"
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string"
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Region": {
"Key": "string",
"CodeGroupKey": "string"
},
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"EmployeeCountRange": {
"Key": "string",
"CodeGroupKey": "string"
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Longitude": 0.1,
"Latitude": 0.1,
"UnitNo": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
EmployeeCount: 0
CustomerNumber: string
OrganisationalNumber: string
CorporateGroup: string
Unit:
Key: string
CodeGroupKey: string
Branch:
Key: string
CodeGroupKey: string
OwnBranch:
Key: string
CodeGroupKey: string
ServiceGrade:
Key: string
CodeGroupKey: string
UnitType:
Key: string
CodeGroupKey: string
Active: true
Segment:
Key: string
CodeGroupKey: string
SubSegment:
Key: string
CodeGroupKey: string
Rating:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Region:
Key: string
CodeGroupKey: string
Type:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
EmployeeCountRange:
Key: string
CodeGroupKey: string
PrimaryEmailAddress: string
PrimaryPhoneNumber: string
WebSite: string
PrimaryAddressRow: string
PrimaryCity: string
PrimaryZipCode: string
PrimaryCounty: string
PrimaryCountryId:
- 0
PrimaryCommunicationCategory: unknown
Longitude: 0.1
Latitude: 0.1
UnitNo: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Company>
<Name>string</Name>
<EmployeeCount>0</EmployeeCount>
<CustomerNumber>string</CustomerNumber>
<OrganisationalNumber>string</OrganisationalNumber>
<CorporateGroup>string</CorporateGroup>
<Unit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Unit>
<Branch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Branch>
<OwnBranch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</OwnBranch>
<ServiceGrade>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</ServiceGrade>
<UnitType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</UnitType>
<Active>true</Active>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Segment>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</SubSegment>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Rating>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Region>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Region>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<EmployeeCountRange>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</EmployeeCountRange>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<UnitNo>string</UnitNo>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Company>

Parameters

Name In Type Required Description
body body Company true none

Example responses

201 Response

{
"Name": "string",
"EmployeeCount": 0,
"CustomerNumber": "string",
"OrganisationalNumber": "string",
"CorporateGroup": "string",
"Unit": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Branch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"OwnBranch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ServiceGrade": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"UnitType": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Active": true,
"Segment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Region": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"EmployeeCountRange": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow1": "string",
"PrimaryAddressRow2": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"IsNew": true,
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"HasDocument": true,
"TagCount": 0,
"Longitude": 0.1,
"Latitude": 0.1,
"LoginStatus": "noLogin",
"UnitNo": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Company>
<Name>string</Name>
<EmployeeCount>0</EmployeeCount>
<CustomerNumber>string</CustomerNumber>
<OrganisationalNumber>string</OrganisationalNumber>
<CorporateGroup>string</CorporateGroup>
<Unit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Unit>
<Branch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Branch>
<OwnBranch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</OwnBranch>
<ServiceGrade>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</ServiceGrade>
<UnitType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</UnitType>
<Active>true</Active>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Segment>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubSegment>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Rating>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Region>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Region>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<EmployeeCountRange>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</EmployeeCountRange>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow1>string</PrimaryAddressRow1>
<PrimaryAddressRow2>string</PrimaryAddressRow2>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<IsNew>true</IsNew>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Responsible>string</Responsible>
<HasDocument>true</HasDocument>
<TagCount>0</TagCount>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<LoginStatus>noLogin</LoginStatus>
<UnitNo>string</UnitNo>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Company>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created Company
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for Company

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to Company

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Company Relations

Relations related to Company

More information

Filter PrivatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/string/PrivatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/PrivatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/PrivatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/PrivatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/PrivatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/PrivatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to PrivatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Company/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/PrivatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/PrivatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Company/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyPrivatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to PrivatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/PrivatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/PrivatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyPrivatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete PrivatePerson relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Company/string/PrivatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/string/PrivatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/PrivatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Company/{id}/PrivatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter CorporatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/CorporatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/string/CorporatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/CorporatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/CorporatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/CorporatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/CorporatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/CorporatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/CorporatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to CorporatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Company/string/CorporatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/CorporatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/CorporatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Company/{id}/CorporatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCorporatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyCorporatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCorporatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyCorporatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to CorporatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/CorporatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/CorporatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/CorporatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/CorporatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCorporatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyCorporatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCorporatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyCorporatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete CorporatePerson relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Company/string/CorporatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/string/CorporatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/CorporatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Company/{id}/CorporatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter RelatedToCompanies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/RelatedToCompanies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/string/RelatedToCompanies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/RelatedToCompanies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/RelatedToCompanies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/RelatedToCompanies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/RelatedToCompanies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/RelatedToCompanies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/RelatedToCompanies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Filter RelatedFromCompanies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/RelatedFromCompanies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/string/RelatedFromCompanies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/RelatedFromCompanies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/RelatedFromCompanies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/RelatedFromCompanies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/RelatedFromCompanies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/RelatedFromCompanies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/RelatedFromCompanies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Filter Groups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/Groups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/string/Groups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Groups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/Groups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/Groups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/Groups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/Groups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/Groups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to CompanyGroup

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Company/string/Groups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/Groups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Groups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Company/{id}/Groups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyCompanyGroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to CompanyGroup

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/Groups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/Groups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Groups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/Groups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyCompanyGroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete CompanyGroup relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Company/string/Groups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/string/Groups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Groups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Company/{id}/Groups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter MarketingProjects based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/string/MarketingProjects/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/MarketingProjects/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/MarketingProjects/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/MarketingProjects/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/MarketingProjects/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/MarketingProjects/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to MarketingProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Company/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/MarketingProjects", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/MarketingProjects");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Company/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyMarketingProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyMarketingProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyMarketingProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyMarketingProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to MarketingProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/MarketingProjects", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/MarketingProjects");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyMarketingProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyMarketingProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyMarketingProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyMarketingProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete MarketingProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Company/string/MarketingProjects/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/string/MarketingProjects/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/MarketingProjects/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Company/{id}/MarketingProjects/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Cases based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/string/Cases/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Cases/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/Cases/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/Cases/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/Cases/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/Cases/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Case

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Company/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/Cases", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Cases");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Company/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Case

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/Cases", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Cases");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Case relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Company/string/Cases/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/string/Cases/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Cases/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Company/{id}/Cases/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Products based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/Products/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/string/Products/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Products/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/Products/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/Products/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/Products/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/Products/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/Products/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Product

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Company/string/Products \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/Products", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Products");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Company/{id}/Products

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyProductRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyProductRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyProductRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyProductRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyProductRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyProductRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Product

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/Products \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/Products", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Products");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/Products

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyProductRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyProductRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyProductRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyProductRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyProductRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyProductRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Product relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Company/string/Products/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/string/Products/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Products/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Company/{id}/Products/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Responsibles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/string/Responsibles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Responsibles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/Responsibles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/Responsibles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/Responsibles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/Responsibles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Filter Activities based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/Activities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/string/Activities/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Activities/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/Activities/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/Activities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/Activities/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/Activities/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/Activities/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Activity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Company/string/Activities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/Activities", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Activities");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Company/{id}/Activities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Activity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/Activities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/Activities", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Activities");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/Activities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Activity relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Company/string/Activities/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/string/Activities/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Activities/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Company/{id}/Activities/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter BusinessProjects based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/BusinessProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/string/BusinessProjects/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/BusinessProjects/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/BusinessProjects/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/BusinessProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/BusinessProjects/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/BusinessProjects/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/BusinessProjects/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to BusinessProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Company/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/Deals", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Deals");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Company/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<BusinessProjectCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</BusinessProjectCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body BusinessProjectCompanyRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<BusinessProjectCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</BusinessProjectCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated BusinessProjectCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to BusinessProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Company/string/Deals", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Deals");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<BusinessProjectCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</BusinessProjectCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body BusinessProjectCompanyRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<BusinessProjectCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</BusinessProjectCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created BusinessProjectCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete BusinessProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Company/string/Deals/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/string/Deals/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Deals/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Company/{id}/Deals/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Deals based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Company/string/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Company/string/Deals/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/string/Deals/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Company/{id}/Deals/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Company/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Company/Deals/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Company/Deals/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Company/Deals/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

AppointmentActivity

Retreive filtrable fields and their type for AppointmentActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter AppointmentActivity based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get AppointmentActivity by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"IsNew": true,
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Duration": "string",
"WorkedTime": 0.1,
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Response": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryContactPhoneNumber": "string",
"PrimaryContact": "string",
"TimeSpan": "string",
"IsDone": true,
"Location": "string",
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"IsPositive": true,
"TagCount": 0,
"IsSyncedToExchange": true,
"SendUpdates": true,
"IsExchangeActivity": true,
"ExchangeId": "string",
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ExchangeMailbox": "string",
"AllDayEvent": true,
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"CreatedBy": "string",
"UpdatedBy": "string",
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<AppointmentActivity>
<IsNew>true</IsNew>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Duration>string</Duration>
<WorkedTime>0.1</WorkedTime>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubCategory>
<Response>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Response>
<PrimaryContactPhoneNumber>string</PrimaryContactPhoneNumber>
<PrimaryContact>string</PrimaryContact>
<TimeSpan>string</TimeSpan>
<IsDone>true</IsDone>
<Location>string</Location>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<IsPositive>true</IsPositive>
<TagCount>0</TagCount>
<IsSyncedToExchange>true</IsSyncedToExchange>
<SendUpdates>true</SendUpdates>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeId>string</ExchangeId>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<ExchangeMailbox>string</ExchangeMailbox>
<AllDayEvent>true</AllDayEvent>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</AppointmentActivity>

Responses

Status Meaning Description Schema
200 OK Success AppointmentActivity
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete AppointmentActivity by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /AppointmentActivity/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update AppointmentActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/AppointmentActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Subject":"string","Start":"2019-08-24T14:15:22Z","End":"2019-08-24T14:15:22Z","WorkedTime":0.1,"Status":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"SubCategory":{"Key":"string","CodeGroupKey":"string"},"Response":{"Key":"string","CodeGroupKey":"string"},"IsDone":true,"Location":"string","Longitude":0.1,"Latitude":0.1,"Responsible":["00000000-0000-0000-0000-000000000000"],"IsExchangeActivity":true,"ExchangeId":"string","ExchangeSyncDate":"2019-08-24T14:15:22Z","ExchangeMailbox":"string","AllDayEvent":true,"PrivatePerson":["00000000-0000-0000-0000-000000000000"],"CorporatePerson":["00000000-0000-0000-0000-000000000000"],"Company":["00000000-0000-0000-0000-000000000000"],"Description":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"WorkedTime\":0.1,\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubCategory\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Response\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Location\":\"string\",\"Longitude\":0.1,\"Latitude\":0.1,\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"IsExchangeActivity\":true,\"ExchangeId\":\"string\",\"ExchangeSyncDate\":\"2019-08-24T14:15:22Z\",\"ExchangeMailbox\":\"string\",\"AllDayEvent\":true,\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"WorkedTime\":0.1,\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubCategory\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Response\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Location\":\"string\",\"Longitude\":0.1,\"Latitude\":0.1,\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"IsExchangeActivity\":true,\"ExchangeId\":\"string\",\"ExchangeSyncDate\":\"2019-08-24T14:15:22Z\",\"ExchangeMailbox\":\"string\",\"AllDayEvent\":true,\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /AppointmentActivity

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"WorkedTime": 0.1,
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string"
},
"Response": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsDone": true,
"Location": "string",
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"IsExchangeActivity": true,
"ExchangeId": "string",
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ExchangeMailbox": "string",
"AllDayEvent": true,
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Subject: string
Start: 2019-08-24T14:15:22Z
End: 2019-08-24T14:15:22Z
WorkedTime: 0.1
Status:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
SubCategory:
Key: string
CodeGroupKey: string
Response:
Key: string
CodeGroupKey: string
IsDone: true
Location: string
Longitude: 0.1
Latitude: 0.1
Responsible:
- 00000000-0000-0000-0000-000000000000
IsExchangeActivity: true
ExchangeId: string
ExchangeSyncDate: 2019-08-24T14:15:22Z
ExchangeMailbox: string
AllDayEvent: true
PrivatePerson:
- 00000000-0000-0000-0000-000000000000
CorporatePerson:
- 00000000-0000-0000-0000-000000000000
Company:
- 00000000-0000-0000-0000-000000000000
Description: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<AppointmentActivity>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<WorkedTime>0.1</WorkedTime>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</SubCategory>
<Response>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Response>
<IsDone>true</IsDone>
<Location>string</Location>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeId>string</ExchangeId>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<ExchangeMailbox>string</ExchangeMailbox>
<AllDayEvent>true</AllDayEvent>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</AppointmentActivity>

Parameters

Name In Type Required Description
body body AppointmentActivity true none

Example responses

200 Response

{
"IsNew": true,
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Duration": "string",
"WorkedTime": 0.1,
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Response": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryContactPhoneNumber": "string",
"PrimaryContact": "string",
"TimeSpan": "string",
"IsDone": true,
"Location": "string",
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"IsPositive": true,
"TagCount": 0,
"IsSyncedToExchange": true,
"SendUpdates": true,
"IsExchangeActivity": true,
"ExchangeId": "string",
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ExchangeMailbox": "string",
"AllDayEvent": true,
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"CreatedBy": "string",
"UpdatedBy": "string",
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<AppointmentActivity>
<IsNew>true</IsNew>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Duration>string</Duration>
<WorkedTime>0.1</WorkedTime>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubCategory>
<Response>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Response>
<PrimaryContactPhoneNumber>string</PrimaryContactPhoneNumber>
<PrimaryContact>string</PrimaryContact>
<TimeSpan>string</TimeSpan>
<IsDone>true</IsDone>
<Location>string</Location>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<IsPositive>true</IsPositive>
<TagCount>0</TagCount>
<IsSyncedToExchange>true</IsSyncedToExchange>
<SendUpdates>true</SendUpdates>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeId>string</ExchangeId>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<ExchangeMailbox>string</ExchangeMailbox>
<AllDayEvent>true</AllDayEvent>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</AppointmentActivity>

Responses

Status Meaning Description Schema
200 OK Entity Updated AppointmentActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create AppointmentActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Subject":"string","Start":"2019-08-24T14:15:22Z","End":"2019-08-24T14:15:22Z","WorkedTime":0.1,"Status":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"SubCategory":{"Key":"string","CodeGroupKey":"string"},"Response":{"Key":"string","CodeGroupKey":"string"},"IsDone":true,"Location":"string","Longitude":0.1,"Latitude":0.1,"Responsible":["00000000-0000-0000-0000-000000000000"],"IsExchangeActivity":true,"ExchangeId":"string","ExchangeSyncDate":"2019-08-24T14:15:22Z","ExchangeMailbox":"string","AllDayEvent":true,"PrivatePerson":["00000000-0000-0000-0000-000000000000"],"CorporatePerson":["00000000-0000-0000-0000-000000000000"],"Company":["00000000-0000-0000-0000-000000000000"],"Description":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"WorkedTime\":0.1,\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubCategory\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Response\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Location\":\"string\",\"Longitude\":0.1,\"Latitude\":0.1,\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"IsExchangeActivity\":true,\"ExchangeId\":\"string\",\"ExchangeSyncDate\":\"2019-08-24T14:15:22Z\",\"ExchangeMailbox\":\"string\",\"AllDayEvent\":true,\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"WorkedTime\":0.1,\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubCategory\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Response\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Location\":\"string\",\"Longitude\":0.1,\"Latitude\":0.1,\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"IsExchangeActivity\":true,\"ExchangeId\":\"string\",\"ExchangeSyncDate\":\"2019-08-24T14:15:22Z\",\"ExchangeMailbox\":\"string\",\"AllDayEvent\":true,\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity

Body parameter

{
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"WorkedTime": 0.1,
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string"
},
"Response": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsDone": true,
"Location": "string",
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"IsExchangeActivity": true,
"ExchangeId": "string",
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ExchangeMailbox": "string",
"AllDayEvent": true,
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Subject: string
Start: 2019-08-24T14:15:22Z
End: 2019-08-24T14:15:22Z
WorkedTime: 0.1
Status:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
SubCategory:
Key: string
CodeGroupKey: string
Response:
Key: string
CodeGroupKey: string
IsDone: true
Location: string
Longitude: 0.1
Latitude: 0.1
Responsible:
- 00000000-0000-0000-0000-000000000000
IsExchangeActivity: true
ExchangeId: string
ExchangeSyncDate: 2019-08-24T14:15:22Z
ExchangeMailbox: string
AllDayEvent: true
PrivatePerson:
- 00000000-0000-0000-0000-000000000000
CorporatePerson:
- 00000000-0000-0000-0000-000000000000
Company:
- 00000000-0000-0000-0000-000000000000
Description: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<AppointmentActivity>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<WorkedTime>0.1</WorkedTime>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</SubCategory>
<Response>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Response>
<IsDone>true</IsDone>
<Location>string</Location>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeId>string</ExchangeId>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<ExchangeMailbox>string</ExchangeMailbox>
<AllDayEvent>true</AllDayEvent>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</AppointmentActivity>

Parameters

Name In Type Required Description
body body AppointmentActivity true none

Example responses

201 Response

{
"IsNew": true,
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Duration": "string",
"WorkedTime": 0.1,
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Response": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryContactPhoneNumber": "string",
"PrimaryContact": "string",
"TimeSpan": "string",
"IsDone": true,
"Location": "string",
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"IsPositive": true,
"TagCount": 0,
"IsSyncedToExchange": true,
"SendUpdates": true,
"IsExchangeActivity": true,
"ExchangeId": "string",
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ExchangeMailbox": "string",
"AllDayEvent": true,
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"CreatedBy": "string",
"UpdatedBy": "string",
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<AppointmentActivity>
<IsNew>true</IsNew>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Duration>string</Duration>
<WorkedTime>0.1</WorkedTime>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubCategory>
<Response>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Response>
<PrimaryContactPhoneNumber>string</PrimaryContactPhoneNumber>
<PrimaryContact>string</PrimaryContact>
<TimeSpan>string</TimeSpan>
<IsDone>true</IsDone>
<Location>string</Location>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<IsPositive>true</IsPositive>
<TagCount>0</TagCount>
<IsSyncedToExchange>true</IsSyncedToExchange>
<SendUpdates>true</SendUpdates>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeId>string</ExchangeId>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<ExchangeMailbox>string</ExchangeMailbox>
<AllDayEvent>true</AllDayEvent>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</AppointmentActivity>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created AppointmentActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for AppointmentActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to AppointmentActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

AppointmentActivity Relations

Filter Cases based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Cases/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Cases/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/Cases/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/Cases/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/Cases/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/Cases/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Case

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Cases", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Cases");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /AppointmentActivity/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Case

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Cases", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Cases");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Case relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Cases/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Cases/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Cases/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /AppointmentActivity/{id}/Cases/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Responsibles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Responsibles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Responsibles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/Responsibles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/Responsibles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/Responsibles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/Responsibles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to User

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Responsibles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Responsibles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /AppointmentActivity/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUserRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityUserRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to User

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Responsibles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Responsibles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUserRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityUserRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete User relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Responsibles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Responsibles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Responsibles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /AppointmentActivity/{id}/Responsibles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Companies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Companies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Companies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/Companies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/Companies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/Companies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/Companies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Company

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Companies", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Companies");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /AppointmentActivity/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Company

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Companies", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Companies");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Company relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Companies/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Companies/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Companies/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /AppointmentActivity/{id}/Companies/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter CompanyGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/CompanyGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/CompanyGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/CompanyGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/CompanyGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/CompanyGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/CompanyGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to CompanyGroup

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/CompanyGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/CompanyGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /AppointmentActivity/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyGroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to CompanyGroup

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/CompanyGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/CompanyGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyGroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete CompanyGroup relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/CompanyGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/CompanyGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/CompanyGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /AppointmentActivity/{id}/CompanyGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Deals based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Deals/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Deals/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/Deals/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/Deals/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/Deals/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/Deals/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to BusinessProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Deals", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Deals");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /AppointmentActivity/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityBusinessProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityBusinessProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to BusinessProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Deals", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Deals");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityBusinessProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityBusinessProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete BusinessProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Deals/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Deals/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Deals/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /AppointmentActivity/{id}/Deals/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter PrivatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/PrivatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/PrivatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/PrivatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/PrivatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/PrivatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/PrivatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to PrivatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/PrivatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/PrivatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /AppointmentActivity/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityPrivatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to PrivatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/PrivatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/PrivatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityPrivatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete PrivatePerson relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/PrivatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/PrivatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/PrivatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /AppointmentActivity/{id}/PrivatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter MarketingActivities based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingActivities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingActivities/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingActivities/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/MarketingActivities/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/MarketingActivities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/MarketingActivities/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/MarketingActivities/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/MarketingActivities/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to MarketingActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingActivities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingActivities", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingActivities");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /AppointmentActivity/{id}/MarketingActivities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityMarketingActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to MarketingActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingActivities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingActivities", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingActivities");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/MarketingActivities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityMarketingActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete MarketingActivity relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingActivities/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingActivities/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingActivities/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /AppointmentActivity/{id}/MarketingActivities/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter MarketingProjects based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingProjects/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingProjects/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/MarketingProjects/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/MarketingProjects/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/MarketingProjects/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/MarketingProjects/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to MarketingProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingProjects", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingProjects");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /AppointmentActivity/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityMarketingProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to MarketingProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingProjects", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingProjects");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityMarketingProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete MarketingProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingProjects/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingProjects/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/MarketingProjects/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /AppointmentActivity/{id}/MarketingProjects/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Workorders based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Workorders/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Workorders/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Workorders/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/Workorders/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/Workorders/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/Workorders/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/Workorders/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/Workorders/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Workorder

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Workorders \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Workorders", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Workorders");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /AppointmentActivity/{id}/Workorders

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Workorder

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Workorders \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Workorders", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Workorders");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/Workorders

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Workorder relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Workorders/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Workorders/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Workorders/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /AppointmentActivity/{id}/Workorders/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ResponsibleUserGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/ResponsibleUserGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/ResponsibleUserGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/ResponsibleUserGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/ResponsibleUserGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/ResponsibleUserGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/ResponsibleUserGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/ResponsibleUserGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/ResponsibleUserGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Group

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/ResponsibleUserGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/ResponsibleUserGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/ResponsibleUserGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /AppointmentActivity/{id}/ResponsibleUserGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUsergroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityUsergroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Group

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/ResponsibleUserGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/ResponsibleUserGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/ResponsibleUserGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/ResponsibleUserGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUsergroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityUsergroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Group relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/ResponsibleUserGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/ResponsibleUserGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/ResponsibleUserGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /AppointmentActivity/{id}/ResponsibleUserGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ServiceArticles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/ServiceArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/ServiceArticles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/ServiceArticles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/ServiceArticles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/ServiceArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/ServiceArticles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/ServiceArticles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/ServiceArticles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Article

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Articles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Articles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Articles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /AppointmentActivity/{id}/Articles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ArticleActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Article

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Articles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Articles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Articles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/Articles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ArticleActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Article relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Articles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Articles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Articles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /AppointmentActivity/{id}/Articles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ProductArticles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/ProductArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/ProductArticles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/ProductArticles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/ProductArticles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/ProductArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/ProductArticles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/ProductArticles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/ProductArticles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Filter Articles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/AppointmentActivity/string/Articles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/string/Articles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/string/Articles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /AppointmentActivity/{id}/Articles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/AppointmentActivity/Articles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/AppointmentActivity/Articles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/AppointmentActivity/Articles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /AppointmentActivity/Articles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Article

Retreive filtrable fields and their type for Article

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Article/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Article/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Article/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter Article based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Article/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Article/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Article/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get Article by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Article/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Article/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Article/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Name": "string",
"Number": "string",
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Active": true,
"Key": "string",
"IsNew": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Subtype": "string",
"CategoryId": "00000000-0000-0000-0000-000000000000",
"Category": [
"00000000-0000-0000-0000-000000000000"
],
"Price": 0.1,
"BillingFrequency": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Unit": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ProductGroup": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Currency": {
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
},
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Article>
<Name>string</Name>
<Number>string</Number>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Active>true</Active>
<Key>string</Key>
<IsNew>true</IsNew>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Subtype>string</Subtype>
<CategoryId>00000000-0000-0000-0000-000000000000</CategoryId>
<Category>00000000-0000-0000-0000-000000000000</Category>
<Price>0.1</Price>
<BillingFrequency>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</BillingFrequency>
<Unit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Unit>
<ProductGroup>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</ProductGroup>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Article>

Responses

Status Meaning Description Schema
200 OK Success Article
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete Article by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Article/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Article/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Article/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update Article

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Article \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Number":"string","Type":{"Key":"string","CodeGroupKey":"string"},"Active":true,"Key":"string","Subtype":"string","CategoryId":"00000000-0000-0000-0000-000000000000","Price":0.1,"BillingFrequency":{"Key":"string","CodeGroupKey":"string"},"Unit":{"Key":"string","CodeGroupKey":"string"},"ProductGroup":{"Key":"string","CodeGroupKey":"string"},"Currency":{"Name":"string","IsSystem":true,"Rate":0.1,"Id":"00000000-0000-0000-0000-000000000000"},"Description":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Article", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Number\":\"string\",\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Active\":true,\"Key\":\"string\",\"Subtype\":\"string\",\"CategoryId\":\"00000000-0000-0000-0000-000000000000\",\"Price\":0.1,\"BillingFrequency\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Unit\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ProductGroup\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Currency\":{\"Name\":\"string\",\"IsSystem\":true,\"Rate\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"},\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Number\":\"string\",\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Active\":true,\"Key\":\"string\",\"Subtype\":\"string\",\"CategoryId\":\"00000000-0000-0000-0000-000000000000\",\"Price\":0.1,\"BillingFrequency\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Unit\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ProductGroup\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Currency\":{\"Name\":\"string\",\"IsSystem\":true,\"Rate\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"},\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Article

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Name": "string",
"Number": "string",
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Active": true,
"Key": "string",
"Subtype": "string",
"CategoryId": "00000000-0000-0000-0000-000000000000",
"Price": 0.1,
"BillingFrequency": {
"Key": "string",
"CodeGroupKey": "string"
},
"Unit": {
"Key": "string",
"CodeGroupKey": "string"
},
"ProductGroup": {
"Key": "string",
"CodeGroupKey": "string"
},
"Currency": {
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
},
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Number: string
Type:
Key: string
CodeGroupKey: string
Active: true
Key: string
Subtype: string
CategoryId: 00000000-0000-0000-0000-000000000000
Price: 0.1
BillingFrequency:
Key: string
CodeGroupKey: string
Unit:
Key: string
CodeGroupKey: string
ProductGroup:
Key: string
CodeGroupKey: string
Currency:
Name: string
IsSystem: true
Rate: 0.1
Id: 00000000-0000-0000-0000-000000000000
Description: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Article>
<Name>string</Name>
<Number>string</Number>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Active>true</Active>
<Key>string</Key>
<Subtype>string</Subtype>
<CategoryId>00000000-0000-0000-0000-000000000000</CategoryId>
<Price>0.1</Price>
<BillingFrequency>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</BillingFrequency>
<Unit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Unit>
<ProductGroup>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</ProductGroup>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Article>

Parameters

Name In Type Required Description
body body Article true none

Example responses

200 Response

{
"Name": "string",
"Number": "string",
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Active": true,
"Key": "string",
"IsNew": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Subtype": "string",
"CategoryId": "00000000-0000-0000-0000-000000000000",
"Category": [
"00000000-0000-0000-0000-000000000000"
],
"Price": 0.1,
"BillingFrequency": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Unit": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ProductGroup": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Currency": {
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
},
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Article>
<Name>string</Name>
<Number>string</Number>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Active>true</Active>
<Key>string</Key>
<IsNew>true</IsNew>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Subtype>string</Subtype>
<CategoryId>00000000-0000-0000-0000-000000000000</CategoryId>
<Category>00000000-0000-0000-0000-000000000000</Category>
<Price>0.1</Price>
<BillingFrequency>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</BillingFrequency>
<Unit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Unit>
<ProductGroup>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</ProductGroup>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Article>

Responses

Status Meaning Description Schema
200 OK Entity Updated Article
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create Article

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Article \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Number":"string","Type":{"Key":"string","CodeGroupKey":"string"},"Active":true,"Key":"string","Subtype":"string","CategoryId":"00000000-0000-0000-0000-000000000000","Price":0.1,"BillingFrequency":{"Key":"string","CodeGroupKey":"string"},"Unit":{"Key":"string","CodeGroupKey":"string"},"ProductGroup":{"Key":"string","CodeGroupKey":"string"},"Currency":{"Name":"string","IsSystem":true,"Rate":0.1,"Id":"00000000-0000-0000-0000-000000000000"},"Description":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Article", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Number\":\"string\",\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Active\":true,\"Key\":\"string\",\"Subtype\":\"string\",\"CategoryId\":\"00000000-0000-0000-0000-000000000000\",\"Price\":0.1,\"BillingFrequency\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Unit\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ProductGroup\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Currency\":{\"Name\":\"string\",\"IsSystem\":true,\"Rate\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"},\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Number\":\"string\",\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Active\":true,\"Key\":\"string\",\"Subtype\":\"string\",\"CategoryId\":\"00000000-0000-0000-0000-000000000000\",\"Price\":0.1,\"BillingFrequency\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Unit\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ProductGroup\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Currency\":{\"Name\":\"string\",\"IsSystem\":true,\"Rate\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"},\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Article

Body parameter

{
"Name": "string",
"Number": "string",
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Active": true,
"Key": "string",
"Subtype": "string",
"CategoryId": "00000000-0000-0000-0000-000000000000",
"Price": 0.1,
"BillingFrequency": {
"Key": "string",
"CodeGroupKey": "string"
},
"Unit": {
"Key": "string",
"CodeGroupKey": "string"
},
"ProductGroup": {
"Key": "string",
"CodeGroupKey": "string"
},
"Currency": {
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
},
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Number: string
Type:
Key: string
CodeGroupKey: string
Active: true
Key: string
Subtype: string
CategoryId: 00000000-0000-0000-0000-000000000000
Price: 0.1
BillingFrequency:
Key: string
CodeGroupKey: string
Unit:
Key: string
CodeGroupKey: string
ProductGroup:
Key: string
CodeGroupKey: string
Currency:
Name: string
IsSystem: true
Rate: 0.1
Id: 00000000-0000-0000-0000-000000000000
Description: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Article>
<Name>string</Name>
<Number>string</Number>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Active>true</Active>
<Key>string</Key>
<Subtype>string</Subtype>
<CategoryId>00000000-0000-0000-0000-000000000000</CategoryId>
<Price>0.1</Price>
<BillingFrequency>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</BillingFrequency>
<Unit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Unit>
<ProductGroup>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</ProductGroup>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Article>

Parameters

Name In Type Required Description
body body Article true none

Example responses

201 Response

{
"Name": "string",
"Number": "string",
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Active": true,
"Key": "string",
"IsNew": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Subtype": "string",
"CategoryId": "00000000-0000-0000-0000-000000000000",
"Category": [
"00000000-0000-0000-0000-000000000000"
],
"Price": 0.1,
"BillingFrequency": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Unit": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ProductGroup": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Currency": {
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
},
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Article>
<Name>string</Name>
<Number>string</Number>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Active>true</Active>
<Key>string</Key>
<IsNew>true</IsNew>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Subtype>string</Subtype>
<CategoryId>00000000-0000-0000-0000-000000000000</CategoryId>
<Category>00000000-0000-0000-0000-000000000000</Category>
<Price>0.1</Price>
<BillingFrequency>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</BillingFrequency>
<Unit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Unit>
<ProductGroup>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</ProductGroup>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Article>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created Article
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for Article

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Article/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Article/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Article/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to Article

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Article/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Article/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Article/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Article Relations

Filter Projects based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Article/string/Projects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Article/string/Projects/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/string/Projects/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Article/{id}/Projects/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Retreive filtrable fields and their type for Projects related to Article

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Article/Projects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Article/Projects/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/Projects/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Article/Projects/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Updates the relation to Project

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Article/string/Projects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Article/string/Projects", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/string/Projects");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Article/{id}/Projects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ArticleProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Project

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Article/string/Projects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Article/string/Projects", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/string/Projects");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Article/{id}/Projects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ArticleProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Project relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Article/string/Projects/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Article/string/Projects/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/string/Projects/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Article/{id}/Projects/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Companies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Article/string/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Article/string/Companies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/string/Companies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Article/{id}/Companies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Retreive filtrable fields and their type for Companies related to Article

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Article/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Article/Companies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/Companies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Article/Companies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Updates the relation to Company

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Article/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Article/string/Companies", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/string/Companies");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Article/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleCompanyRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ArticleCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Company

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Article/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Article/string/Companies", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/string/Companies");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Article/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleCompanyRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ArticleCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Company relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Article/string/Companies/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Article/string/Companies/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Article/string/Companies/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Article/{id}/Companies/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

CompanyGroup

Retreive filtrable fields and their type for CompanyGroup

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CompanyGroup/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CompanyGroup/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter CompanyGroup based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CompanyGroup/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CompanyGroup/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get CompanyGroup by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CompanyGroup/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CompanyGroup/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"IsNew": true,
"Name": "string",
"OrganisationalNumber": "string",
"Active": true,
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Segment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Region": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Branch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"OwnBranch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow1": "string",
"PrimaryAddressRow2": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"HasDocument": true,
"MainContactId": "00000000-0000-0000-0000-000000000000",
"MainContact": "string",
"MainContactPrimaryMobilePhone": "string",
"MainContactPrimaryPhone": "string",
"MainContactPrimaryEmail": "string",
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"Longitude": 0.1,
"Latitude": 0.1,
"TagCount": 0,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroup>
<IsNew>true</IsNew>
<Name>string</Name>
<OrganisationalNumber>string</OrganisationalNumber>
<Active>true</Active>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Segment>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubSegment>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Rating>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Region>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Region>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Branch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Branch>
<OwnBranch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</OwnBranch>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow1>string</PrimaryAddressRow1>
<PrimaryAddressRow2>string</PrimaryAddressRow2>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<HasDocument>true</HasDocument>
<MainContactId>00000000-0000-0000-0000-000000000000</MainContactId>
<MainContact>string</MainContact>
<MainContactPrimaryMobilePhone>string</MainContactPrimaryMobilePhone>
<MainContactPrimaryPhone>string</MainContactPrimaryPhone>
<MainContactPrimaryEmail>string</MainContactPrimaryEmail>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Responsible>string</Responsible>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<TagCount>0</TagCount>
<Id>00000000-0000-0000-0000-000000000000</Id>
</CompanyGroup>

Responses

Status Meaning Description Schema
200 OK Success CompanyGroup
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete CompanyGroup by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/CompanyGroup/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /CompanyGroup/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update CompanyGroup

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/CompanyGroup \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","OrganisationalNumber":"string","Active":true,"Type":{"Key":"string","CodeGroupKey":"string"},"Segment":{"Key":"string","CodeGroupKey":"string"},"SubSegment":{"Key":"string","CodeGroupKey":"string"},"Rating":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Region":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Branch":{"Key":"string","CodeGroupKey":"string"},"OwnBranch":{"Key":"string","CodeGroupKey":"string"},"PrimaryEmailAddress":"string","PrimaryPhoneNumber":"string","WebSite":"string","PrimaryAddress":"string","PrimaryAddressRow":"string","PrimaryCity":"string","PrimaryZipCode":"string","PrimaryCounty":"string","PrimaryCountryId":[0],"PrimaryCommunicationCategory":"unknown","Longitude":0.1,"Latitude":0.1,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"OrganisationalNumber\":\"string\",\"Active\":true,\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Segment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubSegment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Rating\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Region\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Branch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"OwnBranch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddress\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Longitude\":0.1,\"Latitude\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"OrganisationalNumber\":\"string\",\"Active\":true,\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Segment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubSegment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Rating\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Region\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Branch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"OwnBranch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddress\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Longitude\":0.1,\"Latitude\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /CompanyGroup

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Name": "string",
"OrganisationalNumber": "string",
"Active": true,
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Segment": {
"Key": "string",
"CodeGroupKey": "string"
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string"
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Region": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Branch": {
"Key": "string",
"CodeGroupKey": "string"
},
"OwnBranch": {
"Key": "string",
"CodeGroupKey": "string"
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Longitude": 0.1,
"Latitude": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
OrganisationalNumber: string
Active: true
Type:
Key: string
CodeGroupKey: string
Segment:
Key: string
CodeGroupKey: string
SubSegment:
Key: string
CodeGroupKey: string
Rating:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Region:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Branch:
Key: string
CodeGroupKey: string
OwnBranch:
Key: string
CodeGroupKey: string
PrimaryEmailAddress: string
PrimaryPhoneNumber: string
WebSite: string
PrimaryAddress: string
PrimaryAddressRow: string
PrimaryCity: string
PrimaryZipCode: string
PrimaryCounty: string
PrimaryCountryId:
- 0
PrimaryCommunicationCategory: unknown
Longitude: 0.1
Latitude: 0.1
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroup>
<Name>string</Name>
<OrganisationalNumber>string</OrganisationalNumber>
<Active>true</Active>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Segment>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</SubSegment>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Rating>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Region>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Region>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Branch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Branch>
<OwnBranch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</OwnBranch>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Id>00000000-0000-0000-0000-000000000000</Id>
</CompanyGroup>

Parameters

Name In Type Required Description
body body CompanyGroup true none

Example responses

200 Response

{
"IsNew": true,
"Name": "string",
"OrganisationalNumber": "string",
"Active": true,
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Segment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Region": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Branch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"OwnBranch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow1": "string",
"PrimaryAddressRow2": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"HasDocument": true,
"MainContactId": "00000000-0000-0000-0000-000000000000",
"MainContact": "string",
"MainContactPrimaryMobilePhone": "string",
"MainContactPrimaryPhone": "string",
"MainContactPrimaryEmail": "string",
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"Longitude": 0.1,
"Latitude": 0.1,
"TagCount": 0,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroup>
<IsNew>true</IsNew>
<Name>string</Name>
<OrganisationalNumber>string</OrganisationalNumber>
<Active>true</Active>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Segment>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubSegment>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Rating>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Region>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Region>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Branch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Branch>
<OwnBranch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</OwnBranch>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow1>string</PrimaryAddressRow1>
<PrimaryAddressRow2>string</PrimaryAddressRow2>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<HasDocument>true</HasDocument>
<MainContactId>00000000-0000-0000-0000-000000000000</MainContactId>
<MainContact>string</MainContact>
<MainContactPrimaryMobilePhone>string</MainContactPrimaryMobilePhone>
<MainContactPrimaryPhone>string</MainContactPrimaryPhone>
<MainContactPrimaryEmail>string</MainContactPrimaryEmail>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Responsible>string</Responsible>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<TagCount>0</TagCount>
<Id>00000000-0000-0000-0000-000000000000</Id>
</CompanyGroup>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyGroup
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create CompanyGroup

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CompanyGroup \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","OrganisationalNumber":"string","Active":true,"Type":{"Key":"string","CodeGroupKey":"string"},"Segment":{"Key":"string","CodeGroupKey":"string"},"SubSegment":{"Key":"string","CodeGroupKey":"string"},"Rating":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Region":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Branch":{"Key":"string","CodeGroupKey":"string"},"OwnBranch":{"Key":"string","CodeGroupKey":"string"},"PrimaryEmailAddress":"string","PrimaryPhoneNumber":"string","WebSite":"string","PrimaryAddress":"string","PrimaryAddressRow":"string","PrimaryCity":"string","PrimaryZipCode":"string","PrimaryCounty":"string","PrimaryCountryId":[0],"PrimaryCommunicationCategory":"unknown","Longitude":0.1,"Latitude":0.1,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"OrganisationalNumber\":\"string\",\"Active\":true,\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Segment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubSegment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Rating\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Region\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Branch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"OwnBranch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddress\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Longitude\":0.1,\"Latitude\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"OrganisationalNumber\":\"string\",\"Active\":true,\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Segment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubSegment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Rating\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Region\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Branch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"OwnBranch\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddress\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Longitude\":0.1,\"Latitude\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CompanyGroup

Body parameter

{
"Name": "string",
"OrganisationalNumber": "string",
"Active": true,
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Segment": {
"Key": "string",
"CodeGroupKey": "string"
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string"
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Region": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Branch": {
"Key": "string",
"CodeGroupKey": "string"
},
"OwnBranch": {
"Key": "string",
"CodeGroupKey": "string"
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Longitude": 0.1,
"Latitude": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
OrganisationalNumber: string
Active: true
Type:
Key: string
CodeGroupKey: string
Segment:
Key: string
CodeGroupKey: string
SubSegment:
Key: string
CodeGroupKey: string
Rating:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Region:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Branch:
Key: string
CodeGroupKey: string
OwnBranch:
Key: string
CodeGroupKey: string
PrimaryEmailAddress: string
PrimaryPhoneNumber: string
WebSite: string
PrimaryAddress: string
PrimaryAddressRow: string
PrimaryCity: string
PrimaryZipCode: string
PrimaryCounty: string
PrimaryCountryId:
- 0
PrimaryCommunicationCategory: unknown
Longitude: 0.1
Latitude: 0.1
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroup>
<Name>string</Name>
<OrganisationalNumber>string</OrganisationalNumber>
<Active>true</Active>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Segment>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</SubSegment>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Rating>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Region>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Region>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Branch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Branch>
<OwnBranch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</OwnBranch>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Id>00000000-0000-0000-0000-000000000000</Id>
</CompanyGroup>

Parameters

Name In Type Required Description
body body CompanyGroup true none

Example responses

201 Response

{
"IsNew": true,
"Name": "string",
"OrganisationalNumber": "string",
"Active": true,
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Segment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Region": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Branch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"OwnBranch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow1": "string",
"PrimaryAddressRow2": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"HasDocument": true,
"MainContactId": "00000000-0000-0000-0000-000000000000",
"MainContact": "string",
"MainContactPrimaryMobilePhone": "string",
"MainContactPrimaryPhone": "string",
"MainContactPrimaryEmail": "string",
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"Longitude": 0.1,
"Latitude": 0.1,
"TagCount": 0,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroup>
<IsNew>true</IsNew>
<Name>string</Name>
<OrganisationalNumber>string</OrganisationalNumber>
<Active>true</Active>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Segment>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubSegment>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Rating>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Region>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Region>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Branch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Branch>
<OwnBranch>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</OwnBranch>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow1>string</PrimaryAddressRow1>
<PrimaryAddressRow2>string</PrimaryAddressRow2>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<HasDocument>true</HasDocument>
<MainContactId>00000000-0000-0000-0000-000000000000</MainContactId>
<MainContact>string</MainContact>
<MainContactPrimaryMobilePhone>string</MainContactPrimaryMobilePhone>
<MainContactPrimaryPhone>string</MainContactPrimaryPhone>
<MainContactPrimaryEmail>string</MainContactPrimaryEmail>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Responsible>string</Responsible>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<TagCount>0</TagCount>
<Id>00000000-0000-0000-0000-000000000000</Id>
</CompanyGroup>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyGroup
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for CompanyGroup

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CompanyGroup/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CompanyGroup/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to CompanyGroup

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CompanyGroup/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

CompanyGroup Relations

Filter PrivatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/PrivatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/PrivatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CompanyGroup/{id}/PrivatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CompanyGroup/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/PrivatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/PrivatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CompanyGroup/PrivatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to PrivatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/PrivatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/PrivatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /CompanyGroup/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyGroupPrivatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyGroupPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to PrivatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/PrivatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/PrivatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CompanyGroup/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyGroupPrivatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyGroupPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete PrivatePerson relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/PrivatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/PrivatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/PrivatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /CompanyGroup/{id}/PrivatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter CorporatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/CorporatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/CorporatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/CorporatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CompanyGroup/{id}/CorporatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CompanyGroup/CorporatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/CorporatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/CorporatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CompanyGroup/CorporatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to CorporatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/CorporatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/CorporatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/CorporatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /CompanyGroup/{id}/CorporatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupCorporatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyGroupCorporatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupCorporatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyGroupCorporatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to CorporatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/CorporatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/CorporatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/CorporatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CompanyGroup/{id}/CorporatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupCorporatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyGroupCorporatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupCorporatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyGroupCorporatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete CorporatePerson relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/CorporatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/CorporatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/CorporatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /CompanyGroup/{id}/CorporatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Companies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/Companies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/Companies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CompanyGroup/{id}/Companies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CompanyGroup/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/Companies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/Companies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CompanyGroup/Companies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Company

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/Companies", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/Companies");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /CompanyGroup/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyCompanyGroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Company

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/Companies", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/Companies");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CompanyGroup/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyCompanyGroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Company relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/Companies/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/Companies/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/Companies/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /CompanyGroup/{id}/Companies/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Responsibles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CompanyGroup/string/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/string/Responsibles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/string/Responsibles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CompanyGroup/{id}/Responsibles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CompanyGroup/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CompanyGroup/Responsibles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CompanyGroup/Responsibles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CompanyGroup/Responsibles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

CorporatePerson

Retreive filtrable fields and their type for CorporatePerson

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CorporatePerson/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CorporatePerson/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter CorporatePerson based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CorporatePerson/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CorporatePerson/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get CorporatePerson by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CorporatePerson/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CorporatePerson/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Name": "string",
"FirstName": "string",
"LastName": "string",
"MiddleName": "string",
"Gender": "unknown",
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Language": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Title": "string",
"Salutation": "string",
"DateOfBirth": "2019-08-24T14:15:22Z",
"EstablishedContact": true,
"Unit": "string",
"Position": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryMobilePhoneNumber": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"CompanyPrimaryAddressRow": "string",
"CompanyPrimaryCity": "string",
"CompanyPrimaryZipCode": "string",
"CompanyPrimaryCounty": "string",
"CompanyPrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Pul": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PulDate": "2019-08-24T14:15:22Z",
"Role": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Active": true,
"ThumbViewImageFileId": "00000000-0000-0000-0000-000000000000",
"HasThumbViewImage": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"MainCompanyId": "00000000-0000-0000-0000-000000000000",
"MainCompany": "string",
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"IsNew": true,
"LoginStatus": "noLogin",
"TagCount": 0,
"PrimaryRelationId": "00000000-0000-0000-0000-000000000000",
"PrimaryRelation": "string",
"HasPhoneNumber": true,
"GDPRConsentIsRequired": true,
"GDPRConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ConsentComment": "string",
"MarketingConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingSource": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingOptIn": [
"00000000-0000-0000-0000-000000000000"
],
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CorporatePerson>
<Name>string</Name>
<FirstName>string</FirstName>
<LastName>string</LastName>
<MiddleName>string</MiddleName>
<Gender>unknown</Gender>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Language>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Language>
<Title>string</Title>
<Salutation>string</Salutation>
<DateOfBirth>2019-08-24T14:15:22Z</DateOfBirth>
<EstablishedContact>true</EstablishedContact>
<Unit>string</Unit>
<Position>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Position>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryMobilePhoneNumber>string</PrimaryMobilePhoneNumber>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<CompanyPrimaryAddressRow>string</CompanyPrimaryAddressRow>
<CompanyPrimaryCity>string</CompanyPrimaryCity>
<CompanyPrimaryZipCode>string</CompanyPrimaryZipCode>
<CompanyPrimaryCounty>string</CompanyPrimaryCounty>
<CompanyPrimaryCountryId>0</CompanyPrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Pul>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Pul>
<PulDate>2019-08-24T14:15:22Z</PulDate>
<Role>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Role>
<Active>true</Active>
<ThumbViewImageFileId>00000000-0000-0000-0000-000000000000</ThumbViewImageFileId>
<HasThumbViewImage>true</HasThumbViewImage>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Responsible>string</Responsible>
<MainCompanyId>00000000-0000-0000-0000-000000000000</MainCompanyId>
<MainCompany>string</MainCompany>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<IsNew>true</IsNew>
<LoginStatus>noLogin</LoginStatus>
<TagCount>0</TagCount>
<PrimaryRelationId>00000000-0000-0000-0000-000000000000</PrimaryRelationId>
<PrimaryRelation>string</PrimaryRelation>
<HasPhoneNumber>true</HasPhoneNumber>
<GDPRConsentIsRequired>true</GDPRConsentIsRequired>
<GDPRConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</GDPRConsent>
<ConsentComment>string</ConsentComment>
<MarketingConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</MarketingConsent>
<MarketingSource>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</MarketingSource>
<MarketingOptIn>00000000-0000-0000-0000-000000000000</MarketingOptIn>
<Id>00000000-0000-0000-0000-000000000000</Id>
</CorporatePerson>

Responses

Status Meaning Description Schema
200 OK Success CorporatePerson
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete CorporatePerson by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/CorporatePerson/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /CorporatePerson/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update CorporatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/CorporatePerson \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"FirstName":"string","LastName":"string","MiddleName":"string","Gender":"unknown","Category":{"Key":"string","CodeGroupKey":"string"},"Language":{"Key":"string","CodeGroupKey":"string"},"Title":"string","Salutation":"string","DateOfBirth":"2019-08-24T14:15:22Z","EstablishedContact":true,"Unit":"string","Position":{"Key":"string","CodeGroupKey":"string"},"PrimaryEmailAddress":"string","PrimaryMobilePhoneNumber":"string","PrimaryPhoneNumber":"string","WebSite":"string","PrimaryAddressRow":"string","PrimaryCity":"string","PrimaryZipCode":"string","PrimaryCounty":"string","PrimaryCountryId":[0],"PrimaryCommunicationCategory":"unknown","Pul":{"Key":"string","CodeGroupKey":"string"},"PulDate":"2019-08-24T14:15:22Z","Role":{"Key":"string","CodeGroupKey":"string"},"Active":true,"ThumbViewImageFileId":"00000000-0000-0000-0000-000000000000","Longitude":0.1,"Latitude":0.1,"GDPRConsent":{"Key":"string","CodeGroupKey":"string"},"ConsentComment":"string","MarketingConsent":{"Key":"string","CodeGroupKey":"string"},"MarketingSource":{"Key":"string","CodeGroupKey":"string"},"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CorporatePerson", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"FirstName\":\"string\",\"LastName\":\"string\",\"MiddleName\":\"string\",\"Gender\":\"unknown\",\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Language\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Title\":\"string\",\"Salutation\":\"string\",\"DateOfBirth\":\"2019-08-24T14:15:22Z\",\"EstablishedContact\":true,\"Unit\":\"string\",\"Position\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryMobilePhoneNumber\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Pul\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PulDate\":\"2019-08-24T14:15:22Z\",\"Role\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Active\":true,\"ThumbViewImageFileId\":\"00000000-0000-0000-0000-000000000000\",\"Longitude\":0.1,\"Latitude\":0.1,\"GDPRConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ConsentComment\":\"string\",\"MarketingConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"MarketingSource\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"FirstName\":\"string\",\"LastName\":\"string\",\"MiddleName\":\"string\",\"Gender\":\"unknown\",\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Language\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Title\":\"string\",\"Salutation\":\"string\",\"DateOfBirth\":\"2019-08-24T14:15:22Z\",\"EstablishedContact\":true,\"Unit\":\"string\",\"Position\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryMobilePhoneNumber\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Pul\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PulDate\":\"2019-08-24T14:15:22Z\",\"Role\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Active\":true,\"ThumbViewImageFileId\":\"00000000-0000-0000-0000-000000000000\",\"Longitude\":0.1,\"Latitude\":0.1,\"GDPRConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ConsentComment\":\"string\",\"MarketingConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"MarketingSource\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /CorporatePerson

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"FirstName": "string",
"LastName": "string",
"MiddleName": "string",
"Gender": "unknown",
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Language": {
"Key": "string",
"CodeGroupKey": "string"
},
"Title": "string",
"Salutation": "string",
"DateOfBirth": "2019-08-24T14:15:22Z",
"EstablishedContact": true,
"Unit": "string",
"Position": {
"Key": "string",
"CodeGroupKey": "string"
},
"PrimaryEmailAddress": "string",
"PrimaryMobilePhoneNumber": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Pul": {
"Key": "string",
"CodeGroupKey": "string"
},
"PulDate": "2019-08-24T14:15:22Z",
"Role": {
"Key": "string",
"CodeGroupKey": "string"
},
"Active": true,
"ThumbViewImageFileId": "00000000-0000-0000-0000-000000000000",
"Longitude": 0.1,
"Latitude": 0.1,
"GDPRConsent": {
"Key": "string",
"CodeGroupKey": "string"
},
"ConsentComment": "string",
"MarketingConsent": {
"Key": "string",
"CodeGroupKey": "string"
},
"MarketingSource": {
"Key": "string",
"CodeGroupKey": "string"
},
"Id": "00000000-0000-0000-0000-000000000000"
}
FirstName: string
LastName: string
MiddleName: string
Gender: unknown
Category:
Key: string
CodeGroupKey: string
Language:
Key: string
CodeGroupKey: string
Title: string
Salutation: string
DateOfBirth: 2019-08-24T14:15:22Z
EstablishedContact: true
Unit: string
Position:
Key: string
CodeGroupKey: string
PrimaryEmailAddress: string
PrimaryMobilePhoneNumber: string
PrimaryPhoneNumber: string
WebSite: string
PrimaryAddressRow: string
PrimaryCity: string
PrimaryZipCode: string
PrimaryCounty: string
PrimaryCountryId:
- 0
PrimaryCommunicationCategory: unknown
Pul:
Key: string
CodeGroupKey: string
PulDate: 2019-08-24T14:15:22Z
Role:
Key: string
CodeGroupKey: string
Active: true
ThumbViewImageFileId: 00000000-0000-0000-0000-000000000000
Longitude: 0.1
Latitude: 0.1
GDPRConsent:
Key: string
CodeGroupKey: string
ConsentComment: string
MarketingConsent:
Key: string
CodeGroupKey: string
MarketingSource:
Key: string
CodeGroupKey: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CorporatePerson>
<FirstName>string</FirstName>
<LastName>string</LastName>
<MiddleName>string</MiddleName>
<Gender>unknown</Gender>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Language>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Language>
<Title>string</Title>
<Salutation>string</Salutation>
<DateOfBirth>2019-08-24T14:15:22Z</DateOfBirth>
<EstablishedContact>true</EstablishedContact>
<Unit>string</Unit>
<Position>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Position>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryMobilePhoneNumber>string</PrimaryMobilePhoneNumber>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Pul>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Pul>
<PulDate>2019-08-24T14:15:22Z</PulDate>
<Role>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Role>
<Active>true</Active>
<ThumbViewImageFileId>00000000-0000-0000-0000-000000000000</ThumbViewImageFileId>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<GDPRConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</GDPRConsent>
<ConsentComment>string</ConsentComment>
<MarketingConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</MarketingConsent>
<MarketingSource>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</MarketingSource>
<Id>00000000-0000-0000-0000-000000000000</Id>
</CorporatePerson>

Parameters

Name In Type Required Description
body body CorporatePerson true none

Example responses

200 Response

{
"Name": "string",
"FirstName": "string",
"LastName": "string",
"MiddleName": "string",
"Gender": "unknown",
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Language": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Title": "string",
"Salutation": "string",
"DateOfBirth": "2019-08-24T14:15:22Z",
"EstablishedContact": true,
"Unit": "string",
"Position": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryMobilePhoneNumber": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"CompanyPrimaryAddressRow": "string",
"CompanyPrimaryCity": "string",
"CompanyPrimaryZipCode": "string",
"CompanyPrimaryCounty": "string",
"CompanyPrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Pul": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PulDate": "2019-08-24T14:15:22Z",
"Role": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Active": true,
"ThumbViewImageFileId": "00000000-0000-0000-0000-000000000000",
"HasThumbViewImage": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"MainCompanyId": "00000000-0000-0000-0000-000000000000",
"MainCompany": "string",
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"IsNew": true,
"LoginStatus": "noLogin",
"TagCount": 0,
"PrimaryRelationId": "00000000-0000-0000-0000-000000000000",
"PrimaryRelation": "string",
"HasPhoneNumber": true,
"GDPRConsentIsRequired": true,
"GDPRConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ConsentComment": "string",
"MarketingConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingSource": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingOptIn": [
"00000000-0000-0000-0000-000000000000"
],
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CorporatePerson>
<Name>string</Name>
<FirstName>string</FirstName>
<LastName>string</LastName>
<MiddleName>string</MiddleName>
<Gender>unknown</Gender>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Language>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Language>
<Title>string</Title>
<Salutation>string</Salutation>
<DateOfBirth>2019-08-24T14:15:22Z</DateOfBirth>
<EstablishedContact>true</EstablishedContact>
<Unit>string</Unit>
<Position>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Position>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryMobilePhoneNumber>string</PrimaryMobilePhoneNumber>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<CompanyPrimaryAddressRow>string</CompanyPrimaryAddressRow>
<CompanyPrimaryCity>string</CompanyPrimaryCity>
<CompanyPrimaryZipCode>string</CompanyPrimaryZipCode>
<CompanyPrimaryCounty>string</CompanyPrimaryCounty>
<CompanyPrimaryCountryId>0</CompanyPrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Pul>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Pul>
<PulDate>2019-08-24T14:15:22Z</PulDate>
<Role>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Role>
<Active>true</Active>
<ThumbViewImageFileId>00000000-0000-0000-0000-000000000000</ThumbViewImageFileId>
<HasThumbViewImage>true</HasThumbViewImage>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Responsible>string</Responsible>
<MainCompanyId>00000000-0000-0000-0000-000000000000</MainCompanyId>
<MainCompany>string</MainCompany>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<IsNew>true</IsNew>
<LoginStatus>noLogin</LoginStatus>
<TagCount>0</TagCount>
<PrimaryRelationId>00000000-0000-0000-0000-000000000000</PrimaryRelationId>
<PrimaryRelation>string</PrimaryRelation>
<HasPhoneNumber>true</HasPhoneNumber>
<GDPRConsentIsRequired>true</GDPRConsentIsRequired>
<GDPRConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</GDPRConsent>
<ConsentComment>string</ConsentComment>
<MarketingConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</MarketingConsent>
<MarketingSource>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</MarketingSource>
<MarketingOptIn>00000000-0000-0000-0000-000000000000</MarketingOptIn>
<Id>00000000-0000-0000-0000-000000000000</Id>
</CorporatePerson>

Responses

Status Meaning Description Schema
200 OK Entity Updated CorporatePerson
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create CorporatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CorporatePerson \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"FirstName":"string","LastName":"string","MiddleName":"string","Gender":"unknown","Category":{"Key":"string","CodeGroupKey":"string"},"Language":{"Key":"string","CodeGroupKey":"string"},"Title":"string","Salutation":"string","DateOfBirth":"2019-08-24T14:15:22Z","EstablishedContact":true,"Unit":"string","Position":{"Key":"string","CodeGroupKey":"string"},"PrimaryEmailAddress":"string","PrimaryMobilePhoneNumber":"string","PrimaryPhoneNumber":"string","WebSite":"string","PrimaryAddressRow":"string","PrimaryCity":"string","PrimaryZipCode":"string","PrimaryCounty":"string","PrimaryCountryId":[0],"PrimaryCommunicationCategory":"unknown","Pul":{"Key":"string","CodeGroupKey":"string"},"PulDate":"2019-08-24T14:15:22Z","Role":{"Key":"string","CodeGroupKey":"string"},"Active":true,"ThumbViewImageFileId":"00000000-0000-0000-0000-000000000000","Longitude":0.1,"Latitude":0.1,"GDPRConsent":{"Key":"string","CodeGroupKey":"string"},"ConsentComment":"string","MarketingConsent":{"Key":"string","CodeGroupKey":"string"},"MarketingSource":{"Key":"string","CodeGroupKey":"string"},"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CorporatePerson", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"FirstName\":\"string\",\"LastName\":\"string\",\"MiddleName\":\"string\",\"Gender\":\"unknown\",\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Language\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Title\":\"string\",\"Salutation\":\"string\",\"DateOfBirth\":\"2019-08-24T14:15:22Z\",\"EstablishedContact\":true,\"Unit\":\"string\",\"Position\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryMobilePhoneNumber\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Pul\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PulDate\":\"2019-08-24T14:15:22Z\",\"Role\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Active\":true,\"ThumbViewImageFileId\":\"00000000-0000-0000-0000-000000000000\",\"Longitude\":0.1,\"Latitude\":0.1,\"GDPRConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ConsentComment\":\"string\",\"MarketingConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"MarketingSource\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"FirstName\":\"string\",\"LastName\":\"string\",\"MiddleName\":\"string\",\"Gender\":\"unknown\",\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Language\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Title\":\"string\",\"Salutation\":\"string\",\"DateOfBirth\":\"2019-08-24T14:15:22Z\",\"EstablishedContact\":true,\"Unit\":\"string\",\"Position\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryMobilePhoneNumber\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Pul\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PulDate\":\"2019-08-24T14:15:22Z\",\"Role\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Active\":true,\"ThumbViewImageFileId\":\"00000000-0000-0000-0000-000000000000\",\"Longitude\":0.1,\"Latitude\":0.1,\"GDPRConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ConsentComment\":\"string\",\"MarketingConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"MarketingSource\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CorporatePerson

Body parameter

{
"FirstName": "string",
"LastName": "string",
"MiddleName": "string",
"Gender": "unknown",
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Language": {
"Key": "string",
"CodeGroupKey": "string"
},
"Title": "string",
"Salutation": "string",
"DateOfBirth": "2019-08-24T14:15:22Z",
"EstablishedContact": true,
"Unit": "string",
"Position": {
"Key": "string",
"CodeGroupKey": "string"
},
"PrimaryEmailAddress": "string",
"PrimaryMobilePhoneNumber": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Pul": {
"Key": "string",
"CodeGroupKey": "string"
},
"PulDate": "2019-08-24T14:15:22Z",
"Role": {
"Key": "string",
"CodeGroupKey": "string"
},
"Active": true,
"ThumbViewImageFileId": "00000000-0000-0000-0000-000000000000",
"Longitude": 0.1,
"Latitude": 0.1,
"GDPRConsent": {
"Key": "string",
"CodeGroupKey": "string"
},
"ConsentComment": "string",
"MarketingConsent": {
"Key": "string",
"CodeGroupKey": "string"
},
"MarketingSource": {
"Key": "string",
"CodeGroupKey": "string"
},
"Id": "00000000-0000-0000-0000-000000000000"
}
FirstName: string
LastName: string
MiddleName: string
Gender: unknown
Category:
Key: string
CodeGroupKey: string
Language:
Key: string
CodeGroupKey: string
Title: string
Salutation: string
DateOfBirth: 2019-08-24T14:15:22Z
EstablishedContact: true
Unit: string
Position:
Key: string
CodeGroupKey: string
PrimaryEmailAddress: string
PrimaryMobilePhoneNumber: string
PrimaryPhoneNumber: string
WebSite: string
PrimaryAddressRow: string
PrimaryCity: string
PrimaryZipCode: string
PrimaryCounty: string
PrimaryCountryId:
- 0
PrimaryCommunicationCategory: unknown
Pul:
Key: string
CodeGroupKey: string
PulDate: 2019-08-24T14:15:22Z
Role:
Key: string
CodeGroupKey: string
Active: true
ThumbViewImageFileId: 00000000-0000-0000-0000-000000000000
Longitude: 0.1
Latitude: 0.1
GDPRConsent:
Key: string
CodeGroupKey: string
ConsentComment: string
MarketingConsent:
Key: string
CodeGroupKey: string
MarketingSource:
Key: string
CodeGroupKey: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CorporatePerson>
<FirstName>string</FirstName>
<LastName>string</LastName>
<MiddleName>string</MiddleName>
<Gender>unknown</Gender>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Language>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Language>
<Title>string</Title>
<Salutation>string</Salutation>
<DateOfBirth>2019-08-24T14:15:22Z</DateOfBirth>
<EstablishedContact>true</EstablishedContact>
<Unit>string</Unit>
<Position>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Position>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryMobilePhoneNumber>string</PrimaryMobilePhoneNumber>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Pul>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Pul>
<PulDate>2019-08-24T14:15:22Z</PulDate>
<Role>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Role>
<Active>true</Active>
<ThumbViewImageFileId>00000000-0000-0000-0000-000000000000</ThumbViewImageFileId>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<GDPRConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</GDPRConsent>
<ConsentComment>string</ConsentComment>
<MarketingConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</MarketingConsent>
<MarketingSource>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</MarketingSource>
<Id>00000000-0000-0000-0000-000000000000</Id>
</CorporatePerson>

Parameters

Name In Type Required Description
body body CorporatePerson true none

Example responses

201 Response

{
"Name": "string",
"FirstName": "string",
"LastName": "string",
"MiddleName": "string",
"Gender": "unknown",
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Language": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Title": "string",
"Salutation": "string",
"DateOfBirth": "2019-08-24T14:15:22Z",
"EstablishedContact": true,
"Unit": "string",
"Position": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryMobilePhoneNumber": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"CompanyPrimaryAddressRow": "string",
"CompanyPrimaryCity": "string",
"CompanyPrimaryZipCode": "string",
"CompanyPrimaryCounty": "string",
"CompanyPrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Pul": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PulDate": "2019-08-24T14:15:22Z",
"Role": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Active": true,
"ThumbViewImageFileId": "00000000-0000-0000-0000-000000000000",
"HasThumbViewImage": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"MainCompanyId": "00000000-0000-0000-0000-000000000000",
"MainCompany": "string",
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"IsNew": true,
"LoginStatus": "noLogin",
"TagCount": 0,
"PrimaryRelationId": "00000000-0000-0000-0000-000000000000",
"PrimaryRelation": "string",
"HasPhoneNumber": true,
"GDPRConsentIsRequired": true,
"GDPRConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ConsentComment": "string",
"MarketingConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingSource": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingOptIn": [
"00000000-0000-0000-0000-000000000000"
],
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CorporatePerson>
<Name>string</Name>
<FirstName>string</FirstName>
<LastName>string</LastName>
<MiddleName>string</MiddleName>
<Gender>unknown</Gender>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Language>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Language>
<Title>string</Title>
<Salutation>string</Salutation>
<DateOfBirth>2019-08-24T14:15:22Z</DateOfBirth>
<EstablishedContact>true</EstablishedContact>
<Unit>string</Unit>
<Position>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Position>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryMobilePhoneNumber>string</PrimaryMobilePhoneNumber>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<CompanyPrimaryAddressRow>string</CompanyPrimaryAddressRow>
<CompanyPrimaryCity>string</CompanyPrimaryCity>
<CompanyPrimaryZipCode>string</CompanyPrimaryZipCode>
<CompanyPrimaryCounty>string</CompanyPrimaryCounty>
<CompanyPrimaryCountryId>0</CompanyPrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Pul>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Pul>
<PulDate>2019-08-24T14:15:22Z</PulDate>
<Role>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Role>
<Active>true</Active>
<ThumbViewImageFileId>00000000-0000-0000-0000-000000000000</ThumbViewImageFileId>
<HasThumbViewImage>true</HasThumbViewImage>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Responsible>string</Responsible>
<MainCompanyId>00000000-0000-0000-0000-000000000000</MainCompanyId>
<MainCompany>string</MainCompany>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<IsNew>true</IsNew>
<LoginStatus>noLogin</LoginStatus>
<TagCount>0</TagCount>
<PrimaryRelationId>00000000-0000-0000-0000-000000000000</PrimaryRelationId>
<PrimaryRelation>string</PrimaryRelation>
<HasPhoneNumber>true</HasPhoneNumber>
<GDPRConsentIsRequired>true</GDPRConsentIsRequired>
<GDPRConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</GDPRConsent>
<ConsentComment>string</ConsentComment>
<MarketingConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</MarketingConsent>
<MarketingSource>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</MarketingSource>
<MarketingOptIn>00000000-0000-0000-0000-000000000000</MarketingOptIn>
<Id>00000000-0000-0000-0000-000000000000</Id>
</CorporatePerson>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CorporatePerson
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for CorporatePerson

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CorporatePerson/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CorporatePerson/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to CorporatePerson

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CorporatePerson/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CorporatePerson/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

CorporatePerson Relations

Filter Companies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CorporatePerson/string/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/string/Companies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/string/Companies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CorporatePerson/{id}/Companies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CorporatePerson/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/Companies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/Companies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CorporatePerson/Companies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Company

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/CorporatePerson/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/string/Companies", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/string/Companies");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /CorporatePerson/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCorporatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyCorporatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCorporatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyCorporatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Company

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CorporatePerson/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/string/Companies", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/string/Companies");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CorporatePerson/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCorporatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyCorporatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCorporatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyCorporatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Company relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/CorporatePerson/string/Companies/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/string/Companies/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/string/Companies/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /CorporatePerson/{id}/Companies/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter CompanyGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CorporatePerson/string/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/string/CompanyGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/string/CompanyGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CorporatePerson/{id}/CompanyGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CorporatePerson/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/CompanyGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/CompanyGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CorporatePerson/CompanyGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to CompanyGroup

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/CorporatePerson/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/string/CompanyGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/string/CompanyGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /CorporatePerson/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupCorporatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyGroupCorporatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupCorporatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyGroupCorporatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to CompanyGroup

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CorporatePerson/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/string/CompanyGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/string/CompanyGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CorporatePerson/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupCorporatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyGroupCorporatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupCorporatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupCorporatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyGroupCorporatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete CompanyGroup relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/CorporatePerson/string/CompanyGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/string/CompanyGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/string/CompanyGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /CorporatePerson/{id}/CompanyGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Responsibles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/CorporatePerson/string/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/string/Responsibles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/string/Responsibles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /CorporatePerson/{id}/Responsibles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/CorporatePerson/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/CorporatePerson/Responsibles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/CorporatePerson/Responsibles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /CorporatePerson/Responsibles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Country

Get

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Country/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Country/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Country/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Country/{id}

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

[
{
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
}
]
<?xml version="1.0" encoding="UTF-8" ?>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>

Responses

Status Meaning Description Schema
200 OK OK Inline
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Code] false none none
» Key string false none none
» CodeGroupKey string false none none
» Caption string false read-only none
» Active boolean false read-only none

Currency

Get

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Currency/string \
--header 'Accept: application/json'
fetch("https://testing.sweetsystems.se/api/Currency/string", {
"method": "GET",
"headers": {
"Accept": "application/json"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Currency/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
IRestResponse response = client.Execute(request);

GET /Currency/{id}

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>

Responses

Status Meaning Description Schema
200 OK Success Currency
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Post

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Currency \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","IsSystem":true,"Rate":0.1,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Currency", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"IsSystem\":true,\"Rate\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Currency");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"IsSystem\":true,\"Rate\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Currency

Body parameter

{
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
IsSystem: true
Rate: 0.1
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>

Parameters

Name In Type Required Description
body body Currency true none

Example responses

201 Response

{
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created Currency
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Put

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Currency \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","IsSystem":true,"Rate":0.1,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Currency", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"IsSystem\":true,\"Rate\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Currency");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"IsSystem\":true,\"Rate\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Currency

Body parameter

{
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
IsSystem: true
Rate: 0.1
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>

Parameters

Name In Type Required Description
body body Currency true none

Example responses

200 Response

{
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>

Responses

Status Meaning Description Schema
200 OK Entity Updated Currency
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Deal

Retreive filtrable fields and their type for Deal

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Deal/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Deal/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Deal/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Deal/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter Deal based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Deal/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Deal/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Deal/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Deal/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get Deal by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Deal/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Deal/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Deal/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Deal/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"IsNew": true,
"Description": "string",
"Number": 0,
"EstimatedEndDate": "2019-08-24T14:15:22Z",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Lost": true,
"HasDocument": true,
"LostReason": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Probability": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Source": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Price": 0.1,
"Quantity": 0.1,
"QuantityUnit": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"DecisionStatus": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Reason": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ReasonDescription": "string",
"OfferDate": "2019-08-24T14:15:22Z",
"DelivieryDateFrom": "2019-08-24T14:15:22Z",
"DelivieryDateTo": "2019-08-24T14:15:22Z",
"SystemCurrency": "string",
"TotalValue": 0.1,
"Currency": {
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
},
"CurrencyString": "string",
"Turnover": "manual",
"ForecastValue": 0.1,
"Rate": 0.1,
"TotalValueSystemCurrency": 0.1,
"ForecastValueSystemCurrency": 0.1,
"ResponsibleLong": "string",
"CreatedBy": "string",
"UpdatedBy": "string",
"Active": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"HasProject": true,
"TagCount": 0,
"FirstNote": "string",
"IsDue": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Deal>
<IsNew>true</IsNew>
<Description>string</Description>
<Number>0</Number>
<EstimatedEndDate>2019-08-24T14:15:22Z</EstimatedEndDate>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Lost>true</Lost>
<HasDocument>true</HasDocument>
<LostReason>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</LostReason>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Probability>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Probability>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<Source>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Source>
<Price>0.1</Price>
<Quantity>0.1</Quantity>
<QuantityUnit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</QuantityUnit>
<DecisionStatus>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</DecisionStatus>
<Reason>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Reason>
<ReasonDescription>string</ReasonDescription>
<OfferDate>2019-08-24T14:15:22Z</OfferDate>
<DelivieryDateFrom>2019-08-24T14:15:22Z</DelivieryDateFrom>
<DelivieryDateTo>2019-08-24T14:15:22Z</DelivieryDateTo>
<SystemCurrency>string</SystemCurrency>
<TotalValue>0.1</TotalValue>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>
<CurrencyString>string</CurrencyString>
<Turnover>manual</Turnover>
<ForecastValue>0.1</ForecastValue>
<Rate>0.1</Rate>
<TotalValueSystemCurrency>0.1</TotalValueSystemCurrency>
<ForecastValueSystemCurrency>0.1</ForecastValueSystemCurrency>
<ResponsibleLong>string</ResponsibleLong>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Active>true</Active>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<HasProject>true</HasProject>
<TagCount>0</TagCount>
<FirstNote>string</FirstNote>
<IsDue>true</IsDue>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Deal>

Responses

Status Meaning Description Schema
200 OK Success Deal
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete Deal by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Deal/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Deal/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Deal/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Deal/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update Deal

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Deal \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Description":"string","Number":0,"EstimatedEndDate":"2019-08-24T14:15:22Z","StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","Lost":true,"LostReason":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Probability":{"Key":"string","CodeGroupKey":"string"},"Type":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"Source":{"Key":"string","CodeGroupKey":"string"},"Price":0.1,"Quantity":0.1,"QuantityUnit":{"Key":"string","CodeGroupKey":"string"},"DecisionStatus":{"Key":"string","CodeGroupKey":"string"},"Reason":{"Key":"string","CodeGroupKey":"string"},"ReasonDescription":"string","OfferDate":"2019-08-24T14:15:22Z","DelivieryDateFrom":"2019-08-24T14:15:22Z","DelivieryDateTo":"2019-08-24T14:15:22Z","TotalValue":0.1,"Currency":{"Name":"string","IsSystem":true,"Rate":0.1,"Id":"00000000-0000-0000-0000-000000000000"},"Turnover":"manual","Active":true,"Longitude":0.1,"Latitude":0.1,"Responsible":["00000000-0000-0000-0000-000000000000"],"FirstNote":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Deal", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Description\":\"string\",\"Number\":0,\"EstimatedEndDate\":\"2019-08-24T14:15:22Z\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Lost\":true,\"LostReason\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Probability\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Source\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Price\":0.1,\"Quantity\":0.1,\"QuantityUnit\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"DecisionStatus\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Reason\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ReasonDescription\":\"string\",\"OfferDate\":\"2019-08-24T14:15:22Z\",\"DelivieryDateFrom\":\"2019-08-24T14:15:22Z\",\"DelivieryDateTo\":\"2019-08-24T14:15:22Z\",\"TotalValue\":0.1,\"Currency\":{\"Name\":\"string\",\"IsSystem\":true,\"Rate\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"},\"Turnover\":\"manual\",\"Active\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"FirstNote\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Deal");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Description\":\"string\",\"Number\":0,\"EstimatedEndDate\":\"2019-08-24T14:15:22Z\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Lost\":true,\"LostReason\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Probability\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Source\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Price\":0.1,\"Quantity\":0.1,\"QuantityUnit\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"DecisionStatus\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Reason\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ReasonDescription\":\"string\",\"OfferDate\":\"2019-08-24T14:15:22Z\",\"DelivieryDateFrom\":\"2019-08-24T14:15:22Z\",\"DelivieryDateTo\":\"2019-08-24T14:15:22Z\",\"TotalValue\":0.1,\"Currency\":{\"Name\":\"string\",\"IsSystem\":true,\"Rate\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"},\"Turnover\":\"manual\",\"Active\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"FirstNote\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Deal

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Description": "string",
"Number": 0,
"EstimatedEndDate": "2019-08-24T14:15:22Z",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Lost": true,
"LostReason": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Probability": {
"Key": "string",
"CodeGroupKey": "string"
},
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"Source": {
"Key": "string",
"CodeGroupKey": "string"
},
"Price": 0.1,
"Quantity": 0.1,
"QuantityUnit": {
"Key": "string",
"CodeGroupKey": "string"
},
"DecisionStatus": {
"Key": "string",
"CodeGroupKey": "string"
},
"Reason": {
"Key": "string",
"CodeGroupKey": "string"
},
"ReasonDescription": "string",
"OfferDate": "2019-08-24T14:15:22Z",
"DelivieryDateFrom": "2019-08-24T14:15:22Z",
"DelivieryDateTo": "2019-08-24T14:15:22Z",
"TotalValue": 0.1,
"Currency": {
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
},
"Turnover": "manual",
"Active": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"FirstNote": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Description: string
Number: 0
EstimatedEndDate: 2019-08-24T14:15:22Z
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
Lost: true
LostReason:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Probability:
Key: string
CodeGroupKey: string
Type:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
Source:
Key: string
CodeGroupKey: string
Price: 0.1
Quantity: 0.1
QuantityUnit:
Key: string
CodeGroupKey: string
DecisionStatus:
Key: string
CodeGroupKey: string
Reason:
Key: string
CodeGroupKey: string
ReasonDescription: string
OfferDate: 2019-08-24T14:15:22Z
DelivieryDateFrom: 2019-08-24T14:15:22Z
DelivieryDateTo: 2019-08-24T14:15:22Z
TotalValue: 0.1
Currency:
Name: string
IsSystem: true
Rate: 0.1
Id: 00000000-0000-0000-0000-000000000000
Turnover: manual
Active: true
Longitude: 0.1
Latitude: 0.1
Responsible:
- 00000000-0000-0000-0000-000000000000
FirstNote: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Deal>
<Description>string</Description>
<Number>0</Number>
<EstimatedEndDate>2019-08-24T14:15:22Z</EstimatedEndDate>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Lost>true</Lost>
<LostReason>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</LostReason>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Probability>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Probability>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<Source>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Source>
<Price>0.1</Price>
<Quantity>0.1</Quantity>
<QuantityUnit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</QuantityUnit>
<DecisionStatus>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</DecisionStatus>
<Reason>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Reason>
<ReasonDescription>string</ReasonDescription>
<OfferDate>2019-08-24T14:15:22Z</OfferDate>
<DelivieryDateFrom>2019-08-24T14:15:22Z</DelivieryDateFrom>
<DelivieryDateTo>2019-08-24T14:15:22Z</DelivieryDateTo>
<TotalValue>0.1</TotalValue>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>
<Turnover>manual</Turnover>
<Active>true</Active>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<FirstNote>string</FirstNote>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Deal>

Parameters

Name In Type Required Description
body body Deal true none

Example responses

200 Response

{
"IsNew": true,
"Description": "string",
"Number": 0,
"EstimatedEndDate": "2019-08-24T14:15:22Z",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Lost": true,
"HasDocument": true,
"LostReason": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Probability": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Source": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Price": 0.1,
"Quantity": 0.1,
"QuantityUnit": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"DecisionStatus": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Reason": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ReasonDescription": "string",
"OfferDate": "2019-08-24T14:15:22Z",
"DelivieryDateFrom": "2019-08-24T14:15:22Z",
"DelivieryDateTo": "2019-08-24T14:15:22Z",
"SystemCurrency": "string",
"TotalValue": 0.1,
"Currency": {
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
},
"CurrencyString": "string",
"Turnover": "manual",
"ForecastValue": 0.1,
"Rate": 0.1,
"TotalValueSystemCurrency": 0.1,
"ForecastValueSystemCurrency": 0.1,
"ResponsibleLong": "string",
"CreatedBy": "string",
"UpdatedBy": "string",
"Active": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"HasProject": true,
"TagCount": 0,
"FirstNote": "string",
"IsDue": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Deal>
<IsNew>true</IsNew>
<Description>string</Description>
<Number>0</Number>
<EstimatedEndDate>2019-08-24T14:15:22Z</EstimatedEndDate>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Lost>true</Lost>
<HasDocument>true</HasDocument>
<LostReason>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</LostReason>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Probability>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Probability>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<Source>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Source>
<Price>0.1</Price>
<Quantity>0.1</Quantity>
<QuantityUnit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</QuantityUnit>
<DecisionStatus>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</DecisionStatus>
<Reason>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Reason>
<ReasonDescription>string</ReasonDescription>
<OfferDate>2019-08-24T14:15:22Z</OfferDate>
<DelivieryDateFrom>2019-08-24T14:15:22Z</DelivieryDateFrom>
<DelivieryDateTo>2019-08-24T14:15:22Z</DelivieryDateTo>
<SystemCurrency>string</SystemCurrency>
<TotalValue>0.1</TotalValue>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>
<CurrencyString>string</CurrencyString>
<Turnover>manual</Turnover>
<ForecastValue>0.1</ForecastValue>
<Rate>0.1</Rate>
<TotalValueSystemCurrency>0.1</TotalValueSystemCurrency>
<ForecastValueSystemCurrency>0.1</ForecastValueSystemCurrency>
<ResponsibleLong>string</ResponsibleLong>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Active>true</Active>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<HasProject>true</HasProject>
<TagCount>0</TagCount>
<FirstNote>string</FirstNote>
<IsDue>true</IsDue>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Deal>

Responses

Status Meaning Description Schema
200 OK Entity Updated Deal
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create Deal

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Deal \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Description":"string","Number":0,"EstimatedEndDate":"2019-08-24T14:15:22Z","StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","Lost":true,"LostReason":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Probability":{"Key":"string","CodeGroupKey":"string"},"Type":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"Source":{"Key":"string","CodeGroupKey":"string"},"Price":0.1,"Quantity":0.1,"QuantityUnit":{"Key":"string","CodeGroupKey":"string"},"DecisionStatus":{"Key":"string","CodeGroupKey":"string"},"Reason":{"Key":"string","CodeGroupKey":"string"},"ReasonDescription":"string","OfferDate":"2019-08-24T14:15:22Z","DelivieryDateFrom":"2019-08-24T14:15:22Z","DelivieryDateTo":"2019-08-24T14:15:22Z","TotalValue":0.1,"Currency":{"Name":"string","IsSystem":true,"Rate":0.1,"Id":"00000000-0000-0000-0000-000000000000"},"Turnover":"manual","Active":true,"Longitude":0.1,"Latitude":0.1,"Responsible":["00000000-0000-0000-0000-000000000000"],"FirstNote":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Deal", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Description\":\"string\",\"Number\":0,\"EstimatedEndDate\":\"2019-08-24T14:15:22Z\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Lost\":true,\"LostReason\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Probability\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Source\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Price\":0.1,\"Quantity\":0.1,\"QuantityUnit\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"DecisionStatus\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Reason\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ReasonDescription\":\"string\",\"OfferDate\":\"2019-08-24T14:15:22Z\",\"DelivieryDateFrom\":\"2019-08-24T14:15:22Z\",\"DelivieryDateTo\":\"2019-08-24T14:15:22Z\",\"TotalValue\":0.1,\"Currency\":{\"Name\":\"string\",\"IsSystem\":true,\"Rate\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"},\"Turnover\":\"manual\",\"Active\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"FirstNote\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Deal");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Description\":\"string\",\"Number\":0,\"EstimatedEndDate\":\"2019-08-24T14:15:22Z\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Lost\":true,\"LostReason\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Probability\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Source\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Price\":0.1,\"Quantity\":0.1,\"QuantityUnit\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"DecisionStatus\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Reason\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ReasonDescription\":\"string\",\"OfferDate\":\"2019-08-24T14:15:22Z\",\"DelivieryDateFrom\":\"2019-08-24T14:15:22Z\",\"DelivieryDateTo\":\"2019-08-24T14:15:22Z\",\"TotalValue\":0.1,\"Currency\":{\"Name\":\"string\",\"IsSystem\":true,\"Rate\":0.1,\"Id\":\"00000000-0000-0000-0000-000000000000\"},\"Turnover\":\"manual\",\"Active\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"FirstNote\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Deal

Body parameter

{
"Description": "string",
"Number": 0,
"EstimatedEndDate": "2019-08-24T14:15:22Z",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Lost": true,
"LostReason": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Probability": {
"Key": "string",
"CodeGroupKey": "string"
},
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"Source": {
"Key": "string",
"CodeGroupKey": "string"
},
"Price": 0.1,
"Quantity": 0.1,
"QuantityUnit": {
"Key": "string",
"CodeGroupKey": "string"
},
"DecisionStatus": {
"Key": "string",
"CodeGroupKey": "string"
},
"Reason": {
"Key": "string",
"CodeGroupKey": "string"
},
"ReasonDescription": "string",
"OfferDate": "2019-08-24T14:15:22Z",
"DelivieryDateFrom": "2019-08-24T14:15:22Z",
"DelivieryDateTo": "2019-08-24T14:15:22Z",
"TotalValue": 0.1,
"Currency": {
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
},
"Turnover": "manual",
"Active": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"FirstNote": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Description: string
Number: 0
EstimatedEndDate: 2019-08-24T14:15:22Z
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
Lost: true
LostReason:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Probability:
Key: string
CodeGroupKey: string
Type:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
Source:
Key: string
CodeGroupKey: string
Price: 0.1
Quantity: 0.1
QuantityUnit:
Key: string
CodeGroupKey: string
DecisionStatus:
Key: string
CodeGroupKey: string
Reason:
Key: string
CodeGroupKey: string
ReasonDescription: string
OfferDate: 2019-08-24T14:15:22Z
DelivieryDateFrom: 2019-08-24T14:15:22Z
DelivieryDateTo: 2019-08-24T14:15:22Z
TotalValue: 0.1
Currency:
Name: string
IsSystem: true
Rate: 0.1
Id: 00000000-0000-0000-0000-000000000000
Turnover: manual
Active: true
Longitude: 0.1
Latitude: 0.1
Responsible:
- 00000000-0000-0000-0000-000000000000
FirstNote: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Deal>
<Description>string</Description>
<Number>0</Number>
<EstimatedEndDate>2019-08-24T14:15:22Z</EstimatedEndDate>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Lost>true</Lost>
<LostReason>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</LostReason>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Probability>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Probability>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<Source>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Source>
<Price>0.1</Price>
<Quantity>0.1</Quantity>
<QuantityUnit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</QuantityUnit>
<DecisionStatus>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</DecisionStatus>
<Reason>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Reason>
<ReasonDescription>string</ReasonDescription>
<OfferDate>2019-08-24T14:15:22Z</OfferDate>
<DelivieryDateFrom>2019-08-24T14:15:22Z</DelivieryDateFrom>
<DelivieryDateTo>2019-08-24T14:15:22Z</DelivieryDateTo>
<TotalValue>0.1</TotalValue>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>
<Turnover>manual</Turnover>
<Active>true</Active>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<FirstNote>string</FirstNote>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Deal>

Parameters

Name In Type Required Description
body body Deal true none

Example responses

201 Response

{
"IsNew": true,
"Description": "string",
"Number": 0,
"EstimatedEndDate": "2019-08-24T14:15:22Z",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Lost": true,
"HasDocument": true,
"LostReason": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Probability": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Source": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Price": 0.1,
"Quantity": 0.1,
"QuantityUnit": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"DecisionStatus": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Reason": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ReasonDescription": "string",
"OfferDate": "2019-08-24T14:15:22Z",
"DelivieryDateFrom": "2019-08-24T14:15:22Z",
"DelivieryDateTo": "2019-08-24T14:15:22Z",
"SystemCurrency": "string",
"TotalValue": 0.1,
"Currency": {
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
},
"CurrencyString": "string",
"Turnover": "manual",
"ForecastValue": 0.1,
"Rate": 0.1,
"TotalValueSystemCurrency": 0.1,
"ForecastValueSystemCurrency": 0.1,
"ResponsibleLong": "string",
"CreatedBy": "string",
"UpdatedBy": "string",
"Active": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"HasProject": true,
"TagCount": 0,
"FirstNote": "string",
"IsDue": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Deal>
<IsNew>true</IsNew>
<Description>string</Description>
<Number>0</Number>
<EstimatedEndDate>2019-08-24T14:15:22Z</EstimatedEndDate>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Lost>true</Lost>
<HasDocument>true</HasDocument>
<LostReason>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</LostReason>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Probability>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Probability>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<Source>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Source>
<Price>0.1</Price>
<Quantity>0.1</Quantity>
<QuantityUnit>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</QuantityUnit>
<DecisionStatus>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</DecisionStatus>
<Reason>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Reason>
<ReasonDescription>string</ReasonDescription>
<OfferDate>2019-08-24T14:15:22Z</OfferDate>
<DelivieryDateFrom>2019-08-24T14:15:22Z</DelivieryDateFrom>
<DelivieryDateTo>2019-08-24T14:15:22Z</DelivieryDateTo>
<SystemCurrency>string</SystemCurrency>
<TotalValue>0.1</TotalValue>
<Currency>
<Name>string</Name>
<IsSystem>true</IsSystem>
<Rate>0.1</Rate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Currency>
<CurrencyString>string</CurrencyString>
<Turnover>manual</Turnover>
<ForecastValue>0.1</ForecastValue>
<Rate>0.1</Rate>
<TotalValueSystemCurrency>0.1</TotalValueSystemCurrency>
<ForecastValueSystemCurrency>0.1</ForecastValueSystemCurrency>
<ResponsibleLong>string</ResponsibleLong>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Active>true</Active>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<HasProject>true</HasProject>
<TagCount>0</TagCount>
<FirstNote>string</FirstNote>
<IsDue>true</IsDue>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Deal>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created Deal
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for Deal

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Deal/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Deal/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Deal/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Deal/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to Deal

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Deal/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Deal/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Deal/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Deal/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

DistributionMarketingActivity

Retreive filtrable fields and their type for DistributionMarketingActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/DistributionMarketingActivity/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/DistributionMarketingActivity/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/DistributionMarketingActivity/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /DistributionMarketingActivity/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter DistributionMarketingActivity based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/DistributionMarketingActivity/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/DistributionMarketingActivity/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/DistributionMarketingActivity/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /DistributionMarketingActivity/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get DistributionMarketingActivity by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/DistributionMarketingActivity/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/DistributionMarketingActivity/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/DistributionMarketingActivity/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /DistributionMarketingActivity/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Name": "string",
"Description": "string",
"WebSite": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingProject": "string",
"MarketingPlan": "string",
"MarketingPlanAndProject": "string",
"TimeSpan": "string",
"IsExternal": true,
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"MarketingPlanId": "00000000-0000-0000-0000-000000000000",
"IsNew": true,
"TagCount": 0,
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"ProcessItemCount": 0,
"ActiveProcessItemCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Active": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<DistributionMarketingActivity>
<Name>string</Name>
<Description>string</Description>
<WebSite>string</WebSite>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<MarketingProject>string</MarketingProject>
<MarketingPlan>string</MarketingPlan>
<MarketingPlanAndProject>string</MarketingPlanAndProject>
<TimeSpan>string</TimeSpan>
<IsExternal>true</IsExternal>
<MarketingProjectId>00000000-0000-0000-0000-000000000000</MarketingProjectId>
<MarketingPlanId>00000000-0000-0000-0000-000000000000</MarketingPlanId>
<IsNew>true</IsNew>
<TagCount>0</TagCount>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<ProcessItemCount>0</ProcessItemCount>
<ActiveProcessItemCount>0</ActiveProcessItemCount>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Active>true</Active>
<Id>00000000-0000-0000-0000-000000000000</Id>
</DistributionMarketingActivity>

Responses

Status Meaning Description Schema
200 OK Success DistributionMarketingActivity
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete DistributionMarketingActivity by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/DistributionMarketingActivity/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/DistributionMarketingActivity/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/DistributionMarketingActivity/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /DistributionMarketingActivity/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update DistributionMarketingActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/DistributionMarketingActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Description":"string","WebSite":"string","StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","Status":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"IsExternal":true,"TargetParticipantQuantity":0,"TargetResponseRatePercent":0,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/DistributionMarketingActivity", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Description\":\"string\",\"WebSite\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsExternal\":true,\"TargetParticipantQuantity\":0,\"TargetResponseRatePercent\":0,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/DistributionMarketingActivity");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Description\":\"string\",\"WebSite\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsExternal\":true,\"TargetParticipantQuantity\":0,\"TargetResponseRatePercent\":0,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /DistributionMarketingActivity

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Name": "string",
"Description": "string",
"WebSite": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsExternal": true,
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Description: string
WebSite: string
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
Status:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
IsExternal: true
TargetParticipantQuantity: 0
TargetResponseRatePercent: 0
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<DistributionMarketingActivity>
<Name>string</Name>
<Description>string</Description>
<WebSite>string</WebSite>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<IsExternal>true</IsExternal>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<Id>00000000-0000-0000-0000-000000000000</Id>
</DistributionMarketingActivity>

Parameters

Name In Type Required Description
body body DistributionMarketingActivity true none

Example responses

200 Response

{
"Name": "string",
"Description": "string",
"WebSite": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingProject": "string",
"MarketingPlan": "string",
"MarketingPlanAndProject": "string",
"TimeSpan": "string",
"IsExternal": true,
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"MarketingPlanId": "00000000-0000-0000-0000-000000000000",
"IsNew": true,
"TagCount": 0,
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"ProcessItemCount": 0,
"ActiveProcessItemCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Active": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<DistributionMarketingActivity>
<Name>string</Name>
<Description>string</Description>
<WebSite>string</WebSite>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<MarketingProject>string</MarketingProject>
<MarketingPlan>string</MarketingPlan>
<MarketingPlanAndProject>string</MarketingPlanAndProject>
<TimeSpan>string</TimeSpan>
<IsExternal>true</IsExternal>
<MarketingProjectId>00000000-0000-0000-0000-000000000000</MarketingProjectId>
<MarketingPlanId>00000000-0000-0000-0000-000000000000</MarketingPlanId>
<IsNew>true</IsNew>
<TagCount>0</TagCount>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<ProcessItemCount>0</ProcessItemCount>
<ActiveProcessItemCount>0</ActiveProcessItemCount>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Active>true</Active>
<Id>00000000-0000-0000-0000-000000000000</Id>
</DistributionMarketingActivity>

Responses

Status Meaning Description Schema
200 OK Entity Updated DistributionMarketingActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create DistributionMarketingActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/DistributionMarketingActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Description":"string","WebSite":"string","StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","Status":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"IsExternal":true,"TargetParticipantQuantity":0,"TargetResponseRatePercent":0,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/DistributionMarketingActivity", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Description\":\"string\",\"WebSite\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsExternal\":true,\"TargetParticipantQuantity\":0,\"TargetResponseRatePercent\":0,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/DistributionMarketingActivity");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Description\":\"string\",\"WebSite\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsExternal\":true,\"TargetParticipantQuantity\":0,\"TargetResponseRatePercent\":0,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /DistributionMarketingActivity

Body parameter

{
"Name": "string",
"Description": "string",
"WebSite": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsExternal": true,
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Description: string
WebSite: string
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
Status:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
IsExternal: true
TargetParticipantQuantity: 0
TargetResponseRatePercent: 0
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<DistributionMarketingActivity>
<Name>string</Name>
<Description>string</Description>
<WebSite>string</WebSite>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<IsExternal>true</IsExternal>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<Id>00000000-0000-0000-0000-000000000000</Id>
</DistributionMarketingActivity>

Parameters

Name In Type Required Description
body body DistributionMarketingActivity true none

Example responses

201 Response

{
"Name": "string",
"Description": "string",
"WebSite": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingProject": "string",
"MarketingPlan": "string",
"MarketingPlanAndProject": "string",
"TimeSpan": "string",
"IsExternal": true,
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"MarketingPlanId": "00000000-0000-0000-0000-000000000000",
"IsNew": true,
"TagCount": 0,
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"ProcessItemCount": 0,
"ActiveProcessItemCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Active": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<DistributionMarketingActivity>
<Name>string</Name>
<Description>string</Description>
<WebSite>string</WebSite>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<MarketingProject>string</MarketingProject>
<MarketingPlan>string</MarketingPlan>
<MarketingPlanAndProject>string</MarketingPlanAndProject>
<TimeSpan>string</TimeSpan>
<IsExternal>true</IsExternal>
<MarketingProjectId>00000000-0000-0000-0000-000000000000</MarketingProjectId>
<MarketingPlanId>00000000-0000-0000-0000-000000000000</MarketingPlanId>
<IsNew>true</IsNew>
<TagCount>0</TagCount>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<ProcessItemCount>0</ProcessItemCount>
<ActiveProcessItemCount>0</ActiveProcessItemCount>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Active>true</Active>
<Id>00000000-0000-0000-0000-000000000000</Id>
</DistributionMarketingActivity>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created DistributionMarketingActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for DistributionMarketingActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/DistributionMarketingActivity/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/DistributionMarketingActivity/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/DistributionMarketingActivity/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /DistributionMarketingActivity/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to DistributionMarketingActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/DistributionMarketingActivity/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/DistributionMarketingActivity/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/DistributionMarketingActivity/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /DistributionMarketingActivity/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Documents

GetDocumentById

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /documents/{id}

Parameters

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

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CreatedDate": "2019-08-24T14:15:22Z",
"UpdatedDate": "2019-08-24T14:15:22Z",
"IsExt": true,
"CreatedBy": "00000000-0000-0000-0000-000000000000",
"UpdatedBy": "00000000-0000-0000-0000-000000000000",
"Uri": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Document>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Name>string</Name>
<CreatedDate>2019-08-24T14:15:22Z</CreatedDate>
<UpdatedDate>2019-08-24T14:15:22Z</UpdatedDate>
<IsExt>true</IsExt>
<CreatedBy>00000000-0000-0000-0000-000000000000</CreatedBy>
<UpdatedBy>00000000-0000-0000-0000-000000000000</UpdatedBy>
<Uri>string</Uri>
</Document>

Responses

Status Meaning Description Schema
200 OK Document reference in sweet Document

GetDocumentFileById

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/file \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/file", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/file");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /documents/{id}/file

Parameters

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

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

EmailActivity

Retreive filtrable fields and their type for EmailActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter EmailActivity based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get EmailActivity by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"IsNew": true,
"FromString": "string",
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MessageId": "00000000-0000-0000-0000-000000000000",
"IsEditable": true,
"IsDone": true,
"Body": "string",
"From": [
"string"
],
"ToRecipients": [
"string"
],
"CcRecipients": [
"string"
],
"BccRecipients": [
"string"
],
"IsBodyHtml": true,
"SentDate": "2019-08-24T14:15:22Z",
"IncomingDate": "2019-08-24T14:15:22Z",
"IsIncomingEmail": true,
"ReadDate": "2019-08-24T14:15:22Z",
"IsExchangeActivity": true,
"ExchangeId": "string",
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"CreatedBy": "string",
"UpdatedBy": "string",
"IsCurrentUserResponsible": true,
"IsDraft": true,
"IsFromCase": true,
"IsReply": true,
"CaseId": "00000000-0000-0000-0000-000000000000",
"ReplyText": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<EmailActivity>
<IsNew>true</IsNew>
<FromString>string</FromString>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<MessageId>00000000-0000-0000-0000-000000000000</MessageId>
<IsEditable>true</IsEditable>
<IsDone>true</IsDone>
<Body>string</Body>
<From>string</From>
<ToRecipients>string</ToRecipients>
<CcRecipients>string</CcRecipients>
<BccRecipients>string</BccRecipients>
<IsBodyHtml>true</IsBodyHtml>
<SentDate>2019-08-24T14:15:22Z</SentDate>
<IncomingDate>2019-08-24T14:15:22Z</IncomingDate>
<IsIncomingEmail>true</IsIncomingEmail>
<ReadDate>2019-08-24T14:15:22Z</ReadDate>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeId>string</ExchangeId>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<IsCurrentUserResponsible>true</IsCurrentUserResponsible>
<IsDraft>true</IsDraft>
<IsFromCase>true</IsFromCase>
<IsReply>true</IsReply>
<CaseId>00000000-0000-0000-0000-000000000000</CaseId>
<ReplyText>string</ReplyText>
<Id>00000000-0000-0000-0000-000000000000</Id>
</EmailActivity>

Responses

Status Meaning Description Schema
200 OK Success EmailActivity
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete EmailActivity by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/EmailActivity/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /EmailActivity/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update EmailActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/EmailActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Subject":"string","Start":"2019-08-24T14:15:22Z","End":"2019-08-24T14:15:22Z","Status":{"Key":"string","CodeGroupKey":"string"},"IsDone":true,"Body":"string","From":["string"],"ToRecipients":["string"],"CcRecipients":["string"],"BccRecipients":["string"],"IsBodyHtml":true,"SentDate":"2019-08-24T14:15:22Z","IsExchangeActivity":true,"ExchangeId":"string","ExchangeSyncDate":"2019-08-24T14:15:22Z","ReplyText":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Body\":\"string\",\"From\":[\"string\"],\"ToRecipients\":[\"string\"],\"CcRecipients\":[\"string\"],\"BccRecipients\":[\"string\"],\"IsBodyHtml\":true,\"SentDate\":\"2019-08-24T14:15:22Z\",\"IsExchangeActivity\":true,\"ExchangeId\":\"string\",\"ExchangeSyncDate\":\"2019-08-24T14:15:22Z\",\"ReplyText\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Body\":\"string\",\"From\":[\"string\"],\"ToRecipients\":[\"string\"],\"CcRecipients\":[\"string\"],\"BccRecipients\":[\"string\"],\"IsBodyHtml\":true,\"SentDate\":\"2019-08-24T14:15:22Z\",\"IsExchangeActivity\":true,\"ExchangeId\":\"string\",\"ExchangeSyncDate\":\"2019-08-24T14:15:22Z\",\"ReplyText\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /EmailActivity

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsDone": true,
"Body": "string",
"From": [
"string"
],
"ToRecipients": [
"string"
],
"CcRecipients": [
"string"
],
"BccRecipients": [
"string"
],
"IsBodyHtml": true,
"SentDate": "2019-08-24T14:15:22Z",
"IsExchangeActivity": true,
"ExchangeId": "string",
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ReplyText": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Subject: string
Start: 2019-08-24T14:15:22Z
End: 2019-08-24T14:15:22Z
Status:
Key: string
CodeGroupKey: string
IsDone: true
Body: string
From:
- string
ToRecipients:
- string
CcRecipients:
- string
BccRecipients:
- string
IsBodyHtml: true
SentDate: 2019-08-24T14:15:22Z
IsExchangeActivity: true
ExchangeId: string
ExchangeSyncDate: 2019-08-24T14:15:22Z
ReplyText: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<EmailActivity>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<IsDone>true</IsDone>
<Body>string</Body>
<From>string</From>
<ToRecipients>string</ToRecipients>
<CcRecipients>string</CcRecipients>
<BccRecipients>string</BccRecipients>
<IsBodyHtml>true</IsBodyHtml>
<SentDate>2019-08-24T14:15:22Z</SentDate>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeId>string</ExchangeId>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<ReplyText>string</ReplyText>
<Id>00000000-0000-0000-0000-000000000000</Id>
</EmailActivity>

Parameters

Name In Type Required Description
body body EmailActivity true none

Example responses

200 Response

{
"IsNew": true,
"FromString": "string",
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MessageId": "00000000-0000-0000-0000-000000000000",
"IsEditable": true,
"IsDone": true,
"Body": "string",
"From": [
"string"
],
"ToRecipients": [
"string"
],
"CcRecipients": [
"string"
],
"BccRecipients": [
"string"
],
"IsBodyHtml": true,
"SentDate": "2019-08-24T14:15:22Z",
"IncomingDate": "2019-08-24T14:15:22Z",
"IsIncomingEmail": true,
"ReadDate": "2019-08-24T14:15:22Z",
"IsExchangeActivity": true,
"ExchangeId": "string",
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"CreatedBy": "string",
"UpdatedBy": "string",
"IsCurrentUserResponsible": true,
"IsDraft": true,
"IsFromCase": true,
"IsReply": true,
"CaseId": "00000000-0000-0000-0000-000000000000",
"ReplyText": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<EmailActivity>
<IsNew>true</IsNew>
<FromString>string</FromString>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<MessageId>00000000-0000-0000-0000-000000000000</MessageId>
<IsEditable>true</IsEditable>
<IsDone>true</IsDone>
<Body>string</Body>
<From>string</From>
<ToRecipients>string</ToRecipients>
<CcRecipients>string</CcRecipients>
<BccRecipients>string</BccRecipients>
<IsBodyHtml>true</IsBodyHtml>
<SentDate>2019-08-24T14:15:22Z</SentDate>
<IncomingDate>2019-08-24T14:15:22Z</IncomingDate>
<IsIncomingEmail>true</IsIncomingEmail>
<ReadDate>2019-08-24T14:15:22Z</ReadDate>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeId>string</ExchangeId>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<IsCurrentUserResponsible>true</IsCurrentUserResponsible>
<IsDraft>true</IsDraft>
<IsFromCase>true</IsFromCase>
<IsReply>true</IsReply>
<CaseId>00000000-0000-0000-0000-000000000000</CaseId>
<ReplyText>string</ReplyText>
<Id>00000000-0000-0000-0000-000000000000</Id>
</EmailActivity>

Responses

Status Meaning Description Schema
200 OK Entity Updated EmailActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create EmailActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Subject":"string","Start":"2019-08-24T14:15:22Z","End":"2019-08-24T14:15:22Z","Status":{"Key":"string","CodeGroupKey":"string"},"IsDone":true,"Body":"string","From":["string"],"ToRecipients":["string"],"CcRecipients":["string"],"BccRecipients":["string"],"IsBodyHtml":true,"SentDate":"2019-08-24T14:15:22Z","IsExchangeActivity":true,"ExchangeId":"string","ExchangeSyncDate":"2019-08-24T14:15:22Z","ReplyText":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Body\":\"string\",\"From\":[\"string\"],\"ToRecipients\":[\"string\"],\"CcRecipients\":[\"string\"],\"BccRecipients\":[\"string\"],\"IsBodyHtml\":true,\"SentDate\":\"2019-08-24T14:15:22Z\",\"IsExchangeActivity\":true,\"ExchangeId\":\"string\",\"ExchangeSyncDate\":\"2019-08-24T14:15:22Z\",\"ReplyText\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Body\":\"string\",\"From\":[\"string\"],\"ToRecipients\":[\"string\"],\"CcRecipients\":[\"string\"],\"BccRecipients\":[\"string\"],\"IsBodyHtml\":true,\"SentDate\":\"2019-08-24T14:15:22Z\",\"IsExchangeActivity\":true,\"ExchangeId\":\"string\",\"ExchangeSyncDate\":\"2019-08-24T14:15:22Z\",\"ReplyText\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity

Body parameter

{
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsDone": true,
"Body": "string",
"From": [
"string"
],
"ToRecipients": [
"string"
],
"CcRecipients": [
"string"
],
"BccRecipients": [
"string"
],
"IsBodyHtml": true,
"SentDate": "2019-08-24T14:15:22Z",
"IsExchangeActivity": true,
"ExchangeId": "string",
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ReplyText": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Subject: string
Start: 2019-08-24T14:15:22Z
End: 2019-08-24T14:15:22Z
Status:
Key: string
CodeGroupKey: string
IsDone: true
Body: string
From:
- string
ToRecipients:
- string
CcRecipients:
- string
BccRecipients:
- string
IsBodyHtml: true
SentDate: 2019-08-24T14:15:22Z
IsExchangeActivity: true
ExchangeId: string
ExchangeSyncDate: 2019-08-24T14:15:22Z
ReplyText: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<EmailActivity>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<IsDone>true</IsDone>
<Body>string</Body>
<From>string</From>
<ToRecipients>string</ToRecipients>
<CcRecipients>string</CcRecipients>
<BccRecipients>string</BccRecipients>
<IsBodyHtml>true</IsBodyHtml>
<SentDate>2019-08-24T14:15:22Z</SentDate>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeId>string</ExchangeId>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<ReplyText>string</ReplyText>
<Id>00000000-0000-0000-0000-000000000000</Id>
</EmailActivity>

Parameters

Name In Type Required Description
body body EmailActivity true none

Example responses

201 Response

{
"IsNew": true,
"FromString": "string",
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MessageId": "00000000-0000-0000-0000-000000000000",
"IsEditable": true,
"IsDone": true,
"Body": "string",
"From": [
"string"
],
"ToRecipients": [
"string"
],
"CcRecipients": [
"string"
],
"BccRecipients": [
"string"
],
"IsBodyHtml": true,
"SentDate": "2019-08-24T14:15:22Z",
"IncomingDate": "2019-08-24T14:15:22Z",
"IsIncomingEmail": true,
"ReadDate": "2019-08-24T14:15:22Z",
"IsExchangeActivity": true,
"ExchangeId": "string",
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"CreatedBy": "string",
"UpdatedBy": "string",
"IsCurrentUserResponsible": true,
"IsDraft": true,
"IsFromCase": true,
"IsReply": true,
"CaseId": "00000000-0000-0000-0000-000000000000",
"ReplyText": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<EmailActivity>
<IsNew>true</IsNew>
<FromString>string</FromString>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<MessageId>00000000-0000-0000-0000-000000000000</MessageId>
<IsEditable>true</IsEditable>
<IsDone>true</IsDone>
<Body>string</Body>
<From>string</From>
<ToRecipients>string</ToRecipients>
<CcRecipients>string</CcRecipients>
<BccRecipients>string</BccRecipients>
<IsBodyHtml>true</IsBodyHtml>
<SentDate>2019-08-24T14:15:22Z</SentDate>
<IncomingDate>2019-08-24T14:15:22Z</IncomingDate>
<IsIncomingEmail>true</IsIncomingEmail>
<ReadDate>2019-08-24T14:15:22Z</ReadDate>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeId>string</ExchangeId>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<IsCurrentUserResponsible>true</IsCurrentUserResponsible>
<IsDraft>true</IsDraft>
<IsFromCase>true</IsFromCase>
<IsReply>true</IsReply>
<CaseId>00000000-0000-0000-0000-000000000000</CaseId>
<ReplyText>string</ReplyText>
<Id>00000000-0000-0000-0000-000000000000</Id>
</EmailActivity>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created EmailActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for EmailActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to EmailActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

EmailActivity Relations

Filter Cases based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Cases/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Cases/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/Cases/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/Cases/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/Cases/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/Cases/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Case

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Cases", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Cases");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /EmailActivity/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Case

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Cases", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Cases");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Case relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Cases/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Cases/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Cases/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /EmailActivity/{id}/Cases/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Responsibles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Responsibles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Responsibles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/Responsibles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/Responsibles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/Responsibles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/Responsibles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to User

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Responsibles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Responsibles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /EmailActivity/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUserRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityUserRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to User

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Responsibles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Responsibles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUserRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityUserRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete User relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Responsibles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Responsibles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Responsibles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /EmailActivity/{id}/Responsibles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Companies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Companies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Companies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/Companies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/Companies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/Companies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/Companies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Company

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Companies", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Companies");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /EmailActivity/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Company

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Companies", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Companies");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Company relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Companies/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Companies/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Companies/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /EmailActivity/{id}/Companies/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter CompanyGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/CompanyGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/CompanyGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/CompanyGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/CompanyGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/CompanyGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/CompanyGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to CompanyGroup

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/EmailActivity/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/CompanyGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/CompanyGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /EmailActivity/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyGroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to CompanyGroup

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/CompanyGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/CompanyGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyGroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete CompanyGroup relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/EmailActivity/string/CompanyGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/CompanyGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/CompanyGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /EmailActivity/{id}/CompanyGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Deals based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Deals/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Deals/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/Deals/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/Deals/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/Deals/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/Deals/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to BusinessProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Deals", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Deals");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /EmailActivity/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityBusinessProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityBusinessProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to BusinessProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Deals", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Deals");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityBusinessProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityBusinessProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete BusinessProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Deals/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Deals/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Deals/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /EmailActivity/{id}/Deals/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter PrivatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/PrivatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/PrivatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/PrivatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/PrivatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/PrivatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/PrivatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to PrivatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/EmailActivity/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/PrivatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/PrivatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /EmailActivity/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityPrivatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to PrivatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/PrivatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/PrivatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityPrivatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete PrivatePerson relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/EmailActivity/string/PrivatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/PrivatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/PrivatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /EmailActivity/{id}/PrivatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter MarketingActivities based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/MarketingActivities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingActivities/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingActivities/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/MarketingActivities/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/MarketingActivities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/MarketingActivities/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/MarketingActivities/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/MarketingActivities/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to MarketingActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/EmailActivity/string/MarketingActivities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingActivities", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingActivities");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /EmailActivity/{id}/MarketingActivities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityMarketingActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to MarketingActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/MarketingActivities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingActivities", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingActivities");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/MarketingActivities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityMarketingActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete MarketingActivity relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/EmailActivity/string/MarketingActivities/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingActivities/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingActivities/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /EmailActivity/{id}/MarketingActivities/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter MarketingProjects based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingProjects/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingProjects/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/MarketingProjects/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/MarketingProjects/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/MarketingProjects/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/MarketingProjects/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to MarketingProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/EmailActivity/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingProjects", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingProjects");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /EmailActivity/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityMarketingProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to MarketingProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingProjects", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingProjects");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityMarketingProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete MarketingProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/EmailActivity/string/MarketingProjects/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingProjects/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/MarketingProjects/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /EmailActivity/{id}/MarketingProjects/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Workorders based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Workorders/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Workorders/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Workorders/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/Workorders/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/Workorders/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/Workorders/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/Workorders/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/Workorders/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Workorder

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Workorders \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Workorders", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Workorders");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /EmailActivity/{id}/Workorders

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Workorder

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Workorders \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Workorders", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Workorders");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/Workorders

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Workorder relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Workorders/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Workorders/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Workorders/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /EmailActivity/{id}/Workorders/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ResponsibleUserGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/ResponsibleUserGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/ResponsibleUserGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/ResponsibleUserGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/ResponsibleUserGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/ResponsibleUserGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/ResponsibleUserGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/ResponsibleUserGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/ResponsibleUserGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Group

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/EmailActivity/string/ResponsibleUserGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/ResponsibleUserGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/ResponsibleUserGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /EmailActivity/{id}/ResponsibleUserGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUsergroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityUsergroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Group

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/ResponsibleUserGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/ResponsibleUserGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/ResponsibleUserGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/ResponsibleUserGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUsergroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityUsergroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Group relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/EmailActivity/string/ResponsibleUserGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/ResponsibleUserGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/ResponsibleUserGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /EmailActivity/{id}/ResponsibleUserGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ServiceArticles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/ServiceArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/ServiceArticles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/ServiceArticles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/ServiceArticles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/ServiceArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/ServiceArticles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/ServiceArticles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/ServiceArticles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Article

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Articles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Articles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Articles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /EmailActivity/{id}/Articles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ArticleActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Article

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Articles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Articles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Articles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/Articles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ArticleActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Article relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Articles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Articles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Articles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /EmailActivity/{id}/Articles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ProductArticles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/ProductArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/ProductArticles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/ProductArticles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/ProductArticles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/ProductArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/ProductArticles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/ProductArticles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/ProductArticles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Filter Articles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/EmailActivity/string/Articles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/EmailActivity/string/Articles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/string/Articles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /EmailActivity/{id}/Articles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/EmailActivity/Articles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/EmailActivity/Articles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/EmailActivity/Articles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /EmailActivity/Articles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Forms

CreateAnswerset

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Forms/Answerset \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"id":"00000000-0000-0000-0000-000000000000","questionKeyAnswers":[{"key":"string","answer":["string"]}]}'
fetch("https://testing.sweetsystems.se/api/Forms/Answerset", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"id\":\"00000000-0000-0000-0000-000000000000\",\"questionKeyAnswers\":[{\"key\":\"string\",\"answer\":[\"string\"]}]}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Forms/Answerset");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"id\":\"00000000-0000-0000-0000-000000000000\",\"questionKeyAnswers\":[{\"key\":\"string\",\"answer\":[\"string\"]}]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Forms/Answerset

Body parameter

{
"id": "00000000-0000-0000-0000-000000000000",
"questionKeyAnswers": [
{
"key": "string",
"answer": [
"string"
]
}
]
}
id: 00000000-0000-0000-0000-000000000000
questionKeyAnswers:
- key: string
answer:
- string
<?xml version="1.0" encoding="UTF-8" ?>
<PostAnswersetArgument>
<id>00000000-0000-0000-0000-000000000000</id>
<questionKeyAnswers>
<key>string</key>
<answer>string</answer>
</questionKeyAnswers>
</PostAnswersetArgument>

Parameters

Name In Type Required Description
body body PostAnswersetArgument true none

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK redirect url to the answerset created string
201 Created Created string
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

GetAnswersetByAnswerSetId

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Forms/Answerset/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Forms/Answerset/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Forms/Answerset/497f6eca-6276-4993-bfeb-53cbbbba6f08");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Forms/Answerset/{answersetId}

Parameters

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

Example responses

200 Response

{
"Answers": {
"property1": {
"property1": {
"Answers": [
"string"
],
"RowId": "00000000-0000-0000-0000-000000000000"
},
"property2": {
"Answers": [
"string"
],
"RowId": "00000000-0000-0000-0000-000000000000"
}
},
"property2": {
"property1": {
"Answers": [
"string"
],
"RowId": "00000000-0000-0000-0000-000000000000"
},
"property2": {
"Answers": [
"string"
],
"RowId": "00000000-0000-0000-0000-000000000000"
}
}
},
"Documents": {
"property1": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"Index": 0,
"DocumentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomRowId": "00000000-0000-0000-0000-000000000000",
"Path": "string",
"ContentType": "string",
"IsImage": true,
"Extension": "string",
"Length": 0
}
],
"property2": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"Index": 0,
"DocumentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomRowId": "00000000-0000-0000-0000-000000000000",
"Path": "string",
"ContentType": "string",
"IsImage": true,
"Extension": "string",
"Length": 0
}
]
},
"LockedQuestions": {
"property1": {
"LockedBy": "string",
"LockedDate": "2019-08-24T14:15:22Z",
"LockedDateInt": 0.1
},
"property2": {
"LockedBy": "string",
"LockedDate": "2019-08-24T14:15:22Z",
"LockedDateInt": 0.1
}
},
"Id": "00000000-0000-0000-0000-000000000000",
"SurveyId": "00000000-0000-0000-0000-000000000000",
"SurveyVersionId": "00000000-0000-0000-0000-000000000000",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"LockedDate": "2019-08-24T14:15:22Z",
"Version": 0,
"LCID": 0,
"IsNew": true,
"DocumentId": "00000000-0000-0000-0000-000000000000",
"AnsweredQuestionsOnPages": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"StartDateInt": 0.1,
"StartDateString": "string",
"EndDateInt": 0.1,
"EndDateString": "string",
"FormPackageInstanceId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<AnswerSet>
<Answers>
<property1>
<property1>
<Answers>string</Answers>
<RowId>00000000-0000-0000-0000-000000000000</RowId>
</property1>
<property2>
<Answers>string</Answers>
<RowId>00000000-0000-0000-0000-000000000000</RowId>
</property2>
</property1>
<property2>
<property1>
<Answers>string</Answers>
<RowId>00000000-0000-0000-0000-000000000000</RowId>
</property1>
<property2>
<Answers>string</Answers>
<RowId>00000000-0000-0000-0000-000000000000</RowId>
</property2>
</property2>
</Answers>
<Documents>
<property1>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Index>0</Index>
<DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
<Name>string</Name>
<CustomRowId>00000000-0000-0000-0000-000000000000</CustomRowId>
<Path>string</Path>
<ContentType>string</ContentType>
<IsImage>true</IsImage>
<Extension>string</Extension>
<Length>0</Length>
</property1>
<property2>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Index>0</Index>
<DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
<Name>string</Name>
<CustomRowId>00000000-0000-0000-0000-000000000000</CustomRowId>
<Path>string</Path>
<ContentType>string</ContentType>
<IsImage>true</IsImage>
<Extension>string</Extension>
<Length>0</Length>
</property2>
</Documents>
<LockedQuestions>
<property1>
<LockedBy>string</LockedBy>
<LockedDate>2019-08-24T14:15:22Z</LockedDate>
<LockedDateInt>0.1</LockedDateInt>
</property1>
<property2>
<LockedBy>string</LockedBy>
<LockedDate>2019-08-24T14:15:22Z</LockedDate>
<LockedDateInt>0.1</LockedDateInt>
</property2>
</LockedQuestions>
<Id>00000000-0000-0000-0000-000000000000</Id>
<SurveyId>00000000-0000-0000-0000-000000000000</SurveyId>
<SurveyVersionId>00000000-0000-0000-0000-000000000000</SurveyVersionId>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<LockedDate>2019-08-24T14:15:22Z</LockedDate>
<Version>0</Version>
<LCID>0</LCID>
<IsNew>true</IsNew>
<DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
<AnsweredQuestionsOnPages>
<property1>string</property1>
<property2>string</property2>
</AnsweredQuestionsOnPages>
<StartDateInt>0.1</StartDateInt>
<StartDateString>string</StartDateString>
<EndDateInt>0.1</EndDateInt>
<EndDateString>string</EndDateString>
<FormPackageInstanceId>00000000-0000-0000-0000-000000000000</FormPackageInstanceId>
</AnswerSet>

Responses

Status Meaning Description Schema
200 OK OK AnswerSet
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

GetAnswerSetValuePairs

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Forms/Answerset/497f6eca-6276-4993-bfeb-53cbbbba6f08/Answers \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Forms/Answerset/497f6eca-6276-4993-bfeb-53cbbbba6f08/Answers", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Forms/Answerset/497f6eca-6276-4993-bfeb-53cbbbba6f08/Answers");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Forms/Answerset/{answersetId}/Answers

Parameters

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

Example responses

200 Response

[
{
"key": "string",
"answer": [
"string"
]
}
]
<?xml version="1.0" encoding="UTF-8" ?>
<key>string</key>
<answer>string</answer>

Responses

Status Meaning Description Schema
200 OK OK Inline
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [QuestionKeyAnswer] false none none
» key string false none none
» answer [string] false none none

GetAnswersetDigitalSignatureByAnswerSetId

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Forms/Answerset/497f6eca-6276-4993-bfeb-53cbbbba6f08/DigitalSignature \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Forms/Answerset/497f6eca-6276-4993-bfeb-53cbbbba6f08/DigitalSignature", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Forms/Answerset/497f6eca-6276-4993-bfeb-53cbbbba6f08/DigitalSignature");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Forms/Answerset/{answersetId}/DigitalSignature

Parameters

Name In Type Required Description
answersetId path string(uuid) true none
syncDigitalSignature query boolean false none

Example responses

200 Response

{
"AnswerSetId": "00000000-0000-0000-0000-000000000000",
"SignedDocumentId": "00000000-0000-0000-0000-000000000000",
"DigitalSignatureId": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Status": "string",
"Success": true,
"StatusDetail": "string",
"RedirectUrl": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<AnswerSetDigitalSignature>
<AnswerSetId>00000000-0000-0000-0000-000000000000</AnswerSetId>
<SignedDocumentId>00000000-0000-0000-0000-000000000000</SignedDocumentId>
<DigitalSignatureId>string</DigitalSignatureId>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Status>string</Status>
<Success>true</Success>
<StatusDetail>string</StatusDetail>
<RedirectUrl>string</RedirectUrl>
</AnswerSetDigitalSignature>

Responses

Status Meaning Description Schema
200 OK OK AnswerSetDigitalSignature
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

GetCompletedAnswerSetsSince

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Forms/Answerset/2019-08-24T14%3A15%3A22Z \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Forms/Answerset/2019-08-24T14%3A15%3A22Z", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Forms/Answerset/2019-08-24T14%3A15%3A22Z");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Forms/Answerset/{completedSince}

Parameters

Name In Type Required Description
completedSince path string(date-time) true none

Example responses

200 Response

[
{
"AnswerSetId": "00000000-0000-0000-0000-000000000000",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"LockedDate": "2019-08-24T14:15:22Z",
"LCID": 0,
"SurveyId": "00000000-0000-0000-0000-000000000000",
"SurveyVersionId": "00000000-0000-0000-0000-000000000000",
"SurveyKey": "string",
"Version": 0,
"RequireDigitalSignature": true,
"DocumentId": "00000000-0000-0000-0000-000000000000",
"DocumentName": "string",
"SignedDocumentId": "00000000-0000-0000-0000-000000000000",
"SignedDocumentName": "string",
"DigitalSignatureId": "string",
"SignedLanguage": "string",
"SignedStatus": "string",
"SignedTags": {
"property1": "string",
"property2": "string"
},
"SignStartDate": "2019-08-24T14:15:22Z",
"SignEndDate": "2019-08-24T14:15:22Z"
}
]
<?xml version="1.0" encoding="UTF-8" ?>
<AnswerSetId>00000000-0000-0000-0000-000000000000</AnswerSetId>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<LockedDate>2019-08-24T14:15:22Z</LockedDate>
<LCID>0</LCID>
<SurveyId>00000000-0000-0000-0000-000000000000</SurveyId>
<SurveyVersionId>00000000-0000-0000-0000-000000000000</SurveyVersionId>
<SurveyKey>string</SurveyKey>
<Version>0</Version>
<RequireDigitalSignature>true</RequireDigitalSignature>
<DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
<DocumentName>string</DocumentName>
<SignedDocumentId>00000000-0000-0000-0000-000000000000</SignedDocumentId>
<SignedDocumentName>string</SignedDocumentName>
<DigitalSignatureId>string</DigitalSignatureId>
<SignedLanguage>string</SignedLanguage>
<SignedStatus>string</SignedStatus>
<SignedTags>
<property1>string</property1>
<property2>string</property2>
</SignedTags>
<SignStartDate>2019-08-24T14:15:22Z</SignStartDate>
<SignEndDate>2019-08-24T14:15:22Z</SignEndDate>

Responses

Status Meaning Description Schema
200 OK OK Inline
500 Internal Server Error InternalServerError None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [CompletedAnswerSet] false none none
» AnswerSetId string(uuid) false none none
» StartDate string(date-time) false none none
» EndDate string(date-time) false none none
» LockedDate string(date-time) false none none
» LCID integer(int32) false none none
» SurveyId string(uuid) false none none
» SurveyVersionId string(uuid) false none none
» SurveyKey string false none none
» Version integer(int32) false none none
» RequireDigitalSignature boolean false none none
» DocumentId string(uuid) false none none
» DocumentName string false none none
» SignedDocumentId string(uuid) false none none
» SignedDocumentName string false none none
» DigitalSignatureId string false none none
» SignedLanguage string false none none
» SignedStatus string false none none
» SignedTags object false none none
»» additionalProperties string false none none
» SignStartDate string(date-time) false none none
» SignEndDate string(date-time) false none none

GetAnswersetsByFormId

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Forms/497f6eca-6276-4993-bfeb-53cbbbba6f08/Answerset \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Forms/497f6eca-6276-4993-bfeb-53cbbbba6f08/Answerset", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Forms/497f6eca-6276-4993-bfeb-53cbbbba6f08/Answerset");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Forms/{id}/Answerset

Parameters

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

Example responses

200 Response

[
{
"id": "00000000-0000-0000-0000-000000000000",
"started": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"form_version": 0
}
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>00000000-0000-0000-0000-000000000000</id>
<started>2019-08-24T14:15:22Z</started>
<endDate>2019-08-24T14:15:22Z</endDate>
<form_version>0</form_version>

Responses

Status Meaning Description Schema
200 OK OK Inline
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AnswersetSummary] false none none
» id string(uuid) false none none
» started string(date-time) false none none
» endDate string(date-time) false none none
» form_version integer(int32) false none none

GetAnswersetsByFormIdAfterEndDate

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Forms/497f6eca-6276-4993-bfeb-53cbbbba6f08/Answerset/2019-08-24T14%3A15%3A22Z \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Forms/497f6eca-6276-4993-bfeb-53cbbbba6f08/Answerset/2019-08-24T14%3A15%3A22Z", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Forms/497f6eca-6276-4993-bfeb-53cbbbba6f08/Answerset/2019-08-24T14%3A15%3A22Z");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Forms/{id}/Answerset/{afterEndDate}

Parameters

Name In Type Required Description
id path string(uuid) true none
afterEndDate path string(date-time) true none

Example responses

200 Response

[
{
"id": "00000000-0000-0000-0000-000000000000",
"started": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"form_version": 0
}
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>00000000-0000-0000-0000-000000000000</id>
<started>2019-08-24T14:15:22Z</started>
<endDate>2019-08-24T14:15:22Z</endDate>
<form_version>0</form_version>

Responses

Status Meaning Description Schema
200 OK OK Inline
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AnswersetSummary] false none none
» id string(uuid) false none none
» started string(date-time) false none none
» endDate string(date-time) false none none
» form_version integer(int32) false none none

SyncDigitalSignatures

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Forms/SyncDigitalSignatures \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Forms/SyncDigitalSignatures", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Forms/SyncDigitalSignatures");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Forms/SyncDigitalSignatures

Responses

Status Meaning Description Schema
200 OK OK None
500 Internal Server Error InternalServerError None

GetFormDefinitionById

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Forms/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Forms/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Forms/497f6eca-6276-4993-bfeb-53cbbbba6f08");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Forms/{id}

Parameters

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

Example responses

200 Response

{
"id": "string",
"questions": [
{
"key": "string",
"parentKey": "string",
"type": "string",
"text": "string"
}
]
}
<?xml version="1.0" encoding="UTF-8" ?>
<Form>
<id>string</id>
<questions>
<key>string</key>
<parentKey>string</parentKey>
<type>string</type>
<text>string</text>
</questions>
</Form>

Responses

Status Meaning Description Schema
200 OK OK Form
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

GetFormDefinitions

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Forms \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Forms", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Forms");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Forms

Example responses

200 Response

[
{
"id": "00000000-0000-0000-0000-000000000000",
"key": "string",
"name": [
{
"lcid": 0,
"caption": "string"
}
]
}
]
<?xml version="1.0" encoding="UTF-8" ?>
<id>00000000-0000-0000-0000-000000000000</id>
<key>string</key>
<name>
<lcid>0</lcid>
<caption>string</caption>
</name>

Responses

Status Meaning Description Schema
200 OK id/key of forms Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [FormIdKey] false none none
» id string(uuid) false none none
» key string false none none
» name [FormText] false none none
»» lcid integer(int32) false none none
»» caption string false none none

Hooks

Hooks_GetHookTypes

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Hooks/Types \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Hooks/Types", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Hooks/Types");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Hooks/Types

Responses

Status Meaning Description Schema
200 OK list of possible hook types None
401 Unauthorized wrong or missing api key None

Hooks_GetHooks

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Hooks \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Hooks", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Hooks");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Hooks

Responses

Status Meaning Description Schema
200 OK list of registered hooks None
401 Unauthorized wrong or missing api key None

Hooks_RegisterHook

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Hooks \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"event":"string","target_url":"string"}'
fetch("https://testing.sweetsystems.se/api/Hooks", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"event\":\"string\",\"target_url\":\"string\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Hooks");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"event\":\"string\",\"target_url\":\"string\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Hooks

Body parameter

{
"event": "string",
"target_url": "string"
}
event: string
target_url: string
<?xml version="1.0" encoding="UTF-8" ?>
<Hook>
<event>string</event>
<target_url>string</target_url>
</Hook>

Parameters

Name In Type Required Description
body body Hook true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline
201 Created hook is created None
204 No Content hook is updated None
400 Bad Request mallformed callback url None
401 Unauthorized wrong or missing api key None

Response Schema

Hooks_UnregisterHook

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Hooks \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '"string"'
fetch("https://testing.sweetsystems.se/api/Hooks", {
"method": "DELETE",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "\"string\""
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Hooks");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "\"string\"", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

DELETE /Hooks

Body parameter

"string"
string

Parameters

Name In Type Required Description
body body string true none

Responses

Status Meaning Description Schema
200 OK hook deleted None
400 Bad Request Missing event None
401 Unauthorized wrong or missing api key None

Issue

Retreive filtrable fields and their type for Issue

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Issue/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Issue/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter Issue based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Issue/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get Issue by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Issue/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Issue/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"IssueId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CaseNumber": "string",
"Priority": "low",
"OrderNumber": "string",
"Source": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Deadline": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"RegistrationDate": "2019-08-24T14:15:22Z",
"PlannedEndDate": "2019-08-24T14:15:22Z",
"InvestigationDate": "2019-08-24T14:15:22Z",
"ActualEndDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"HasDocument": true,
"Description": "string",
"IsFavorite": true,
"IsFollowing": true,
"MayUnfollow": true,
"IsNew": true,
"HasNoteAttachment": true,
"HasExternalNoteAttachment": true,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"NameLong": "string",
"ResponsibleLong": "string",
"CreatedBy": "string",
"CreatedByUser": "string",
"UpdatedBy": "string",
"StatusLong": "string",
"IsDue": true,
"Company": "string",
"CompanyId": "00000000-0000-0000-0000-000000000000",
"PrivatePerson": "string",
"PrivatePersonId": "00000000-0000-0000-0000-000000000000",
"CorporatePersonId": "00000000-0000-0000-0000-000000000000",
"CorporatePerson": "string",
"CompanyCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePersonsCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePersonsCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"Longitude": 0.1,
"Latitude": 0.1,
"TagCount": 0,
"AccountId": "00000000-0000-0000-0000-000000000000",
"Followers": [
"string"
],
"DescriptionRawText": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Issue>
<IssueId>00000000-0000-0000-0000-000000000000</IssueId>
<Name>string</Name>
<CaseNumber>string</CaseNumber>
<Priority>low</Priority>
<OrderNumber>string</OrderNumber>
<Source>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Source>
<Deadline>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Deadline>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<RegistrationDate>2019-08-24T14:15:22Z</RegistrationDate>
<PlannedEndDate>2019-08-24T14:15:22Z</PlannedEndDate>
<InvestigationDate>2019-08-24T14:15:22Z</InvestigationDate>
<ActualEndDate>2019-08-24T14:15:22Z</ActualEndDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<HasDocument>true</HasDocument>
<Description>string</Description>
<IsFavorite>true</IsFavorite>
<IsFollowing>true</IsFollowing>
<MayUnfollow>true</MayUnfollow>
<IsNew>true</IsNew>
<HasNoteAttachment>true</HasNoteAttachment>
<HasExternalNoteAttachment>true</HasExternalNoteAttachment>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<NameLong>string</NameLong>
<ResponsibleLong>string</ResponsibleLong>
<CreatedBy>string</CreatedBy>
<CreatedByUser>string</CreatedByUser>
<UpdatedBy>string</UpdatedBy>
<StatusLong>string</StatusLong>
<IsDue>true</IsDue>
<Company>string</Company>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<PrivatePerson>string</PrivatePerson>
<PrivatePersonId>00000000-0000-0000-0000-000000000000</PrivatePersonId>
<CorporatePersonId>00000000-0000-0000-0000-000000000000</CorporatePersonId>
<CorporatePerson>string</CorporatePerson>
<CompanyCustomers>00000000-0000-0000-0000-000000000000</CompanyCustomers>
<CorporatePersonsCustomers>00000000-0000-0000-0000-000000000000</CorporatePersonsCustomers>
<PrivatePersonsCustomers>00000000-0000-0000-0000-000000000000</PrivatePersonsCustomers>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<TagCount>0</TagCount>
<AccountId>00000000-0000-0000-0000-000000000000</AccountId>
<Followers>string</Followers>
<DescriptionRawText>string</DescriptionRawText>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Issue>

Responses

Status Meaning Description Schema
200 OK Success Issue
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete Issue by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Issue/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Issue/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update Issue

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Issue \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Priority":"low","OrderNumber":"string","Source":{"Key":"string","CodeGroupKey":"string"},"Deadline":{"Key":"string","CodeGroupKey":"string"},"Type":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"RegistrationDate":"2019-08-24T14:15:22Z","PlannedEndDate":"2019-08-24T14:15:22Z","InvestigationDate":"2019-08-24T14:15:22Z","ActualEndDate":"2019-08-24T14:15:22Z","Status":{"Key":"string","CodeGroupKey":"string"},"Description":"string","Responsible":["00000000-0000-0000-0000-000000000000"],"CompanyCustomers":["00000000-0000-0000-0000-000000000000"],"CorporatePersonsCustomers":["00000000-0000-0000-0000-000000000000"],"PrivatePersonsCustomers":["00000000-0000-0000-0000-000000000000"],"Longitude":0.1,"Latitude":0.1,"AccountId":"00000000-0000-0000-0000-000000000000","Followers":["string"],"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Priority\":\"low\",\"OrderNumber\":\"string\",\"Source\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Deadline\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"RegistrationDate\":\"2019-08-24T14:15:22Z\",\"PlannedEndDate\":\"2019-08-24T14:15:22Z\",\"InvestigationDate\":\"2019-08-24T14:15:22Z\",\"ActualEndDate\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Description\":\"string\",\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"CompanyCustomers\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePersonsCustomers\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePersonsCustomers\":[\"00000000-0000-0000-0000-000000000000\"],\"Longitude\":0.1,\"Latitude\":0.1,\"AccountId\":\"00000000-0000-0000-0000-000000000000\",\"Followers\":[\"string\"],\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Priority\":\"low\",\"OrderNumber\":\"string\",\"Source\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Deadline\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"RegistrationDate\":\"2019-08-24T14:15:22Z\",\"PlannedEndDate\":\"2019-08-24T14:15:22Z\",\"InvestigationDate\":\"2019-08-24T14:15:22Z\",\"ActualEndDate\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Description\":\"string\",\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"CompanyCustomers\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePersonsCustomers\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePersonsCustomers\":[\"00000000-0000-0000-0000-000000000000\"],\"Longitude\":0.1,\"Latitude\":0.1,\"AccountId\":\"00000000-0000-0000-0000-000000000000\",\"Followers\":[\"string\"],\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Issue

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Name": "string",
"Priority": "low",
"OrderNumber": "string",
"Source": {
"Key": "string",
"CodeGroupKey": "string"
},
"Deadline": {
"Key": "string",
"CodeGroupKey": "string"
},
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"RegistrationDate": "2019-08-24T14:15:22Z",
"PlannedEndDate": "2019-08-24T14:15:22Z",
"InvestigationDate": "2019-08-24T14:15:22Z",
"ActualEndDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Description": "string",
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"CompanyCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePersonsCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePersonsCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"Longitude": 0.1,
"Latitude": 0.1,
"AccountId": "00000000-0000-0000-0000-000000000000",
"Followers": [
"string"
],
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Priority: low
OrderNumber: string
Source:
Key: string
CodeGroupKey: string
Deadline:
Key: string
CodeGroupKey: string
Type:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
RegistrationDate: 2019-08-24T14:15:22Z
PlannedEndDate: 2019-08-24T14:15:22Z
InvestigationDate: 2019-08-24T14:15:22Z
ActualEndDate: 2019-08-24T14:15:22Z
Status:
Key: string
CodeGroupKey: string
Description: string
Responsible:
- 00000000-0000-0000-0000-000000000000
CompanyCustomers:
- 00000000-0000-0000-0000-000000000000
CorporatePersonsCustomers:
- 00000000-0000-0000-0000-000000000000
PrivatePersonsCustomers:
- 00000000-0000-0000-0000-000000000000
Longitude: 0.1
Latitude: 0.1
AccountId: 00000000-0000-0000-0000-000000000000
Followers:
- string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Issue>
<Name>string</Name>
<Priority>low</Priority>
<OrderNumber>string</OrderNumber>
<Source>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Source>
<Deadline>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Deadline>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<RegistrationDate>2019-08-24T14:15:22Z</RegistrationDate>
<PlannedEndDate>2019-08-24T14:15:22Z</PlannedEndDate>
<InvestigationDate>2019-08-24T14:15:22Z</InvestigationDate>
<ActualEndDate>2019-08-24T14:15:22Z</ActualEndDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Description>string</Description>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<CompanyCustomers>00000000-0000-0000-0000-000000000000</CompanyCustomers>
<CorporatePersonsCustomers>00000000-0000-0000-0000-000000000000</CorporatePersonsCustomers>
<PrivatePersonsCustomers>00000000-0000-0000-0000-000000000000</PrivatePersonsCustomers>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<AccountId>00000000-0000-0000-0000-000000000000</AccountId>
<Followers>string</Followers>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Issue>

Parameters

Name In Type Required Description
body body Issue true none

Example responses

200 Response

{
"IssueId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CaseNumber": "string",
"Priority": "low",
"OrderNumber": "string",
"Source": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Deadline": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"RegistrationDate": "2019-08-24T14:15:22Z",
"PlannedEndDate": "2019-08-24T14:15:22Z",
"InvestigationDate": "2019-08-24T14:15:22Z",
"ActualEndDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"HasDocument": true,
"Description": "string",
"IsFavorite": true,
"IsFollowing": true,
"MayUnfollow": true,
"IsNew": true,
"HasNoteAttachment": true,
"HasExternalNoteAttachment": true,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"NameLong": "string",
"ResponsibleLong": "string",
"CreatedBy": "string",
"CreatedByUser": "string",
"UpdatedBy": "string",
"StatusLong": "string",
"IsDue": true,
"Company": "string",
"CompanyId": "00000000-0000-0000-0000-000000000000",
"PrivatePerson": "string",
"PrivatePersonId": "00000000-0000-0000-0000-000000000000",
"CorporatePersonId": "00000000-0000-0000-0000-000000000000",
"CorporatePerson": "string",
"CompanyCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePersonsCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePersonsCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"Longitude": 0.1,
"Latitude": 0.1,
"TagCount": 0,
"AccountId": "00000000-0000-0000-0000-000000000000",
"Followers": [
"string"
],
"DescriptionRawText": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Issue>
<IssueId>00000000-0000-0000-0000-000000000000</IssueId>
<Name>string</Name>
<CaseNumber>string</CaseNumber>
<Priority>low</Priority>
<OrderNumber>string</OrderNumber>
<Source>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Source>
<Deadline>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Deadline>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<RegistrationDate>2019-08-24T14:15:22Z</RegistrationDate>
<PlannedEndDate>2019-08-24T14:15:22Z</PlannedEndDate>
<InvestigationDate>2019-08-24T14:15:22Z</InvestigationDate>
<ActualEndDate>2019-08-24T14:15:22Z</ActualEndDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<HasDocument>true</HasDocument>
<Description>string</Description>
<IsFavorite>true</IsFavorite>
<IsFollowing>true</IsFollowing>
<MayUnfollow>true</MayUnfollow>
<IsNew>true</IsNew>
<HasNoteAttachment>true</HasNoteAttachment>
<HasExternalNoteAttachment>true</HasExternalNoteAttachment>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<NameLong>string</NameLong>
<ResponsibleLong>string</ResponsibleLong>
<CreatedBy>string</CreatedBy>
<CreatedByUser>string</CreatedByUser>
<UpdatedBy>string</UpdatedBy>
<StatusLong>string</StatusLong>
<IsDue>true</IsDue>
<Company>string</Company>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<PrivatePerson>string</PrivatePerson>
<PrivatePersonId>00000000-0000-0000-0000-000000000000</PrivatePersonId>
<CorporatePersonId>00000000-0000-0000-0000-000000000000</CorporatePersonId>
<CorporatePerson>string</CorporatePerson>
<CompanyCustomers>00000000-0000-0000-0000-000000000000</CompanyCustomers>
<CorporatePersonsCustomers>00000000-0000-0000-0000-000000000000</CorporatePersonsCustomers>
<PrivatePersonsCustomers>00000000-0000-0000-0000-000000000000</PrivatePersonsCustomers>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<TagCount>0</TagCount>
<AccountId>00000000-0000-0000-0000-000000000000</AccountId>
<Followers>string</Followers>
<DescriptionRawText>string</DescriptionRawText>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Issue>

Responses

Status Meaning Description Schema
200 OK Entity Updated Issue
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create Issue

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Priority":"low","OrderNumber":"string","Source":{"Key":"string","CodeGroupKey":"string"},"Deadline":{"Key":"string","CodeGroupKey":"string"},"Type":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"RegistrationDate":"2019-08-24T14:15:22Z","PlannedEndDate":"2019-08-24T14:15:22Z","InvestigationDate":"2019-08-24T14:15:22Z","ActualEndDate":"2019-08-24T14:15:22Z","Status":{"Key":"string","CodeGroupKey":"string"},"Description":"string","Responsible":["00000000-0000-0000-0000-000000000000"],"CompanyCustomers":["00000000-0000-0000-0000-000000000000"],"CorporatePersonsCustomers":["00000000-0000-0000-0000-000000000000"],"PrivatePersonsCustomers":["00000000-0000-0000-0000-000000000000"],"Longitude":0.1,"Latitude":0.1,"AccountId":"00000000-0000-0000-0000-000000000000","Followers":["string"],"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Priority\":\"low\",\"OrderNumber\":\"string\",\"Source\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Deadline\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"RegistrationDate\":\"2019-08-24T14:15:22Z\",\"PlannedEndDate\":\"2019-08-24T14:15:22Z\",\"InvestigationDate\":\"2019-08-24T14:15:22Z\",\"ActualEndDate\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Description\":\"string\",\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"CompanyCustomers\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePersonsCustomers\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePersonsCustomers\":[\"00000000-0000-0000-0000-000000000000\"],\"Longitude\":0.1,\"Latitude\":0.1,\"AccountId\":\"00000000-0000-0000-0000-000000000000\",\"Followers\":[\"string\"],\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Priority\":\"low\",\"OrderNumber\":\"string\",\"Source\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Deadline\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"RegistrationDate\":\"2019-08-24T14:15:22Z\",\"PlannedEndDate\":\"2019-08-24T14:15:22Z\",\"InvestigationDate\":\"2019-08-24T14:15:22Z\",\"ActualEndDate\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Description\":\"string\",\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"CompanyCustomers\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePersonsCustomers\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePersonsCustomers\":[\"00000000-0000-0000-0000-000000000000\"],\"Longitude\":0.1,\"Latitude\":0.1,\"AccountId\":\"00000000-0000-0000-0000-000000000000\",\"Followers\":[\"string\"],\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue

Body parameter

{
"Name": "string",
"Priority": "low",
"OrderNumber": "string",
"Source": {
"Key": "string",
"CodeGroupKey": "string"
},
"Deadline": {
"Key": "string",
"CodeGroupKey": "string"
},
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"RegistrationDate": "2019-08-24T14:15:22Z",
"PlannedEndDate": "2019-08-24T14:15:22Z",
"InvestigationDate": "2019-08-24T14:15:22Z",
"ActualEndDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Description": "string",
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"CompanyCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePersonsCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePersonsCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"Longitude": 0.1,
"Latitude": 0.1,
"AccountId": "00000000-0000-0000-0000-000000000000",
"Followers": [
"string"
],
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Priority: low
OrderNumber: string
Source:
Key: string
CodeGroupKey: string
Deadline:
Key: string
CodeGroupKey: string
Type:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
RegistrationDate: 2019-08-24T14:15:22Z
PlannedEndDate: 2019-08-24T14:15:22Z
InvestigationDate: 2019-08-24T14:15:22Z
ActualEndDate: 2019-08-24T14:15:22Z
Status:
Key: string
CodeGroupKey: string
Description: string
Responsible:
- 00000000-0000-0000-0000-000000000000
CompanyCustomers:
- 00000000-0000-0000-0000-000000000000
CorporatePersonsCustomers:
- 00000000-0000-0000-0000-000000000000
PrivatePersonsCustomers:
- 00000000-0000-0000-0000-000000000000
Longitude: 0.1
Latitude: 0.1
AccountId: 00000000-0000-0000-0000-000000000000
Followers:
- string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Issue>
<Name>string</Name>
<Priority>low</Priority>
<OrderNumber>string</OrderNumber>
<Source>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Source>
<Deadline>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Deadline>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<RegistrationDate>2019-08-24T14:15:22Z</RegistrationDate>
<PlannedEndDate>2019-08-24T14:15:22Z</PlannedEndDate>
<InvestigationDate>2019-08-24T14:15:22Z</InvestigationDate>
<ActualEndDate>2019-08-24T14:15:22Z</ActualEndDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Description>string</Description>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<CompanyCustomers>00000000-0000-0000-0000-000000000000</CompanyCustomers>
<CorporatePersonsCustomers>00000000-0000-0000-0000-000000000000</CorporatePersonsCustomers>
<PrivatePersonsCustomers>00000000-0000-0000-0000-000000000000</PrivatePersonsCustomers>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<AccountId>00000000-0000-0000-0000-000000000000</AccountId>
<Followers>string</Followers>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Issue>

Parameters

Name In Type Required Description
body body Issue true none

Example responses

201 Response

{
"IssueId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CaseNumber": "string",
"Priority": "low",
"OrderNumber": "string",
"Source": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Deadline": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"RegistrationDate": "2019-08-24T14:15:22Z",
"PlannedEndDate": "2019-08-24T14:15:22Z",
"InvestigationDate": "2019-08-24T14:15:22Z",
"ActualEndDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"HasDocument": true,
"Description": "string",
"IsFavorite": true,
"IsFollowing": true,
"MayUnfollow": true,
"IsNew": true,
"HasNoteAttachment": true,
"HasExternalNoteAttachment": true,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"NameLong": "string",
"ResponsibleLong": "string",
"CreatedBy": "string",
"CreatedByUser": "string",
"UpdatedBy": "string",
"StatusLong": "string",
"IsDue": true,
"Company": "string",
"CompanyId": "00000000-0000-0000-0000-000000000000",
"PrivatePerson": "string",
"PrivatePersonId": "00000000-0000-0000-0000-000000000000",
"CorporatePersonId": "00000000-0000-0000-0000-000000000000",
"CorporatePerson": "string",
"CompanyCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePersonsCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePersonsCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"Longitude": 0.1,
"Latitude": 0.1,
"TagCount": 0,
"AccountId": "00000000-0000-0000-0000-000000000000",
"Followers": [
"string"
],
"DescriptionRawText": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Issue>
<IssueId>00000000-0000-0000-0000-000000000000</IssueId>
<Name>string</Name>
<CaseNumber>string</CaseNumber>
<Priority>low</Priority>
<OrderNumber>string</OrderNumber>
<Source>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Source>
<Deadline>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Deadline>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<RegistrationDate>2019-08-24T14:15:22Z</RegistrationDate>
<PlannedEndDate>2019-08-24T14:15:22Z</PlannedEndDate>
<InvestigationDate>2019-08-24T14:15:22Z</InvestigationDate>
<ActualEndDate>2019-08-24T14:15:22Z</ActualEndDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<HasDocument>true</HasDocument>
<Description>string</Description>
<IsFavorite>true</IsFavorite>
<IsFollowing>true</IsFollowing>
<MayUnfollow>true</MayUnfollow>
<IsNew>true</IsNew>
<HasNoteAttachment>true</HasNoteAttachment>
<HasExternalNoteAttachment>true</HasExternalNoteAttachment>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<NameLong>string</NameLong>
<ResponsibleLong>string</ResponsibleLong>
<CreatedBy>string</CreatedBy>
<CreatedByUser>string</CreatedByUser>
<UpdatedBy>string</UpdatedBy>
<StatusLong>string</StatusLong>
<IsDue>true</IsDue>
<Company>string</Company>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<PrivatePerson>string</PrivatePerson>
<PrivatePersonId>00000000-0000-0000-0000-000000000000</PrivatePersonId>
<CorporatePersonId>00000000-0000-0000-0000-000000000000</CorporatePersonId>
<CorporatePerson>string</CorporatePerson>
<CompanyCustomers>00000000-0000-0000-0000-000000000000</CompanyCustomers>
<CorporatePersonsCustomers>00000000-0000-0000-0000-000000000000</CorporatePersonsCustomers>
<PrivatePersonsCustomers>00000000-0000-0000-0000-000000000000</PrivatePersonsCustomers>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<TagCount>0</TagCount>
<AccountId>00000000-0000-0000-0000-000000000000</AccountId>
<Followers>string</Followers>
<DescriptionRawText>string</DescriptionRawText>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Issue>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created Issue
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for Issue

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Issue/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Issue/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to Issue

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Issue/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Issue/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Issue Relations

Filter Activities based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/Activities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Issue/string/Activities/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Activities/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/Activities/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Issue/Activities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/Activities/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/Activities/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Issue/Activities/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Activity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Issue/string/Activities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/Activities", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Activities");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Issue/{id}/Activities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Activity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/Activities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/Activities", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Activities");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/Activities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Activity relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Issue/string/Activities/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/string/Activities/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Activities/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Issue/{id}/Activities/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Responsibles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Issue/string/Responsibles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Responsibles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/Responsibles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Issue/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/Responsibles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/Responsibles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Issue/Responsibles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to User

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Issue/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/Responsibles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Responsibles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Issue/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<UserCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</UserCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body UserCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<UserCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</UserCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated UserCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to User

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/Responsibles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Responsibles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<UserCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</UserCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body UserCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<UserCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</UserCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created UserCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete User relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Issue/string/Responsibles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/string/Responsibles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Responsibles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Issue/{id}/Responsibles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Companies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Issue/string/Companies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Companies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/Companies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Issue/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/Companies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/Companies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Issue/Companies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Company

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Issue/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/Companies", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Companies");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Issue/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Company

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/Companies", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Companies");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Company relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Issue/string/Companies/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/string/Companies/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Companies/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Issue/{id}/Companies/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter MarketingProjects based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Issue/string/MarketingProjects/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/MarketingProjects/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/MarketingProjects/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Issue/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/MarketingProjects/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/MarketingProjects/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Issue/MarketingProjects/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to MarketingProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Issue/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/MarketingProjects", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/MarketingProjects");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Issue/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingProjectCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</MarketingProjectCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body MarketingProjectCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingProjectCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</MarketingProjectCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated MarketingProjectCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to MarketingProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/MarketingProjects", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/MarketingProjects");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingProjectCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</MarketingProjectCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body MarketingProjectCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingProjectCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</MarketingProjectCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created MarketingProjectCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete MarketingProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Issue/string/MarketingProjects/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/string/MarketingProjects/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/MarketingProjects/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Issue/{id}/MarketingProjects/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter CorporatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/CorporatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Issue/string/CorporatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/CorporatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/CorporatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Issue/CorporatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/CorporatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/CorporatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Issue/CorporatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to CompanyCorporatePersonRelation

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Issue/string/CorporatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/CorporatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/CorporatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Issue/{id}/CorporatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyPersonRelationCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyPersonRelationCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyPersonRelationCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyPersonRelationCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyPersonRelationCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyPersonRelationCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to CompanyCorporatePersonRelation

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/CorporatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/CorporatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/CorporatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/CorporatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyPersonRelationCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyPersonRelationCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyPersonRelationCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyPersonRelationCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyPersonRelationCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyPersonRelationCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete CompanyCorporatePersonRelation relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Issue/string/CorporatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/string/CorporatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/CorporatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Issue/{id}/CorporatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter PrivatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Issue/string/PrivatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/PrivatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/PrivatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Issue/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/PrivatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/PrivatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Issue/PrivatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to PrivatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Issue/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/PrivatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/PrivatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Issue/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePersonCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</PrivatePersonCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body PrivatePersonCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePersonCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</PrivatePersonCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated PrivatePersonCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to PrivatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/PrivatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/PrivatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePersonCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</PrivatePersonCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body PrivatePersonCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePersonCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</PrivatePersonCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created PrivatePersonCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete PrivatePerson relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Issue/string/PrivatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/string/PrivatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/PrivatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Issue/{id}/PrivatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Deals based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Issue/string/Deals/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Deals/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/Deals/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Issue/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/Deals/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/Deals/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Issue/Deals/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to BusinessProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Issue/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/Deals", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Deals");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Issue/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<BusinessProjectCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</BusinessProjectCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body BusinessProjectCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<BusinessProjectCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</BusinessProjectCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated BusinessProjectCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to BusinessProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Issue/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Issue/string/Deals", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Deals");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Issue/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<BusinessProjectCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</BusinessProjectCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body BusinessProjectCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<BusinessProjectCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</BusinessProjectCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created BusinessProjectCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete BusinessProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Issue/string/Deals/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Issue/string/Deals/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Issue/string/Deals/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Issue/{id}/Deals/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

MarketingActivity

Retreive filtrable fields and their type for MarketingActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/MarketingActivity/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingActivity/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingActivity/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /MarketingActivity/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter MarketingActivity based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/MarketingActivity/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/MarketingActivity/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingActivity/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /MarketingActivity/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get MarketingActivity by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/MarketingActivity/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingActivity/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingActivity/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /MarketingActivity/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Name": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"HasDocument": true,
"IsNew": true,
"IsExternal": true,
"MarketingProject": "string",
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingActivity>
<Name>string</Name>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<HasDocument>true</HasDocument>
<IsNew>true</IsNew>
<IsExternal>true</IsExternal>
<MarketingProject>string</MarketingProject>
<MarketingProjectId>00000000-0000-0000-0000-000000000000</MarketingProjectId>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingActivity>

Responses

Status Meaning Description Schema
200 OK Success MarketingActivity
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete MarketingActivity by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/MarketingActivity/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingActivity/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingActivity/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /MarketingActivity/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update MarketingActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/MarketingActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Description":"string","StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","IsExternal":true,"MarketingProjectId":"00000000-0000-0000-0000-000000000000","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/MarketingActivity", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Description\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"IsExternal\":true,\"MarketingProjectId\":\"00000000-0000-0000-0000-000000000000\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingActivity");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Description\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"IsExternal\":true,\"MarketingProjectId\":\"00000000-0000-0000-0000-000000000000\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /MarketingActivity

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Name": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"IsExternal": true,
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Description: string
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
IsExternal: true
MarketingProjectId: 00000000-0000-0000-0000-000000000000
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingActivity>
<Name>string</Name>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<IsExternal>true</IsExternal>
<MarketingProjectId>00000000-0000-0000-0000-000000000000</MarketingProjectId>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingActivity>

Parameters

Name In Type Required Description
body body MarketingActivity true none

Example responses

200 Response

{
"Name": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"HasDocument": true,
"IsNew": true,
"IsExternal": true,
"MarketingProject": "string",
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingActivity>
<Name>string</Name>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<HasDocument>true</HasDocument>
<IsNew>true</IsNew>
<IsExternal>true</IsExternal>
<MarketingProject>string</MarketingProject>
<MarketingProjectId>00000000-0000-0000-0000-000000000000</MarketingProjectId>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingActivity>

Responses

Status Meaning Description Schema
200 OK Entity Updated MarketingActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create MarketingActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/MarketingActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Description":"string","StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","IsExternal":true,"MarketingProjectId":"00000000-0000-0000-0000-000000000000","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/MarketingActivity", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Description\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"IsExternal\":true,\"MarketingProjectId\":\"00000000-0000-0000-0000-000000000000\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingActivity");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Description\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"IsExternal\":true,\"MarketingProjectId\":\"00000000-0000-0000-0000-000000000000\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /MarketingActivity

Body parameter

{
"Name": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"IsExternal": true,
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Description: string
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
IsExternal: true
MarketingProjectId: 00000000-0000-0000-0000-000000000000
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingActivity>
<Name>string</Name>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<IsExternal>true</IsExternal>
<MarketingProjectId>00000000-0000-0000-0000-000000000000</MarketingProjectId>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingActivity>

Parameters

Name In Type Required Description
body body MarketingActivity true none

Example responses

201 Response

{
"Name": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"HasDocument": true,
"IsNew": true,
"IsExternal": true,
"MarketingProject": "string",
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingActivity>
<Name>string</Name>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<HasDocument>true</HasDocument>
<IsNew>true</IsNew>
<IsExternal>true</IsExternal>
<MarketingProject>string</MarketingProject>
<MarketingProjectId>00000000-0000-0000-0000-000000000000</MarketingProjectId>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingActivity>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created MarketingActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for MarketingActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/MarketingActivity/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingActivity/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingActivity/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /MarketingActivity/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to MarketingActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/MarketingActivity/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingActivity/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingActivity/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /MarketingActivity/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

MarketingPlan

Retreive filtrable fields and their type for MarketingPlan

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/MarketingPlan/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingPlan/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingPlan/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /MarketingPlan/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter MarketingPlan based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/MarketingPlan/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/MarketingPlan/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingPlan/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /MarketingPlan/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get MarketingPlan by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/MarketingPlan/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingPlan/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingPlan/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /MarketingPlan/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Name": "string",
"Number": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Active": true,
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"TimeSpan": "string",
"HasDocument": true,
"IsNew": true,
"IsExternal": true,
"TagCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingPlan>
<Name>string</Name>
<Number>string</Number>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Active>true</Active>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<TimeSpan>string</TimeSpan>
<HasDocument>true</HasDocument>
<IsNew>true</IsNew>
<IsExternal>true</IsExternal>
<TagCount>0</TagCount>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingPlan>

Responses

Status Meaning Description Schema
200 OK Success MarketingPlan
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete MarketingPlan by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/MarketingPlan/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingPlan/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingPlan/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /MarketingPlan/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update MarketingPlan

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/MarketingPlan \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Number":"string","Description":"string","StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","Active":true,"Status":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"IsExternal":true,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/MarketingPlan", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Number\":\"string\",\"Description\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Active\":true,\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsExternal\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingPlan");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Number\":\"string\",\"Description\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Active\":true,\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsExternal\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /MarketingPlan

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Name": "string",
"Number": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Active": true,
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsExternal": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Number: string
Description: string
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
Active: true
Status:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
IsExternal: true
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingPlan>
<Name>string</Name>
<Number>string</Number>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Active>true</Active>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<IsExternal>true</IsExternal>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingPlan>

Parameters

Name In Type Required Description
body body MarketingPlan true none

Example responses

200 Response

{
"Name": "string",
"Number": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Active": true,
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"TimeSpan": "string",
"HasDocument": true,
"IsNew": true,
"IsExternal": true,
"TagCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingPlan>
<Name>string</Name>
<Number>string</Number>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Active>true</Active>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<TimeSpan>string</TimeSpan>
<HasDocument>true</HasDocument>
<IsNew>true</IsNew>
<IsExternal>true</IsExternal>
<TagCount>0</TagCount>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingPlan>

Responses

Status Meaning Description Schema
200 OK Entity Updated MarketingPlan
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create MarketingPlan

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/MarketingPlan \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Number":"string","Description":"string","StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","Active":true,"Status":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"IsExternal":true,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/MarketingPlan", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Number\":\"string\",\"Description\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Active\":true,\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsExternal\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingPlan");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Number\":\"string\",\"Description\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Active\":true,\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsExternal\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /MarketingPlan

Body parameter

{
"Name": "string",
"Number": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Active": true,
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsExternal": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Number: string
Description: string
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
Active: true
Status:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
IsExternal: true
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingPlan>
<Name>string</Name>
<Number>string</Number>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Active>true</Active>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<IsExternal>true</IsExternal>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingPlan>

Parameters

Name In Type Required Description
body body MarketingPlan true none

Example responses

201 Response

{
"Name": "string",
"Number": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Active": true,
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"TimeSpan": "string",
"HasDocument": true,
"IsNew": true,
"IsExternal": true,
"TagCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingPlan>
<Name>string</Name>
<Number>string</Number>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Active>true</Active>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<TimeSpan>string</TimeSpan>
<HasDocument>true</HasDocument>
<IsNew>true</IsNew>
<IsExternal>true</IsExternal>
<TagCount>0</TagCount>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingPlan>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created MarketingPlan
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for MarketingPlan

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/MarketingPlan/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingPlan/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingPlan/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /MarketingPlan/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to MarketingPlan

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/MarketingPlan/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingPlan/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingPlan/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /MarketingPlan/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

MarketingProject

Retreive filtrable fields and their type for MarketingProject

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/MarketingProject/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingProject/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingProject/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /MarketingProject/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter MarketingProject based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/MarketingProject/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/MarketingProject/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingProject/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /MarketingProject/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get MarketingProject by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/MarketingProject/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingProject/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingProject/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /MarketingProject/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Name": "string",
"Number": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Active": true,
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"TimeSpan": "string",
"MarketingPlan": "string",
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"NumberOfProcessListItems": 0,
"NumberOfActiveProcessListItems": 0,
"MarketingPlanId": [
"00000000-0000-0000-0000-000000000000"
],
"HasDocument": true,
"ThumbViewImageFileId": "00000000-0000-0000-0000-000000000000",
"HasThumbViewImage": true,
"IsExternal": true,
"IsNew": true,
"TagCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingProject>
<Name>string</Name>
<Number>string</Number>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Active>true</Active>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<TimeSpan>string</TimeSpan>
<MarketingPlan>string</MarketingPlan>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<NumberOfProcessListItems>0</NumberOfProcessListItems>
<NumberOfActiveProcessListItems>0</NumberOfActiveProcessListItems>
<MarketingPlanId>00000000-0000-0000-0000-000000000000</MarketingPlanId>
<HasDocument>true</HasDocument>
<ThumbViewImageFileId>00000000-0000-0000-0000-000000000000</ThumbViewImageFileId>
<HasThumbViewImage>true</HasThumbViewImage>
<IsExternal>true</IsExternal>
<IsNew>true</IsNew>
<TagCount>0</TagCount>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingProject>

Responses

Status Meaning Description Schema
200 OK Success MarketingProject
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete MarketingProject by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/MarketingProject/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingProject/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingProject/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /MarketingProject/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update MarketingProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/MarketingProject \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Number":"string","Description":"string","StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","Active":true,"Status":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"TargetParticipantQuantity":0,"TargetResponseRatePercent":0,"MarketingPlanId":["00000000-0000-0000-0000-000000000000"],"ThumbViewImageFileId":"00000000-0000-0000-0000-000000000000","IsExternal":true,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/MarketingProject", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Number\":\"string\",\"Description\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Active\":true,\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"TargetParticipantQuantity\":0,\"TargetResponseRatePercent\":0,\"MarketingPlanId\":[\"00000000-0000-0000-0000-000000000000\"],\"ThumbViewImageFileId\":\"00000000-0000-0000-0000-000000000000\",\"IsExternal\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingProject");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Number\":\"string\",\"Description\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Active\":true,\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"TargetParticipantQuantity\":0,\"TargetResponseRatePercent\":0,\"MarketingPlanId\":[\"00000000-0000-0000-0000-000000000000\"],\"ThumbViewImageFileId\":\"00000000-0000-0000-0000-000000000000\",\"IsExternal\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /MarketingProject

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Name": "string",
"Number": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Active": true,
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"MarketingPlanId": [
"00000000-0000-0000-0000-000000000000"
],
"ThumbViewImageFileId": "00000000-0000-0000-0000-000000000000",
"IsExternal": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Number: string
Description: string
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
Active: true
Status:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
TargetParticipantQuantity: 0
TargetResponseRatePercent: 0
MarketingPlanId:
- 00000000-0000-0000-0000-000000000000
ThumbViewImageFileId: 00000000-0000-0000-0000-000000000000
IsExternal: true
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingProject>
<Name>string</Name>
<Number>string</Number>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Active>true</Active>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<MarketingPlanId>00000000-0000-0000-0000-000000000000</MarketingPlanId>
<ThumbViewImageFileId>00000000-0000-0000-0000-000000000000</ThumbViewImageFileId>
<IsExternal>true</IsExternal>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingProject>

Parameters

Name In Type Required Description
body body MarketingProject true none

Example responses

200 Response

{
"Name": "string",
"Number": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Active": true,
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"TimeSpan": "string",
"MarketingPlan": "string",
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"NumberOfProcessListItems": 0,
"NumberOfActiveProcessListItems": 0,
"MarketingPlanId": [
"00000000-0000-0000-0000-000000000000"
],
"HasDocument": true,
"ThumbViewImageFileId": "00000000-0000-0000-0000-000000000000",
"HasThumbViewImage": true,
"IsExternal": true,
"IsNew": true,
"TagCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingProject>
<Name>string</Name>
<Number>string</Number>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Active>true</Active>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<TimeSpan>string</TimeSpan>
<MarketingPlan>string</MarketingPlan>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<NumberOfProcessListItems>0</NumberOfProcessListItems>
<NumberOfActiveProcessListItems>0</NumberOfActiveProcessListItems>
<MarketingPlanId>00000000-0000-0000-0000-000000000000</MarketingPlanId>
<HasDocument>true</HasDocument>
<ThumbViewImageFileId>00000000-0000-0000-0000-000000000000</ThumbViewImageFileId>
<HasThumbViewImage>true</HasThumbViewImage>
<IsExternal>true</IsExternal>
<IsNew>true</IsNew>
<TagCount>0</TagCount>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingProject>

Responses

Status Meaning Description Schema
200 OK Entity Updated MarketingProject
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create MarketingProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/MarketingProject \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Number":"string","Description":"string","StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","Active":true,"Status":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"TargetParticipantQuantity":0,"TargetResponseRatePercent":0,"MarketingPlanId":["00000000-0000-0000-0000-000000000000"],"ThumbViewImageFileId":"00000000-0000-0000-0000-000000000000","IsExternal":true,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/MarketingProject", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Number\":\"string\",\"Description\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Active\":true,\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"TargetParticipantQuantity\":0,\"TargetResponseRatePercent\":0,\"MarketingPlanId\":[\"00000000-0000-0000-0000-000000000000\"],\"ThumbViewImageFileId\":\"00000000-0000-0000-0000-000000000000\",\"IsExternal\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingProject");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Number\":\"string\",\"Description\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"Active\":true,\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"TargetParticipantQuantity\":0,\"TargetResponseRatePercent\":0,\"MarketingPlanId\":[\"00000000-0000-0000-0000-000000000000\"],\"ThumbViewImageFileId\":\"00000000-0000-0000-0000-000000000000\",\"IsExternal\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /MarketingProject

Body parameter

{
"Name": "string",
"Number": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Active": true,
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"MarketingPlanId": [
"00000000-0000-0000-0000-000000000000"
],
"ThumbViewImageFileId": "00000000-0000-0000-0000-000000000000",
"IsExternal": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Number: string
Description: string
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
Active: true
Status:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
TargetParticipantQuantity: 0
TargetResponseRatePercent: 0
MarketingPlanId:
- 00000000-0000-0000-0000-000000000000
ThumbViewImageFileId: 00000000-0000-0000-0000-000000000000
IsExternal: true
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingProject>
<Name>string</Name>
<Number>string</Number>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Active>true</Active>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<MarketingPlanId>00000000-0000-0000-0000-000000000000</MarketingPlanId>
<ThumbViewImageFileId>00000000-0000-0000-0000-000000000000</ThumbViewImageFileId>
<IsExternal>true</IsExternal>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingProject>

Parameters

Name In Type Required Description
body body MarketingProject true none

Example responses

201 Response

{
"Name": "string",
"Number": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Active": true,
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"TimeSpan": "string",
"MarketingPlan": "string",
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"NumberOfProcessListItems": 0,
"NumberOfActiveProcessListItems": 0,
"MarketingPlanId": [
"00000000-0000-0000-0000-000000000000"
],
"HasDocument": true,
"ThumbViewImageFileId": "00000000-0000-0000-0000-000000000000",
"HasThumbViewImage": true,
"IsExternal": true,
"IsNew": true,
"TagCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<MarketingProject>
<Name>string</Name>
<Number>string</Number>
<Description>string</Description>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Active>true</Active>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<TimeSpan>string</TimeSpan>
<MarketingPlan>string</MarketingPlan>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<NumberOfProcessListItems>0</NumberOfProcessListItems>
<NumberOfActiveProcessListItems>0</NumberOfActiveProcessListItems>
<MarketingPlanId>00000000-0000-0000-0000-000000000000</MarketingPlanId>
<HasDocument>true</HasDocument>
<ThumbViewImageFileId>00000000-0000-0000-0000-000000000000</ThumbViewImageFileId>
<HasThumbViewImage>true</HasThumbViewImage>
<IsExternal>true</IsExternal>
<IsNew>true</IsNew>
<TagCount>0</TagCount>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Id>00000000-0000-0000-0000-000000000000</Id>
</MarketingProject>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created MarketingProject
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for MarketingProject

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/MarketingProject/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingProject/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingProject/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /MarketingProject/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to MarketingProject

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/MarketingProject/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/MarketingProject/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/MarketingProject/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /MarketingProject/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

ObjectivePlan

Retreive filtrable fields and their type for ObjectivePlan

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ObjectivePlan/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ObjectivePlan/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ObjectivePlan/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ObjectivePlan/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter ObjectivePlan based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ObjectivePlan/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ObjectivePlan/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ObjectivePlan/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ObjectivePlan/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get ObjectivePlan by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ObjectivePlan/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ObjectivePlan/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ObjectivePlan/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ObjectivePlan/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"AreaNote": "string",
"IndividualObjectivesNote": "string",
"MarketNote": "string",
"PortfolioNote": "string",
"PrioritizedObjectivesNote": "string",
"ResponsibilityNote": "string",
"FollowUpDate": "2019-08-24T14:15:22Z",
"UserExtension": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ObjectivePlan>
<AreaNote>string</AreaNote>
<IndividualObjectivesNote>string</IndividualObjectivesNote>
<MarketNote>string</MarketNote>
<PortfolioNote>string</PortfolioNote>
<PrioritizedObjectivesNote>string</PrioritizedObjectivesNote>
<ResponsibilityNote>string</ResponsibilityNote>
<FollowUpDate>2019-08-24T14:15:22Z</FollowUpDate>
<UserExtension>00000000-0000-0000-0000-000000000000</UserExtension>
<Id>00000000-0000-0000-0000-000000000000</Id>
</ObjectivePlan>

Responses

Status Meaning Description Schema
200 OK Success ObjectivePlan
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete ObjectivePlan by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ObjectivePlan/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ObjectivePlan/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ObjectivePlan/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ObjectivePlan/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update ObjectivePlan

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ObjectivePlan \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"AreaNote":"string","IndividualObjectivesNote":"string","MarketNote":"string","PortfolioNote":"string","PrioritizedObjectivesNote":"string","ResponsibilityNote":"string","FollowUpDate":"2019-08-24T14:15:22Z","UserExtension":"00000000-0000-0000-0000-000000000000","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ObjectivePlan", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"AreaNote\":\"string\",\"IndividualObjectivesNote\":\"string\",\"MarketNote\":\"string\",\"PortfolioNote\":\"string\",\"PrioritizedObjectivesNote\":\"string\",\"ResponsibilityNote\":\"string\",\"FollowUpDate\":\"2019-08-24T14:15:22Z\",\"UserExtension\":\"00000000-0000-0000-0000-000000000000\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ObjectivePlan");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"AreaNote\":\"string\",\"IndividualObjectivesNote\":\"string\",\"MarketNote\":\"string\",\"PortfolioNote\":\"string\",\"PrioritizedObjectivesNote\":\"string\",\"ResponsibilityNote\":\"string\",\"FollowUpDate\":\"2019-08-24T14:15:22Z\",\"UserExtension\":\"00000000-0000-0000-0000-000000000000\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ObjectivePlan

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"AreaNote": "string",
"IndividualObjectivesNote": "string",
"MarketNote": "string",
"PortfolioNote": "string",
"PrioritizedObjectivesNote": "string",
"ResponsibilityNote": "string",
"FollowUpDate": "2019-08-24T14:15:22Z",
"UserExtension": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000"
}
AreaNote: string
IndividualObjectivesNote: string
MarketNote: string
PortfolioNote: string
PrioritizedObjectivesNote: string
ResponsibilityNote: string
FollowUpDate: 2019-08-24T14:15:22Z
UserExtension: 00000000-0000-0000-0000-000000000000
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ObjectivePlan>
<AreaNote>string</AreaNote>
<IndividualObjectivesNote>string</IndividualObjectivesNote>
<MarketNote>string</MarketNote>
<PortfolioNote>string</PortfolioNote>
<PrioritizedObjectivesNote>string</PrioritizedObjectivesNote>
<ResponsibilityNote>string</ResponsibilityNote>
<FollowUpDate>2019-08-24T14:15:22Z</FollowUpDate>
<UserExtension>00000000-0000-0000-0000-000000000000</UserExtension>
<Id>00000000-0000-0000-0000-000000000000</Id>
</ObjectivePlan>

Parameters

Name In Type Required Description
body body ObjectivePlan true none

Example responses

200 Response

{
"AreaNote": "string",
"IndividualObjectivesNote": "string",
"MarketNote": "string",
"PortfolioNote": "string",
"PrioritizedObjectivesNote": "string",
"ResponsibilityNote": "string",
"FollowUpDate": "2019-08-24T14:15:22Z",
"UserExtension": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ObjectivePlan>
<AreaNote>string</AreaNote>
<IndividualObjectivesNote>string</IndividualObjectivesNote>
<MarketNote>string</MarketNote>
<PortfolioNote>string</PortfolioNote>
<PrioritizedObjectivesNote>string</PrioritizedObjectivesNote>
<ResponsibilityNote>string</ResponsibilityNote>
<FollowUpDate>2019-08-24T14:15:22Z</FollowUpDate>
<UserExtension>00000000-0000-0000-0000-000000000000</UserExtension>
<Id>00000000-0000-0000-0000-000000000000</Id>
</ObjectivePlan>

Responses

Status Meaning Description Schema
200 OK Entity Updated ObjectivePlan
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create ObjectivePlan

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ObjectivePlan \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"AreaNote":"string","IndividualObjectivesNote":"string","MarketNote":"string","PortfolioNote":"string","PrioritizedObjectivesNote":"string","ResponsibilityNote":"string","FollowUpDate":"2019-08-24T14:15:22Z","UserExtension":"00000000-0000-0000-0000-000000000000","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ObjectivePlan", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"AreaNote\":\"string\",\"IndividualObjectivesNote\":\"string\",\"MarketNote\":\"string\",\"PortfolioNote\":\"string\",\"PrioritizedObjectivesNote\":\"string\",\"ResponsibilityNote\":\"string\",\"FollowUpDate\":\"2019-08-24T14:15:22Z\",\"UserExtension\":\"00000000-0000-0000-0000-000000000000\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ObjectivePlan");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"AreaNote\":\"string\",\"IndividualObjectivesNote\":\"string\",\"MarketNote\":\"string\",\"PortfolioNote\":\"string\",\"PrioritizedObjectivesNote\":\"string\",\"ResponsibilityNote\":\"string\",\"FollowUpDate\":\"2019-08-24T14:15:22Z\",\"UserExtension\":\"00000000-0000-0000-0000-000000000000\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ObjectivePlan

Body parameter

{
"AreaNote": "string",
"IndividualObjectivesNote": "string",
"MarketNote": "string",
"PortfolioNote": "string",
"PrioritizedObjectivesNote": "string",
"ResponsibilityNote": "string",
"FollowUpDate": "2019-08-24T14:15:22Z",
"UserExtension": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000"
}
AreaNote: string
IndividualObjectivesNote: string
MarketNote: string
PortfolioNote: string
PrioritizedObjectivesNote: string
ResponsibilityNote: string
FollowUpDate: 2019-08-24T14:15:22Z
UserExtension: 00000000-0000-0000-0000-000000000000
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ObjectivePlan>
<AreaNote>string</AreaNote>
<IndividualObjectivesNote>string</IndividualObjectivesNote>
<MarketNote>string</MarketNote>
<PortfolioNote>string</PortfolioNote>
<PrioritizedObjectivesNote>string</PrioritizedObjectivesNote>
<ResponsibilityNote>string</ResponsibilityNote>
<FollowUpDate>2019-08-24T14:15:22Z</FollowUpDate>
<UserExtension>00000000-0000-0000-0000-000000000000</UserExtension>
<Id>00000000-0000-0000-0000-000000000000</Id>
</ObjectivePlan>

Parameters

Name In Type Required Description
body body ObjectivePlan true none

Example responses

201 Response

{
"AreaNote": "string",
"IndividualObjectivesNote": "string",
"MarketNote": "string",
"PortfolioNote": "string",
"PrioritizedObjectivesNote": "string",
"ResponsibilityNote": "string",
"FollowUpDate": "2019-08-24T14:15:22Z",
"UserExtension": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ObjectivePlan>
<AreaNote>string</AreaNote>
<IndividualObjectivesNote>string</IndividualObjectivesNote>
<MarketNote>string</MarketNote>
<PortfolioNote>string</PortfolioNote>
<PrioritizedObjectivesNote>string</PrioritizedObjectivesNote>
<ResponsibilityNote>string</ResponsibilityNote>
<FollowUpDate>2019-08-24T14:15:22Z</FollowUpDate>
<UserExtension>00000000-0000-0000-0000-000000000000</UserExtension>
<Id>00000000-0000-0000-0000-000000000000</Id>
</ObjectivePlan>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ObjectivePlan
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for ObjectivePlan

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ObjectivePlan/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ObjectivePlan/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ObjectivePlan/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ObjectivePlan/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to ObjectivePlan

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ObjectivePlan/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ObjectivePlan/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ObjectivePlan/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ObjectivePlan/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

PhoneActivity

Retreive filtrable fields and their type for PhoneActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter PhoneActivity based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get PhoneActivity by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"IsNew": true,
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Response": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryContactPhoneNumber": "string",
"PrimaryContact": "string",
"IsDone": true,
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"IsPositive": true,
"TagCount": 0,
"AllDayEvent": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PhoneActivity>
<IsNew>true</IsNew>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubCategory>
<Response>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Response>
<PrimaryContactPhoneNumber>string</PrimaryContactPhoneNumber>
<PrimaryContact>string</PrimaryContact>
<IsDone>true</IsDone>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<IsPositive>true</IsPositive>
<TagCount>0</TagCount>
<AllDayEvent>true</AllDayEvent>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</PhoneActivity>

Responses

Status Meaning Description Schema
200 OK Success PhoneActivity
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete PhoneActivity by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PhoneActivity/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PhoneActivity/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update PhoneActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PhoneActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Subject":"string","Start":"2019-08-24T14:15:22Z","End":"2019-08-24T14:15:22Z","Status":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"SubCategory":{"Key":"string","CodeGroupKey":"string"},"Response":{"Key":"string","CodeGroupKey":"string"},"IsDone":true,"Longitude":0.1,"Latitude":0.1,"Responsible":["00000000-0000-0000-0000-000000000000"],"PrivatePerson":["00000000-0000-0000-0000-000000000000"],"CorporatePerson":["00000000-0000-0000-0000-000000000000"],"Company":["00000000-0000-0000-0000-000000000000"],"AllDayEvent":true,"Description":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubCategory\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Response\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"AllDayEvent\":true,\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubCategory\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Response\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"AllDayEvent\":true,\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PhoneActivity

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string"
},
"Response": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsDone": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"AllDayEvent": true,
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Subject: string
Start: 2019-08-24T14:15:22Z
End: 2019-08-24T14:15:22Z
Status:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
SubCategory:
Key: string
CodeGroupKey: string
Response:
Key: string
CodeGroupKey: string
IsDone: true
Longitude: 0.1
Latitude: 0.1
Responsible:
- 00000000-0000-0000-0000-000000000000
PrivatePerson:
- 00000000-0000-0000-0000-000000000000
CorporatePerson:
- 00000000-0000-0000-0000-000000000000
Company:
- 00000000-0000-0000-0000-000000000000
AllDayEvent: true
Description: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<PhoneActivity>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</SubCategory>
<Response>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Response>
<IsDone>true</IsDone>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<AllDayEvent>true</AllDayEvent>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</PhoneActivity>

Parameters

Name In Type Required Description
body body PhoneActivity true none

Example responses

200 Response

{
"IsNew": true,
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Response": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryContactPhoneNumber": "string",
"PrimaryContact": "string",
"IsDone": true,
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"IsPositive": true,
"TagCount": 0,
"AllDayEvent": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PhoneActivity>
<IsNew>true</IsNew>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubCategory>
<Response>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Response>
<PrimaryContactPhoneNumber>string</PrimaryContactPhoneNumber>
<PrimaryContact>string</PrimaryContact>
<IsDone>true</IsDone>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<IsPositive>true</IsPositive>
<TagCount>0</TagCount>
<AllDayEvent>true</AllDayEvent>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</PhoneActivity>

Responses

Status Meaning Description Schema
200 OK Entity Updated PhoneActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create PhoneActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Subject":"string","Start":"2019-08-24T14:15:22Z","End":"2019-08-24T14:15:22Z","Status":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"SubCategory":{"Key":"string","CodeGroupKey":"string"},"Response":{"Key":"string","CodeGroupKey":"string"},"IsDone":true,"Longitude":0.1,"Latitude":0.1,"Responsible":["00000000-0000-0000-0000-000000000000"],"PrivatePerson":["00000000-0000-0000-0000-000000000000"],"CorporatePerson":["00000000-0000-0000-0000-000000000000"],"Company":["00000000-0000-0000-0000-000000000000"],"AllDayEvent":true,"Description":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubCategory\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Response\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"AllDayEvent\":true,\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubCategory\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Response\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"AllDayEvent\":true,\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity

Body parameter

{
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string"
},
"Response": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsDone": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"AllDayEvent": true,
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Subject: string
Start: 2019-08-24T14:15:22Z
End: 2019-08-24T14:15:22Z
Status:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
SubCategory:
Key: string
CodeGroupKey: string
Response:
Key: string
CodeGroupKey: string
IsDone: true
Longitude: 0.1
Latitude: 0.1
Responsible:
- 00000000-0000-0000-0000-000000000000
PrivatePerson:
- 00000000-0000-0000-0000-000000000000
CorporatePerson:
- 00000000-0000-0000-0000-000000000000
Company:
- 00000000-0000-0000-0000-000000000000
AllDayEvent: true
Description: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<PhoneActivity>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</SubCategory>
<Response>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Response>
<IsDone>true</IsDone>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<AllDayEvent>true</AllDayEvent>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</PhoneActivity>

Parameters

Name In Type Required Description
body body PhoneActivity true none

Example responses

201 Response

{
"IsNew": true,
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Response": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryContactPhoneNumber": "string",
"PrimaryContact": "string",
"IsDone": true,
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"IsPositive": true,
"TagCount": 0,
"AllDayEvent": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PhoneActivity>
<IsNew>true</IsNew>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubCategory>
<Response>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Response>
<PrimaryContactPhoneNumber>string</PrimaryContactPhoneNumber>
<PrimaryContact>string</PrimaryContact>
<IsDone>true</IsDone>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<IsPositive>true</IsPositive>
<TagCount>0</TagCount>
<AllDayEvent>true</AllDayEvent>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</PhoneActivity>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created PhoneActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for PhoneActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to PhoneActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

PhoneActivity Relations

Filter Cases based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Cases/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Cases/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/Cases/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/Cases/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/Cases/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/Cases/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Case

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Cases", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Cases");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PhoneActivity/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Case

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Cases", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Cases");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Case relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Cases/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Cases/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Cases/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PhoneActivity/{id}/Cases/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Responsibles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Responsibles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Responsibles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/Responsibles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/Responsibles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/Responsibles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/Responsibles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to User

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Responsibles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Responsibles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PhoneActivity/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUserRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityUserRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to User

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Responsibles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Responsibles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUserRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityUserRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete User relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Responsibles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Responsibles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Responsibles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PhoneActivity/{id}/Responsibles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Companies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Companies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Companies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/Companies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/Companies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/Companies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/Companies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Company

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Companies", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Companies");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PhoneActivity/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Company

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Companies", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Companies");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Company relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Companies/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Companies/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Companies/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PhoneActivity/{id}/Companies/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter CompanyGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/CompanyGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/CompanyGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/CompanyGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/CompanyGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/CompanyGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/CompanyGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to CompanyGroup

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/CompanyGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/CompanyGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PhoneActivity/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyGroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to CompanyGroup

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/CompanyGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/CompanyGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyGroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete CompanyGroup relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/CompanyGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/CompanyGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/CompanyGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PhoneActivity/{id}/CompanyGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Deals based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Deals/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Deals/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/Deals/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/Deals/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/Deals/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/Deals/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to BusinessProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Deals", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Deals");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PhoneActivity/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityBusinessProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityBusinessProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to BusinessProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Deals", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Deals");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityBusinessProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityBusinessProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete BusinessProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Deals/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Deals/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Deals/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PhoneActivity/{id}/Deals/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter PrivatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/PrivatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/PrivatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/PrivatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/PrivatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/PrivatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/PrivatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to PrivatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/PrivatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/PrivatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PhoneActivity/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityPrivatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to PrivatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/PrivatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/PrivatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityPrivatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete PrivatePerson relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/PrivatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/PrivatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/PrivatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PhoneActivity/{id}/PrivatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter MarketingActivities based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingActivities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingActivities/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingActivities/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/MarketingActivities/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/MarketingActivities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/MarketingActivities/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/MarketingActivities/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/MarketingActivities/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to MarketingActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingActivities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingActivities", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingActivities");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PhoneActivity/{id}/MarketingActivities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityMarketingActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to MarketingActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingActivities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingActivities", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingActivities");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/MarketingActivities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityMarketingActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete MarketingActivity relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingActivities/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingActivities/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingActivities/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PhoneActivity/{id}/MarketingActivities/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter MarketingProjects based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingProjects/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingProjects/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/MarketingProjects/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/MarketingProjects/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/MarketingProjects/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/MarketingProjects/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to MarketingProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingProjects", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingProjects");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PhoneActivity/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityMarketingProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to MarketingProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingProjects", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingProjects");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityMarketingProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete MarketingProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingProjects/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingProjects/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/MarketingProjects/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PhoneActivity/{id}/MarketingProjects/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Workorders based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Workorders/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Workorders/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Workorders/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/Workorders/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/Workorders/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/Workorders/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/Workorders/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/Workorders/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Workorder

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Workorders \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Workorders", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Workorders");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PhoneActivity/{id}/Workorders

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Workorder

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Workorders \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Workorders", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Workorders");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/Workorders

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Workorder relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Workorders/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Workorders/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Workorders/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PhoneActivity/{id}/Workorders/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ResponsibleUserGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/ResponsibleUserGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/ResponsibleUserGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/ResponsibleUserGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/ResponsibleUserGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/ResponsibleUserGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/ResponsibleUserGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/ResponsibleUserGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/ResponsibleUserGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Group

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/ResponsibleUserGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/ResponsibleUserGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/ResponsibleUserGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PhoneActivity/{id}/ResponsibleUserGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUsergroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityUsergroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Group

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/ResponsibleUserGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/ResponsibleUserGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/ResponsibleUserGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/ResponsibleUserGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUsergroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityUsergroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Group relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/ResponsibleUserGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/ResponsibleUserGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/ResponsibleUserGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PhoneActivity/{id}/ResponsibleUserGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ServiceArticles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/ServiceArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/ServiceArticles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/ServiceArticles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/ServiceArticles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/ServiceArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/ServiceArticles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/ServiceArticles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/ServiceArticles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Article

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Articles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Articles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Articles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PhoneActivity/{id}/Articles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ArticleActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Article

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Articles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Articles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Articles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/Articles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ArticleActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Article relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Articles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Articles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Articles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PhoneActivity/{id}/Articles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ProductArticles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/ProductArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/ProductArticles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/ProductArticles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/ProductArticles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/ProductArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/ProductArticles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/ProductArticles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/ProductArticles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Filter Articles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PhoneActivity/string/Articles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/string/Articles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/string/Articles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PhoneActivity/{id}/Articles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PhoneActivity/Articles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PhoneActivity/Articles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PhoneActivity/Articles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PhoneActivity/Articles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Pricebook

Retreive filtrable fields and their type for Pricebook

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Pricebook/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Pricebook/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Pricebook/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter Pricebook based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Pricebook/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Pricebook/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Pricebook/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get Pricebook by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Pricebook/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Pricebook/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Pricebook/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Name": "string",
"Active": true,
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"UseAsTemplate": true,
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Description": "string",
"CreatedBy": "string",
"UpdatedBy": "string",
"IsNew": true,
"CreatedDate": "2019-08-24T14:15:22Z",
"UpdatedDate": "2019-08-24T14:15:22Z",
"CreatedByUser": "string",
"UpdatedByUser": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Pricebook>
<Name>string</Name>
<Active>true</Active>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<UseAsTemplate>true</UseAsTemplate>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Description>string</Description>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<IsNew>true</IsNew>
<CreatedDate>2019-08-24T14:15:22Z</CreatedDate>
<UpdatedDate>2019-08-24T14:15:22Z</UpdatedDate>
<CreatedByUser>string</CreatedByUser>
<UpdatedByUser>string</UpdatedByUser>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Pricebook>

Responses

Status Meaning Description Schema
200 OK Success Pricebook
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete Pricebook by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Pricebook/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Pricebook/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Pricebook/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update Pricebook

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Pricebook \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Active":true,"StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","UseAsTemplate":true,"Type":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Description":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Pricebook", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Active\":true,\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"UseAsTemplate\":true,\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Active\":true,\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"UseAsTemplate\":true,\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Pricebook

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Name": "string",
"Active": true,
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"UseAsTemplate": true,
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Active: true
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
UseAsTemplate: true
Type:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Description: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Pricebook>
<Name>string</Name>
<Active>true</Active>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<UseAsTemplate>true</UseAsTemplate>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Pricebook>

Parameters

Name In Type Required Description
body body Pricebook true none

Example responses

200 Response

{
"Name": "string",
"Active": true,
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"UseAsTemplate": true,
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Description": "string",
"CreatedBy": "string",
"UpdatedBy": "string",
"IsNew": true,
"CreatedDate": "2019-08-24T14:15:22Z",
"UpdatedDate": "2019-08-24T14:15:22Z",
"CreatedByUser": "string",
"UpdatedByUser": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Pricebook>
<Name>string</Name>
<Active>true</Active>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<UseAsTemplate>true</UseAsTemplate>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Description>string</Description>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<IsNew>true</IsNew>
<CreatedDate>2019-08-24T14:15:22Z</CreatedDate>
<UpdatedDate>2019-08-24T14:15:22Z</UpdatedDate>
<CreatedByUser>string</CreatedByUser>
<UpdatedByUser>string</UpdatedByUser>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Pricebook>

Responses

Status Meaning Description Schema
200 OK Entity Updated Pricebook
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create Pricebook

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Pricebook \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Active":true,"StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","UseAsTemplate":true,"Type":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Description":"string","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Pricebook", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Active\":true,\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"UseAsTemplate\":true,\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Active\":true,\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"UseAsTemplate\":true,\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Description\":\"string\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Pricebook

Body parameter

{
"Name": "string",
"Active": true,
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"UseAsTemplate": true,
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Active: true
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
UseAsTemplate: true
Type:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Description: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Pricebook>
<Name>string</Name>
<Active>true</Active>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<UseAsTemplate>true</UseAsTemplate>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Description>string</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Pricebook>

Parameters

Name In Type Required Description
body body Pricebook true none

Example responses

201 Response

{
"Name": "string",
"Active": true,
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"UseAsTemplate": true,
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Description": "string",
"CreatedBy": "string",
"UpdatedBy": "string",
"IsNew": true,
"CreatedDate": "2019-08-24T14:15:22Z",
"UpdatedDate": "2019-08-24T14:15:22Z",
"CreatedByUser": "string",
"UpdatedByUser": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Pricebook>
<Name>string</Name>
<Active>true</Active>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<UseAsTemplate>true</UseAsTemplate>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Description>string</Description>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<IsNew>true</IsNew>
<CreatedDate>2019-08-24T14:15:22Z</CreatedDate>
<UpdatedDate>2019-08-24T14:15:22Z</UpdatedDate>
<CreatedByUser>string</CreatedByUser>
<UpdatedByUser>string</UpdatedByUser>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Pricebook>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created Pricebook
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for Pricebook

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Pricebook/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Pricebook/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Pricebook/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to Pricebook

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Pricebook/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Pricebook/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Pricebook/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Pricebook Relations

Filter Articles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Pricebook/string/Articles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Pricebook/string/Articles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook/string/Articles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Pricebook/{id}/Articles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Pricebook/Articles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Pricebook/Articles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook/Articles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Pricebook/Articles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Article

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Pricebook/string/Articles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Pricebook/string/Articles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook/string/Articles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Pricebook/{id}/Articles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<PricebookArticleRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</PricebookArticleRelation>

Parameters

Name In Type Required Description
id path string true none
body body PricebookArticleRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PricebookArticleRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</PricebookArticleRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated PricebookArticleRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Article

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Pricebook/string/Articles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Pricebook/string/Articles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook/string/Articles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Pricebook/{id}/Articles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<PricebookArticleRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</PricebookArticleRelation>

Parameters

Name In Type Required Description
id path string true none
body body PricebookArticleRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PricebookArticleRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</PricebookArticleRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created PricebookArticleRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Article relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Pricebook/string/Articles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Pricebook/string/Articles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Pricebook/string/Articles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Pricebook/{id}/Articles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

PrivatePerson

Retreive filtrable fields and their type for PrivatePerson

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PrivatePerson/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PrivatePerson/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter PrivatePerson based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PrivatePerson/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PrivatePerson/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get PrivatePerson by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PrivatePerson/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PrivatePerson/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Name": "string",
"FirstName": "string",
"LastName": "string",
"CustomerNumber": "string",
"Gender": "unknown",
"SocialSecurityNumber": "string",
"Language": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"PrimaryMobilePhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow1": "string",
"PrimaryAddressRow2": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Segment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Pul": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PulDate": "2019-08-24T14:15:22Z",
"Active": true,
"IsDeceased": true,
"HasProtectedIdentity": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"LoginStatus": "noLogin",
"IsNew": true,
"Password": "string",
"PasswordConfirm": "string",
"TagCount": 0,
"HasPhoneNumber": true,
"GDPRConsentIsRequired": true,
"GDPRConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ConsentComment": "string",
"MarketingConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingSource": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingOptIn": [
"00000000-0000-0000-0000-000000000000"
],
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePerson>
<Name>string</Name>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CustomerNumber>string</CustomerNumber>
<Gender>unknown</Gender>
<SocialSecurityNumber>string</SocialSecurityNumber>
<Language>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Language>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<PrimaryMobilePhoneNumber>string</PrimaryMobilePhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow1>string</PrimaryAddressRow1>
<PrimaryAddressRow2>string</PrimaryAddressRow2>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Segment>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Pul>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Pul>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubSegment>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Rating>
<PulDate>2019-08-24T14:15:22Z</PulDate>
<Active>true</Active>
<IsDeceased>true</IsDeceased>
<HasProtectedIdentity>true</HasProtectedIdentity>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Responsible>string</Responsible>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<LoginStatus>noLogin</LoginStatus>
<IsNew>true</IsNew>
<Password>string</Password>
<PasswordConfirm>string</PasswordConfirm>
<TagCount>0</TagCount>
<HasPhoneNumber>true</HasPhoneNumber>
<GDPRConsentIsRequired>true</GDPRConsentIsRequired>
<GDPRConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</GDPRConsent>
<ConsentComment>string</ConsentComment>
<MarketingConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</MarketingConsent>
<MarketingSource>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</MarketingSource>
<MarketingOptIn>00000000-0000-0000-0000-000000000000</MarketingOptIn>
<Id>00000000-0000-0000-0000-000000000000</Id>
</PrivatePerson>

Responses

Status Meaning Description Schema
200 OK Success PrivatePerson
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete PrivatePerson by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PrivatePerson/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PrivatePerson/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update PrivatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PrivatePerson \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"FirstName":"string","LastName":"string","CustomerNumber":"string","Gender":"unknown","SocialSecurityNumber":"string","Language":{"Key":"string","CodeGroupKey":"string"},"PrimaryEmailAddress":"string","PrimaryPhoneNumber":"string","PrimaryMobilePhoneNumber":"string","WebSite":"string","PrimaryAddress":"string","PrimaryAddressRow":"string","PrimaryCity":"string","PrimaryZipCode":"string","PrimaryCounty":"string","PrimaryCountryId":[0],"PrimaryCommunicationCategory":"unknown","Type":{"Key":"string","CodeGroupKey":"string"},"Segment":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Pul":{"Key":"string","CodeGroupKey":"string"},"SubSegment":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Rating":{"Key":"string","CodeGroupKey":"string"},"PulDate":"2019-08-24T14:15:22Z","Active":true,"IsDeceased":true,"HasProtectedIdentity":true,"Longitude":0.1,"Latitude":0.1,"Password":"string","PasswordConfirm":"string","GDPRConsent":{"Key":"string","CodeGroupKey":"string"},"ConsentComment":"string","MarketingConsent":{"Key":"string","CodeGroupKey":"string"},"MarketingSource":{"Key":"string","CodeGroupKey":"string"},"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"FirstName\":\"string\",\"LastName\":\"string\",\"CustomerNumber\":\"string\",\"Gender\":\"unknown\",\"SocialSecurityNumber\":\"string\",\"Language\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"PrimaryMobilePhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddress\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Segment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Pul\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubSegment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Rating\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PulDate\":\"2019-08-24T14:15:22Z\",\"Active\":true,\"IsDeceased\":true,\"HasProtectedIdentity\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"Password\":\"string\",\"PasswordConfirm\":\"string\",\"GDPRConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ConsentComment\":\"string\",\"MarketingConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"MarketingSource\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"FirstName\":\"string\",\"LastName\":\"string\",\"CustomerNumber\":\"string\",\"Gender\":\"unknown\",\"SocialSecurityNumber\":\"string\",\"Language\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"PrimaryMobilePhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddress\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Segment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Pul\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubSegment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Rating\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PulDate\":\"2019-08-24T14:15:22Z\",\"Active\":true,\"IsDeceased\":true,\"HasProtectedIdentity\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"Password\":\"string\",\"PasswordConfirm\":\"string\",\"GDPRConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ConsentComment\":\"string\",\"MarketingConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"MarketingSource\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PrivatePerson

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"FirstName": "string",
"LastName": "string",
"CustomerNumber": "string",
"Gender": "unknown",
"SocialSecurityNumber": "string",
"Language": {
"Key": "string",
"CodeGroupKey": "string"
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"PrimaryMobilePhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Segment": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Pul": {
"Key": "string",
"CodeGroupKey": "string"
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string"
},
"PulDate": "2019-08-24T14:15:22Z",
"Active": true,
"IsDeceased": true,
"HasProtectedIdentity": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Password": "string",
"PasswordConfirm": "string",
"GDPRConsent": {
"Key": "string",
"CodeGroupKey": "string"
},
"ConsentComment": "string",
"MarketingConsent": {
"Key": "string",
"CodeGroupKey": "string"
},
"MarketingSource": {
"Key": "string",
"CodeGroupKey": "string"
},
"Id": "00000000-0000-0000-0000-000000000000"
}
FirstName: string
LastName: string
CustomerNumber: string
Gender: unknown
SocialSecurityNumber: string
Language:
Key: string
CodeGroupKey: string
PrimaryEmailAddress: string
PrimaryPhoneNumber: string
PrimaryMobilePhoneNumber: string
WebSite: string
PrimaryAddress: string
PrimaryAddressRow: string
PrimaryCity: string
PrimaryZipCode: string
PrimaryCounty: string
PrimaryCountryId:
- 0
PrimaryCommunicationCategory: unknown
Type:
Key: string
CodeGroupKey: string
Segment:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Pul:
Key: string
CodeGroupKey: string
SubSegment:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Rating:
Key: string
CodeGroupKey: string
PulDate: 2019-08-24T14:15:22Z
Active: true
IsDeceased: true
HasProtectedIdentity: true
Longitude: 0.1
Latitude: 0.1
Password: string
PasswordConfirm: string
GDPRConsent:
Key: string
CodeGroupKey: string
ConsentComment: string
MarketingConsent:
Key: string
CodeGroupKey: string
MarketingSource:
Key: string
CodeGroupKey: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePerson>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CustomerNumber>string</CustomerNumber>
<Gender>unknown</Gender>
<SocialSecurityNumber>string</SocialSecurityNumber>
<Language>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Language>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<PrimaryMobilePhoneNumber>string</PrimaryMobilePhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Segment>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Pul>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Pul>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</SubSegment>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Rating>
<PulDate>2019-08-24T14:15:22Z</PulDate>
<Active>true</Active>
<IsDeceased>true</IsDeceased>
<HasProtectedIdentity>true</HasProtectedIdentity>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Password>string</Password>
<PasswordConfirm>string</PasswordConfirm>
<GDPRConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</GDPRConsent>
<ConsentComment>string</ConsentComment>
<MarketingConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</MarketingConsent>
<MarketingSource>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</MarketingSource>
<Id>00000000-0000-0000-0000-000000000000</Id>
</PrivatePerson>

Parameters

Name In Type Required Description
body body PrivatePerson true none

Example responses

200 Response

{
"Name": "string",
"FirstName": "string",
"LastName": "string",
"CustomerNumber": "string",
"Gender": "unknown",
"SocialSecurityNumber": "string",
"Language": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"PrimaryMobilePhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow1": "string",
"PrimaryAddressRow2": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Segment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Pul": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PulDate": "2019-08-24T14:15:22Z",
"Active": true,
"IsDeceased": true,
"HasProtectedIdentity": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"LoginStatus": "noLogin",
"IsNew": true,
"Password": "string",
"PasswordConfirm": "string",
"TagCount": 0,
"HasPhoneNumber": true,
"GDPRConsentIsRequired": true,
"GDPRConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ConsentComment": "string",
"MarketingConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingSource": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingOptIn": [
"00000000-0000-0000-0000-000000000000"
],
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePerson>
<Name>string</Name>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CustomerNumber>string</CustomerNumber>
<Gender>unknown</Gender>
<SocialSecurityNumber>string</SocialSecurityNumber>
<Language>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Language>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<PrimaryMobilePhoneNumber>string</PrimaryMobilePhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow1>string</PrimaryAddressRow1>
<PrimaryAddressRow2>string</PrimaryAddressRow2>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Segment>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Pul>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Pul>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubSegment>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Rating>
<PulDate>2019-08-24T14:15:22Z</PulDate>
<Active>true</Active>
<IsDeceased>true</IsDeceased>
<HasProtectedIdentity>true</HasProtectedIdentity>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Responsible>string</Responsible>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<LoginStatus>noLogin</LoginStatus>
<IsNew>true</IsNew>
<Password>string</Password>
<PasswordConfirm>string</PasswordConfirm>
<TagCount>0</TagCount>
<HasPhoneNumber>true</HasPhoneNumber>
<GDPRConsentIsRequired>true</GDPRConsentIsRequired>
<GDPRConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</GDPRConsent>
<ConsentComment>string</ConsentComment>
<MarketingConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</MarketingConsent>
<MarketingSource>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</MarketingSource>
<MarketingOptIn>00000000-0000-0000-0000-000000000000</MarketingOptIn>
<Id>00000000-0000-0000-0000-000000000000</Id>
</PrivatePerson>

Responses

Status Meaning Description Schema
200 OK Entity Updated PrivatePerson
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create PrivatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PrivatePerson \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"FirstName":"string","LastName":"string","CustomerNumber":"string","Gender":"unknown","SocialSecurityNumber":"string","Language":{"Key":"string","CodeGroupKey":"string"},"PrimaryEmailAddress":"string","PrimaryPhoneNumber":"string","PrimaryMobilePhoneNumber":"string","WebSite":"string","PrimaryAddress":"string","PrimaryAddressRow":"string","PrimaryCity":"string","PrimaryZipCode":"string","PrimaryCounty":"string","PrimaryCountryId":[0],"PrimaryCommunicationCategory":"unknown","Type":{"Key":"string","CodeGroupKey":"string"},"Segment":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Pul":{"Key":"string","CodeGroupKey":"string"},"SubSegment":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Rating":{"Key":"string","CodeGroupKey":"string"},"PulDate":"2019-08-24T14:15:22Z","Active":true,"IsDeceased":true,"HasProtectedIdentity":true,"Longitude":0.1,"Latitude":0.1,"Password":"string","PasswordConfirm":"string","GDPRConsent":{"Key":"string","CodeGroupKey":"string"},"ConsentComment":"string","MarketingConsent":{"Key":"string","CodeGroupKey":"string"},"MarketingSource":{"Key":"string","CodeGroupKey":"string"},"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"FirstName\":\"string\",\"LastName\":\"string\",\"CustomerNumber\":\"string\",\"Gender\":\"unknown\",\"SocialSecurityNumber\":\"string\",\"Language\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"PrimaryMobilePhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddress\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Segment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Pul\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubSegment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Rating\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PulDate\":\"2019-08-24T14:15:22Z\",\"Active\":true,\"IsDeceased\":true,\"HasProtectedIdentity\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"Password\":\"string\",\"PasswordConfirm\":\"string\",\"GDPRConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ConsentComment\":\"string\",\"MarketingConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"MarketingSource\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"FirstName\":\"string\",\"LastName\":\"string\",\"CustomerNumber\":\"string\",\"Gender\":\"unknown\",\"SocialSecurityNumber\":\"string\",\"Language\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PrimaryEmailAddress\":\"string\",\"PrimaryPhoneNumber\":\"string\",\"PrimaryMobilePhoneNumber\":\"string\",\"WebSite\":\"string\",\"PrimaryAddress\":\"string\",\"PrimaryAddressRow\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryZipCode\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryCountryId\":[0],\"PrimaryCommunicationCategory\":\"unknown\",\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Segment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Pul\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubSegment\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Rating\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"PulDate\":\"2019-08-24T14:15:22Z\",\"Active\":true,\"IsDeceased\":true,\"HasProtectedIdentity\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"Password\":\"string\",\"PasswordConfirm\":\"string\",\"GDPRConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ConsentComment\":\"string\",\"MarketingConsent\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"MarketingSource\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PrivatePerson

Body parameter

{
"FirstName": "string",
"LastName": "string",
"CustomerNumber": "string",
"Gender": "unknown",
"SocialSecurityNumber": "string",
"Language": {
"Key": "string",
"CodeGroupKey": "string"
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"PrimaryMobilePhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Segment": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Pul": {
"Key": "string",
"CodeGroupKey": "string"
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string"
},
"PulDate": "2019-08-24T14:15:22Z",
"Active": true,
"IsDeceased": true,
"HasProtectedIdentity": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Password": "string",
"PasswordConfirm": "string",
"GDPRConsent": {
"Key": "string",
"CodeGroupKey": "string"
},
"ConsentComment": "string",
"MarketingConsent": {
"Key": "string",
"CodeGroupKey": "string"
},
"MarketingSource": {
"Key": "string",
"CodeGroupKey": "string"
},
"Id": "00000000-0000-0000-0000-000000000000"
}
FirstName: string
LastName: string
CustomerNumber: string
Gender: unknown
SocialSecurityNumber: string
Language:
Key: string
CodeGroupKey: string
PrimaryEmailAddress: string
PrimaryPhoneNumber: string
PrimaryMobilePhoneNumber: string
WebSite: string
PrimaryAddress: string
PrimaryAddressRow: string
PrimaryCity: string
PrimaryZipCode: string
PrimaryCounty: string
PrimaryCountryId:
- 0
PrimaryCommunicationCategory: unknown
Type:
Key: string
CodeGroupKey: string
Segment:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Pul:
Key: string
CodeGroupKey: string
SubSegment:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Rating:
Key: string
CodeGroupKey: string
PulDate: 2019-08-24T14:15:22Z
Active: true
IsDeceased: true
HasProtectedIdentity: true
Longitude: 0.1
Latitude: 0.1
Password: string
PasswordConfirm: string
GDPRConsent:
Key: string
CodeGroupKey: string
ConsentComment: string
MarketingConsent:
Key: string
CodeGroupKey: string
MarketingSource:
Key: string
CodeGroupKey: string
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePerson>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CustomerNumber>string</CustomerNumber>
<Gender>unknown</Gender>
<SocialSecurityNumber>string</SocialSecurityNumber>
<Language>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Language>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<PrimaryMobilePhoneNumber>string</PrimaryMobilePhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Segment>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Pul>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Pul>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</SubSegment>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Rating>
<PulDate>2019-08-24T14:15:22Z</PulDate>
<Active>true</Active>
<IsDeceased>true</IsDeceased>
<HasProtectedIdentity>true</HasProtectedIdentity>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Password>string</Password>
<PasswordConfirm>string</PasswordConfirm>
<GDPRConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</GDPRConsent>
<ConsentComment>string</ConsentComment>
<MarketingConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</MarketingConsent>
<MarketingSource>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</MarketingSource>
<Id>00000000-0000-0000-0000-000000000000</Id>
</PrivatePerson>

Parameters

Name In Type Required Description
body body PrivatePerson true none

Example responses

201 Response

{
"Name": "string",
"FirstName": "string",
"LastName": "string",
"CustomerNumber": "string",
"Gender": "unknown",
"SocialSecurityNumber": "string",
"Language": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"PrimaryMobilePhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow1": "string",
"PrimaryAddressRow2": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Segment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Pul": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PulDate": "2019-08-24T14:15:22Z",
"Active": true,
"IsDeceased": true,
"HasProtectedIdentity": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"LoginStatus": "noLogin",
"IsNew": true,
"Password": "string",
"PasswordConfirm": "string",
"TagCount": 0,
"HasPhoneNumber": true,
"GDPRConsentIsRequired": true,
"GDPRConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ConsentComment": "string",
"MarketingConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingSource": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingOptIn": [
"00000000-0000-0000-0000-000000000000"
],
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePerson>
<Name>string</Name>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CustomerNumber>string</CustomerNumber>
<Gender>unknown</Gender>
<SocialSecurityNumber>string</SocialSecurityNumber>
<Language>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Language>
<PrimaryEmailAddress>string</PrimaryEmailAddress>
<PrimaryPhoneNumber>string</PrimaryPhoneNumber>
<PrimaryMobilePhoneNumber>string</PrimaryMobilePhoneNumber>
<WebSite>string</WebSite>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryAddressRow1>string</PrimaryAddressRow1>
<PrimaryAddressRow2>string</PrimaryAddressRow2>
<PrimaryAddressRow>string</PrimaryAddressRow>
<PrimaryCity>string</PrimaryCity>
<PrimaryZipCode>string</PrimaryZipCode>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryCountryId>0</PrimaryCountryId>
<PrimaryCommunicationCategory>unknown</PrimaryCommunicationCategory>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Segment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Segment>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Pul>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Pul>
<SubSegment>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubSegment>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Rating>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Rating>
<PulDate>2019-08-24T14:15:22Z</PulDate>
<Active>true</Active>
<IsDeceased>true</IsDeceased>
<HasProtectedIdentity>true</HasProtectedIdentity>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Responsible>string</Responsible>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<LoginStatus>noLogin</LoginStatus>
<IsNew>true</IsNew>
<Password>string</Password>
<PasswordConfirm>string</PasswordConfirm>
<TagCount>0</TagCount>
<HasPhoneNumber>true</HasPhoneNumber>
<GDPRConsentIsRequired>true</GDPRConsentIsRequired>
<GDPRConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</GDPRConsent>
<ConsentComment>string</ConsentComment>
<MarketingConsent>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</MarketingConsent>
<MarketingSource>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</MarketingSource>
<MarketingOptIn>00000000-0000-0000-0000-000000000000</MarketingOptIn>
<Id>00000000-0000-0000-0000-000000000000</Id>
</PrivatePerson>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created PrivatePerson
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for PrivatePerson

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PrivatePerson/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PrivatePerson/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to PrivatePerson

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PrivatePerson/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

PrivatePerson Relations

Filter Companies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Companies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Companies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PrivatePerson/{id}/Companies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PrivatePerson/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/Companies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/Companies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PrivatePerson/Companies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Company

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Companies", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Companies");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PrivatePerson/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyPrivatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Company

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Companies", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Companies");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PrivatePerson/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyPrivatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Company relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Companies/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Companies/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Companies/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PrivatePerson/{id}/Companies/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter CompanyGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/CompanyGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/CompanyGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PrivatePerson/{id}/CompanyGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PrivatePerson/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/CompanyGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/CompanyGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PrivatePerson/CompanyGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to CompanyGroup

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/CompanyGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/CompanyGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PrivatePerson/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyGroupPrivatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated CompanyGroupPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to CompanyGroup

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/CompanyGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/CompanyGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PrivatePerson/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body CompanyGroupPrivatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<CompanyGroupPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</CompanyGroupPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created CompanyGroupPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete CompanyGroup relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/CompanyGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/CompanyGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/CompanyGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PrivatePerson/{id}/CompanyGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Activities based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Activities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Activities/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Activities/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PrivatePerson/{id}/Activities/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PrivatePerson/Activities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/Activities/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/Activities/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PrivatePerson/Activities/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Activity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Activities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Activities", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Activities");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PrivatePerson/{id}/Activities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityPrivatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Activity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Activities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Activities", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Activities");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PrivatePerson/{id}/Activities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityPrivatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Activity relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Activities/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Activities/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Activities/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PrivatePerson/{id}/Activities/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Cases based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Cases/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Cases/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PrivatePerson/{id}/Cases/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PrivatePerson/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/Cases/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/Cases/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PrivatePerson/Cases/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Case

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Cases", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Cases");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /PrivatePerson/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePersonCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</PrivatePersonCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body PrivatePersonCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePersonCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</PrivatePersonCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated PrivatePersonCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Case

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Cases", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Cases");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PrivatePerson/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePersonCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</PrivatePersonCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body PrivatePersonCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<PrivatePersonCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</PrivatePersonCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created PrivatePersonCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Case relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Cases/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Cases/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Cases/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /PrivatePerson/{id}/Cases/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Responsibles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/PrivatePerson/string/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/string/Responsibles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/string/Responsibles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /PrivatePerson/{id}/Responsibles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/PrivatePerson/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/PrivatePerson/Responsibles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/PrivatePerson/Responsibles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /PrivatePerson/Responsibles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Selection

GetApiSelectionTemplateKeys

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Crm/Selection \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Crm/Selection", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Crm/Selection");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Crm/Selection

Example responses

200 Response

{
"id": "string",
"description": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Template>
<id>string</id>
<description>string</description>
</Template>

Responses

Status Meaning Description Schema
200 OK OK Template
401 Unauthorized Unauthorized None
404 Not Found Query template not found None
500 Internal Server Error InternalServerError None

GetResult

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Crm/Selection/string \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"group":[{"aggregates":[{"field":"string","aggregate":"string"}],"field":"string","dir":"string"}],"aggregate":[{"field":"string","aggregate":"string"}],"select":[{"field":"string","expression":"string","as":"string"}],"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Crm/Selection/string", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"group\":[{\"aggregates\":[{\"field\":\"string\",\"aggregate\":\"string\"}],\"field\":\"string\",\"dir\":\"string\"}],\"aggregate\":[{\"field\":\"string\",\"aggregate\":\"string\"}],\"select\":[{\"field\":\"string\",\"expression\":\"string\",\"as\":\"string\"}],\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Crm/Selection/string");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"group\":[{\"aggregates\":[{\"field\":\"string\",\"aggregate\":\"string\"}],\"field\":\"string\",\"dir\":\"string\"}],\"aggregate\":[{\"field\":\"string\",\"aggregate\":\"string\"}],\"select\":[{\"field\":\"string\",\"expression\":\"string\",\"as\":\"string\"}],\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Crm/Selection/{key}

Body parameter

{
"group": [
{
"aggregates": [
{
"field": "string",
"aggregate": "string"
}
],
"field": "string",
"dir": "string"
}
],
"aggregate": [
{
"field": "string",
"aggregate": "string"
}
],
"select": [
{
"field": "string",
"expression": "string",
"as": "string"
}
],
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
group:
- aggregates:
- field: string
aggregate: string
field: string
dir: string
aggregate:
- field: string
aggregate: string
select:
- field: string
expression: string
as: string
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<SelectionDataSourceRequest>
<group>
<aggregates>
<field>string</field>
<aggregate>string</aggregate>
</aggregates>
<field>string</field>
<dir>string</dir>
</group>
<aggregate>
<field>string</field>
<aggregate>string</aggregate>
</aggregate>
<select>
<field>string</field>
<expression>string</expression>
<as>string</as>
</select>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</SelectionDataSourceRequest>

Parameters

Name In Type Required Description
key path string true none
body body SelectionDataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request Filter does not validate None
401 Unauthorized Unauthorized None
404 Not Found Query template not found None
500 Internal Server Error InternalServerError None

fieldDefinitions

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Crm/Selection/string/fieldDefinitions \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Crm/Selection/string/fieldDefinitions", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Crm/Selection/string/fieldDefinitions");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Crm/Selection/{key}/fieldDefinitions

Parameters

Name In Type Required Description
key path string true none

Example responses

200 Response

[
{
"field": "string",
"caption": "string",
"fieldType": "string",
"isLookup": true,
"selectable": true,
"filterable": true,
"sortable": true
}
]
<?xml version="1.0" encoding="UTF-8" ?>
<field>string</field>
<caption>string</caption>
<fieldType>string</fieldType>
<isLookup>true</isLookup>
<selectable>true</selectable>
<filterable>true</filterable>
<sortable>true</sortable>

Responses

Status Meaning Description Schema
200 OK OK Inline
401 Unauthorized Unauthorized None
404 Not Found Query template not found None
500 Internal Server Error InternalServerError None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [FieldDefinition] false none none
» field string false none none
» caption string false none none
» fieldType string false none none
» isLookup boolean false none none
» selectable boolean false none none
» filterable boolean false none none
» sortable boolean false none none

GetLookupResult

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Crm/Selection/string/Lookup/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Crm/Selection/string/Lookup/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Crm/Selection/string/Lookup/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Crm/Selection/{key}/Lookup/{field}

Parameters

Name In Type Required Description
key path string true none
field path string true none
filter query string false none

Example responses

200 Response

[
{
"value": {},
"caption": "string"
}
]
<?xml version="1.0" encoding="UTF-8" ?>
<value/>
<caption>string</caption>

Responses

Status Meaning Description Schema
200 OK OK Inline
400 Bad Request Filter does not validate None
401 Unauthorized Unauthorized None
404 Not Found Query template or field not found None
500 Internal Server Error InternalServerError None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [LookupResult] false none none
» value object false none none
» caption string false none none

ServiceAppointmentActivity

Retreive filtrable fields and their type for ServiceAppointmentActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter ServiceAppointmentActivity based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get ServiceAppointmentActivity by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"IsNew": true,
"Subject": "string",
"Description": "string",
"ServiceAppointmentType": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Service": [
"00000000-0000-0000-0000-000000000000"
],
"Product": [
"00000000-0000-0000-0000-000000000000"
],
"AttestedByUser": "string",
"AttestedDate": "2019-08-24T14:15:22Z",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ResponsibleUsergroupId": [
"00000000-0000-0000-0000-000000000000"
],
"Workorder": [
"00000000-0000-0000-0000-000000000000"
],
"CreatedBy": "string",
"UpdatedBy": "string",
"PrimaryAddress": "string",
"PrimaryCity": "string",
"PrimaryCounty": "string",
"PrimaryZipCode": "string",
"Country": [
0
],
"Longitude": 0.1,
"Latitude": 0.1,
"ServiceAppointmentNumber": "string",
"ResponsibleUsergroup": "string",
"Duration": "string",
"WorkorderId": "00000000-0000-0000-0000-000000000000",
"WorkorderName": "string",
"WorkorderNumber": "string",
"ExchangeId": "string",
"IsSyncedToExchange": true,
"SendUpdates": true,
"IsExchangeActivity": true,
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ExchangeMailbox": "string",
"WorkorderStartDate": "2019-08-24T14:15:22Z",
"WorkorderEndDate": "2019-08-24T14:15:22Z",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceAppointmentActivity>
<IsNew>true</IsNew>
<Subject>string</Subject>
<Description>string</Description>
<ServiceAppointmentType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</ServiceAppointmentType>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Service>00000000-0000-0000-0000-000000000000</Service>
<Product>00000000-0000-0000-0000-000000000000</Product>
<AttestedByUser>string</AttestedByUser>
<AttestedDate>2019-08-24T14:15:22Z</AttestedDate>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<ResponsibleUsergroupId>00000000-0000-0000-0000-000000000000</ResponsibleUsergroupId>
<Workorder>00000000-0000-0000-0000-000000000000</Workorder>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryCity>string</PrimaryCity>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryZipCode>string</PrimaryZipCode>
<Country>0</Country>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<ServiceAppointmentNumber>string</ServiceAppointmentNumber>
<ResponsibleUsergroup>string</ResponsibleUsergroup>
<Duration>string</Duration>
<WorkorderId>00000000-0000-0000-0000-000000000000</WorkorderId>
<WorkorderName>string</WorkorderName>
<WorkorderNumber>string</WorkorderNumber>
<ExchangeId>string</ExchangeId>
<IsSyncedToExchange>true</IsSyncedToExchange>
<SendUpdates>true</SendUpdates>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<ExchangeMailbox>string</ExchangeMailbox>
<WorkorderStartDate>2019-08-24T14:15:22Z</WorkorderStartDate>
<WorkorderEndDate>2019-08-24T14:15:22Z</WorkorderEndDate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</ServiceAppointmentActivity>

Responses

Status Meaning Description Schema
200 OK Success ServiceAppointmentActivity
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete ServiceAppointmentActivity by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ServiceAppointmentActivity/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update ServiceAppointmentActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Subject":"string","Description":"string","ServiceAppointmentType":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Service":["00000000-0000-0000-0000-000000000000"],"Product":["00000000-0000-0000-0000-000000000000"],"AttestedDate":"2019-08-24T14:15:22Z","Start":"2019-08-24T14:15:22Z","End":"2019-08-24T14:15:22Z","Status":{"Key":"string","CodeGroupKey":"string"},"ResponsibleUsergroupId":["00000000-0000-0000-0000-000000000000"],"Workorder":["00000000-0000-0000-0000-000000000000"],"PrimaryAddress":"string","PrimaryCity":"string","PrimaryCounty":"string","PrimaryZipCode":"string","Country":[0],"Longitude":0.1,"Latitude":0.1,"WorkorderId":"00000000-0000-0000-0000-000000000000","WorkorderName":"string","WorkorderNumber":"string","ExchangeId":"string","IsExchangeActivity":true,"ExchangeSyncDate":"2019-08-24T14:15:22Z","ExchangeMailbox":"string","WorkorderStartDate":"2019-08-24T14:15:22Z","WorkorderEndDate":"2019-08-24T14:15:22Z","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Subject\":\"string\",\"Description\":\"string\",\"ServiceAppointmentType\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Service\":[\"00000000-0000-0000-0000-000000000000\"],\"Product\":[\"00000000-0000-0000-0000-000000000000\"],\"AttestedDate\":\"2019-08-24T14:15:22Z\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ResponsibleUsergroupId\":[\"00000000-0000-0000-0000-000000000000\"],\"Workorder\":[\"00000000-0000-0000-0000-000000000000\"],\"PrimaryAddress\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryZipCode\":\"string\",\"Country\":[0],\"Longitude\":0.1,\"Latitude\":0.1,\"WorkorderId\":\"00000000-0000-0000-0000-000000000000\",\"WorkorderName\":\"string\",\"WorkorderNumber\":\"string\",\"ExchangeId\":\"string\",\"IsExchangeActivity\":true,\"ExchangeSyncDate\":\"2019-08-24T14:15:22Z\",\"ExchangeMailbox\":\"string\",\"WorkorderStartDate\":\"2019-08-24T14:15:22Z\",\"WorkorderEndDate\":\"2019-08-24T14:15:22Z\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Subject\":\"string\",\"Description\":\"string\",\"ServiceAppointmentType\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Service\":[\"00000000-0000-0000-0000-000000000000\"],\"Product\":[\"00000000-0000-0000-0000-000000000000\"],\"AttestedDate\":\"2019-08-24T14:15:22Z\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ResponsibleUsergroupId\":[\"00000000-0000-0000-0000-000000000000\"],\"Workorder\":[\"00000000-0000-0000-0000-000000000000\"],\"PrimaryAddress\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryZipCode\":\"string\",\"Country\":[0],\"Longitude\":0.1,\"Latitude\":0.1,\"WorkorderId\":\"00000000-0000-0000-0000-000000000000\",\"WorkorderName\":\"string\",\"WorkorderNumber\":\"string\",\"ExchangeId\":\"string\",\"IsExchangeActivity\":true,\"ExchangeSyncDate\":\"2019-08-24T14:15:22Z\",\"ExchangeMailbox\":\"string\",\"WorkorderStartDate\":\"2019-08-24T14:15:22Z\",\"WorkorderEndDate\":\"2019-08-24T14:15:22Z\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ServiceAppointmentActivity

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Subject": "string",
"Description": "string",
"ServiceAppointmentType": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Service": [
"00000000-0000-0000-0000-000000000000"
],
"Product": [
"00000000-0000-0000-0000-000000000000"
],
"AttestedDate": "2019-08-24T14:15:22Z",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"ResponsibleUsergroupId": [
"00000000-0000-0000-0000-000000000000"
],
"Workorder": [
"00000000-0000-0000-0000-000000000000"
],
"PrimaryAddress": "string",
"PrimaryCity": "string",
"PrimaryCounty": "string",
"PrimaryZipCode": "string",
"Country": [
0
],
"Longitude": 0.1,
"Latitude": 0.1,
"WorkorderId": "00000000-0000-0000-0000-000000000000",
"WorkorderName": "string",
"WorkorderNumber": "string",
"ExchangeId": "string",
"IsExchangeActivity": true,
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ExchangeMailbox": "string",
"WorkorderStartDate": "2019-08-24T14:15:22Z",
"WorkorderEndDate": "2019-08-24T14:15:22Z",
"Id": "00000000-0000-0000-0000-000000000000"
}
Subject: string
Description: string
ServiceAppointmentType:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Service:
- 00000000-0000-0000-0000-000000000000
Product:
- 00000000-0000-0000-0000-000000000000
AttestedDate: 2019-08-24T14:15:22Z
Start: 2019-08-24T14:15:22Z
End: 2019-08-24T14:15:22Z
Status:
Key: string
CodeGroupKey: string
ResponsibleUsergroupId:
- 00000000-0000-0000-0000-000000000000
Workorder:
- 00000000-0000-0000-0000-000000000000
PrimaryAddress: string
PrimaryCity: string
PrimaryCounty: string
PrimaryZipCode: string
Country:
- 0
Longitude: 0.1
Latitude: 0.1
WorkorderId: 00000000-0000-0000-0000-000000000000
WorkorderName: string
WorkorderNumber: string
ExchangeId: string
IsExchangeActivity: true
ExchangeSyncDate: 2019-08-24T14:15:22Z
ExchangeMailbox: string
WorkorderStartDate: 2019-08-24T14:15:22Z
WorkorderEndDate: 2019-08-24T14:15:22Z
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceAppointmentActivity>
<Subject>string</Subject>
<Description>string</Description>
<ServiceAppointmentType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</ServiceAppointmentType>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Service>00000000-0000-0000-0000-000000000000</Service>
<Product>00000000-0000-0000-0000-000000000000</Product>
<AttestedDate>2019-08-24T14:15:22Z</AttestedDate>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<ResponsibleUsergroupId>00000000-0000-0000-0000-000000000000</ResponsibleUsergroupId>
<Workorder>00000000-0000-0000-0000-000000000000</Workorder>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryCity>string</PrimaryCity>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryZipCode>string</PrimaryZipCode>
<Country>0</Country>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<WorkorderId>00000000-0000-0000-0000-000000000000</WorkorderId>
<WorkorderName>string</WorkorderName>
<WorkorderNumber>string</WorkorderNumber>
<ExchangeId>string</ExchangeId>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<ExchangeMailbox>string</ExchangeMailbox>
<WorkorderStartDate>2019-08-24T14:15:22Z</WorkorderStartDate>
<WorkorderEndDate>2019-08-24T14:15:22Z</WorkorderEndDate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</ServiceAppointmentActivity>

Parameters

Name In Type Required Description
body body ServiceAppointmentActivity true none

Example responses

200 Response

{
"IsNew": true,
"Subject": "string",
"Description": "string",
"ServiceAppointmentType": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Service": [
"00000000-0000-0000-0000-000000000000"
],
"Product": [
"00000000-0000-0000-0000-000000000000"
],
"AttestedByUser": "string",
"AttestedDate": "2019-08-24T14:15:22Z",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ResponsibleUsergroupId": [
"00000000-0000-0000-0000-000000000000"
],
"Workorder": [
"00000000-0000-0000-0000-000000000000"
],
"CreatedBy": "string",
"UpdatedBy": "string",
"PrimaryAddress": "string",
"PrimaryCity": "string",
"PrimaryCounty": "string",
"PrimaryZipCode": "string",
"Country": [
0
],
"Longitude": 0.1,
"Latitude": 0.1,
"ServiceAppointmentNumber": "string",
"ResponsibleUsergroup": "string",
"Duration": "string",
"WorkorderId": "00000000-0000-0000-0000-000000000000",
"WorkorderName": "string",
"WorkorderNumber": "string",
"ExchangeId": "string",
"IsSyncedToExchange": true,
"SendUpdates": true,
"IsExchangeActivity": true,
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ExchangeMailbox": "string",
"WorkorderStartDate": "2019-08-24T14:15:22Z",
"WorkorderEndDate": "2019-08-24T14:15:22Z",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceAppointmentActivity>
<IsNew>true</IsNew>
<Subject>string</Subject>
<Description>string</Description>
<ServiceAppointmentType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</ServiceAppointmentType>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Service>00000000-0000-0000-0000-000000000000</Service>
<Product>00000000-0000-0000-0000-000000000000</Product>
<AttestedByUser>string</AttestedByUser>
<AttestedDate>2019-08-24T14:15:22Z</AttestedDate>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<ResponsibleUsergroupId>00000000-0000-0000-0000-000000000000</ResponsibleUsergroupId>
<Workorder>00000000-0000-0000-0000-000000000000</Workorder>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryCity>string</PrimaryCity>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryZipCode>string</PrimaryZipCode>
<Country>0</Country>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<ServiceAppointmentNumber>string</ServiceAppointmentNumber>
<ResponsibleUsergroup>string</ResponsibleUsergroup>
<Duration>string</Duration>
<WorkorderId>00000000-0000-0000-0000-000000000000</WorkorderId>
<WorkorderName>string</WorkorderName>
<WorkorderNumber>string</WorkorderNumber>
<ExchangeId>string</ExchangeId>
<IsSyncedToExchange>true</IsSyncedToExchange>
<SendUpdates>true</SendUpdates>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<ExchangeMailbox>string</ExchangeMailbox>
<WorkorderStartDate>2019-08-24T14:15:22Z</WorkorderStartDate>
<WorkorderEndDate>2019-08-24T14:15:22Z</WorkorderEndDate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</ServiceAppointmentActivity>

Responses

Status Meaning Description Schema
200 OK Entity Updated ServiceAppointmentActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create ServiceAppointmentActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Subject":"string","Description":"string","ServiceAppointmentType":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Service":["00000000-0000-0000-0000-000000000000"],"Product":["00000000-0000-0000-0000-000000000000"],"AttestedDate":"2019-08-24T14:15:22Z","Start":"2019-08-24T14:15:22Z","End":"2019-08-24T14:15:22Z","Status":{"Key":"string","CodeGroupKey":"string"},"ResponsibleUsergroupId":["00000000-0000-0000-0000-000000000000"],"Workorder":["00000000-0000-0000-0000-000000000000"],"PrimaryAddress":"string","PrimaryCity":"string","PrimaryCounty":"string","PrimaryZipCode":"string","Country":[0],"Longitude":0.1,"Latitude":0.1,"WorkorderId":"00000000-0000-0000-0000-000000000000","WorkorderName":"string","WorkorderNumber":"string","ExchangeId":"string","IsExchangeActivity":true,"ExchangeSyncDate":"2019-08-24T14:15:22Z","ExchangeMailbox":"string","WorkorderStartDate":"2019-08-24T14:15:22Z","WorkorderEndDate":"2019-08-24T14:15:22Z","Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Subject\":\"string\",\"Description\":\"string\",\"ServiceAppointmentType\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Service\":[\"00000000-0000-0000-0000-000000000000\"],\"Product\":[\"00000000-0000-0000-0000-000000000000\"],\"AttestedDate\":\"2019-08-24T14:15:22Z\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ResponsibleUsergroupId\":[\"00000000-0000-0000-0000-000000000000\"],\"Workorder\":[\"00000000-0000-0000-0000-000000000000\"],\"PrimaryAddress\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryZipCode\":\"string\",\"Country\":[0],\"Longitude\":0.1,\"Latitude\":0.1,\"WorkorderId\":\"00000000-0000-0000-0000-000000000000\",\"WorkorderName\":\"string\",\"WorkorderNumber\":\"string\",\"ExchangeId\":\"string\",\"IsExchangeActivity\":true,\"ExchangeSyncDate\":\"2019-08-24T14:15:22Z\",\"ExchangeMailbox\":\"string\",\"WorkorderStartDate\":\"2019-08-24T14:15:22Z\",\"WorkorderEndDate\":\"2019-08-24T14:15:22Z\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Subject\":\"string\",\"Description\":\"string\",\"ServiceAppointmentType\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Service\":[\"00000000-0000-0000-0000-000000000000\"],\"Product\":[\"00000000-0000-0000-0000-000000000000\"],\"AttestedDate\":\"2019-08-24T14:15:22Z\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"ResponsibleUsergroupId\":[\"00000000-0000-0000-0000-000000000000\"],\"Workorder\":[\"00000000-0000-0000-0000-000000000000\"],\"PrimaryAddress\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryZipCode\":\"string\",\"Country\":[0],\"Longitude\":0.1,\"Latitude\":0.1,\"WorkorderId\":\"00000000-0000-0000-0000-000000000000\",\"WorkorderName\":\"string\",\"WorkorderNumber\":\"string\",\"ExchangeId\":\"string\",\"IsExchangeActivity\":true,\"ExchangeSyncDate\":\"2019-08-24T14:15:22Z\",\"ExchangeMailbox\":\"string\",\"WorkorderStartDate\":\"2019-08-24T14:15:22Z\",\"WorkorderEndDate\":\"2019-08-24T14:15:22Z\",\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity

Body parameter

{
"Subject": "string",
"Description": "string",
"ServiceAppointmentType": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Service": [
"00000000-0000-0000-0000-000000000000"
],
"Product": [
"00000000-0000-0000-0000-000000000000"
],
"AttestedDate": "2019-08-24T14:15:22Z",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"ResponsibleUsergroupId": [
"00000000-0000-0000-0000-000000000000"
],
"Workorder": [
"00000000-0000-0000-0000-000000000000"
],
"PrimaryAddress": "string",
"PrimaryCity": "string",
"PrimaryCounty": "string",
"PrimaryZipCode": "string",
"Country": [
0
],
"Longitude": 0.1,
"Latitude": 0.1,
"WorkorderId": "00000000-0000-0000-0000-000000000000",
"WorkorderName": "string",
"WorkorderNumber": "string",
"ExchangeId": "string",
"IsExchangeActivity": true,
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ExchangeMailbox": "string",
"WorkorderStartDate": "2019-08-24T14:15:22Z",
"WorkorderEndDate": "2019-08-24T14:15:22Z",
"Id": "00000000-0000-0000-0000-000000000000"
}
Subject: string
Description: string
ServiceAppointmentType:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Service:
- 00000000-0000-0000-0000-000000000000
Product:
- 00000000-0000-0000-0000-000000000000
AttestedDate: 2019-08-24T14:15:22Z
Start: 2019-08-24T14:15:22Z
End: 2019-08-24T14:15:22Z
Status:
Key: string
CodeGroupKey: string
ResponsibleUsergroupId:
- 00000000-0000-0000-0000-000000000000
Workorder:
- 00000000-0000-0000-0000-000000000000
PrimaryAddress: string
PrimaryCity: string
PrimaryCounty: string
PrimaryZipCode: string
Country:
- 0
Longitude: 0.1
Latitude: 0.1
WorkorderId: 00000000-0000-0000-0000-000000000000
WorkorderName: string
WorkorderNumber: string
ExchangeId: string
IsExchangeActivity: true
ExchangeSyncDate: 2019-08-24T14:15:22Z
ExchangeMailbox: string
WorkorderStartDate: 2019-08-24T14:15:22Z
WorkorderEndDate: 2019-08-24T14:15:22Z
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceAppointmentActivity>
<Subject>string</Subject>
<Description>string</Description>
<ServiceAppointmentType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</ServiceAppointmentType>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Service>00000000-0000-0000-0000-000000000000</Service>
<Product>00000000-0000-0000-0000-000000000000</Product>
<AttestedDate>2019-08-24T14:15:22Z</AttestedDate>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<ResponsibleUsergroupId>00000000-0000-0000-0000-000000000000</ResponsibleUsergroupId>
<Workorder>00000000-0000-0000-0000-000000000000</Workorder>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryCity>string</PrimaryCity>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryZipCode>string</PrimaryZipCode>
<Country>0</Country>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<WorkorderId>00000000-0000-0000-0000-000000000000</WorkorderId>
<WorkorderName>string</WorkorderName>
<WorkorderNumber>string</WorkorderNumber>
<ExchangeId>string</ExchangeId>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<ExchangeMailbox>string</ExchangeMailbox>
<WorkorderStartDate>2019-08-24T14:15:22Z</WorkorderStartDate>
<WorkorderEndDate>2019-08-24T14:15:22Z</WorkorderEndDate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</ServiceAppointmentActivity>

Parameters

Name In Type Required Description
body body ServiceAppointmentActivity true none

Example responses

201 Response

{
"IsNew": true,
"Subject": "string",
"Description": "string",
"ServiceAppointmentType": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Service": [
"00000000-0000-0000-0000-000000000000"
],
"Product": [
"00000000-0000-0000-0000-000000000000"
],
"AttestedByUser": "string",
"AttestedDate": "2019-08-24T14:15:22Z",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ResponsibleUsergroupId": [
"00000000-0000-0000-0000-000000000000"
],
"Workorder": [
"00000000-0000-0000-0000-000000000000"
],
"CreatedBy": "string",
"UpdatedBy": "string",
"PrimaryAddress": "string",
"PrimaryCity": "string",
"PrimaryCounty": "string",
"PrimaryZipCode": "string",
"Country": [
0
],
"Longitude": 0.1,
"Latitude": 0.1,
"ServiceAppointmentNumber": "string",
"ResponsibleUsergroup": "string",
"Duration": "string",
"WorkorderId": "00000000-0000-0000-0000-000000000000",
"WorkorderName": "string",
"WorkorderNumber": "string",
"ExchangeId": "string",
"IsSyncedToExchange": true,
"SendUpdates": true,
"IsExchangeActivity": true,
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ExchangeMailbox": "string",
"WorkorderStartDate": "2019-08-24T14:15:22Z",
"WorkorderEndDate": "2019-08-24T14:15:22Z",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceAppointmentActivity>
<IsNew>true</IsNew>
<Subject>string</Subject>
<Description>string</Description>
<ServiceAppointmentType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</ServiceAppointmentType>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Service>00000000-0000-0000-0000-000000000000</Service>
<Product>00000000-0000-0000-0000-000000000000</Product>
<AttestedByUser>string</AttestedByUser>
<AttestedDate>2019-08-24T14:15:22Z</AttestedDate>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<ResponsibleUsergroupId>00000000-0000-0000-0000-000000000000</ResponsibleUsergroupId>
<Workorder>00000000-0000-0000-0000-000000000000</Workorder>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryCity>string</PrimaryCity>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryZipCode>string</PrimaryZipCode>
<Country>0</Country>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<ServiceAppointmentNumber>string</ServiceAppointmentNumber>
<ResponsibleUsergroup>string</ResponsibleUsergroup>
<Duration>string</Duration>
<WorkorderId>00000000-0000-0000-0000-000000000000</WorkorderId>
<WorkorderName>string</WorkorderName>
<WorkorderNumber>string</WorkorderNumber>
<ExchangeId>string</ExchangeId>
<IsSyncedToExchange>true</IsSyncedToExchange>
<SendUpdates>true</SendUpdates>
<IsExchangeActivity>true</IsExchangeActivity>
<ExchangeSyncDate>2019-08-24T14:15:22Z</ExchangeSyncDate>
<ExchangeMailbox>string</ExchangeMailbox>
<WorkorderStartDate>2019-08-24T14:15:22Z</WorkorderStartDate>
<WorkorderEndDate>2019-08-24T14:15:22Z</WorkorderEndDate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</ServiceAppointmentActivity>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ServiceAppointmentActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for ServiceAppointmentActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to ServiceAppointmentActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

ServiceAppointmentActivity Relations

Filter Cases based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Cases/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Cases/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/Cases/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Cases/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Cases/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/Cases/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Case

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Cases", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Cases");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ServiceAppointmentActivity/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Case

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Cases", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Cases");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Case relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Cases/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Cases/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Cases/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ServiceAppointmentActivity/{id}/Cases/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Responsibles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Responsibles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Responsibles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/Responsibles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Responsibles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Responsibles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/Responsibles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to User

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Responsibles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Responsibles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ServiceAppointmentActivity/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUserRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityUserRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to User

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Responsibles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Responsibles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUserRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityUserRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete User relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Responsibles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Responsibles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Responsibles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ServiceAppointmentActivity/{id}/Responsibles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Companies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Companies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Companies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/Companies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Companies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Companies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/Companies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Company

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Companies", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Companies");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ServiceAppointmentActivity/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Company

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Companies", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Companies");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Company relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Companies/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Companies/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Companies/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ServiceAppointmentActivity/{id}/Companies/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter CompanyGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/CompanyGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/CompanyGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/CompanyGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/CompanyGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/CompanyGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/CompanyGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to CompanyGroup

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/CompanyGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/CompanyGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ServiceAppointmentActivity/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyGroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to CompanyGroup

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/CompanyGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/CompanyGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyGroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete CompanyGroup relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/CompanyGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/CompanyGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/CompanyGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ServiceAppointmentActivity/{id}/CompanyGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Deals based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Deals/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Deals/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/Deals/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Deals/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Deals/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/Deals/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to BusinessProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Deals", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Deals");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ServiceAppointmentActivity/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityBusinessProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityBusinessProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to BusinessProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Deals", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Deals");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityBusinessProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityBusinessProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete BusinessProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Deals/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Deals/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Deals/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ServiceAppointmentActivity/{id}/Deals/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter PrivatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/PrivatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/PrivatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/PrivatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/PrivatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/PrivatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/PrivatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to PrivatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/PrivatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/PrivatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ServiceAppointmentActivity/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityPrivatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to PrivatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/PrivatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/PrivatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityPrivatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete PrivatePerson relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/PrivatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/PrivatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/PrivatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ServiceAppointmentActivity/{id}/PrivatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter MarketingActivities based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingActivities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingActivities/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingActivities/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/MarketingActivities/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/MarketingActivities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/MarketingActivities/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/MarketingActivities/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/MarketingActivities/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to MarketingActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingActivities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingActivities", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingActivities");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ServiceAppointmentActivity/{id}/MarketingActivities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityMarketingActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to MarketingActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingActivities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingActivities", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingActivities");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/MarketingActivities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityMarketingActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete MarketingActivity relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingActivities/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingActivities/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingActivities/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ServiceAppointmentActivity/{id}/MarketingActivities/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter MarketingProjects based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingProjects/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingProjects/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/MarketingProjects/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/MarketingProjects/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/MarketingProjects/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/MarketingProjects/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to MarketingProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingProjects", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingProjects");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ServiceAppointmentActivity/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityMarketingProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to MarketingProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingProjects", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingProjects");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityMarketingProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete MarketingProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingProjects/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingProjects/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/MarketingProjects/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ServiceAppointmentActivity/{id}/MarketingProjects/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Workorders based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Workorders/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Workorders/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Workorders/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/Workorders/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Workorders/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Workorders/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Workorders/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/Workorders/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Workorder

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Workorders \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Workorders", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Workorders");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ServiceAppointmentActivity/{id}/Workorders

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Workorder

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Workorders \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Workorders", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Workorders");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/Workorders

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Workorder relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Workorders/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Workorders/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Workorders/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ServiceAppointmentActivity/{id}/Workorders/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ResponsibleUserGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ResponsibleUserGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ResponsibleUserGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ResponsibleUserGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/ResponsibleUserGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/ResponsibleUserGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/ResponsibleUserGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/ResponsibleUserGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/ResponsibleUserGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Group

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ResponsibleUserGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ResponsibleUserGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ResponsibleUserGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ServiceAppointmentActivity/{id}/ResponsibleUserGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUsergroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityUsergroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Group

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ResponsibleUserGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ResponsibleUserGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ResponsibleUserGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/ResponsibleUserGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUsergroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityUsergroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Group relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ResponsibleUserGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ResponsibleUserGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ResponsibleUserGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ServiceAppointmentActivity/{id}/ResponsibleUserGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ServiceArticles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ServiceArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ServiceArticles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ServiceArticles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/ServiceArticles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/ServiceArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/ServiceArticles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/ServiceArticles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/ServiceArticles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Article

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Articles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Articles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Articles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /ServiceAppointmentActivity/{id}/Articles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ArticleActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Article

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Articles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Articles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Articles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/Articles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ArticleActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Article relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Articles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Articles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Articles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /ServiceAppointmentActivity/{id}/Articles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ProductArticles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ProductArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ProductArticles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/ProductArticles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/ProductArticles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/ProductArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/ProductArticles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/ProductArticles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/ProductArticles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Filter Articles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Articles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Articles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/string/Articles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /ServiceAppointmentActivity/{id}/Articles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Articles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Articles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/ServiceAppointmentActivity/Articles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /ServiceAppointmentActivity/Articles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Signing

Signing_Callback

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/signing/callback/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
--header 'Accept: application/json'
fetch("https://testing.sweetsystems.se/api/signing/callback/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
"method": "GET",
"headers": {
"Accept": "application/json"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/signing/callback/497f6eca-6276-4993-bfeb-53cbbbba6f08");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
IRestResponse response = client.Execute(request);

GET /signing/callback/{answerSetId}

Parameters

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

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

CallBack

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/signing/packageCallback/497f6eca-6276-4993-bfeb-53cbbbba6f08/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'
fetch("https://testing.sweetsystems.se/api/signing/packageCallback/497f6eca-6276-4993-bfeb-53cbbbba6f08/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": "{}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/signing/packageCallback/497f6eca-6276-4993-bfeb-53cbbbba6f08/497f6eca-6276-4993-bfeb-53cbbbba6f08");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /signing/packageCallback/{connectionId}/{formPackageInstanceId}

Body parameter

{}
{}

Parameters

Name In Type Required Description
connectionId path string(uuid) true none
formPackageInstanceId path string(uuid) true none
body body object true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Signing_PackageCallback

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/signing/packageCallback/497f6eca-6276-4993-bfeb-53cbbbba6f08/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
--header 'Accept: application/json'
fetch("https://testing.sweetsystems.se/api/signing/packageCallback/497f6eca-6276-4993-bfeb-53cbbbba6f08/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
"method": "GET",
"headers": {
"Accept": "application/json"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/signing/packageCallback/497f6eca-6276-4993-bfeb-53cbbbba6f08/497f6eca-6276-4993-bfeb-53cbbbba6f08");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
IRestResponse response = client.Execute(request);

GET /signing/packageCallback/{connectionId}/{formPackageInstanceId}

Parameters

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

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

TargetGroup

Retreive filtrable fields and their type for TargetGroup

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TargetGroup/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TargetGroup/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TargetGroup/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TargetGroup/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter TargetGroup based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TargetGroup/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TargetGroup/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TargetGroup/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TargetGroup/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get TargetGroup by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TargetGroup/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TargetGroup/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TargetGroup/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TargetGroup/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Name": "string",
"Description": "string",
"Public": true,
"Active": true,
"Temporary": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<TargetGroup>
<Name>string</Name>
<Description>string</Description>
<Public>true</Public>
<Active>true</Active>
<Temporary>true</Temporary>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TargetGroup>

Responses

Status Meaning Description Schema
200 OK Success TargetGroup
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete TargetGroup by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TargetGroup/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TargetGroup/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TargetGroup/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TargetGroup/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update TargetGroup

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TargetGroup \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Description":"string","Public":true,"Active":true,"Temporary":true,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TargetGroup", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Description\":\"string\",\"Public\":true,\"Active\":true,\"Temporary\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TargetGroup");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Description\":\"string\",\"Public\":true,\"Active\":true,\"Temporary\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TargetGroup

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Name": "string",
"Description": "string",
"Public": true,
"Active": true,
"Temporary": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Description: string
Public: true
Active: true
Temporary: true
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<TargetGroup>
<Name>string</Name>
<Description>string</Description>
<Public>true</Public>
<Active>true</Active>
<Temporary>true</Temporary>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TargetGroup>

Parameters

Name In Type Required Description
body body TargetGroup true none

Example responses

200 Response

{
"Name": "string",
"Description": "string",
"Public": true,
"Active": true,
"Temporary": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<TargetGroup>
<Name>string</Name>
<Description>string</Description>
<Public>true</Public>
<Active>true</Active>
<Temporary>true</Temporary>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TargetGroup>

Responses

Status Meaning Description Schema
200 OK Entity Updated TargetGroup
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create TargetGroup

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TargetGroup \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Description":"string","Public":true,"Active":true,"Temporary":true,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TargetGroup", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Description\":\"string\",\"Public\":true,\"Active\":true,\"Temporary\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TargetGroup");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Description\":\"string\",\"Public\":true,\"Active\":true,\"Temporary\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TargetGroup

Body parameter

{
"Name": "string",
"Description": "string",
"Public": true,
"Active": true,
"Temporary": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Description: string
Public: true
Active: true
Temporary: true
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<TargetGroup>
<Name>string</Name>
<Description>string</Description>
<Public>true</Public>
<Active>true</Active>
<Temporary>true</Temporary>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TargetGroup>

Parameters

Name In Type Required Description
body body TargetGroup true none

Example responses

201 Response

{
"Name": "string",
"Description": "string",
"Public": true,
"Active": true,
"Temporary": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<TargetGroup>
<Name>string</Name>
<Description>string</Description>
<Public>true</Public>
<Active>true</Active>
<Temporary>true</Temporary>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TargetGroup>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created TargetGroup
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for TargetGroup

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TargetGroup/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TargetGroup/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TargetGroup/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TargetGroup/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to TargetGroup

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TargetGroup/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TargetGroup/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TargetGroup/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TargetGroup/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

TaskActivity

Retreive filtrable fields and their type for TaskActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter TaskActivity based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get TaskActivity by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Duration": "string",
"WorkedTime": 0.1,
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryContactPhoneNumber": "string",
"PrimaryContact": "string",
"IsDone": true,
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"ActivityType": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Location": "string",
"IsReadyForAttestation": true,
"IsAttested": true,
"IsProcessed": true,
"HasExpenseReceipt": true,
"AttestedByUser": "string",
"AttestedDate": "2019-08-24T14:15:22Z",
"AdditionalHoursTripStart": 0.1,
"AdditionalHoursTripEnd": 0.1,
"NumberOfNights": 0,
"NumberOfBreakfast": 0,
"NumberOfLunch": 0,
"NumberOfDinner": 0,
"Description": "string",
"CountryId": [
0
],
"Project": [
"00000000-0000-0000-0000-000000000000"
],
"Workorder": [
"00000000-0000-0000-0000-000000000000"
],
"Article": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"IsNew": true,
"IsPositive": true,
"TagCount": 0,
"AllDayEvent": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<TaskActivity>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Duration>string</Duration>
<WorkedTime>0.1</WorkedTime>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubCategory>
<PrimaryContactPhoneNumber>string</PrimaryContactPhoneNumber>
<PrimaryContact>string</PrimaryContact>
<IsDone>true</IsDone>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<ActivityType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</ActivityType>
<Location>string</Location>
<IsReadyForAttestation>true</IsReadyForAttestation>
<IsAttested>true</IsAttested>
<IsProcessed>true</IsProcessed>
<HasExpenseReceipt>true</HasExpenseReceipt>
<AttestedByUser>string</AttestedByUser>
<AttestedDate>2019-08-24T14:15:22Z</AttestedDate>
<AdditionalHoursTripStart>0.1</AdditionalHoursTripStart>
<AdditionalHoursTripEnd>0.1</AdditionalHoursTripEnd>
<NumberOfNights>0</NumberOfNights>
<NumberOfBreakfast>0</NumberOfBreakfast>
<NumberOfLunch>0</NumberOfLunch>
<NumberOfDinner>0</NumberOfDinner>
<Description>string</Description>
<CountryId>0</CountryId>
<Project>00000000-0000-0000-0000-000000000000</Project>
<Workorder>00000000-0000-0000-0000-000000000000</Workorder>
<Article>00000000-0000-0000-0000-000000000000</Article>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<IsNew>true</IsNew>
<IsPositive>true</IsPositive>
<TagCount>0</TagCount>
<AllDayEvent>true</AllDayEvent>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TaskActivity>

Responses

Status Meaning Description Schema
200 OK Success TaskActivity
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete TaskActivity by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TaskActivity/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TaskActivity/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update TaskActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TaskActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Subject":"string","Start":"2019-08-24T14:15:22Z","End":"2019-08-24T14:15:22Z","WorkedTime":0.1,"Type":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"SubCategory":{"Key":"string","CodeGroupKey":"string"},"IsDone":true,"Longitude":0.1,"Latitude":0.1,"ActivityType":{"Key":"string","CodeGroupKey":"string"},"Location":"string","IsReadyForAttestation":true,"IsAttested":true,"IsProcessed":true,"HasExpenseReceipt":true,"AttestedDate":"2019-08-24T14:15:22Z","AdditionalHoursTripStart":0.1,"AdditionalHoursTripEnd":0.1,"NumberOfNights":0,"NumberOfBreakfast":0,"NumberOfLunch":0,"NumberOfDinner":0,"Description":"string","CountryId":[0],"Project":["00000000-0000-0000-0000-000000000000"],"Workorder":["00000000-0000-0000-0000-000000000000"],"Article":["00000000-0000-0000-0000-000000000000"],"PrivatePerson":["00000000-0000-0000-0000-000000000000"],"CorporatePerson":["00000000-0000-0000-0000-000000000000"],"Company":["00000000-0000-0000-0000-000000000000"],"Responsible":["00000000-0000-0000-0000-000000000000"],"AllDayEvent":true,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"WorkedTime\":0.1,\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubCategory\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"ActivityType\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Location\":\"string\",\"IsReadyForAttestation\":true,\"IsAttested\":true,\"IsProcessed\":true,\"HasExpenseReceipt\":true,\"AttestedDate\":\"2019-08-24T14:15:22Z\",\"AdditionalHoursTripStart\":0.1,\"AdditionalHoursTripEnd\":0.1,\"NumberOfNights\":0,\"NumberOfBreakfast\":0,\"NumberOfLunch\":0,\"NumberOfDinner\":0,\"Description\":\"string\",\"CountryId\":[0],\"Project\":[\"00000000-0000-0000-0000-000000000000\"],\"Workorder\":[\"00000000-0000-0000-0000-000000000000\"],\"Article\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"AllDayEvent\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"WorkedTime\":0.1,\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubCategory\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"ActivityType\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Location\":\"string\",\"IsReadyForAttestation\":true,\"IsAttested\":true,\"IsProcessed\":true,\"HasExpenseReceipt\":true,\"AttestedDate\":\"2019-08-24T14:15:22Z\",\"AdditionalHoursTripStart\":0.1,\"AdditionalHoursTripEnd\":0.1,\"NumberOfNights\":0,\"NumberOfBreakfast\":0,\"NumberOfLunch\":0,\"NumberOfDinner\":0,\"Description\":\"string\",\"CountryId\":[0],\"Project\":[\"00000000-0000-0000-0000-000000000000\"],\"Workorder\":[\"00000000-0000-0000-0000-000000000000\"],\"Article\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"AllDayEvent\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TaskActivity

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"WorkedTime": 0.1,
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsDone": true,
"Longitude": 0.1,
"Latitude": 0.1,
"ActivityType": {
"Key": "string",
"CodeGroupKey": "string"
},
"Location": "string",
"IsReadyForAttestation": true,
"IsAttested": true,
"IsProcessed": true,
"HasExpenseReceipt": true,
"AttestedDate": "2019-08-24T14:15:22Z",
"AdditionalHoursTripStart": 0.1,
"AdditionalHoursTripEnd": 0.1,
"NumberOfNights": 0,
"NumberOfBreakfast": 0,
"NumberOfLunch": 0,
"NumberOfDinner": 0,
"Description": "string",
"CountryId": [
0
],
"Project": [
"00000000-0000-0000-0000-000000000000"
],
"Workorder": [
"00000000-0000-0000-0000-000000000000"
],
"Article": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"AllDayEvent": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
Subject: string
Start: 2019-08-24T14:15:22Z
End: 2019-08-24T14:15:22Z
WorkedTime: 0.1
Type:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
SubCategory:
Key: string
CodeGroupKey: string
IsDone: true
Longitude: 0.1
Latitude: 0.1
ActivityType:
Key: string
CodeGroupKey: string
Location: string
IsReadyForAttestation: true
IsAttested: true
IsProcessed: true
HasExpenseReceipt: true
AttestedDate: 2019-08-24T14:15:22Z
AdditionalHoursTripStart: 0.1
AdditionalHoursTripEnd: 0.1
NumberOfNights: 0
NumberOfBreakfast: 0
NumberOfLunch: 0
NumberOfDinner: 0
Description: string
CountryId:
- 0
Project:
- 00000000-0000-0000-0000-000000000000
Workorder:
- 00000000-0000-0000-0000-000000000000
Article:
- 00000000-0000-0000-0000-000000000000
PrivatePerson:
- 00000000-0000-0000-0000-000000000000
CorporatePerson:
- 00000000-0000-0000-0000-000000000000
Company:
- 00000000-0000-0000-0000-000000000000
Responsible:
- 00000000-0000-0000-0000-000000000000
AllDayEvent: true
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<TaskActivity>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<WorkedTime>0.1</WorkedTime>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</SubCategory>
<IsDone>true</IsDone>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<ActivityType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</ActivityType>
<Location>string</Location>
<IsReadyForAttestation>true</IsReadyForAttestation>
<IsAttested>true</IsAttested>
<IsProcessed>true</IsProcessed>
<HasExpenseReceipt>true</HasExpenseReceipt>
<AttestedDate>2019-08-24T14:15:22Z</AttestedDate>
<AdditionalHoursTripStart>0.1</AdditionalHoursTripStart>
<AdditionalHoursTripEnd>0.1</AdditionalHoursTripEnd>
<NumberOfNights>0</NumberOfNights>
<NumberOfBreakfast>0</NumberOfBreakfast>
<NumberOfLunch>0</NumberOfLunch>
<NumberOfDinner>0</NumberOfDinner>
<Description>string</Description>
<CountryId>0</CountryId>
<Project>00000000-0000-0000-0000-000000000000</Project>
<Workorder>00000000-0000-0000-0000-000000000000</Workorder>
<Article>00000000-0000-0000-0000-000000000000</Article>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<AllDayEvent>true</AllDayEvent>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TaskActivity>

Parameters

Name In Type Required Description
body body TaskActivity true none

Example responses

200 Response

{
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Duration": "string",
"WorkedTime": 0.1,
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryContactPhoneNumber": "string",
"PrimaryContact": "string",
"IsDone": true,
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"ActivityType": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Location": "string",
"IsReadyForAttestation": true,
"IsAttested": true,
"IsProcessed": true,
"HasExpenseReceipt": true,
"AttestedByUser": "string",
"AttestedDate": "2019-08-24T14:15:22Z",
"AdditionalHoursTripStart": 0.1,
"AdditionalHoursTripEnd": 0.1,
"NumberOfNights": 0,
"NumberOfBreakfast": 0,
"NumberOfLunch": 0,
"NumberOfDinner": 0,
"Description": "string",
"CountryId": [
0
],
"Project": [
"00000000-0000-0000-0000-000000000000"
],
"Workorder": [
"00000000-0000-0000-0000-000000000000"
],
"Article": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"IsNew": true,
"IsPositive": true,
"TagCount": 0,
"AllDayEvent": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<TaskActivity>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Duration>string</Duration>
<WorkedTime>0.1</WorkedTime>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubCategory>
<PrimaryContactPhoneNumber>string</PrimaryContactPhoneNumber>
<PrimaryContact>string</PrimaryContact>
<IsDone>true</IsDone>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<ActivityType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</ActivityType>
<Location>string</Location>
<IsReadyForAttestation>true</IsReadyForAttestation>
<IsAttested>true</IsAttested>
<IsProcessed>true</IsProcessed>
<HasExpenseReceipt>true</HasExpenseReceipt>
<AttestedByUser>string</AttestedByUser>
<AttestedDate>2019-08-24T14:15:22Z</AttestedDate>
<AdditionalHoursTripStart>0.1</AdditionalHoursTripStart>
<AdditionalHoursTripEnd>0.1</AdditionalHoursTripEnd>
<NumberOfNights>0</NumberOfNights>
<NumberOfBreakfast>0</NumberOfBreakfast>
<NumberOfLunch>0</NumberOfLunch>
<NumberOfDinner>0</NumberOfDinner>
<Description>string</Description>
<CountryId>0</CountryId>
<Project>00000000-0000-0000-0000-000000000000</Project>
<Workorder>00000000-0000-0000-0000-000000000000</Workorder>
<Article>00000000-0000-0000-0000-000000000000</Article>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<IsNew>true</IsNew>
<IsPositive>true</IsPositive>
<TagCount>0</TagCount>
<AllDayEvent>true</AllDayEvent>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TaskActivity>

Responses

Status Meaning Description Schema
200 OK Entity Updated TaskActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create TaskActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Subject":"string","Start":"2019-08-24T14:15:22Z","End":"2019-08-24T14:15:22Z","WorkedTime":0.1,"Type":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"SubCategory":{"Key":"string","CodeGroupKey":"string"},"IsDone":true,"Longitude":0.1,"Latitude":0.1,"ActivityType":{"Key":"string","CodeGroupKey":"string"},"Location":"string","IsReadyForAttestation":true,"IsAttested":true,"IsProcessed":true,"HasExpenseReceipt":true,"AttestedDate":"2019-08-24T14:15:22Z","AdditionalHoursTripStart":0.1,"AdditionalHoursTripEnd":0.1,"NumberOfNights":0,"NumberOfBreakfast":0,"NumberOfLunch":0,"NumberOfDinner":0,"Description":"string","CountryId":[0],"Project":["00000000-0000-0000-0000-000000000000"],"Workorder":["00000000-0000-0000-0000-000000000000"],"Article":["00000000-0000-0000-0000-000000000000"],"PrivatePerson":["00000000-0000-0000-0000-000000000000"],"CorporatePerson":["00000000-0000-0000-0000-000000000000"],"Company":["00000000-0000-0000-0000-000000000000"],"Responsible":["00000000-0000-0000-0000-000000000000"],"AllDayEvent":true,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"WorkedTime\":0.1,\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubCategory\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"ActivityType\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Location\":\"string\",\"IsReadyForAttestation\":true,\"IsAttested\":true,\"IsProcessed\":true,\"HasExpenseReceipt\":true,\"AttestedDate\":\"2019-08-24T14:15:22Z\",\"AdditionalHoursTripStart\":0.1,\"AdditionalHoursTripEnd\":0.1,\"NumberOfNights\":0,\"NumberOfBreakfast\":0,\"NumberOfLunch\":0,\"NumberOfDinner\":0,\"Description\":\"string\",\"CountryId\":[0],\"Project\":[\"00000000-0000-0000-0000-000000000000\"],\"Workorder\":[\"00000000-0000-0000-0000-000000000000\"],\"Article\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"AllDayEvent\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Subject\":\"string\",\"Start\":\"2019-08-24T14:15:22Z\",\"End\":\"2019-08-24T14:15:22Z\",\"WorkedTime\":0.1,\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"SubCategory\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsDone\":true,\"Longitude\":0.1,\"Latitude\":0.1,\"ActivityType\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Location\":\"string\",\"IsReadyForAttestation\":true,\"IsAttested\":true,\"IsProcessed\":true,\"HasExpenseReceipt\":true,\"AttestedDate\":\"2019-08-24T14:15:22Z\",\"AdditionalHoursTripStart\":0.1,\"AdditionalHoursTripEnd\":0.1,\"NumberOfNights\":0,\"NumberOfBreakfast\":0,\"NumberOfLunch\":0,\"NumberOfDinner\":0,\"Description\":\"string\",\"CountryId\":[0],\"Project\":[\"00000000-0000-0000-0000-000000000000\"],\"Workorder\":[\"00000000-0000-0000-0000-000000000000\"],\"Article\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"Responsible\":[\"00000000-0000-0000-0000-000000000000\"],\"AllDayEvent\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity

Body parameter

{
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"WorkedTime": 0.1,
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsDone": true,
"Longitude": 0.1,
"Latitude": 0.1,
"ActivityType": {
"Key": "string",
"CodeGroupKey": "string"
},
"Location": "string",
"IsReadyForAttestation": true,
"IsAttested": true,
"IsProcessed": true,
"HasExpenseReceipt": true,
"AttestedDate": "2019-08-24T14:15:22Z",
"AdditionalHoursTripStart": 0.1,
"AdditionalHoursTripEnd": 0.1,
"NumberOfNights": 0,
"NumberOfBreakfast": 0,
"NumberOfLunch": 0,
"NumberOfDinner": 0,
"Description": "string",
"CountryId": [
0
],
"Project": [
"00000000-0000-0000-0000-000000000000"
],
"Workorder": [
"00000000-0000-0000-0000-000000000000"
],
"Article": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"AllDayEvent": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
Subject: string
Start: 2019-08-24T14:15:22Z
End: 2019-08-24T14:15:22Z
WorkedTime: 0.1
Type:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
SubCategory:
Key: string
CodeGroupKey: string
IsDone: true
Longitude: 0.1
Latitude: 0.1
ActivityType:
Key: string
CodeGroupKey: string
Location: string
IsReadyForAttestation: true
IsAttested: true
IsProcessed: true
HasExpenseReceipt: true
AttestedDate: 2019-08-24T14:15:22Z
AdditionalHoursTripStart: 0.1
AdditionalHoursTripEnd: 0.1
NumberOfNights: 0
NumberOfBreakfast: 0
NumberOfLunch: 0
NumberOfDinner: 0
Description: string
CountryId:
- 0
Project:
- 00000000-0000-0000-0000-000000000000
Workorder:
- 00000000-0000-0000-0000-000000000000
Article:
- 00000000-0000-0000-0000-000000000000
PrivatePerson:
- 00000000-0000-0000-0000-000000000000
CorporatePerson:
- 00000000-0000-0000-0000-000000000000
Company:
- 00000000-0000-0000-0000-000000000000
Responsible:
- 00000000-0000-0000-0000-000000000000
AllDayEvent: true
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<TaskActivity>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<WorkedTime>0.1</WorkedTime>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</SubCategory>
<IsDone>true</IsDone>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<ActivityType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</ActivityType>
<Location>string</Location>
<IsReadyForAttestation>true</IsReadyForAttestation>
<IsAttested>true</IsAttested>
<IsProcessed>true</IsProcessed>
<HasExpenseReceipt>true</HasExpenseReceipt>
<AttestedDate>2019-08-24T14:15:22Z</AttestedDate>
<AdditionalHoursTripStart>0.1</AdditionalHoursTripStart>
<AdditionalHoursTripEnd>0.1</AdditionalHoursTripEnd>
<NumberOfNights>0</NumberOfNights>
<NumberOfBreakfast>0</NumberOfBreakfast>
<NumberOfLunch>0</NumberOfLunch>
<NumberOfDinner>0</NumberOfDinner>
<Description>string</Description>
<CountryId>0</CountryId>
<Project>00000000-0000-0000-0000-000000000000</Project>
<Workorder>00000000-0000-0000-0000-000000000000</Workorder>
<Article>00000000-0000-0000-0000-000000000000</Article>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<AllDayEvent>true</AllDayEvent>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TaskActivity>

Parameters

Name In Type Required Description
body body TaskActivity true none

Example responses

201 Response

{
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Duration": "string",
"WorkedTime": 0.1,
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryContactPhoneNumber": "string",
"PrimaryContact": "string",
"IsDone": true,
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"ActivityType": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Location": "string",
"IsReadyForAttestation": true,
"IsAttested": true,
"IsProcessed": true,
"HasExpenseReceipt": true,
"AttestedByUser": "string",
"AttestedDate": "2019-08-24T14:15:22Z",
"AdditionalHoursTripStart": 0.1,
"AdditionalHoursTripEnd": 0.1,
"NumberOfNights": 0,
"NumberOfBreakfast": 0,
"NumberOfLunch": 0,
"NumberOfDinner": 0,
"Description": "string",
"CountryId": [
0
],
"Project": [
"00000000-0000-0000-0000-000000000000"
],
"Workorder": [
"00000000-0000-0000-0000-000000000000"
],
"Article": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"IsNew": true,
"IsPositive": true,
"TagCount": 0,
"AllDayEvent": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<TaskActivity>
<Subject>string</Subject>
<Start>2019-08-24T14:15:22Z</Start>
<End>2019-08-24T14:15:22Z</End>
<Duration>string</Duration>
<WorkedTime>0.1</WorkedTime>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<SubCategory>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</SubCategory>
<PrimaryContactPhoneNumber>string</PrimaryContactPhoneNumber>
<PrimaryContact>string</PrimaryContact>
<IsDone>true</IsDone>
<HasDocument>true</HasDocument>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<ActivityType>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</ActivityType>
<Location>string</Location>
<IsReadyForAttestation>true</IsReadyForAttestation>
<IsAttested>true</IsAttested>
<IsProcessed>true</IsProcessed>
<HasExpenseReceipt>true</HasExpenseReceipt>
<AttestedByUser>string</AttestedByUser>
<AttestedDate>2019-08-24T14:15:22Z</AttestedDate>
<AdditionalHoursTripStart>0.1</AdditionalHoursTripStart>
<AdditionalHoursTripEnd>0.1</AdditionalHoursTripEnd>
<NumberOfNights>0</NumberOfNights>
<NumberOfBreakfast>0</NumberOfBreakfast>
<NumberOfLunch>0</NumberOfLunch>
<NumberOfDinner>0</NumberOfDinner>
<Description>string</Description>
<CountryId>0</CountryId>
<Project>00000000-0000-0000-0000-000000000000</Project>
<Workorder>00000000-0000-0000-0000-000000000000</Workorder>
<Article>00000000-0000-0000-0000-000000000000</Article>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<Responsible>00000000-0000-0000-0000-000000000000</Responsible>
<IsNew>true</IsNew>
<IsPositive>true</IsPositive>
<TagCount>0</TagCount>
<AllDayEvent>true</AllDayEvent>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TaskActivity>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created TaskActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for TaskActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to TaskActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

TaskActivity Relations

Filter Cases based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Cases/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Cases/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/Cases/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/Cases/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/Cases/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/Cases/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Case

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Cases", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Cases");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TaskActivity/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Case

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Cases", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Cases");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Case relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Cases/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Cases/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Cases/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TaskActivity/{id}/Cases/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Responsibles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Responsibles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Responsibles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/Responsibles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/Responsibles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/Responsibles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/Responsibles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to User

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Responsibles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Responsibles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TaskActivity/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUserRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityUserRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to User

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Responsibles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Responsibles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUserRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUserRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityUserRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete User relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Responsibles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Responsibles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Responsibles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TaskActivity/{id}/Responsibles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Companies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Companies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Companies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/Companies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/Companies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/Companies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/Companies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Company

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Companies", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Companies");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TaskActivity/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Company

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Companies", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Companies");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Company relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Companies/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Companies/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Companies/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TaskActivity/{id}/Companies/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter CompanyGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/CompanyGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/CompanyGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/CompanyGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/CompanyGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/CompanyGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/CompanyGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/CompanyGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to CompanyGroup

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TaskActivity/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/CompanyGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/CompanyGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TaskActivity/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyGroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to CompanyGroup

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/CompanyGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/CompanyGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/CompanyGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/CompanyGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityCompanyGroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityCompanyGroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityCompanyGroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityCompanyGroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete CompanyGroup relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TaskActivity/string/CompanyGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/CompanyGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/CompanyGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TaskActivity/{id}/CompanyGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Deals based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Deals/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Deals/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/Deals/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/Deals/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/Deals/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/Deals/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to BusinessProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Deals", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Deals");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TaskActivity/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityBusinessProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityBusinessProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to BusinessProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Deals", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Deals");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityBusinessProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityBusinessProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityBusinessProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityBusinessProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete BusinessProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Deals/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Deals/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Deals/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TaskActivity/{id}/Deals/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter PrivatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/PrivatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/PrivatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/PrivatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/PrivatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/PrivatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/PrivatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to PrivatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TaskActivity/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/PrivatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/PrivatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TaskActivity/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityPrivatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to PrivatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/PrivatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/PrivatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityPrivatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete PrivatePerson relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TaskActivity/string/PrivatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/PrivatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/PrivatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TaskActivity/{id}/PrivatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter MarketingActivities based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/MarketingActivities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingActivities/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingActivities/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/MarketingActivities/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/MarketingActivities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/MarketingActivities/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/MarketingActivities/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/MarketingActivities/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to MarketingActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TaskActivity/string/MarketingActivities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingActivities", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingActivities");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TaskActivity/{id}/MarketingActivities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityMarketingActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to MarketingActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/MarketingActivities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingActivities", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingActivities");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/MarketingActivities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityMarketingActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete MarketingActivity relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TaskActivity/string/MarketingActivities/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingActivities/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingActivities/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TaskActivity/{id}/MarketingActivities/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter MarketingProjects based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingProjects/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingProjects/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/MarketingProjects/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/MarketingProjects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/MarketingProjects/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/MarketingProjects/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/MarketingProjects/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to MarketingProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TaskActivity/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingProjects", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingProjects");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TaskActivity/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityMarketingProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to MarketingProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/MarketingProjects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingProjects", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingProjects");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/MarketingProjects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityMarketingProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityMarketingProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityMarketingProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityMarketingProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete MarketingProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TaskActivity/string/MarketingProjects/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingProjects/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/MarketingProjects/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TaskActivity/{id}/MarketingProjects/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Workorders based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Workorders/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Workorders/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Workorders/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/Workorders/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/Workorders/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/Workorders/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/Workorders/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/Workorders/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Workorder

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Workorders \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Workorders", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Workorders");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TaskActivity/{id}/Workorders

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Workorder

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Workorders \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Workorders", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Workorders");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/Workorders

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Workorder relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Workorders/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Workorders/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Workorders/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TaskActivity/{id}/Workorders/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ResponsibleUserGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/ResponsibleUserGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/ResponsibleUserGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/ResponsibleUserGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/ResponsibleUserGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/ResponsibleUserGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/ResponsibleUserGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/ResponsibleUserGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/ResponsibleUserGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Group

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TaskActivity/string/ResponsibleUserGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/ResponsibleUserGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/ResponsibleUserGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TaskActivity/{id}/ResponsibleUserGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUsergroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ActivityUsergroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Group

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/ResponsibleUserGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/ResponsibleUserGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/ResponsibleUserGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/ResponsibleUserGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body ActivityUsergroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ActivityUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ActivityUsergroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ActivityUsergroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Group relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TaskActivity/string/ResponsibleUserGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/ResponsibleUserGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/ResponsibleUserGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TaskActivity/{id}/ResponsibleUserGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ServiceArticles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/ServiceArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/ServiceArticles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/ServiceArticles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/ServiceArticles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/ServiceArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/ServiceArticles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/ServiceArticles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/ServiceArticles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Article

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Articles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Articles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Articles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TaskActivity/{id}/Articles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated ArticleActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Article

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Articles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Articles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Articles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/Articles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body ArticleActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ArticleActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</ArticleActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created ArticleActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Article relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Articles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Articles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Articles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TaskActivity/{id}/Articles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ProductArticles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/ProductArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/ProductArticles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/ProductArticles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/ProductArticles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/ProductArticles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/ProductArticles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/ProductArticles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/ProductArticles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Filter Articles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TaskActivity/string/Articles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TaskActivity/string/Articles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/string/Articles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TaskActivity/{id}/Articles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TaskActivity/Articles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TaskActivity/Articles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TaskActivity/Articles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TaskActivity/Articles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

TelemarketingActivity

Retreive filtrable fields and their type for TelemarketingActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TelemarketingActivity/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TelemarketingActivity/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TelemarketingActivity/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TelemarketingActivity/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter TelemarketingActivity based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TelemarketingActivity/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/TelemarketingActivity/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TelemarketingActivity/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TelemarketingActivity/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get TelemarketingActivity by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TelemarketingActivity/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TelemarketingActivity/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TelemarketingActivity/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TelemarketingActivity/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Name": "string",
"Description": "string",
"WebSite": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"FollowUpDate": "2019-08-24T14:15:22Z",
"ReportDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingProject": "string",
"MarketingPlan": "string",
"MarketingPlanAndProject": "string",
"TimeSpan": "string",
"IsExternal": true,
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"MarketingPlanId": "00000000-0000-0000-0000-000000000000",
"IsNew": true,
"TagCount": 0,
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"ProcessItemCount": 0,
"ActiveProcessItemCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Active": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<TelemarketingActivity>
<Name>string</Name>
<Description>string</Description>
<WebSite>string</WebSite>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<FollowUpDate>2019-08-24T14:15:22Z</FollowUpDate>
<ReportDate>2019-08-24T14:15:22Z</ReportDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<MarketingProject>string</MarketingProject>
<MarketingPlan>string</MarketingPlan>
<MarketingPlanAndProject>string</MarketingPlanAndProject>
<TimeSpan>string</TimeSpan>
<IsExternal>true</IsExternal>
<MarketingProjectId>00000000-0000-0000-0000-000000000000</MarketingProjectId>
<MarketingPlanId>00000000-0000-0000-0000-000000000000</MarketingPlanId>
<IsNew>true</IsNew>
<TagCount>0</TagCount>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<ProcessItemCount>0</ProcessItemCount>
<ActiveProcessItemCount>0</ActiveProcessItemCount>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Active>true</Active>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TelemarketingActivity>

Responses

Status Meaning Description Schema
200 OK Success TelemarketingActivity
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete TelemarketingActivity by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/TelemarketingActivity/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TelemarketingActivity/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TelemarketingActivity/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /TelemarketingActivity/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update TelemarketingActivity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/TelemarketingActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Description":"string","WebSite":"string","StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","FollowUpDate":"2019-08-24T14:15:22Z","ReportDate":"2019-08-24T14:15:22Z","Status":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"IsExternal":true,"TargetParticipantQuantity":0,"TargetResponseRatePercent":0,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TelemarketingActivity", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Description\":\"string\",\"WebSite\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"FollowUpDate\":\"2019-08-24T14:15:22Z\",\"ReportDate\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsExternal\":true,\"TargetParticipantQuantity\":0,\"TargetResponseRatePercent\":0,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TelemarketingActivity");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Description\":\"string\",\"WebSite\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"FollowUpDate\":\"2019-08-24T14:15:22Z\",\"ReportDate\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsExternal\":true,\"TargetParticipantQuantity\":0,\"TargetResponseRatePercent\":0,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /TelemarketingActivity

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Name": "string",
"Description": "string",
"WebSite": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"FollowUpDate": "2019-08-24T14:15:22Z",
"ReportDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsExternal": true,
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Description: string
WebSite: string
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
FollowUpDate: 2019-08-24T14:15:22Z
ReportDate: 2019-08-24T14:15:22Z
Status:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
IsExternal: true
TargetParticipantQuantity: 0
TargetResponseRatePercent: 0
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<TelemarketingActivity>
<Name>string</Name>
<Description>string</Description>
<WebSite>string</WebSite>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<FollowUpDate>2019-08-24T14:15:22Z</FollowUpDate>
<ReportDate>2019-08-24T14:15:22Z</ReportDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<IsExternal>true</IsExternal>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TelemarketingActivity>

Parameters

Name In Type Required Description
body body TelemarketingActivity true none

Example responses

200 Response

{
"Name": "string",
"Description": "string",
"WebSite": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"FollowUpDate": "2019-08-24T14:15:22Z",
"ReportDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingProject": "string",
"MarketingPlan": "string",
"MarketingPlanAndProject": "string",
"TimeSpan": "string",
"IsExternal": true,
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"MarketingPlanId": "00000000-0000-0000-0000-000000000000",
"IsNew": true,
"TagCount": 0,
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"ProcessItemCount": 0,
"ActiveProcessItemCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Active": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<TelemarketingActivity>
<Name>string</Name>
<Description>string</Description>
<WebSite>string</WebSite>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<FollowUpDate>2019-08-24T14:15:22Z</FollowUpDate>
<ReportDate>2019-08-24T14:15:22Z</ReportDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<MarketingProject>string</MarketingProject>
<MarketingPlan>string</MarketingPlan>
<MarketingPlanAndProject>string</MarketingPlanAndProject>
<TimeSpan>string</TimeSpan>
<IsExternal>true</IsExternal>
<MarketingProjectId>00000000-0000-0000-0000-000000000000</MarketingProjectId>
<MarketingPlanId>00000000-0000-0000-0000-000000000000</MarketingPlanId>
<IsNew>true</IsNew>
<TagCount>0</TagCount>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<ProcessItemCount>0</ProcessItemCount>
<ActiveProcessItemCount>0</ActiveProcessItemCount>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Active>true</Active>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TelemarketingActivity>

Responses

Status Meaning Description Schema
200 OK Entity Updated TelemarketingActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create TelemarketingActivity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/TelemarketingActivity \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Name":"string","Description":"string","WebSite":"string","StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","FollowUpDate":"2019-08-24T14:15:22Z","ReportDate":"2019-08-24T14:15:22Z","Status":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"IsExternal":true,"TargetParticipantQuantity":0,"TargetResponseRatePercent":0,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/TelemarketingActivity", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Name\":\"string\",\"Description\":\"string\",\"WebSite\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"FollowUpDate\":\"2019-08-24T14:15:22Z\",\"ReportDate\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsExternal\":true,\"TargetParticipantQuantity\":0,\"TargetResponseRatePercent\":0,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TelemarketingActivity");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Name\":\"string\",\"Description\":\"string\",\"WebSite\":\"string\",\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"FollowUpDate\":\"2019-08-24T14:15:22Z\",\"ReportDate\":\"2019-08-24T14:15:22Z\",\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"IsExternal\":true,\"TargetParticipantQuantity\":0,\"TargetResponseRatePercent\":0,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /TelemarketingActivity

Body parameter

{
"Name": "string",
"Description": "string",
"WebSite": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"FollowUpDate": "2019-08-24T14:15:22Z",
"ReportDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"IsExternal": true,
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"Id": "00000000-0000-0000-0000-000000000000"
}
Name: string
Description: string
WebSite: string
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
FollowUpDate: 2019-08-24T14:15:22Z
ReportDate: 2019-08-24T14:15:22Z
Status:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
IsExternal: true
TargetParticipantQuantity: 0
TargetResponseRatePercent: 0
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<TelemarketingActivity>
<Name>string</Name>
<Description>string</Description>
<WebSite>string</WebSite>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<FollowUpDate>2019-08-24T14:15:22Z</FollowUpDate>
<ReportDate>2019-08-24T14:15:22Z</ReportDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<IsExternal>true</IsExternal>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TelemarketingActivity>

Parameters

Name In Type Required Description
body body TelemarketingActivity true none

Example responses

201 Response

{
"Name": "string",
"Description": "string",
"WebSite": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"FollowUpDate": "2019-08-24T14:15:22Z",
"ReportDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingProject": "string",
"MarketingPlan": "string",
"MarketingPlanAndProject": "string",
"TimeSpan": "string",
"IsExternal": true,
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"MarketingPlanId": "00000000-0000-0000-0000-000000000000",
"IsNew": true,
"TagCount": 0,
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"ProcessItemCount": 0,
"ActiveProcessItemCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Active": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<TelemarketingActivity>
<Name>string</Name>
<Description>string</Description>
<WebSite>string</WebSite>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<FollowUpDate>2019-08-24T14:15:22Z</FollowUpDate>
<ReportDate>2019-08-24T14:15:22Z</ReportDate>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<MarketingProject>string</MarketingProject>
<MarketingPlan>string</MarketingPlan>
<MarketingPlanAndProject>string</MarketingPlanAndProject>
<TimeSpan>string</TimeSpan>
<IsExternal>true</IsExternal>
<MarketingProjectId>00000000-0000-0000-0000-000000000000</MarketingProjectId>
<MarketingPlanId>00000000-0000-0000-0000-000000000000</MarketingPlanId>
<IsNew>true</IsNew>
<TagCount>0</TagCount>
<TargetParticipantQuantity>0</TargetParticipantQuantity>
<TargetResponseRatePercent>0</TargetResponseRatePercent>
<ProcessItemCount>0</ProcessItemCount>
<ActiveProcessItemCount>0</ActiveProcessItemCount>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Active>true</Active>
<Id>00000000-0000-0000-0000-000000000000</Id>
</TelemarketingActivity>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created TelemarketingActivity
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for TelemarketingActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TelemarketingActivity/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TelemarketingActivity/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TelemarketingActivity/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TelemarketingActivity/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to TelemarketingActivity

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/TelemarketingActivity/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/TelemarketingActivity/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/TelemarketingActivity/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /TelemarketingActivity/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

TwoFactor

TwoFactor_GenerateChallenge

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/two-factor/generate \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"EntityId":"00000000-0000-0000-0000-000000000000","DeliveryMethod":"api","DeliveryAddress":"string","CodeLength":0,"CodeAlphanumeric":true,"CodeExpirationInSeconds":0,"CallbackUrl":"string"}'
fetch("https://testing.sweetsystems.se/api/two-factor/generate", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"EntityId\":\"00000000-0000-0000-0000-000000000000\",\"DeliveryMethod\":\"api\",\"DeliveryAddress\":\"string\",\"CodeLength\":0,\"CodeAlphanumeric\":true,\"CodeExpirationInSeconds\":0,\"CallbackUrl\":\"string\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/two-factor/generate");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"EntityId\":\"00000000-0000-0000-0000-000000000000\",\"DeliveryMethod\":\"api\",\"DeliveryAddress\":\"string\",\"CodeLength\":0,\"CodeAlphanumeric\":true,\"CodeExpirationInSeconds\":0,\"CallbackUrl\":\"string\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /two-factor/generate

Body parameter

{
"EntityId": "00000000-0000-0000-0000-000000000000",
"DeliveryMethod": "api",
"DeliveryAddress": "string",
"CodeLength": 0,
"CodeAlphanumeric": true,
"CodeExpirationInSeconds": 0,
"CallbackUrl": "string"
}
EntityId: 00000000-0000-0000-0000-000000000000
DeliveryMethod: api
DeliveryAddress: string
CodeLength: 0
CodeAlphanumeric: true
CodeExpirationInSeconds: 0
CallbackUrl: string
<?xml version="1.0" encoding="UTF-8" ?>
<ChallengeRequest>
<EntityId>00000000-0000-0000-0000-000000000000</EntityId>
<DeliveryMethod>api</DeliveryMethod>
<DeliveryAddress>string</DeliveryAddress>
<CodeLength>0</CodeLength>
<CodeAlphanumeric>true</CodeAlphanumeric>
<CodeExpirationInSeconds>0</CodeExpirationInSeconds>
<CallbackUrl>string</CallbackUrl>
</ChallengeRequest>

Parameters

Name In Type Required Description
body body ChallengeRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

TwoFactor_Verify

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/two-factor/497f6eca-6276-4993-bfeb-53cbbbba6f08/verify \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '"string"'
fetch("https://testing.sweetsystems.se/api/two-factor/497f6eca-6276-4993-bfeb-53cbbbba6f08/verify", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "\"string\""
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/two-factor/497f6eca-6276-4993-bfeb-53cbbbba6f08/verify");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "\"string\"", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /two-factor/{entityId}/verify

Body parameter

"string"
string

Parameters

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

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Version

Version_Get

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Version \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Version", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Version");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Version

Example responses

200 Response

{
"Name": "string",
"Major": 0,
"Minor": 0,
"Patch": 0,
"Build": 0,
"Version": "string"
}
<?xml version="1.0" encoding="UTF-8" ?>
<ProductVersion>
<Name>string</Name>
<Major>0</Major>
<Minor>0</Minor>
<Patch>0</Patch>
<Build>0</Build>
<Version>string</Version>
</ProductVersion>

Responses

Status Meaning Description Schema
200 OK Success ProductVersion
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Workorder

Retreive filtrable fields and their type for Workorder

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/Filter \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/Filter", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/Filter

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
500 Internal Server Error InternalServerError None

Filter Workorder based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/Filter \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Workorder/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
body body DataSourceRequest true none

Responses

Status Meaning Description Schema
200 OK OK None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Get Workorder by it’s Id

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/string \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/string", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/{id}

The response header contains a ETag(or entity tag) value that can be used in subsequent Get/Put request.

When using a If-Match: value in the Get request header you can check that you have the latest version of the entity.

Example. If-Match: ABC123

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
"Subject": "string",
"Description": "string",
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Duration": "string",
"PrimaryAddress": "string",
"PrimaryCity": "string",
"PrimaryCounty": "string",
"PrimaryZipCode": "string",
"Country": [
0
],
"Longitude": 0.1,
"Latitude": 0.1,
"IsNew": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Project": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Case": [
"00000000-0000-0000-0000-000000000000"
],
"PrimaryResponsible": "string",
"ResponsibleUsergroupId": [
"00000000-0000-0000-0000-000000000000"
],
"WorkorderNumber": "string",
"Active": true,
"ShowCreateServiceAppointment": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Workorder>
<Subject>string</Subject>
<Description>string</Description>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Duration>string</Duration>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryCity>string</PrimaryCity>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryZipCode>string</PrimaryZipCode>
<Country>0</Country>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<IsNew>true</IsNew>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Project>00000000-0000-0000-0000-000000000000</Project>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<Case>00000000-0000-0000-0000-000000000000</Case>
<PrimaryResponsible>string</PrimaryResponsible>
<ResponsibleUsergroupId>00000000-0000-0000-0000-000000000000</ResponsibleUsergroupId>
<WorkorderNumber>string</WorkorderNumber>
<Active>true</Active>
<ShowCreateServiceAppointment>true</ShowCreateServiceAppointment>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Workorder>

Responses

Status Meaning Description Schema
200 OK Success Workorder
304 Not Modified You have the latest version None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
429 Too Many Requests Too many requests None
500 Internal Server Error InternalServerError None

Delete Workorder by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Workorder/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Workorder/{id}

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Update Workorder

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Workorder \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Subject":"string","Description":"string","Type":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","PrimaryAddress":"string","PrimaryCity":"string","PrimaryCounty":"string","PrimaryZipCode":"string","Country":[0],"Longitude":0.1,"Latitude":0.1,"Project":["00000000-0000-0000-0000-000000000000"],"PrivatePerson":["00000000-0000-0000-0000-000000000000"],"CorporatePerson":["00000000-0000-0000-0000-000000000000"],"Company":["00000000-0000-0000-0000-000000000000"],"Case":["00000000-0000-0000-0000-000000000000"],"ResponsibleUsergroupId":["00000000-0000-0000-0000-000000000000"],"WorkorderNumber":"string","Active":true,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Subject\":\"string\",\"Description\":\"string\",\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"PrimaryAddress\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryZipCode\":\"string\",\"Country\":[0],\"Longitude\":0.1,\"Latitude\":0.1,\"Project\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"Case\":[\"00000000-0000-0000-0000-000000000000\"],\"ResponsibleUsergroupId\":[\"00000000-0000-0000-0000-000000000000\"],\"WorkorderNumber\":\"string\",\"Active\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Subject\":\"string\",\"Description\":\"string\",\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"PrimaryAddress\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryZipCode\":\"string\",\"Country\":[0],\"Longitude\":0.1,\"Latitude\":0.1,\"Project\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"Case\":[\"00000000-0000-0000-0000-000000000000\"],\"ResponsibleUsergroupId\":[\"00000000-0000-0000-0000-000000000000\"],\"WorkorderNumber\":\"string\",\"Active\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Workorder

Put uses ETag (or entity tag) to make sure you are updating the latest version of the entity.

When you do a Get against the entity you get a ETag: value in the response header.

Add a request header value to your Put request with If-Match: value to make sure you update the latest version.

Example. If-Match: ABC123

Body parameter

{
"Subject": "string",
"Description": "string",
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"PrimaryAddress": "string",
"PrimaryCity": "string",
"PrimaryCounty": "string",
"PrimaryZipCode": "string",
"Country": [
0
],
"Longitude": 0.1,
"Latitude": 0.1,
"Project": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Case": [
"00000000-0000-0000-0000-000000000000"
],
"ResponsibleUsergroupId": [
"00000000-0000-0000-0000-000000000000"
],
"WorkorderNumber": "string",
"Active": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
Subject: string
Description: string
Type:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
PrimaryAddress: string
PrimaryCity: string
PrimaryCounty: string
PrimaryZipCode: string
Country:
- 0
Longitude: 0.1
Latitude: 0.1
Project:
- 00000000-0000-0000-0000-000000000000
PrivatePerson:
- 00000000-0000-0000-0000-000000000000
CorporatePerson:
- 00000000-0000-0000-0000-000000000000
Company:
- 00000000-0000-0000-0000-000000000000
Case:
- 00000000-0000-0000-0000-000000000000
ResponsibleUsergroupId:
- 00000000-0000-0000-0000-000000000000
WorkorderNumber: string
Active: true
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Workorder>
<Subject>string</Subject>
<Description>string</Description>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryCity>string</PrimaryCity>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryZipCode>string</PrimaryZipCode>
<Country>0</Country>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Project>00000000-0000-0000-0000-000000000000</Project>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<Case>00000000-0000-0000-0000-000000000000</Case>
<ResponsibleUsergroupId>00000000-0000-0000-0000-000000000000</ResponsibleUsergroupId>
<WorkorderNumber>string</WorkorderNumber>
<Active>true</Active>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Workorder>

Parameters

Name In Type Required Description
body body Workorder true none

Example responses

200 Response

{
"Subject": "string",
"Description": "string",
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Duration": "string",
"PrimaryAddress": "string",
"PrimaryCity": "string",
"PrimaryCounty": "string",
"PrimaryZipCode": "string",
"Country": [
0
],
"Longitude": 0.1,
"Latitude": 0.1,
"IsNew": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Project": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Case": [
"00000000-0000-0000-0000-000000000000"
],
"PrimaryResponsible": "string",
"ResponsibleUsergroupId": [
"00000000-0000-0000-0000-000000000000"
],
"WorkorderNumber": "string",
"Active": true,
"ShowCreateServiceAppointment": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Workorder>
<Subject>string</Subject>
<Description>string</Description>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Duration>string</Duration>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryCity>string</PrimaryCity>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryZipCode>string</PrimaryZipCode>
<Country>0</Country>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<IsNew>true</IsNew>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Project>00000000-0000-0000-0000-000000000000</Project>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<Case>00000000-0000-0000-0000-000000000000</Case>
<PrimaryResponsible>string</PrimaryResponsible>
<ResponsibleUsergroupId>00000000-0000-0000-0000-000000000000</ResponsibleUsergroupId>
<WorkorderNumber>string</WorkorderNumber>
<Active>true</Active>
<ShowCreateServiceAppointment>true</ShowCreateServiceAppointment>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Workorder>

Responses

Status Meaning Description Schema
200 OK Entity Updated Workorder
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create Workorder

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Subject":"string","Description":"string","Type":{"Key":"string","CodeGroupKey":"string"},"Status":{"Key":"string","CodeGroupKey":"string"},"Category":{"Key":"string","CodeGroupKey":"string"},"Priority":{"Key":"string","CodeGroupKey":"string"},"StartDate":"2019-08-24T14:15:22Z","EndDate":"2019-08-24T14:15:22Z","PrimaryAddress":"string","PrimaryCity":"string","PrimaryCounty":"string","PrimaryZipCode":"string","Country":[0],"Longitude":0.1,"Latitude":0.1,"Project":["00000000-0000-0000-0000-000000000000"],"PrivatePerson":["00000000-0000-0000-0000-000000000000"],"CorporatePerson":["00000000-0000-0000-0000-000000000000"],"Company":["00000000-0000-0000-0000-000000000000"],"Case":["00000000-0000-0000-0000-000000000000"],"ResponsibleUsergroupId":["00000000-0000-0000-0000-000000000000"],"WorkorderNumber":"string","Active":true,"Id":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Subject\":\"string\",\"Description\":\"string\",\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"PrimaryAddress\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryZipCode\":\"string\",\"Country\":[0],\"Longitude\":0.1,\"Latitude\":0.1,\"Project\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"Case\":[\"00000000-0000-0000-0000-000000000000\"],\"ResponsibleUsergroupId\":[\"00000000-0000-0000-0000-000000000000\"],\"WorkorderNumber\":\"string\",\"Active\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Subject\":\"string\",\"Description\":\"string\",\"Type\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Status\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Category\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"Priority\":{\"Key\":\"string\",\"CodeGroupKey\":\"string\"},\"StartDate\":\"2019-08-24T14:15:22Z\",\"EndDate\":\"2019-08-24T14:15:22Z\",\"PrimaryAddress\":\"string\",\"PrimaryCity\":\"string\",\"PrimaryCounty\":\"string\",\"PrimaryZipCode\":\"string\",\"Country\":[0],\"Longitude\":0.1,\"Latitude\":0.1,\"Project\":[\"00000000-0000-0000-0000-000000000000\"],\"PrivatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"CorporatePerson\":[\"00000000-0000-0000-0000-000000000000\"],\"Company\":[\"00000000-0000-0000-0000-000000000000\"],\"Case\":[\"00000000-0000-0000-0000-000000000000\"],\"ResponsibleUsergroupId\":[\"00000000-0000-0000-0000-000000000000\"],\"WorkorderNumber\":\"string\",\"Active\":true,\"Id\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder

Body parameter

{
"Subject": "string",
"Description": "string",
"Type": {
"Key": "string",
"CodeGroupKey": "string"
},
"Status": {
"Key": "string",
"CodeGroupKey": "string"
},
"Category": {
"Key": "string",
"CodeGroupKey": "string"
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string"
},
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"PrimaryAddress": "string",
"PrimaryCity": "string",
"PrimaryCounty": "string",
"PrimaryZipCode": "string",
"Country": [
0
],
"Longitude": 0.1,
"Latitude": 0.1,
"Project": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Case": [
"00000000-0000-0000-0000-000000000000"
],
"ResponsibleUsergroupId": [
"00000000-0000-0000-0000-000000000000"
],
"WorkorderNumber": "string",
"Active": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
Subject: string
Description: string
Type:
Key: string
CodeGroupKey: string
Status:
Key: string
CodeGroupKey: string
Category:
Key: string
CodeGroupKey: string
Priority:
Key: string
CodeGroupKey: string
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
PrimaryAddress: string
PrimaryCity: string
PrimaryCounty: string
PrimaryZipCode: string
Country:
- 0
Longitude: 0.1
Latitude: 0.1
Project:
- 00000000-0000-0000-0000-000000000000
PrivatePerson:
- 00000000-0000-0000-0000-000000000000
CorporatePerson:
- 00000000-0000-0000-0000-000000000000
Company:
- 00000000-0000-0000-0000-000000000000
Case:
- 00000000-0000-0000-0000-000000000000
ResponsibleUsergroupId:
- 00000000-0000-0000-0000-000000000000
WorkorderNumber: string
Active: true
Id: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<Workorder>
<Subject>string</Subject>
<Description>string</Description>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
</Priority>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryCity>string</PrimaryCity>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryZipCode>string</PrimaryZipCode>
<Country>0</Country>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<Project>00000000-0000-0000-0000-000000000000</Project>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<Case>00000000-0000-0000-0000-000000000000</Case>
<ResponsibleUsergroupId>00000000-0000-0000-0000-000000000000</ResponsibleUsergroupId>
<WorkorderNumber>string</WorkorderNumber>
<Active>true</Active>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Workorder>

Parameters

Name In Type Required Description
body body Workorder true none

Example responses

201 Response

{
"Subject": "string",
"Description": "string",
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Duration": "string",
"PrimaryAddress": "string",
"PrimaryCity": "string",
"PrimaryCounty": "string",
"PrimaryZipCode": "string",
"Country": [
0
],
"Longitude": 0.1,
"Latitude": 0.1,
"IsNew": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Project": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Case": [
"00000000-0000-0000-0000-000000000000"
],
"PrimaryResponsible": "string",
"ResponsibleUsergroupId": [
"00000000-0000-0000-0000-000000000000"
],
"WorkorderNumber": "string",
"Active": true,
"ShowCreateServiceAppointment": true,
"Id": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<Workorder>
<Subject>string</Subject>
<Description>string</Description>
<Type>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Type>
<Status>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Status>
<Category>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Category>
<Priority>
<Key>string</Key>
<CodeGroupKey>string</CodeGroupKey>
<Caption>string</Caption>
<Active>true</Active>
</Priority>
<StartDate>2019-08-24T14:15:22Z</StartDate>
<EndDate>2019-08-24T14:15:22Z</EndDate>
<Duration>string</Duration>
<PrimaryAddress>string</PrimaryAddress>
<PrimaryCity>string</PrimaryCity>
<PrimaryCounty>string</PrimaryCounty>
<PrimaryZipCode>string</PrimaryZipCode>
<Country>0</Country>
<Longitude>0.1</Longitude>
<Latitude>0.1</Latitude>
<IsNew>true</IsNew>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<Project>00000000-0000-0000-0000-000000000000</Project>
<PrivatePerson>00000000-0000-0000-0000-000000000000</PrivatePerson>
<CorporatePerson>00000000-0000-0000-0000-000000000000</CorporatePerson>
<Company>00000000-0000-0000-0000-000000000000</Company>
<Case>00000000-0000-0000-0000-000000000000</Case>
<PrimaryResponsible>string</PrimaryResponsible>
<ResponsibleUsergroupId>00000000-0000-0000-0000-000000000000</ResponsibleUsergroupId>
<WorkorderNumber>string</WorkorderNumber>
<Active>true</Active>
<ShowCreateServiceAppointment>true</ShowCreateServiceAppointment>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Workorder>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created Workorder
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Get tags valid for Workorder

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/Tags \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/Tags", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/Tags");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/Tags

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Get tags connected to Workorder

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/string/Documents \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Documents", {
"method": "GET",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Documents");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/{id}/Documents

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Workorder Relations

Filter Deals based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Deals/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Deals/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/Deals/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/Deals/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/Deals/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/Deals/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/Deals/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to BusinessProject

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Workorder/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Deals", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Deals");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Workorder/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderBusinessprojectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderBusinessprojectRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderBusinessprojectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderBusinessprojectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderBusinessprojectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderBusinessprojectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to BusinessProject

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/Deals \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Deals", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Deals");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/Deals

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderBusinessprojectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderBusinessprojectRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderBusinessprojectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderBusinessprojectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderBusinessprojectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderBusinessprojectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete BusinessProject relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Workorder/string/Deals/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Deals/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Deals/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Workorder/{id}/Deals/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Projects based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/Projects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Projects/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Projects/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/Projects/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/Projects/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/Projects/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/Projects/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/Projects/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Project

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Workorder/string/Projects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Projects", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Projects");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Workorder/{id}/Projects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderProjectRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderProjectRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Project

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/Projects \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Projects", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Projects");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/Projects

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderProjectRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderProjectRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderProjectRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderProjectRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderProjectRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Project relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Workorder/string/Projects/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Projects/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Projects/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Workorder/{id}/Projects/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Companies based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Companies/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Companies/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/Companies/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/Companies/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/Companies/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/Companies/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/Companies/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Company

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Workorder/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Companies", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Companies");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Workorder/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderCompanyRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Company

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/Companies \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Companies", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Companies");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/Companies

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderCompanyRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderCompanyRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderCompanyRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderCompanyRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderCompanyRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Company relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Workorder/string/Companies/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Companies/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Companies/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Workorder/{id}/Companies/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Cases based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Cases/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Cases/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/Cases/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/Cases/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/Cases/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/Cases/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/Cases/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Case

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Workorder/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Cases", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Cases");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Workorder/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderCaseRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderCaseRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Case

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/Cases \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Cases", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Cases");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/Cases

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderCaseRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderCaseRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderCaseRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderCaseRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderCaseRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Case relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Workorder/string/Cases/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Cases/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Cases/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Workorder/{id}/Cases/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter PrivatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/PrivatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/PrivatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/PrivatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/PrivatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/PrivatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/PrivatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/PrivatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to PrivatePerson

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Workorder/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/PrivatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/PrivatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Workorder/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderPrivatePersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to PrivatePerson

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/PrivatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/PrivatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/PrivatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/PrivatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderPrivatePersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderPrivatePersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderPrivatePersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderPrivatePersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderPrivatePersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete PrivatePerson relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Workorder/string/PrivatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/string/PrivatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/PrivatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Workorder/{id}/PrivatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter CorporatePersons based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/CorporatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/CorporatePersons/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/CorporatePersons/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/CorporatePersons/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/CorporatePersons/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/CorporatePersons/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/CorporatePersons/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/CorporatePersons/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to CorporatePersonRelation

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Workorder/string/CorporatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/CorporatePersons", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/CorporatePersons");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Workorder/{id}/CorporatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderCompanyPersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderCompanyPersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderCompanyPersonRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderCompanyPersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderCompanyPersonRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderCompanyPersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to CorporatePersonRelation

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/CorporatePersons \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/CorporatePersons", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/CorporatePersons");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/CorporatePersons

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderCompanyPersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderCompanyPersonRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderCompanyPersonRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderCompanyPersonRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderCompanyPersonRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderCompanyPersonRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete CorporatePersonRelation relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Workorder/string/CorporatePersons/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/string/CorporatePersons/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/CorporatePersons/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Workorder/{id}/CorporatePersons/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Responsibles based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Responsibles/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Responsibles/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/Responsibles/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/Responsibles/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/Responsibles/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/Responsibles/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/Responsibles/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to User

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Workorder/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Responsibles", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Responsibles");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Workorder/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderUserRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderUserRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderUserRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderUserRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to User

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/Responsibles \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Responsibles", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Responsibles");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/Responsibles

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderUserRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderUserRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderUserRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderUserRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderUserRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete User relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Workorder/string/Responsibles/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Responsibles/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Responsibles/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Workorder/{id}/Responsibles/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter Activities based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/Activities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Activities/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Activities/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/Activities/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/Activities/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/Activities/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/Activities/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/Activities/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Activity

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Workorder/string/Activities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Activities", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Activities");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Workorder/{id}/Activities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderActivityRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Activity

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/Activities \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Activities", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Activities");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/Activities

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderActivityRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderActivityRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderActivityRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderActivityRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Activity relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Workorder/string/Activities/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/string/Activities/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/Activities/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Workorder/{id}/Activities/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Filter ResponsibleUserGroups based on fields and their type

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/ResponsibleUserGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"take":1,"skip":0,"sort":[{"field":"string","dir":"string"}],"filter":{"field":"string","operator":"string","value":{},"logic":"string","filters":[{}]}}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/ResponsibleUserGroups/Filter", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/ResponsibleUserGroups/Filter");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"take\":1,\"skip\":0,\"sort\":[{\"field\":\"string\",\"dir\":\"string\"}],\"filter\":{\"field\":\"string\",\"operator\":\"string\",\"value\":{},\"logic\":\"string\",\"filters\":[{}]}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/ResponsibleUserGroups/Filter

Body parameter

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}
take: 1
skip: 0
sort:
- field: string
dir: string
filter:
field: string
operator: string
value: {}
logic: string
filters:
- {}
<?xml version="1.0" encoding="UTF-8" ?>
<DataSourceRequest>
<take>1</take>
<skip>0</skip>
<sort>
<field>string</field>
<dir>string</dir>
</sort>
<filter>
<field>string</field>
<operator>string</operator>
<value/>
<logic>string</logic>
<filters/>
</filter>
</DataSourceRequest>

Parameters

Name In Type Required Description
id path string true none
body body DataSourceRequest true none

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>

Responses

Status Meaning Description Schema
200 OK OK Inline

Response Schema

Code samples

curl --request GET \
--url https://testing.sweetsystems.se/api/Workorder/ResponsibleUserGroups/Filter \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/ResponsibleUserGroups/Filter", {
"method": "GET",
"headers": {
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/ResponsibleUserGroups/Filter");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

GET /Workorder/ResponsibleUserGroups/Filter

Example responses

200 Response

{}
<?xml version="1.0" encoding="UTF-8" ?>
Status Meaning Description Schema
200 OK OK Inline

Updates the relation to Group

Code samples

curl --request PUT \
--url https://testing.sweetsystems.se/api/Workorder/string/ResponsibleUserGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/ResponsibleUserGroups", {
"method": "PUT",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/ResponsibleUserGroups");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

PUT /Workorder/{id}/ResponsibleUserGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderUsergroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderUsergroupRelation true none

Example responses

200 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderUsergroupRelation>

Responses

Status Meaning Description Schema
200 OK Entity Updated WorkorderUsergroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
412 Precondition Failed Etag missmatch None
500 Internal Server Error InternalServerError None

Create new relation to Group

Code samples

curl --request POST \
--url https://testing.sweetsystems.se/api/Workorder/string/ResponsibleUserGroups \
--header 'Accept: application/json' \
--header 'Authorization: Basic APIKEY123' \
--header 'Content-Type: application/json' \
--data '{"Id":"00000000-0000-0000-0000-000000000000","RoleCodeKey":"string","RelatedEntityId":"00000000-0000-0000-0000-000000000000"}'
fetch("https://testing.sweetsystems.se/api/Workorder/string/ResponsibleUserGroups", {
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic APIKEY123"
},
"body": "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}"
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/ResponsibleUserGroups");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Basic APIKEY123");
request.AddParameter("application/json", "{\"Id\":\"00000000-0000-0000-0000-000000000000\",\"RoleCodeKey\":\"string\",\"RelatedEntityId\":\"00000000-0000-0000-0000-000000000000\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

POST /Workorder/{id}/ResponsibleUserGroups

Body parameter

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
Id: 00000000-0000-0000-0000-000000000000
RoleCodeKey: string
RelatedEntityId: 00000000-0000-0000-0000-000000000000
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderUsergroupRelation>

Parameters

Name In Type Required Description
id path string true none
body body WorkorderUsergroupRelation true none

Example responses

201 Response

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0" encoding="UTF-8" ?>
<WorkorderUsergroupRelation>
<Id>00000000-0000-0000-0000-000000000000</Id>
<RoleCodeKey>string</RoleCodeKey>
<RelatedEntityId>00000000-0000-0000-0000-000000000000</RelatedEntityId>
</WorkorderUsergroupRelation>

Responses

Status Meaning Description Schema
200 OK Not used None
201 Created Entity Created WorkorderUsergroupRelation
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
409 Conflict Entity with same Id already exist None
500 Internal Server Error InternalServerError None

Delete Group relation by it’s Id

Code samples

curl --request DELETE \
--url https://testing.sweetsystems.se/api/Workorder/string/ResponsibleUserGroups/string \
--header 'Authorization: Basic APIKEY123'
fetch("https://testing.sweetsystems.se/api/Workorder/string/ResponsibleUserGroups/string", {
"method": "DELETE",
"headers": {
"Authorization": "Basic APIKEY123"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});
var client = new RestClient("https://testing.sweetsystems.se/api/Workorder/string/ResponsibleUserGroups/string");
var request = new RestRequest(Method.DELETE);
request.AddHeader("Authorization", "Basic APIKEY123");
IRestResponse response = client.Execute(request);

DELETE /Workorder/{id}/ResponsibleUserGroups/{idOfRelation}

Parameters

Name In Type Required Description
idOfRelation path string true none
id path string true none

Responses

Status Meaning Description Schema
200 OK Not used None
204 No Content Success None
400 Bad Request BadRequest None
401 Unauthorized Unauthorized None
404 Not Found NotFound None
500 Internal Server Error InternalServerError None

Schemas

DataSourceRequest

{
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}

Properties

Name Type Required Restrictions Description
take integer(int32) true none none
skip integer(int32) false none none
sort [Sort] false none none
filter Filter false none none

Sort

{
"field": "string",
"dir": "string"
}

Properties

Name Type Required Restrictions Description
field string false none none
dir string false none none

Filter

{
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": []
}
]
}

Properties

Name Type Required Restrictions Description
field string false none none
operator string false none none
value object false none none
logic string false none none
filters [Filter] false none none

AppointmentActivity

{
"IsNew": true,
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Duration": "string",
"WorkedTime": 0.1,
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Response": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryContactPhoneNumber": "string",
"PrimaryContact": "string",
"TimeSpan": "string",
"IsDone": true,
"Location": "string",
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"IsPositive": true,
"TagCount": 0,
"IsSyncedToExchange": true,
"SendUpdates": true,
"IsExchangeActivity": true,
"ExchangeId": "string",
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ExchangeMailbox": "string",
"AllDayEvent": true,
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"CreatedBy": "string",
"UpdatedBy": "string",
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
IsNew boolean false read-only none
Subject string false none none
Start string(date-time) false none none
End string(date-time) false none none
Duration string false read-only none
WorkedTime number(double) false none none
Status Code false none none
Category Code false none none
Priority Code false none none
SubCategory Code false none none
Response Code false none none
PrimaryContactPhoneNumber string false read-only none
PrimaryContact string false read-only none
TimeSpan string false read-only none
IsDone boolean false none none
Location string false none none
HasDocument boolean false read-only none
Longitude number(double) false none none
Latitude number(double) false none none
Responsible [string] false none none
IsPositive boolean false read-only none
TagCount integer(int32) false read-only none
IsSyncedToExchange boolean false read-only none
SendUpdates boolean false read-only none
IsExchangeActivity boolean false none none
ExchangeId string false none none
ExchangeSyncDate string(date-time) false none none
ExchangeMailbox string false none none
AllDayEvent boolean false none none
PrivatePerson [string] false none none
CorporatePerson [string] false none none
Company [string] false none none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Description string false none none
Id string(uuid) false none none

Code

{
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
}

Properties

Name Type Required Restrictions Description
Key string false none none
CodeGroupKey string false none none
Caption string false read-only none
Active boolean false read-only none

ActivityCaseRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

ActivityUserRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

ActivityCompanyRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

ActivityCompanyGroupRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

ActivityBusinessProjectRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

ActivityPrivatePersonRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

ActivityMarketingActivityRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

ActivityMarketingProjectRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

WorkorderActivityRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

ActivityUsergroupRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

ArticleActivityRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

Article

{
"Name": "string",
"Number": "string",
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Active": true,
"Key": "string",
"IsNew": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Subtype": "string",
"CategoryId": "00000000-0000-0000-0000-000000000000",
"Category": [
"00000000-0000-0000-0000-000000000000"
],
"Price": 0.1,
"BillingFrequency": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Unit": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ProductGroup": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Currency": {
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
},
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Name string false none none
Number string false none none
Type Code false none none
Active boolean false none none
Key string false none none
IsNew boolean false read-only none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Subtype string false none none
CategoryId string(uuid) false none none
Category [string] false read-only none
Price number(double) false none none
BillingFrequency Code false none none
Unit Code false none none
ProductGroup Code false none none
Currency Currency false none none
Description string false none none
Id string(uuid) false none none

Currency

{
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Name string true none none
IsSystem boolean false none none
Rate number(double) false none none
Id string(uuid) false none none

ArticleProjectRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

ArticleCompanyRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

CodeGroup

{
"CodeGroupKey": "string",
"Caption": "string"
}

Properties

Name Type Required Restrictions Description
CodeGroupKey string false none none
Caption string false none none

Company

{
"Name": "string",
"EmployeeCount": 0,
"CustomerNumber": "string",
"OrganisationalNumber": "string",
"CorporateGroup": "string",
"Unit": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Branch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"OwnBranch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ServiceGrade": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"UnitType": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Active": true,
"Segment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Region": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"EmployeeCountRange": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow1": "string",
"PrimaryAddressRow2": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"IsNew": true,
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"HasDocument": true,
"TagCount": 0,
"Longitude": 0.1,
"Latitude": 0.1,
"LoginStatus": "noLogin",
"UnitNo": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Name string true none none
EmployeeCount integer(int32) false none none
CustomerNumber string false none none
OrganisationalNumber string false none none
CorporateGroup string false none none
Unit Code false none none
Branch Code false none none
OwnBranch Code false none none
ServiceGrade Code false none none
UnitType Code false none none
Active boolean false none none
Segment Code false none none
SubSegment Code false none none
Rating Code false none none
Status Code false none none
Region Code false none none
Type Code false none none
Category Code false none none
EmployeeCountRange Code false none none
PrimaryEmailAddress string false none none
PrimaryPhoneNumber string false none none
WebSite string false none none
PrimaryAddress string false read-only none
PrimaryAddressRow1 string false read-only none
PrimaryAddressRow2 string false read-only none
PrimaryAddressRow string false none none
PrimaryCity string false none none
PrimaryZipCode string false none none
PrimaryCounty string false none none
IsNew boolean false read-only none
PrimaryCountryId [integer] false none none
PrimaryCommunicationCategory string false none none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Responsible string false read-only none
HasDocument boolean false read-only none
TagCount integer(int32) false read-only none
Longitude number(double) false none none
Latitude number(double) false none none
LoginStatus string false read-only none
UnitNo string false none none
Id string(uuid) false none none

Enumerated Values

Property Value
PrimaryCommunicationCategory unknown
PrimaryCommunicationCategory mail
PrimaryCommunicationCategory email
PrimaryCommunicationCategory phone
PrimaryCommunicationCategory sms
LoginStatus noLogin
LoginStatus loginInActive
LoginStatus loginActive

CompanyPrivatePersonRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

CompanyCorporatePersonRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

CompanyCompanyGroupRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

CompanyMarketingProjectRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

CompanyCaseRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

CompanyProductRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

BusinessProjectCompanyRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

CompanyGroup

{
"IsNew": true,
"Name": "string",
"OrganisationalNumber": "string",
"Active": true,
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Segment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Region": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Branch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"OwnBranch": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow1": "string",
"PrimaryAddressRow2": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"HasDocument": true,
"MainContactId": "00000000-0000-0000-0000-000000000000",
"MainContact": "string",
"MainContactPrimaryMobilePhone": "string",
"MainContactPrimaryPhone": "string",
"MainContactPrimaryEmail": "string",
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"Longitude": 0.1,
"Latitude": 0.1,
"TagCount": 0,
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
IsNew boolean false read-only none
Name string false none none
OrganisationalNumber string false none none
Active boolean false none none
Type Code false none none
Segment Code false none none
SubSegment Code false none none
Rating Code false none none
Status Code false none none
Region Code false none none
Category Code false none none
Branch Code false none none
OwnBranch Code false none none
PrimaryEmailAddress string false none none
PrimaryPhoneNumber string false none none
WebSite string false none none
PrimaryAddress string false none none
PrimaryAddressRow1 string false read-only none
PrimaryAddressRow2 string false read-only none
PrimaryAddressRow string false none none
PrimaryCity string false none none
PrimaryZipCode string false none none
PrimaryCounty string false none none
PrimaryCountryId [integer] false none none
PrimaryCommunicationCategory string false none none
HasDocument boolean false read-only none
MainContactId string(uuid) false read-only none
MainContact string false read-only none
MainContactPrimaryMobilePhone string false read-only none
MainContactPrimaryPhone string false read-only none
MainContactPrimaryEmail string false read-only none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Responsible string false read-only none
Longitude number(double) false none none
Latitude number(double) false none none
TagCount integer(int32) false read-only none
Id string(uuid) false none none

Enumerated Values

Property Value
PrimaryCommunicationCategory unknown
PrimaryCommunicationCategory mail
PrimaryCommunicationCategory email
PrimaryCommunicationCategory phone
PrimaryCommunicationCategory sms

CompanyGroupPrivatePersonRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

CompanyGroupCorporatePersonRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

CorporatePerson

{
"Name": "string",
"FirstName": "string",
"LastName": "string",
"MiddleName": "string",
"Gender": "unknown",
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Language": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Title": "string",
"Salutation": "string",
"DateOfBirth": "2019-08-24T14:15:22Z",
"EstablishedContact": true,
"Unit": "string",
"Position": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryMobilePhoneNumber": "string",
"PrimaryPhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"CompanyPrimaryAddressRow": "string",
"CompanyPrimaryCity": "string",
"CompanyPrimaryZipCode": "string",
"CompanyPrimaryCounty": "string",
"CompanyPrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Pul": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PulDate": "2019-08-24T14:15:22Z",
"Role": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Active": true,
"ThumbViewImageFileId": "00000000-0000-0000-0000-000000000000",
"HasThumbViewImage": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"MainCompanyId": "00000000-0000-0000-0000-000000000000",
"MainCompany": "string",
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"IsNew": true,
"LoginStatus": "noLogin",
"TagCount": 0,
"PrimaryRelationId": "00000000-0000-0000-0000-000000000000",
"PrimaryRelation": "string",
"HasPhoneNumber": true,
"GDPRConsentIsRequired": true,
"GDPRConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ConsentComment": "string",
"MarketingConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingSource": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingOptIn": [
"00000000-0000-0000-0000-000000000000"
],
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Name string false read-only none
FirstName string true none none
LastName string true none none
MiddleName string false none none
Gender string false none none
Category Code false none none
Language Code false none none
Title string false none none
Salutation string false none none
DateOfBirth string(date-time) false none none
EstablishedContact boolean false none none
Unit string false none none
Position Code false none none
PrimaryEmailAddress string false none none
PrimaryMobilePhoneNumber string false none none
PrimaryPhoneNumber string false none none
WebSite string false none none
PrimaryAddress string false read-only none
PrimaryAddressRow string false none none
PrimaryCity string false none none
PrimaryZipCode string false none none
PrimaryCounty string false none none
PrimaryCountryId [integer] false none none
CompanyPrimaryAddressRow string false read-only none
CompanyPrimaryCity string false read-only none
CompanyPrimaryZipCode string false read-only none
CompanyPrimaryCounty string false read-only none
CompanyPrimaryCountryId [integer] false read-only none
PrimaryCommunicationCategory string false none none
Pul Code false none none
PulDate string(date-time) false none none
Role Code false none none
Active boolean false none none
ThumbViewImageFileId string(uuid) false none none
HasThumbViewImage boolean false read-only none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Responsible string false read-only none
MainCompanyId string(uuid) false read-only none
MainCompany string false read-only none
HasDocument boolean false read-only none
Longitude number(double) false none none
Latitude number(double) false none none
IsNew boolean false read-only none
LoginStatus string false read-only none
TagCount integer(int32) false read-only none
PrimaryRelationId string(uuid) false read-only none
PrimaryRelation string false read-only none
HasPhoneNumber boolean false read-only none
GDPRConsentIsRequired boolean false read-only none
GDPRConsent Code true none none
ConsentComment string false none none
MarketingConsent Code false none none
MarketingSource Code false none none
MarketingOptIn [string] false read-only none
Id string(uuid) false none none

Enumerated Values

Property Value
Gender unknown
Gender male
Gender female
Gender other
PrimaryCommunicationCategory unknown
PrimaryCommunicationCategory mail
PrimaryCommunicationCategory email
PrimaryCommunicationCategory phone
PrimaryCommunicationCategory sms
LoginStatus noLogin
LoginStatus loginInActive
LoginStatus loginActive

Deal

{
"IsNew": true,
"Description": "string",
"Number": 0,
"EstimatedEndDate": "2019-08-24T14:15:22Z",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Lost": true,
"HasDocument": true,
"LostReason": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Probability": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Source": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Price": 0.1,
"Quantity": 0.1,
"QuantityUnit": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"DecisionStatus": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Reason": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ReasonDescription": "string",
"OfferDate": "2019-08-24T14:15:22Z",
"DelivieryDateFrom": "2019-08-24T14:15:22Z",
"DelivieryDateTo": "2019-08-24T14:15:22Z",
"SystemCurrency": "string",
"TotalValue": 0.1,
"Currency": {
"Name": "string",
"IsSystem": true,
"Rate": 0.1,
"Id": "00000000-0000-0000-0000-000000000000"
},
"CurrencyString": "string",
"Turnover": "manual",
"ForecastValue": 0.1,
"Rate": 0.1,
"TotalValueSystemCurrency": 0.1,
"ForecastValueSystemCurrency": 0.1,
"ResponsibleLong": "string",
"CreatedBy": "string",
"UpdatedBy": "string",
"Active": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"HasProject": true,
"TagCount": 0,
"FirstNote": "string",
"IsDue": true,
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
IsNew boolean false read-only none
Description string true none none
Number integer(int32) false none none
EstimatedEndDate string(date-time) false none none
StartDate string(date-time) false none none
EndDate string(date-time) false none none
Lost boolean false none none
HasDocument boolean false read-only none
LostReason Code false none none
Status Code false none none
Probability Code false none none
Type Code false none none
Priority Code false none none
Source Code false none none
Price number(double) false none none
Quantity number(double) false none none
QuantityUnit Code false none none
DecisionStatus Code true none none
Reason Code false none none
ReasonDescription string false none none
OfferDate string(date-time) false none none
DelivieryDateFrom string(date-time) false none none
DelivieryDateTo string(date-time) false none none
SystemCurrency string false read-only none
TotalValue number(double) false none none
Currency Currency true none none
CurrencyString string false read-only none
Turnover string true none none
ForecastValue number(double) false read-only none
Rate number(double) false read-only none
TotalValueSystemCurrency number(double) false read-only none
ForecastValueSystemCurrency number(double) false read-only none
ResponsibleLong string false read-only none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Active boolean false none none
Longitude number(double) false none none
Latitude number(double) false none none
Responsible [string] false none none
HasProject boolean false read-only none
TagCount integer(int32) false read-only none
FirstNote string false none none
IsDue boolean false read-only none
Id string(uuid) false none none

Enumerated Values

Property Value
Turnover manual
Turnover calculated

DistributionMarketingActivity

{
"Name": "string",
"Description": "string",
"WebSite": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingProject": "string",
"MarketingPlan": "string",
"MarketingPlanAndProject": "string",
"TimeSpan": "string",
"IsExternal": true,
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"MarketingPlanId": "00000000-0000-0000-0000-000000000000",
"IsNew": true,
"TagCount": 0,
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"ProcessItemCount": 0,
"ActiveProcessItemCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Active": true,
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Name string true none none
Description string false none none
WebSite string false none none
StartDate string(date-time) false none none
EndDate string(date-time) false none none
Status Code false none none
Priority Code false none none
MarketingProject string false read-only none
MarketingPlan string false read-only none
MarketingPlanAndProject string false read-only none
TimeSpan string false read-only none
IsExternal boolean false none none
MarketingProjectId string(uuid) false read-only none
MarketingPlanId string(uuid) false read-only none
IsNew boolean false read-only none
TagCount integer(int32) false read-only none
TargetParticipantQuantity integer(int32) false none none
TargetResponseRatePercent integer(int32) false none none
ProcessItemCount integer(int32) false read-only none
ActiveProcessItemCount integer(int32) false read-only none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Active boolean false read-only none
Id string(uuid) false none none

Document

{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CreatedDate": "2019-08-24T14:15:22Z",
"UpdatedDate": "2019-08-24T14:15:22Z",
"IsExt": true,
"CreatedBy": "00000000-0000-0000-0000-000000000000",
"UpdatedBy": "00000000-0000-0000-0000-000000000000",
"Uri": "string"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) false none none
Name string false none none
CreatedDate string(date-time) false none none
UpdatedDate string(date-time) false none none
IsExt boolean false none none
CreatedBy string(uuid) false none none
UpdatedBy string(uuid) false none none
Uri string false none none

EmailActivity

{
"IsNew": true,
"FromString": "string",
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MessageId": "00000000-0000-0000-0000-000000000000",
"IsEditable": true,
"IsDone": true,
"Body": "string",
"From": [
"string"
],
"ToRecipients": [
"string"
],
"CcRecipients": [
"string"
],
"BccRecipients": [
"string"
],
"IsBodyHtml": true,
"SentDate": "2019-08-24T14:15:22Z",
"IncomingDate": "2019-08-24T14:15:22Z",
"IsIncomingEmail": true,
"ReadDate": "2019-08-24T14:15:22Z",
"IsExchangeActivity": true,
"ExchangeId": "string",
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"CreatedBy": "string",
"UpdatedBy": "string",
"IsCurrentUserResponsible": true,
"IsDraft": true,
"IsFromCase": true,
"IsReply": true,
"CaseId": "00000000-0000-0000-0000-000000000000",
"ReplyText": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
IsNew boolean false read-only none
FromString string false read-only none
Subject string false none none
Start string(date-time) false none none
End string(date-time) false none none
Status Code false none none
MessageId string(uuid) false read-only none
IsEditable boolean false read-only none
IsDone boolean false none none
Body string false none none
From [string] false none none
ToRecipients [string] false none none
CcRecipients [string] false none none
BccRecipients [string] false none none
IsBodyHtml boolean false none none
SentDate string(date-time) false none none
IncomingDate string(date-time) false read-only none
IsIncomingEmail boolean false read-only none
ReadDate string(date-time) false read-only none
IsExchangeActivity boolean false none none
ExchangeId string false none none
ExchangeSyncDate string(date-time) false none none
CreatedBy string false read-only none
UpdatedBy string false read-only none
IsCurrentUserResponsible boolean false read-only none
IsDraft boolean false read-only none
IsFromCase boolean false read-only none
IsReply boolean false read-only none
CaseId string(uuid) false read-only none
ReplyText string false none none
Id string(uuid) false none none

PostAnswersetArgument

{
"id": "00000000-0000-0000-0000-000000000000",
"questionKeyAnswers": [
{
"key": "string",
"answer": [
"string"
]
}
]
}

Properties

Name Type Required Restrictions Description
id string(uuid) true none none
questionKeyAnswers [QuestionKeyAnswer] true none none

QuestionKeyAnswer

{
"key": "string",
"answer": [
"string"
]
}

Properties

Name Type Required Restrictions Description
key string false none none
answer [string] false none none

AnswerSet

{
"Answers": {
"property1": {
"property1": {
"Answers": [
"string"
],
"RowId": "00000000-0000-0000-0000-000000000000"
},
"property2": {
"Answers": [
"string"
],
"RowId": "00000000-0000-0000-0000-000000000000"
}
},
"property2": {
"property1": {
"Answers": [
"string"
],
"RowId": "00000000-0000-0000-0000-000000000000"
},
"property2": {
"Answers": [
"string"
],
"RowId": "00000000-0000-0000-0000-000000000000"
}
}
},
"Documents": {
"property1": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"Index": 0,
"DocumentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomRowId": "00000000-0000-0000-0000-000000000000",
"Path": "string",
"ContentType": "string",
"IsImage": true,
"Extension": "string",
"Length": 0
}
],
"property2": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"Index": 0,
"DocumentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomRowId": "00000000-0000-0000-0000-000000000000",
"Path": "string",
"ContentType": "string",
"IsImage": true,
"Extension": "string",
"Length": 0
}
]
},
"LockedQuestions": {
"property1": {
"LockedBy": "string",
"LockedDate": "2019-08-24T14:15:22Z",
"LockedDateInt": 0.1
},
"property2": {
"LockedBy": "string",
"LockedDate": "2019-08-24T14:15:22Z",
"LockedDateInt": 0.1
}
},
"Id": "00000000-0000-0000-0000-000000000000",
"SurveyId": "00000000-0000-0000-0000-000000000000",
"SurveyVersionId": "00000000-0000-0000-0000-000000000000",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"LockedDate": "2019-08-24T14:15:22Z",
"Version": 0,
"LCID": 0,
"IsNew": true,
"DocumentId": "00000000-0000-0000-0000-000000000000",
"AnsweredQuestionsOnPages": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"StartDateInt": 0.1,
"StartDateString": "string",
"EndDateInt": 0.1,
"EndDateString": "string",
"FormPackageInstanceId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Answers object false none none
» additionalProperties object false none none
»» additionalProperties AnswerSetSelectedAnswer false none none
Documents object false none none
» additionalProperties [DocumentInfo] false none none
LockedQuestions object false none none
» additionalProperties AnswerSetLockedAnswer false none none
Id string(uuid) false none none
SurveyId string(uuid) false none none
SurveyVersionId string(uuid) false none none
StartDate string(date-time) false none none
EndDate string(date-time) false none none
LockedDate string(date-time) false none none
Version integer(int32) false none none
LCID integer(int32) false none none
IsNew boolean false none none
DocumentId string(uuid) false none none
AnsweredQuestionsOnPages object false none none
» additionalProperties [string] false none none
StartDateInt number(double) false read-only none
StartDateString string false read-only none
EndDateInt number(double) false read-only none
EndDateString string false read-only none
FormPackageInstanceId string(uuid) false read-only none

AnswerSetSelectedAnswer

{
"Answers": [
"string"
],
"RowId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Answers [string] false none none
RowId string(uuid) false none none

DocumentInfo

{
"Id": "00000000-0000-0000-0000-000000000000",
"Index": 0,
"DocumentId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomRowId": "00000000-0000-0000-0000-000000000000",
"Path": "string",
"ContentType": "string",
"IsImage": true,
"Extension": "string",
"Length": 0
}

Properties

Name Type Required Restrictions Description
Id string(uuid) false none none
Index integer(int32) false none none
DocumentId string(uuid) false none none
Name string false none none
CustomRowId string(uuid) false none none
Path string false none none
ContentType string false none none
IsImage boolean false read-only none
Extension string false read-only none
Length integer(int64) false none none

AnswerSetLockedAnswer

{
"LockedBy": "string",
"LockedDate": "2019-08-24T14:15:22Z",
"LockedDateInt": 0.1
}

Properties

Name Type Required Restrictions Description
LockedBy string false none none
LockedDate string(date-time) false none none
LockedDateInt number(double) false read-only none

AnswerSetDigitalSignature

{
"AnswerSetId": "00000000-0000-0000-0000-000000000000",
"SignedDocumentId": "00000000-0000-0000-0000-000000000000",
"DigitalSignatureId": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Status": "string",
"Success": true,
"StatusDetail": "string",
"RedirectUrl": "string"
}

Properties

Name Type Required Restrictions Description
AnswerSetId string(uuid) false none none
SignedDocumentId string(uuid) false none none
DigitalSignatureId string false none none
StartDate string(date-time) false none none
EndDate string(date-time) false none none
Status string false none none
Success boolean false none none
StatusDetail string false none none
RedirectUrl string false none none

CompletedAnswerSet

{
"AnswerSetId": "00000000-0000-0000-0000-000000000000",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"LockedDate": "2019-08-24T14:15:22Z",
"LCID": 0,
"SurveyId": "00000000-0000-0000-0000-000000000000",
"SurveyVersionId": "00000000-0000-0000-0000-000000000000",
"SurveyKey": "string",
"Version": 0,
"RequireDigitalSignature": true,
"DocumentId": "00000000-0000-0000-0000-000000000000",
"DocumentName": "string",
"SignedDocumentId": "00000000-0000-0000-0000-000000000000",
"SignedDocumentName": "string",
"DigitalSignatureId": "string",
"SignedLanguage": "string",
"SignedStatus": "string",
"SignedTags": {
"property1": "string",
"property2": "string"
},
"SignStartDate": "2019-08-24T14:15:22Z",
"SignEndDate": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
AnswerSetId string(uuid) false none none
StartDate string(date-time) false none none
EndDate string(date-time) false none none
LockedDate string(date-time) false none none
LCID integer(int32) false none none
SurveyId string(uuid) false none none
SurveyVersionId string(uuid) false none none
SurveyKey string false none none
Version integer(int32) false none none
RequireDigitalSignature boolean false none none
DocumentId string(uuid) false none none
DocumentName string false none none
SignedDocumentId string(uuid) false none none
SignedDocumentName string false none none
DigitalSignatureId string false none none
SignedLanguage string false none none
SignedStatus string false none none
SignedTags object false none none
» additionalProperties string false none none
SignStartDate string(date-time) false none none
SignEndDate string(date-time) false none none

AnswersetSummary

{
"id": "00000000-0000-0000-0000-000000000000",
"started": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"form_version": 0
}

Properties

Name Type Required Restrictions Description
id string(uuid) false none none
started string(date-time) false none none
endDate string(date-time) false none none
form_version integer(int32) false none none

Form

{
"id": "string",
"questions": [
{
"key": "string",
"parentKey": "string",
"type": "string",
"text": "string"
}
]
}

Properties

Name Type Required Restrictions Description
id string false none none
questions [Query] false none none

Query

{
"key": "string",
"parentKey": "string",
"type": "string",
"text": "string"
}

Properties

Name Type Required Restrictions Description
key string false none none
parentKey string false none none
type string false none none
text string false none none

FormIdKey

{
"id": "00000000-0000-0000-0000-000000000000",
"key": "string",
"name": [
{
"lcid": 0,
"caption": "string"
}
]
}

Properties

Name Type Required Restrictions Description
id string(uuid) false none none
key string false none none
name [FormText] false none none

FormText

{
"lcid": 0,
"caption": "string"
}

Properties

Name Type Required Restrictions Description
lcid integer(int32) false none none
caption string false none none

Hook

{
"event": "string",
"target_url": "string"
}

Properties

Name Type Required Restrictions Description
event string true none none
target_url string true none none

InboxAccount

{
"Id": "00000000-0000-0000-0000-000000000000",
"Name": "string"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) false none none
Name string false none none

Issue

{
"IssueId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CaseNumber": "string",
"Priority": "low",
"OrderNumber": "string",
"Source": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Deadline": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"RegistrationDate": "2019-08-24T14:15:22Z",
"PlannedEndDate": "2019-08-24T14:15:22Z",
"InvestigationDate": "2019-08-24T14:15:22Z",
"ActualEndDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"HasDocument": true,
"Description": "string",
"IsFavorite": true,
"IsFollowing": true,
"MayUnfollow": true,
"IsNew": true,
"HasNoteAttachment": true,
"HasExternalNoteAttachment": true,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"NameLong": "string",
"ResponsibleLong": "string",
"CreatedBy": "string",
"CreatedByUser": "string",
"UpdatedBy": "string",
"StatusLong": "string",
"IsDue": true,
"Company": "string",
"CompanyId": "00000000-0000-0000-0000-000000000000",
"PrivatePerson": "string",
"PrivatePersonId": "00000000-0000-0000-0000-000000000000",
"CorporatePersonId": "00000000-0000-0000-0000-000000000000",
"CorporatePerson": "string",
"CompanyCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePersonsCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePersonsCustomers": [
"00000000-0000-0000-0000-000000000000"
],
"Longitude": 0.1,
"Latitude": 0.1,
"TagCount": 0,
"AccountId": "00000000-0000-0000-0000-000000000000",
"Followers": [
"string"
],
"DescriptionRawText": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
IssueId string(uuid) false read-only none
Name string false none none
CaseNumber string false read-only none
Priority string true none none
OrderNumber string false none none
Source Code false none none
Deadline Code false none none
Type Code true none none
Category Code false none none
RegistrationDate string(date-time) true none none
PlannedEndDate string(date-time) false none none
InvestigationDate string(date-time) false none none
ActualEndDate string(date-time) false none none
Status Code true none none
HasDocument boolean false read-only none
Description string false none none
IsFavorite boolean false read-only none
IsFollowing boolean false read-only none
MayUnfollow boolean false read-only none
IsNew boolean false read-only none
HasNoteAttachment boolean false read-only none
HasExternalNoteAttachment boolean false read-only none
Responsible [string] false none none
NameLong string false read-only none
ResponsibleLong string false read-only none
CreatedBy string false read-only none
CreatedByUser string false read-only none
UpdatedBy string false read-only none
StatusLong string false read-only none
IsDue boolean false read-only none
Company string false read-only none
CompanyId string(uuid) false read-only none
PrivatePerson string false read-only none
PrivatePersonId string(uuid) false read-only none
CorporatePersonId string(uuid) false read-only none
CorporatePerson string false read-only none
CompanyCustomers [string] false none none
CorporatePersonsCustomers [string] false none none
PrivatePersonsCustomers [string] false none none
Longitude number(double) false none none
Latitude number(double) false none none
TagCount integer(int32) false read-only none
AccountId string(uuid) false none none
Followers [string] false none none
DescriptionRawText string false read-only none
Id string(uuid) false none none

Enumerated Values

Property Value
Priority low
Priority medium
Priority high

UserCaseRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

MarketingProjectCaseRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

CompanyPersonRelationCaseRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

PrivatePersonCaseRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

BusinessProjectCaseRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

MarketingActivity

{
"Name": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"HasDocument": true,
"IsNew": true,
"IsExternal": true,
"MarketingProject": "string",
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Name string true none none
Description string false none none
StartDate string(date-time) true none none
EndDate string(date-time) false none none
HasDocument boolean false read-only none
IsNew boolean false read-only none
IsExternal boolean false none none
MarketingProject string false read-only none
MarketingProjectId string(uuid) true none none
Id string(uuid) false none none

MarketingPlan

{
"Name": "string",
"Number": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Active": true,
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"TimeSpan": "string",
"HasDocument": true,
"IsNew": true,
"IsExternal": true,
"TagCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Name string true none none
Number string false none none
Description string false none none
StartDate string(date-time) false none none
EndDate string(date-time) false none none
Active boolean false none none
Status Code true none none
Priority Code false none none
TimeSpan string false read-only none
HasDocument boolean false read-only none
IsNew boolean false read-only none
IsExternal boolean false none none
TagCount integer(int32) false read-only none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Id string(uuid) false none none

MarketingProject

{
"Name": "string",
"Number": "string",
"Description": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Active": true,
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"TimeSpan": "string",
"MarketingPlan": "string",
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"NumberOfProcessListItems": 0,
"NumberOfActiveProcessListItems": 0,
"MarketingPlanId": [
"00000000-0000-0000-0000-000000000000"
],
"HasDocument": true,
"ThumbViewImageFileId": "00000000-0000-0000-0000-000000000000",
"HasThumbViewImage": true,
"IsExternal": true,
"IsNew": true,
"TagCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Name string true none none
Number string false none none
Description string false none none
StartDate string(date-time) false none none
EndDate string(date-time) false none none
Active boolean false none none
Status Code true none none
Priority Code false none none
TimeSpan string false read-only none
MarketingPlan string false read-only none
TargetParticipantQuantity integer(int32) false none none
TargetResponseRatePercent integer(int32) false none none
NumberOfProcessListItems integer(int32) false read-only none
NumberOfActiveProcessListItems integer(int32) false read-only none
MarketingPlanId [string] false none none
HasDocument boolean false read-only none
ThumbViewImageFileId string(uuid) false none none
HasThumbViewImage boolean false read-only none
IsExternal boolean false none none
IsNew boolean false read-only none
TagCount integer(int32) false read-only none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Id string(uuid) false none none

ObjectivePlan

{
"AreaNote": "string",
"IndividualObjectivesNote": "string",
"MarketNote": "string",
"PortfolioNote": "string",
"PrioritizedObjectivesNote": "string",
"ResponsibilityNote": "string",
"FollowUpDate": "2019-08-24T14:15:22Z",
"UserExtension": "00000000-0000-0000-0000-000000000000",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
AreaNote string false none none
IndividualObjectivesNote string false none none
MarketNote string false none none
PortfolioNote string false none none
PrioritizedObjectivesNote string false none none
ResponsibilityNote string false none none
FollowUpDate string(date-time) false none none
UserExtension string(uuid) true none none
Id string(uuid) false none none

PhoneActivity

{
"IsNew": true,
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Response": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryContactPhoneNumber": "string",
"PrimaryContact": "string",
"IsDone": true,
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"IsPositive": true,
"TagCount": 0,
"AllDayEvent": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Description": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
IsNew boolean false read-only none
Subject string false none none
Start string(date-time) false none none
End string(date-time) false none none
Status Code false none none
Category Code false none none
Priority Code false none none
SubCategory Code false none none
Response Code false none none
PrimaryContactPhoneNumber string false read-only none
PrimaryContact string false read-only none
IsDone boolean false none none
HasDocument boolean false read-only none
Longitude number(double) false none none
Latitude number(double) false none none
Responsible [string] false none none
PrivatePerson [string] false none none
CorporatePerson [string] false none none
Company [string] false none none
IsPositive boolean false read-only none
TagCount integer(int32) false read-only none
AllDayEvent boolean false none none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Description string false none none
Id string(uuid) false none none

Pricebook

{
"Name": "string",
"Active": true,
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"UseAsTemplate": true,
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Description": "string",
"CreatedBy": "string",
"UpdatedBy": "string",
"IsNew": true,
"CreatedDate": "2019-08-24T14:15:22Z",
"UpdatedDate": "2019-08-24T14:15:22Z",
"CreatedByUser": "string",
"UpdatedByUser": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Name string false none none
Active boolean false none none
StartDate string(date-time) false none none
EndDate string(date-time) false none none
UseAsTemplate boolean false none none
Type Code false none none
Status Code false none none
Description string false none none
CreatedBy string false read-only none
UpdatedBy string false read-only none
IsNew boolean false read-only none
CreatedDate string(date-time) false read-only none
UpdatedDate string(date-time) false read-only none
CreatedByUser string false read-only none
UpdatedByUser string false read-only none
Id string(uuid) false none none

PricebookArticleRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

PrivatePerson

{
"Name": "string",
"FirstName": "string",
"LastName": "string",
"CustomerNumber": "string",
"Gender": "unknown",
"SocialSecurityNumber": "string",
"Language": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryEmailAddress": "string",
"PrimaryPhoneNumber": "string",
"PrimaryMobilePhoneNumber": "string",
"WebSite": "string",
"PrimaryAddress": "string",
"PrimaryAddressRow1": "string",
"PrimaryAddressRow2": "string",
"PrimaryAddressRow": "string",
"PrimaryCity": "string",
"PrimaryZipCode": "string",
"PrimaryCounty": "string",
"PrimaryCountryId": [
0
],
"PrimaryCommunicationCategory": "unknown",
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Segment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Pul": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubSegment": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Rating": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PulDate": "2019-08-24T14:15:22Z",
"Active": true,
"IsDeceased": true,
"HasProtectedIdentity": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Responsible": "string",
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"LoginStatus": "noLogin",
"IsNew": true,
"Password": "string",
"PasswordConfirm": "string",
"TagCount": 0,
"HasPhoneNumber": true,
"GDPRConsentIsRequired": true,
"GDPRConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ConsentComment": "string",
"MarketingConsent": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingSource": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingOptIn": [
"00000000-0000-0000-0000-000000000000"
],
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Name string false read-only none
FirstName string false none none
LastName string false none none
CustomerNumber string false none none
Gender string false none none
SocialSecurityNumber string false none none
Language Code false none none
PrimaryEmailAddress string false none none
PrimaryPhoneNumber string false none none
PrimaryMobilePhoneNumber string false none none
WebSite string false none none
PrimaryAddress string false none none
PrimaryAddressRow1 string false read-only none
PrimaryAddressRow2 string false read-only none
PrimaryAddressRow string false none none
PrimaryCity string false none none
PrimaryZipCode string false none none
PrimaryCounty string false none none
PrimaryCountryId [integer] false none none
PrimaryCommunicationCategory string false none none
Type Code false none none
Segment Code false none none
Category Code false none none
Pul Code false none none
SubSegment Code false none none
Status Code false none none
Rating Code false none none
PulDate string(date-time) false none none
Active boolean false none none
IsDeceased boolean false none none
HasProtectedIdentity boolean false none none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Responsible string false read-only none
HasDocument boolean false read-only none
Longitude number(double) false none none
Latitude number(double) false none none
LoginStatus string false read-only none
IsNew boolean false read-only none
Password string false none none
PasswordConfirm string false none none
TagCount integer(int32) false read-only none
HasPhoneNumber boolean false read-only none
GDPRConsentIsRequired boolean false read-only none
GDPRConsent Code true none none
ConsentComment string false none none
MarketingConsent Code false none none
MarketingSource Code false none none
MarketingOptIn [string] false read-only none
Id string(uuid) false none none

Enumerated Values

Property Value
Gender unknown
Gender male
Gender female
Gender other
PrimaryCommunicationCategory unknown
PrimaryCommunicationCategory email
PrimaryCommunicationCategory phone
PrimaryCommunicationCategory sms
LoginStatus noLogin
LoginStatus loginInActive
LoginStatus loginActive

Template

{
"id": "string",
"description": "string"
}

Properties

Name Type Required Restrictions Description
id string false none none
description string false none none

SelectionDataSourceRequest

{
"group": [
{
"aggregates": [
{
"field": "string",
"aggregate": "string"
}
],
"field": "string",
"dir": "string"
}
],
"aggregate": [
{
"field": "string",
"aggregate": "string"
}
],
"select": [
{
"field": "string",
"expression": "string",
"as": "string"
}
],
"take": 1,
"skip": 0,
"sort": [
{
"field": "string",
"dir": "string"
}
],
"filter": {
"field": "string",
"operator": "string",
"value": {},
"logic": "string",
"filters": [
{}
]
}
}

Properties

Name Type Required Restrictions Description
group [Group] false none none
aggregate [Aggregator] false none none
select [SelectColumn] false none none
take integer(int32) true none none
skip integer(int32) false none none
sort [Sort] false none none
filter Filter false none none

Group

{
"aggregates": [
{
"field": "string",
"aggregate": "string"
}
],
"field": "string",
"dir": "string"
}

Properties

Name Type Required Restrictions Description
aggregates [Aggregator] false none none
field string false none none
dir string false none none

Aggregator

{
"field": "string",
"aggregate": "string"
}

Properties

Name Type Required Restrictions Description
field string false none none
aggregate string false none none

SelectColumn

{
"field": "string",
"expression": "string",
"as": "string"
}

Properties

Name Type Required Restrictions Description
field string false none none
expression string false none none
as string false none none

FieldDefinition

{
"field": "string",
"caption": "string",
"fieldType": "string",
"isLookup": true,
"selectable": true,
"filterable": true,
"sortable": true
}

Properties

Name Type Required Restrictions Description
field string false none none
caption string false none none
fieldType string false none none
isLookup boolean false none none
selectable boolean false none none
filterable boolean false none none
sortable boolean false none none

LookupResult

{
"value": {},
"caption": "string"
}

Properties

Name Type Required Restrictions Description
value object false none none
caption string false none none

ServiceAppointmentActivity

{
"IsNew": true,
"Subject": "string",
"Description": "string",
"ServiceAppointmentType": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Service": [
"00000000-0000-0000-0000-000000000000"
],
"Product": [
"00000000-0000-0000-0000-000000000000"
],
"AttestedByUser": "string",
"AttestedDate": "2019-08-24T14:15:22Z",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"ResponsibleUsergroupId": [
"00000000-0000-0000-0000-000000000000"
],
"Workorder": [
"00000000-0000-0000-0000-000000000000"
],
"CreatedBy": "string",
"UpdatedBy": "string",
"PrimaryAddress": "string",
"PrimaryCity": "string",
"PrimaryCounty": "string",
"PrimaryZipCode": "string",
"Country": [
0
],
"Longitude": 0.1,
"Latitude": 0.1,
"ServiceAppointmentNumber": "string",
"ResponsibleUsergroup": "string",
"Duration": "string",
"WorkorderId": "00000000-0000-0000-0000-000000000000",
"WorkorderName": "string",
"WorkorderNumber": "string",
"ExchangeId": "string",
"IsSyncedToExchange": true,
"SendUpdates": true,
"IsExchangeActivity": true,
"ExchangeSyncDate": "2019-08-24T14:15:22Z",
"ExchangeMailbox": "string",
"WorkorderStartDate": "2019-08-24T14:15:22Z",
"WorkorderEndDate": "2019-08-24T14:15:22Z",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
IsNew boolean false read-only none
Subject string false none none
Description string false none none
ServiceAppointmentType Code false none none
Priority Code false none none
Category Code false none none
Service [string] false none none
Product [string] false none none
AttestedByUser string false read-only none
AttestedDate string(date-time) false none none
Start string(date-time) false none none
End string(date-time) false none none
Status Code false none none
ResponsibleUsergroupId [string] false none none
Workorder [string] false none none
CreatedBy string false read-only none
UpdatedBy string false read-only none
PrimaryAddress string false none none
PrimaryCity string false none none
PrimaryCounty string false none none
PrimaryZipCode string false none none
Country [integer] false none none
Longitude number(double) false none none
Latitude number(double) false none none
ServiceAppointmentNumber string false read-only none
ResponsibleUsergroup string false read-only none
Duration string false read-only none
WorkorderId string(uuid) false none none
WorkorderName string false none none
WorkorderNumber string false none none
ExchangeId string false none none
IsSyncedToExchange boolean false read-only none
SendUpdates boolean false read-only none
IsExchangeActivity boolean false none none
ExchangeSyncDate string(date-time) false none none
ExchangeMailbox string false none none
WorkorderStartDate string(date-time) false none none
WorkorderEndDate string(date-time) false none none
Id string(uuid) false none none

TargetGroup

{
"Name": "string",
"Description": "string",
"Public": true,
"Active": true,
"Temporary": true,
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Name string true none none
Description string false none none
Public boolean false none none
Active boolean false none none
Temporary boolean false none none
Id string(uuid) false none none

TaskActivity

{
"Subject": "string",
"Start": "2019-08-24T14:15:22Z",
"End": "2019-08-24T14:15:22Z",
"Duration": "string",
"WorkedTime": 0.1,
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"SubCategory": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"PrimaryContactPhoneNumber": "string",
"PrimaryContact": "string",
"IsDone": true,
"HasDocument": true,
"Longitude": 0.1,
"Latitude": 0.1,
"ActivityType": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Location": "string",
"IsReadyForAttestation": true,
"IsAttested": true,
"IsProcessed": true,
"HasExpenseReceipt": true,
"AttestedByUser": "string",
"AttestedDate": "2019-08-24T14:15:22Z",
"AdditionalHoursTripStart": 0.1,
"AdditionalHoursTripEnd": 0.1,
"NumberOfNights": 0,
"NumberOfBreakfast": 0,
"NumberOfLunch": 0,
"NumberOfDinner": 0,
"Description": "string",
"CountryId": [
0
],
"Project": [
"00000000-0000-0000-0000-000000000000"
],
"Workorder": [
"00000000-0000-0000-0000-000000000000"
],
"Article": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Responsible": [
"00000000-0000-0000-0000-000000000000"
],
"IsNew": true,
"IsPositive": true,
"TagCount": 0,
"AllDayEvent": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Subject string false none none
Start string(date-time) false none none
End string(date-time) false none none
Duration string false read-only none
WorkedTime number(double) false none none
Type Code false none none
Status Code false none none
Category Code false none none
Priority Code false none none
SubCategory Code false none none
PrimaryContactPhoneNumber string false read-only none
PrimaryContact string false read-only none
IsDone boolean false none none
HasDocument boolean false read-only none
Longitude number(double) false none none
Latitude number(double) false none none
ActivityType Code false none none
Location string false none none
IsReadyForAttestation boolean false none none
IsAttested boolean false none none
IsProcessed boolean false none none
HasExpenseReceipt boolean false none none
AttestedByUser string false read-only none
AttestedDate string(date-time) false none none
AdditionalHoursTripStart number(double) false none none
AdditionalHoursTripEnd number(double) false none none
NumberOfNights integer(int32) false none none
NumberOfBreakfast integer(int32) false none none
NumberOfLunch integer(int32) false none none
NumberOfDinner integer(int32) false none none
Description string false none none
CountryId [integer] false none none
Project [string] false none none
Workorder [string] false none none
Article [string] false none none
PrivatePerson [string] false none none
CorporatePerson [string] false none none
Company [string] false none none
Responsible [string] false none none
IsNew boolean false read-only none
IsPositive boolean false read-only none
TagCount integer(int32) false read-only none
AllDayEvent boolean false none none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Id string(uuid) false none none

TelemarketingActivity

{
"Name": "string",
"Description": "string",
"WebSite": "string",
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"FollowUpDate": "2019-08-24T14:15:22Z",
"ReportDate": "2019-08-24T14:15:22Z",
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"MarketingProject": "string",
"MarketingPlan": "string",
"MarketingPlanAndProject": "string",
"TimeSpan": "string",
"IsExternal": true,
"MarketingProjectId": "00000000-0000-0000-0000-000000000000",
"MarketingPlanId": "00000000-0000-0000-0000-000000000000",
"IsNew": true,
"TagCount": 0,
"TargetParticipantQuantity": 0,
"TargetResponseRatePercent": 0,
"ProcessItemCount": 0,
"ActiveProcessItemCount": 0,
"CreatedBy": "string",
"UpdatedBy": "string",
"Active": true,
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Name string true none none
Description string false none none
WebSite string false none none
StartDate string(date-time) false none none
EndDate string(date-time) false none none
FollowUpDate string(date-time) false none none
ReportDate string(date-time) false none none
Status Code false none none
Priority Code false none none
MarketingProject string false read-only none
MarketingPlan string false read-only none
MarketingPlanAndProject string false read-only none
TimeSpan string false read-only none
IsExternal boolean false none none
MarketingProjectId string(uuid) false read-only none
MarketingPlanId string(uuid) false read-only none
IsNew boolean false read-only none
TagCount integer(int32) false read-only none
TargetParticipantQuantity integer(int32) false none none
TargetResponseRatePercent integer(int32) false none none
ProcessItemCount integer(int32) false read-only none
ActiveProcessItemCount integer(int32) false read-only none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Active boolean false read-only none
Id string(uuid) false none none

ChallengeRequest

{
"EntityId": "00000000-0000-0000-0000-000000000000",
"DeliveryMethod": "api",
"DeliveryAddress": "string",
"CodeLength": 0,
"CodeAlphanumeric": true,
"CodeExpirationInSeconds": 0,
"CallbackUrl": "string"
}

Properties

Name Type Required Restrictions Description
EntityId string(uuid) false none none
DeliveryMethod string false none none
DeliveryAddress string false none none
CodeLength integer(int32) false none none
CodeAlphanumeric boolean false none none
CodeExpirationInSeconds integer(int32) false none none
CallbackUrl string false none none

Enumerated Values

Property Value
DeliveryMethod api
DeliveryMethod email

User

{
"UserId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"UserName": "string",
"Email": "string"
}

Properties

Name Type Required Restrictions Description
UserId string(uuid) false none none
Name string false none none
UserName string false none none
Email string false none none

ProductVersion

{
"Name": "string",
"Major": 0,
"Minor": 0,
"Patch": 0,
"Build": 0,
"Version": "string"
}

Properties

Name Type Required Restrictions Description
Name string false none none
Major integer(int32) false none none
Minor integer(int32) false none none
Patch integer(int32) false none none
Build integer(int32) false none none
Version string false read-only none

Workorder

{
"Subject": "string",
"Description": "string",
"Type": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Status": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Category": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"Priority": {
"Key": "string",
"CodeGroupKey": "string",
"Caption": "string",
"Active": true
},
"StartDate": "2019-08-24T14:15:22Z",
"EndDate": "2019-08-24T14:15:22Z",
"Duration": "string",
"PrimaryAddress": "string",
"PrimaryCity": "string",
"PrimaryCounty": "string",
"PrimaryZipCode": "string",
"Country": [
0
],
"Longitude": 0.1,
"Latitude": 0.1,
"IsNew": true,
"CreatedBy": "string",
"UpdatedBy": "string",
"Project": [
"00000000-0000-0000-0000-000000000000"
],
"PrivatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"CorporatePerson": [
"00000000-0000-0000-0000-000000000000"
],
"Company": [
"00000000-0000-0000-0000-000000000000"
],
"Case": [
"00000000-0000-0000-0000-000000000000"
],
"PrimaryResponsible": "string",
"ResponsibleUsergroupId": [
"00000000-0000-0000-0000-000000000000"
],
"WorkorderNumber": "string",
"Active": true,
"ShowCreateServiceAppointment": true,
"Id": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Subject string false none none
Description string false none none
Type Code false none none
Status Code false none none
Category Code false none none
Priority Code false none none
StartDate string(date-time) false none none
EndDate string(date-time) false none none
Duration string false read-only none
PrimaryAddress string false none none
PrimaryCity string false none none
PrimaryCounty string false none none
PrimaryZipCode string false none none
Country [integer] false none none
Longitude number(double) false none none
Latitude number(double) false none none
IsNew boolean false read-only none
CreatedBy string false read-only none
UpdatedBy string false read-only none
Project [string] false none none
PrivatePerson [string] false none none
CorporatePerson [string] false none none
Company [string] false none none
Case [string] false none none
PrimaryResponsible string false read-only none
ResponsibleUsergroupId [string] false none none
WorkorderNumber string false none none
Active boolean false none none
ShowCreateServiceAppointment boolean false read-only none
Id string(uuid) false none none

WorkorderBusinessprojectRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

WorkorderProjectRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

WorkorderCompanyRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

WorkorderCaseRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

WorkorderPrivatePersonRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

WorkorderCompanyPersonRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

WorkorderUserRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none

WorkorderUsergroupRelation

{
"Id": "00000000-0000-0000-0000-000000000000",
"RoleCodeKey": "string",
"RelatedEntityId": "00000000-0000-0000-0000-000000000000"
}

Properties

Name Type Required Restrictions Description
Id string(uuid) true none none
RoleCodeKey string true none none
RelatedEntityId string(uuid) true none none