JavaScript SDK Samples - Territory Operations
Get All Territories
class Territory
{
/**
* Get Territories
* This method is used to get the list of territories enabled for your organization and print the response.
*/
static async getTerritories(){
//Get instance of TerritoriesOperations Class
let territoriesOperations = new ZCRM.Territory.Operations();
//Call getTerritories method
let response = await territoriesOperations.getTerritories();
if(response != null){
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
if([204, 304].includes(response.getStatusCode())){
console.log(response.getStatusCode() == 204? "No Content" : "Not Modified");
return;
}
//Get object from response
let responseObject = response.getObject();
if(responseObject != null){
//Check if expected ResponseWrapper instance is received
if(responseObject instanceof ZCRM.Territory.Model.ResponseWrapper){
//Get the array of obtained Territory instances
let territories = responseObject.getTerritories();
territories.forEach(territory => {
//Get the CreatedTime of each Territory
console.log("Territory CreatedTime: " + territory.getCreatedTime());
//Get the ModifiedTime of each Territory
console.log("Territory ModifiedTime: " + territory.getModifiedTime());
//Get the manager User instance of each Territory
let manager = territory.getManager();
//Check if manager is not null
if(manager != null){
//Get the Name of the Manager
console.log("Territory Manager User-Name: " + manager.getName());
//Get the ID of the Manager
console.log("Territory Manager User-ID: " + manager.getId());
}
//Get the ParentId of each Territory
console.log("Territory ParentId: " + territory.getParentId());
// Get the Criteria instance of each Territory
let criteria = territory.getCriteria();
//Check if criteria is not null
if(criteria != null){
this.printCriteria(criteria);
}
//Get the Name of each Territory
console.log("Territory Name: " + territory.getName());
//Get the modifiedBy User instance of each Territory
let modifiedBy = territory.getModifiedBy();
//Check if modifiedBy is not null
if(modifiedBy != null){
//Get the Name of the modifiedBy User
console.log("Territory Modified By User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("Territory Modified By User-ID: " + modifiedBy.getId());
}
//Get the Description of each Territory
console.log("Territory Description: " + territory.getDescription());
//Get the ID of each Territory
console.log("Territory ID: " + territory.getId());
//Get the createdBy User instance of each Territory
let createdBy = territory.getCreatedBy();
//Check if createdBy is not null
if(createdBy != null){
//Get the Name of the createdBy User
console.log("Territory Created By User-Name: " + createdBy.getName());
//Get the ID of the createdBy User
console.log("Territory Created By User-ID: " + createdBy.getId());
}
});
}
//Check if the request returned an exception
else if(responseObject instanceof ZCRM.Territory.Model.APIException){
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}
Get a Territory
class Territory
{
/**
* Get Territory
* This method is used to get the single territory and print the response.
* @param {BigInt} territoryId The ID of the Territory to be obtainted
*/
static async getTerritory(territoryId){
//example
//let territoryId = 3409643000000505351n;
//Get instance of TerritoriesOperations Class
let territoriesOperations = new ZCRM.Territory.Operations();
//Call getTerritory method that takes territoryId as parameter
let response = await territoriesOperations.getTerritory(territoryId);
if(response != null){
//Get the status code from response
console.log("Status Code: " + response.getStatusCode());
if([204, 304].includes(response.getStatusCode())){
console.log(response.getStatusCode() == 204? "No Content" : "Not Modified");
return;
}
//Get object from response
let responseObject = response.getObject();
if(responseObject != null){
//Check if expected ResponseWrapper instance is received
if(responseObject instanceof ZCRM.Territory.Model.ResponseWrapper){
//Get the array of obtained Territory instances
let territories = responseObject.getTerritories();
territories.forEach(territory => {
//Get the CreatedTime of each Territory
console.log("Territory CreatedTime: " + territory.getCreatedTime());
//Get the ModifiedTime of each Territory
console.log("Territory ModifiedTime: " + territory.getModifiedTime());
//Get the manager User instance of each Territory
let manager = territory.getManager();
//Check if manager is not null
if(manager != null){
//Get the Name of the Manager
console.log("Territory Manager User-Name: " + manager.getName());
//Get the ID of the Manager
console.log("Territory Manager User-ID: " + manager.getId());
}
//Get the ParentId of each Territory
console.log("Territory ParentId: " + territory.getParentId());
// Get the Criteria instance of each Territory
let criteria = territory.getCriteria();
//Check if criteria is not null
if(criteria != null){
this.printCriteria(criteria);
}
//Get the Name of each Territory
console.log("Territory Name: " + territory.getName());
//Get the modifiedBy User instance of each Territory
let modifiedBy = territory.getModifiedBy();
//Check if modifiedBy is not null
if(modifiedBy != null){
//Get the Name of the modifiedBy User
console.log("Territory Modified By User-Name: " + modifiedBy.getName());
//Get the ID of the modifiedBy User
console.log("Territory Modified By User-ID: " + modifiedBy.getId());
}
//Get the Description of each Territory
console.log("Territory Description: " + territory.getDescription());
//Get the ID of each Territory
console.log("Territory ID: " + territory.getId());
//Get the createdBy User instance of each Territory
let createdBy = territory.getCreatedBy();
//Check if createdBy is not null
if(createdBy != null){
//Get the Name of the createdBy User
console.log("Territory Created By User-Name: " + createdBy.getName());
//Get the ID of the createdBy User
console.log("Territory Created By User-ID: " + createdBy.getId());
}
});
}
//Check if the request returned an exception
else if(responseObject instanceof ZCRM.Territory.Model.APIException){
//Get the Status
console.log("Status: " + responseObject.getStatus().getValue());
//Get the Code
console.log("Code: " + responseObject.getCode().getValue());
console.log("Details");
//Get the details map
let details = responseObject.getDetails();
if(details != null){
Array.from(details.keys()).forEach(key => {
console.log(key + ": " + details.get(key));
});
}
//Get the Message
console.log("Message: " + responseObject.getMessage().getValue());
}
}
}
}
}