using RestSharp;
var options = new RestClientOptions("http://localhost:49843/api/v1/Agents/Targets/GetTargetGroupForYearAndDimension");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"TargetYear\": 123,\n \"DimensionId\": 123\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({TargetYear: 123, DimensionId: 123})
};
fetch('http://localhost:49843/api/v1/Agents/Targets/GetTargetGroupForYearAndDimension', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "49843",
CURLOPT_URL => "http://localhost:49843/api/v1/Agents/Targets/GetTargetGroupForYearAndDimension",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'TargetYear' => 123,
'DimensionId' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:49843/api/v1/Agents/Targets/GetTargetGroupForYearAndDimension"
payload = {
"TargetYear": 123,
"DimensionId": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({TargetYear: 123, DimensionId: 123})
};
fetch('http://localhost:49843/api/v1/Agents/Targets/GetTargetGroupForYearAndDimension', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"TargetGroupId": 123,
"Year": 123,
"EntityType": "None",
"PeriodType": "None",
"TargetAssignments": [
{
"TargetAssignmentInfoId": 123,
"Values": [
123
],
"Locked": true,
"TargetAssociate": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"TargetContact": {
"ContactId": 123,
"Name": "<string>",
"OrgNr": "<string>",
"Department": "<string>",
"URL": "<string>",
"City": "<string>",
"DirectPhone": "<string>",
"AssociateId": 123,
"CountryId": 123,
"EmailAddress": "<string>",
"Kananame": "<string>",
"EmailAddressName": "<string>",
"URLName": "<string>",
"AssociateFullName": "<string>",
"BusinessName": "<string>",
"CategoryName": "<string>",
"CountryName": "<string>",
"Address": {
"Wgs84Latitude": 123,
"Wgs84Longitude": 123,
"LocalizedAddress": [
[
{
"Name": "<string>",
"Value": "<string>",
"Tooltip": "<string>",
"Label": "<string>",
"ValueLength": 123,
"AddressType": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
]
],
"Street": {
"AtypeIdx": "Unknown",
"Address1": "<string>",
"Address2": "<string>",
"Address3": "<string>",
"City": "<string>",
"County": "<string>",
"State": "<string>",
"Zipcode": "<string>",
"Formatted": "<string>"
},
"Postal": {
"AtypeIdx": "Unknown",
"Address1": "<string>",
"Address2": "<string>",
"Address3": "<string>",
"City": "<string>",
"County": "<string>",
"State": "<string>",
"Zipcode": "<string>",
"Formatted": "<string>"
},
"Formatted": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"FormattedAddress": "<string>",
"FullName": "<string>",
"IsOwnerContact": true,
"ActiveErpLinks": 123,
"Number1": "<string>",
"Number2": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"TargetUserGroup": {
"Value": "<string>",
"Tooltip": "<string>",
"Id": 123,
"Rank": 123,
"Deleted": true,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Currency": {
"Id": 123,
"Value": "<string>",
"Tooltip": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"DimensionListItem": 123,
"DimensionListItemDisplayName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TargetDimension": {
"TargetDimensionId": 123,
"AssignmentLevel": "None",
"EntityType": "None",
"MeasurementUnit": "None",
"DimensionListField": "<string>",
"DimensionListName": "<string>",
"DimensionListId": 123,
"DimensionListLabel": "<string>",
"SelectedDimensions": [
123
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Get Target Group For Year And Dimension
Returns the target group for the specified year and dimension.
NsApiSlow threshold: 5000 ms.
using RestSharp;
var options = new RestClientOptions("http://localhost:49843/api/v1/Agents/Targets/GetTargetGroupForYearAndDimension");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"TargetYear\": 123,\n \"DimensionId\": 123\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({TargetYear: 123, DimensionId: 123})
};
fetch('http://localhost:49843/api/v1/Agents/Targets/GetTargetGroupForYearAndDimension', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "49843",
CURLOPT_URL => "http://localhost:49843/api/v1/Agents/Targets/GetTargetGroupForYearAndDimension",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'TargetYear' => 123,
'DimensionId' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:49843/api/v1/Agents/Targets/GetTargetGroupForYearAndDimension"
payload = {
"TargetYear": 123,
"DimensionId": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({TargetYear: 123, DimensionId: 123})
};
fetch('http://localhost:49843/api/v1/Agents/Targets/GetTargetGroupForYearAndDimension', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"TargetGroupId": 123,
"Year": 123,
"EntityType": "None",
"PeriodType": "None",
"TargetAssignments": [
{
"TargetAssignmentInfoId": 123,
"Values": [
123
],
"Locked": true,
"TargetAssociate": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"Type": "Unknown",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": true,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"TargetContact": {
"ContactId": 123,
"Name": "<string>",
"OrgNr": "<string>",
"Department": "<string>",
"URL": "<string>",
"City": "<string>",
"DirectPhone": "<string>",
"AssociateId": 123,
"CountryId": 123,
"EmailAddress": "<string>",
"Kananame": "<string>",
"EmailAddressName": "<string>",
"URLName": "<string>",
"AssociateFullName": "<string>",
"BusinessName": "<string>",
"CategoryName": "<string>",
"CountryName": "<string>",
"Address": {
"Wgs84Latitude": 123,
"Wgs84Longitude": 123,
"LocalizedAddress": [
[
{
"Name": "<string>",
"Value": "<string>",
"Tooltip": "<string>",
"Label": "<string>",
"ValueLength": 123,
"AddressType": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
]
],
"Street": {
"AtypeIdx": "Unknown",
"Address1": "<string>",
"Address2": "<string>",
"Address3": "<string>",
"City": "<string>",
"County": "<string>",
"State": "<string>",
"Zipcode": "<string>",
"Formatted": "<string>"
},
"Postal": {
"AtypeIdx": "Unknown",
"Address1": "<string>",
"Address2": "<string>",
"Address3": "<string>",
"City": "<string>",
"County": "<string>",
"State": "<string>",
"Zipcode": "<string>",
"Formatted": "<string>"
},
"Formatted": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"FormattedAddress": "<string>",
"FullName": "<string>",
"IsOwnerContact": true,
"ActiveErpLinks": 123,
"Number1": "<string>",
"Number2": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"TargetUserGroup": {
"Value": "<string>",
"Tooltip": "<string>",
"Id": 123,
"Rank": 123,
"Deleted": true,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Currency": {
"Id": 123,
"Value": "<string>",
"Tooltip": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"DimensionListItem": 123,
"DimensionListItemDisplayName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TargetDimension": {
"TargetDimensionId": 123,
"AssignmentLevel": "None",
"EntityType": "None",
"MeasurementUnit": "None",
"DimensionListField": "<string>",
"DimensionListName": "<string>",
"DimensionListId": 123,
"DimensionListLabel": "<string>",
"SelectedDimensions": [
123
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
TargetYear, DimensionId
Response
OK
Target Group carrier Carrier object for TargetGroup. Services for the TargetGroup Carrier is available from the Targets Agent.
Primary key
The year this set of targets are associated with (2020, 2021...)
Entity type for this set of targets (Sale, Project, Selection, Appointment...)
None, Sale Period type for editing this set of targets (Year, Quarter...)
None, Year, HalfYear, Quarter, Month Collection of target values
Show child attributes
Show child attributes
Target Dimension carrier Carrier object for TargetDimension. Services for the TargetDimension Carrier is available from the Targets Agent.
Show child attributes
Show child attributes
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Show child attributes
Show child attributes
Field property dictionary mapping field names to field access rights.
Show child attributes
Show child attributes