AccountAPI

RoboHead API Documentation - Account

This page describes various APIs required to update and fetch the account level information.

Paths List all operations

/account.do?cmd=Update

GET /account.do?cmd=Update

Account

Summary

Update Account

Description

Updates account.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

removeWelcomeLogo

query

If want to remove welcome logo provide value true. Default value will be false

Object

type:"boolean"

boolean

timezone

query

Provide timezone. To get time zone list give call to ListTimezones of list module. Specify the name of time zone (eg. US/Eastern)

Yes

Object

type:"string"

string

inboxEmailName

query

Provide name for inbox emails eg. roboheadTest

Yes

Object

type:"string"

string

allowSaveUserName

query

Provide 1 (true) to allow saving user name else 2 (false). Default value is 1 (true).

Object

type:"integer"

integer

dateFormat

query

Provide date format for the user account. To get date formats give call to ListDateFormats of list module. Provide the date value as parameter. (eg. mm/dd/yyyy)

Yes

Object

type:"string"

string

pwdContainSymbol

query

Provide 1 (true) to allow symbols in password else 2 (false). Default value is 2 (false).

Object

type:"integer"

integer

pwdContainNumber

query

Provide 1 (true) to allow numbers in password else 2 (false). Default value is 2 (false).

Object

type:"integer"

integer

pwdUpperLower

query

Provide 1 (true) to allow upper case, lower case in password else 2 (false). Default value is 2 (false).

Object

type:"integer"

integer

pwdExpiryDays

query

Provide number of days in which the password should expire.

Object

type:"integer"

integer

pwdAsUserName

query

Provide 1 (true) to allow to set user name as password else 2 (false). Default value is 2 (false).

Yes

Object

type:"integer"

integer

allowSavePwd

query

Provide 1 (true) to allow save password as password else 2 (false). Default value is 1 (true).

Yes

Object

type:"integer"

integer

requireInitialPwdReset

query

Provide 1 (true) if to enable initial password reset else 2 (false). Default value is 2 (false).

Object

type:"integer"

integer

weekStartDay

query

Provide week start day eg. Monday, Tuesday, etc

Yes

Object

type:"integer"

integer

expenseContribute

query

Provide type for expense contribute,

None (0)
View (1)
Manage (2)
Default value is None (0)

Object

type:"integer"

integer

expenseView

query

Provide type for expense contribute,

None (0)
View (1)
Default value is None (0)

Object

type:"integer"

integer

accountCurrencyId

query

Provide currency id. To get currency list give call to GetListByType of list module, pass type = 15.

Object

type:"integer"

integer

defaultEmailDisplayName

query

Provide default email display name

Object

type:"string"

string

newFileIds

query

Provide comma separated file ids to add new to the account

Object

type:"string"

string

oldFileIds

query

Provide comma separated old file ids. If old file Ids not included in this list, they will be removed from the account.

Object

type:"string"

string

billingDay

query

Provide billing day

Object

type:"integer"

integer

pwdMinimumLength

query

Provide password minimum length.

Yes

Object

type:"integer"

integer

maxNumFailedAttempts

query

Set number of failed login attempts. For example, if value is 2 then user login will be locked after 2 unsuccessful login attempts.

Object

type:"integer"

integer

numLastPwdCannotbeUsed

query

Set number of last passwords cannot be used. For example, if value is 2 then last 2 passwords cannot be used again as new password.

Object

type:"integer"

integer

allowRequesterEditSubmittedRequest

query

To allow request edit and submit set True(1) else False(2).

Object

type:"integer"

integer

Responses

Response Type Description

Response Type	Description
Success	`Schema` : Result Response contain customParams, It provide updated account Id. Sample JSON Request Sample : /account.do cmd=Update timezone=US/Central inboxEmailName=demo allowSaveUserName=1 dateFormat=dd/MM/yyyy pwdContainNumber=2 pwdContainSymbol=2 pwdUpperLower=2 pwdExpiryDays=1 pwdAsUserName=2 allowSavePwd=1 requireInitialPwdReset=2 weekStartDay=0 expenseContribute=1 expenseView=1 accountCurrencyId=151 defaultEmailDisplayName=RoboHead Demo Account newFileIds= oldFileIds= billingDay=1 pwdMinimumLength=4 removeWelcomeLogo=1 numLastPwdCannotbeUsed=1 maxNumFailedAttempts=5 allowRequesterEditSubmittedRequest=1 JSESSIONID=2E2B368143F19A6147600AC409907CAF Response Sample : { "returnCode": 0, "messageKey": "msg_account_success_updateAccount", "detailedMessage": "Account updated successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "5D9A26454E8BEEC50014EA591AE8E034", "errorMessages": null, "success": true }
Failure	Unexpected error `Schema` : Result

Success

Schema : Result

Response contain customParams, It provide updated account Id.

Sample JSON


Request Sample :
/account.do
cmd=Update
timezone=US/Central
inboxEmailName=demo
allowSaveUserName=1
dateFormat=dd/MM/yyyy
pwdContainNumber=2
pwdContainSymbol=2
pwdUpperLower=2
pwdExpiryDays=1
pwdAsUserName=2
allowSavePwd=1
requireInitialPwdReset=2
weekStartDay=0
expenseContribute=1
expenseView=1
accountCurrencyId=151
defaultEmailDisplayName=RoboHead Demo Account
newFileIds=
oldFileIds=
billingDay=1
pwdMinimumLength=4
removeWelcomeLogo=1
numLastPwdCannotbeUsed=1
maxNumFailedAttempts=5
allowRequesterEditSubmittedRequest=1
JSESSIONID=2E2B368143F19A6147600AC409907CAF
Response Sample : {
  "returnCode": 0,
  "messageKey": "msg_account_success_updateAccount",
  "detailedMessage": "Account updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "5D9A26454E8BEEC50014EA591AE8E034",
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=Get

GET /account.do?cmd=Get

Account

Summary

Get account

Description

Returns all account details.

Access

Account Admin

Parameters

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful `Schema` : Account Sample JSON Request Sample : /account.do cmd=Get JSESSIONID=394509A41B57989A821511E4890AEA57 Response Sample : { "id": 10036, "globalListByContractTermsId": null, "globalListByInvoiceFrequencyId": null, "globalListByClassificationId": { "id": 7, "createdBy": 0, "createdOn": null, "modifiedBy": null, "modifiedOn": null, "state": 0, "listType": 0, "value": null, "displayValue": "Proof of Concept", "sortOrder": 0 }, "globalListByCurrencyId": { "id": 151, "createdBy": 0, "createdOn": null, "modifiedBy": null, "modifiedOn": null, "state": 0, "listType": 0, "value": "$", "displayValue": "Dollar($)", "sortOrder": 0 }, "globalListByAccountManagerId": { "id": 16, "createdBy": 0, "createdOn": null, "modifiedBy": null, "modifiedOn": null, "state": 0, "listType": 0, "value": null, "displayValue": "JD", "sortOrder": 0 }, "globalListByIndustryId": null, "createdBy": 10000, "createdOn": "04/01/2014 03:50 PM US/Central", "modifiedBy": 23066, "modifiedOn": "10/19/2016 07:09 AM US/Central", "state": 1, "accountName": "RoboHead Demo Account", "accountUrl": "demo", "timezone": "US/Central", "defaultEmailDisplayName": "RoboHead Demo Account", "inboxEmailName": "demo", "accountCloseDate": null, "directS3Download": 1, "requestNumberFormat": "%04d", "resetRequestNumberYearlyFlag": 2, "startRequestNumber": 1000, "fiscalYearStartDate": "12/28/2013 12:00 AM US/Central", "projectNumberFormat": "%04d", "resetProjectNumberYearlyFlag": 2, "startProjectNumber": 1000, "pwdExpiryDays": 1, "pwdMinimumLength": 4, "requireInitialPwdReset": 2, "pwdContainNumber": 2, "pwdContainSymbol": 2, "pwdUpperLower": 2, "pwdAsUserName": 2, "allowSaveUserName": 1, "allowSavePwd": 1, "allowEditForApproval": 2, "allowExternalRequests": 1, "allowExternalReviews": 1, "storageLimit": 1050, "enableReviewModule": 1, "enableRequestModule": 1, "enableProjectModule": 1, "enableLibraryModule": 1, "enableCampaignModule": 1, "enableTimeModule": 1, "enableExpenseModule": 1, "enablePersonalTodos": 1, "enableTaskModule": 1, "enableClientModule": 1, "enableApi": 2, "expenseContribute": 1, "expenseView": 1, "sessionTimeoutMinutes": 120, "numContractedUsers": 50, "numContractedContacts": 1000, "dateFormat": "dd/MM/yyyy", "customLabels": "", "requiredTaskDates": 1, "requiredReviewDates": 1, "weekStartDay": 0, "contractSignature": null, "firstUseDate": null, "poEndDate": null, "renewalType": 0, "loginCustomLabels": "", "extraStorageRate": 0, "nameOnContract": "", "contractLastExecutionDate": null, "goLiveDate": null, "otherTerms": null, "legacyAccount": 2, "billingDay": 1, "baseRatePerUser": 0, "additionalUserRate": 0, "collaboratorModuleRate": 0, "requesterModuleRate": 0, "bundledModuleRate": 0, "enableSaml": 2, "samlEntityId": null, "accountSummary": { "account": null, "storageUsed": 1, "numUsers": 11, "numContacts": 8, "lastLogin": "10/19/2016 07:04 AM US/Central" }, "accountLogoUrl": null, "welcomeLogoUrl": null, "formatttedProjectNumberFormat": "1000", "formatttedRequestNumberFormat": "1000", "messagesMap": {} }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successful

Schema : Account

Sample JSON


Request Sample :
/account.do
cmd=Get
JSESSIONID=394509A41B57989A821511E4890AEA57

Response Sample : {
  "id": 10036,
  "globalListByContractTermsId": null,
  "globalListByInvoiceFrequencyId": null,
  "globalListByClassificationId": {
    "id": 7,
    "createdBy": 0,
    "createdOn": null,
    "modifiedBy": null,
    "modifiedOn": null,
    "state": 0,
    "listType": 0,
    "value": null,
    "displayValue": "Proof of Concept",
    "sortOrder": 0
  },
  "globalListByCurrencyId": {
    "id": 151,
    "createdBy": 0,
    "createdOn": null,
    "modifiedBy": null,
    "modifiedOn": null,
    "state": 0,
    "listType": 0,
    "value": "$",
    "displayValue": "Dollar($)",
    "sortOrder": 0
  },
  "globalListByAccountManagerId": {
    "id": 16,
    "createdBy": 0,
    "createdOn": null,
    "modifiedBy": null,
    "modifiedOn": null,
    "state": 0,
    "listType": 0,
    "value": null,
    "displayValue": "JD",
    "sortOrder": 0
  },
  "globalListByIndustryId": null,
  "createdBy": 10000,
  "createdOn": "04/01/2014 03:50 PM  US/Central",
  "modifiedBy": 23066,
  "modifiedOn": "10/19/2016 07:09 AM  US/Central",
  "state": 1,
  "accountName": "RoboHead Demo Account",
  "accountUrl": "demo",
  "timezone": "US/Central",
  "defaultEmailDisplayName": "RoboHead Demo Account",
  "inboxEmailName": "demo",
  "accountCloseDate": null,
  "directS3Download": 1,
  "requestNumberFormat": "%04d",
  "resetRequestNumberYearlyFlag": 2,
  "startRequestNumber": 1000,
  "fiscalYearStartDate": "12/28/2013 12:00 AM  US/Central",
  "projectNumberFormat": "%04d",
  "resetProjectNumberYearlyFlag": 2,
  "startProjectNumber": 1000,
  "pwdExpiryDays": 1,
  "pwdMinimumLength": 4,
  "requireInitialPwdReset": 2,
  "pwdContainNumber": 2,
  "pwdContainSymbol": 2,
  "pwdUpperLower": 2,
  "pwdAsUserName": 2,
  "allowSaveUserName": 1,
  "allowSavePwd": 1,
  "allowEditForApproval": 2,
  "allowExternalRequests": 1,
  "allowExternalReviews": 1,
  "storageLimit": 1050,
  "enableReviewModule": 1,
  "enableRequestModule": 1,
  "enableProjectModule": 1,
  "enableLibraryModule": 1,
  "enableCampaignModule": 1,
  "enableTimeModule": 1,
  "enableExpenseModule": 1,
  "enablePersonalTodos": 1,
  "enableTaskModule": 1,
  "enableClientModule": 1,
  "enableApi": 2,
  "expenseContribute": 1,
  "expenseView": 1,
  "sessionTimeoutMinutes": 120,
  "numContractedUsers": 50,
  "numContractedContacts": 1000,
  "dateFormat": "dd/MM/yyyy",
  "customLabels": "",
  "requiredTaskDates": 1,
  "requiredReviewDates": 1,
  "weekStartDay": 0,
  "contractSignature": null,
  "firstUseDate": null,
  "poEndDate": null,
  "renewalType": 0,
  "loginCustomLabels": "",
  "extraStorageRate": 0,
  "nameOnContract": "",
  "contractLastExecutionDate": null,
  "goLiveDate": null,
  "otherTerms": null,
  "legacyAccount": 2,
  "billingDay": 1,
  "baseRatePerUser": 0,
  "additionalUserRate": 0,
  "collaboratorModuleRate": 0,
  "requesterModuleRate": 0,
  "bundledModuleRate": 0,
  "enableSaml": 2,
  "samlEntityId": null,
  "accountSummary": {
    "account": null,
    "storageUsed": 1,
    "numUsers": 11,
    "numContacts": 8,
    "lastLogin": "10/19/2016 07:04 AM  US/Central"
  },
  "accountLogoUrl": null,
  "welcomeLogoUrl": null,
  "formatttedProjectNumberFormat": "1000",
  "formatttedRequestNumberFormat": "1000",
  "messagesMap": {}
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=ListListTypes

GET /account.do?cmd=ListListTypes

Account

Summary

Get list of all Account List types.

Description

Get list of all Account List types for a account. These are account level lists such as Expense Types, Suppliers.

Access

Account Admin

Parameters

Responses

Response Type Description

Response Type	Description
Success	Retrieves list types in id-value format. `Schema` : List of account list types in Id-Value format { IdValuePair }
Failure	Unexpected error `Schema` : Result

Success

Retrieves list types in id-value format.

Schema : List of account list types in Id-Value format

{ IdValuePair }

Failure

Unexpected error

Schema : Result

/account.do?cmd=ListAccountExpenseFieldOptions

GET /account.do?cmd=ListAccountExpenseFieldOptions

Account

Summary

Get list for List types.

Description

Get list for List types.

Access

Contact

Parameters

Name

Located in

Description

Required

Schema

listType

query

Provide list type.

Yes

Object

type:"integer"

integer

page

query

Page parameter is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.

Yes

Object

type:"integer"

integer

start

query

Provide start for your page. If not provided default will be 0 ie first record.

Object

type:"integer"

integer

limit

query

Provide total records for a page.

Yes

Object

type:"integer"

integer

Responses

Response Type Description

Response Type	Description
Success	Retrieved successfully. `Schema` : ExpenseFieldOptions
Failure	Unexpected error `Schema` : Result

Success

Retrieved successfully.

Schema : ExpenseFieldOptions

Failure

Unexpected error

Schema : Result

/account.do?cmd=AddAccountExpenseFieldOption

GET /account.do?cmd=AddAccountExpenseFieldOption

Account

Summary

Add expense field option.

Description

Add expense field option

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client Id to add expense field option.

Yes

Object

type:"string"

integer

displayValue

query

Provide display value expense field.

Yes

Object

type:"string"

integer

listType

query

Provide list type id.

Yes

Object

type:"string"

integer

value

query

Provide value.

Yes

Object

type:"string"

integer

sortOrder

query

Provide sort order.

Object

type:"string"

integer

Responses

Response Type Description

Response Type	Description
Success	`Schema` : Result Response contain customParams, It provide added expense fields Id. Sample JSON `Response Sample : { "returnCode": 0, "messageKey": "msg_account_success_addListItem", "detailedMessage": "List item added successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "61558670C9E09B986A825AEFFE82", "customParams": { "accountExpenseFieldOptionId": 98243 }, "errorMessages": null, "success": true }`
Failure	Unexpected error `Schema` : Result

Success

Schema : Result

Response contain customParams, It provide added expense fields Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_account_success_addListItem",
  "detailedMessage": "List item added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "61558670C9E09B986A825AEFFE82",
  "customParams": {
    "accountExpenseFieldOptionId": 98243
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=UpdateAccountExpenseFieldOption

GET /account.do?cmd=UpdateAccountExpenseFieldOption

Account

Summary

Update List Item.

Description

Update Account Expense Field Option.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

expenseFieldOptionId

query

Provide expense field option id to update expense field.

Yes

Object

type:"string"

integer

displayValue

query

Provide display value expense field.

Yes

Object

type:"string"

integer

listType

query

Provide list type id.

Yes

Object

type:"string"

integer

value

query

Provide value.

Yes

Object

type:"string"

integer

sortOrder

query

Provide sort order.

Object

type:"string"

integer

Responses

Response Type Description

Response Type	Description
Success	`Schema` : Result Response contain customParams, It provide updated expense field's Id. Sample JSON `Response Sample : { "returnCode": 0, "messageKey": "msg_account_success_updateListItem", "detailedMessage": "List item updated successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "6155867C0C9EA09B986A825AEFFE82", "customParams": { "accountExpenseFieldOptionId": 34243 }, "errorMessages": null, "success": true }`
Failure	Unexpected error `Schema` : Result

Success

Schema : Result

Response contain customParams, It provide updated expense field's Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_account_success_updateListItem",
  "detailedMessage": "List item updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "6155867C0C9EA09B986A825AEFFE82",
  "customParams": {
    "accountExpenseFieldOptionId": 34243
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=DeleteAccountExpenseFieldOption

GET /account.do?cmd=DeleteAccountExpenseFieldOption

Account

Summary

Delete Expense Field Options.

Description

Delete Expense Field Options.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

expenseFieldOptionId

query

Provide expense field option Id to delete expense field.

Yes

Object

type:"string"

integer

Responses

Response Type Description

Success

List item deleted successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/account.do?cmd=ActivateAccountExpenseFieldOption
- GET /account.do?cmd=ActivateAccountExpenseFieldOption
  Account
  
  Summary
  
  Activate List item
  Description
  Activate list item.
  
  Access
  
  Account Admin
  Parameters
  
  Name Located in Description Required Schema
  
  listId query
  Provide list item id to activate.
  Yes
  
  Object
  type:"integer"
  
  integer
  
  Responses
  
  Response Type Description
  
  Success
  List item activated successfully.
  
  Schema : Result
  
  Failure
  Unexpected error
  
  Schema : Result

/account.do?cmd=UpdateAccountExpenseFieldOptionsOrder

GET /account.do?cmd=UpdateAccountExpenseFieldOptionsOrder

Account

Summary

Update List Item.

Description

Update List Item.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

expenseFieldOptionIds

query

Provide comma separated expense field Id's.

Yes

Object

type:"string"

String

listType

query

Provide list type id.

Yes

Object

type:"string"

integer

Responses

Response Type Description

Success

List reordered successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/account.do?cmd=ListHolidays

GET /account.do?cmd=ListHolidays

Account

Summary

List account holidays

Description

List account holidays.

Access

Project Member +

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide client Id. (required if client segmentation enabled).

Object

type:"integer"

integer

page

query

Page parameter is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.

Yes

Object

type:"integer"

integer

start

query

Provide start for your page. If not provided default will be 0 ie first record.

Yes

Object

type:"integer"

integer

limit

query

Provide total records for a page. If not provided default 5 records will be returne

Yes

Object

type:"integer"

integer

Responses

Response Type Description

Success

Retrieval list of account holidays.

Schema : { AccountHoliday }

Failure

Unexpected error

Schema : Result

/account.do?cmd=AddHoliday

GET /account.do?cmd=AddHoliday

Account

Summary

Add account holiday

Description

Add account holiday.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

description

query

Provide description for holiday

Yes

Object

type:"string"

string

clientId

query

Provide client Id. (required if client segmentation enabled).

Object

type:"integer"

integer

startDate

query

Provide start date for holiday

Yes

Object

type:"string"

format:"date"

string (date)

endDate

query

Provide end date for holiday

Yes

Object

type:"string"

format:"date"

string (date)

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide added holiday's Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_account_success_addHoliday",
  "detailedMessage": "Account holiday added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "6155867C0C9EF3A06A825AEFFE82",
  "customParams": {
    "accountHolidayId": 85362
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=UpdateHoliday

GET /account.do?cmd=UpdateHoliday

Account

Summary

Update account holiday

Description

Update account holiday.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

query

Provide holiday id

Yes

Object

type:"integer"

integer

clientId

query

Provide client Id. (required if client segmentation enabled).

Object

type:"integer"

integer

description

query

Provide description for holiday

Yes

Object

type:"string"

string

startDate

query

Provide start date for holiday

Yes

Object

type:"string"

format:"date"

string (date)

endDate

query

Provide end date for holiday

Yes

Object

type:"string"

format:"date"

string (date)

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide updated holiday's Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_account_success_updateHoliday",
  "detailedMessage": "Account holiday updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "6155867C0C9EF3A09B986AFE82",
  "customParams": {
    "accountHolidayId": 99962
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=DeleteHoliday
- GET /account.do?cmd=DeleteHoliday
  Account
  
  Summary
  
  Delete account holiday
  Description
  Delete account holiday.
  
  Access
  
  Account Admin
  Parameters
  
  Name Located in Description Required Schema
  
  holidayId query
  Provide holiday id
  Yes
  
  Object
  type:"integer"
  
  integer
  
  Responses
  
  Response Type Description
  
  Success
  Updated successfully
  
  Schema : Result
  
  Failure
  Unexpected error
  
  Schema : Result
/account.do?cmd=ListStamps
- GET /account.do?cmd=ListStamps
  Account
  
  Summary
  
  List account stamps
  Description
  Get stamp list for account
  
  Access
  
  Contact +
  Parameters
  NA
  Responses
  
  Response Type Description
  
  Success
  Retrieval successfully
  
  Schema : List of stamps
  
  { Stamp }
  
  Failure
  Unexpected error
  
  Schema : Result

/account.do?cmd=AddStamp

GET /account.do?cmd=AddStamp

Account

Summary

Add Stamp

Description

Add Stamp.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

labelText

query

Provide label text

Yes

Object

type:"string"

string

labelColor

query

Provide hex color code

Yes

Object

type:"string"

string

labelBackgroundColor

query

Provide hex color code

Yes

Object

type:"string"

string

sortOrder

query

Provide position in the list

Yes

Object

type:"integer"

integer

Responses

Response Type Description

Success

Stamp added successfully

Schema : Result

Response contain customParams, It provide stamp Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_account_success_addStamp",
  "detailedMessage": "Stamp added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "6155867C0C9EF3A09B986A825AEFFE82",
  "customParams": {
    "stampId": 675
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=UpdateStamp

GET /account.do?cmd=UpdateStamp

Account

Summary

Update Stamp

Description

Update Stamp.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

query

Provide stamp id

Yes

Object

type:"integer"

integer

labelText

query

Provide lable text

Yes

Object

type:"string"

string

labelColor

query

Provide hex color code

Yes

Object

type:"string"

string

labelBackgroundColor

query

Provide hex color code

Yes

Object

type:"string"

string

sortOrder

query

Provide position in the list

Yes

Object

type:"integer"

integer

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide updated stamp Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_account_success_updateStamp",
  "detailedMessage": "Stamp updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "6155867C0C9EF3A09B986A825AEFFE82",
  "customParams": {
    "stampId": 9727
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=DeleteStamp
- GET /account.do?cmd=DeleteStamp
  Account
  
  Summary
  
  Delete Stamp
  Description
  Delete Stamp.
  
  Access
  
  Account Admin
  Parameters
  
  Name Located in Description Required Schema
  
  stampId query
  Provide stamp Id to delete
  Yes
  
  Object
  type:"integer"
  
  integer
  
  Responses
  
  Response Type Description
  
  Success
  Stamp deleted successfully
  
  Schema : Result
  
  Failure
  Unexpected error
  
  Schema : Result

/account.do?cmd=UpdateEmailTemplate

GET /account.do?cmd=UpdateEmailTemplate

Account

Summary

Update Email Template

Description

Update email template.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

query

Provide email template id

Yes

Object

type:"integer"

integer

subject

query

Provide subject text

Yes

Object

type:"string"

string

htmlMessage

query

Provide html message

Yes

Object

type:"string"

string

Responses

Response Type Description

Success

Email updated successfully

Schema : Result

Failure

Unexpected error

Schema : Result

/account.do?cmd=ResetEmailTemplatetoDefault
- GET /account.do?cmd=ResetEmailTemplatetoDefault
  Account
  
  Summary
  
  Reset email template to default
  Description
  Reset email template to default.
  
  Access
  
  Account Admin
  Parameters
  
  Name Located in Description Required Schema
  
  id query
  Provide email template id
  Yes
  
  Object
  type:"integer"
  
  integer
  
  Responses
  
  Response Type Description
  
  Success
  Email reset successfully
  
  Schema : Result
  
  Failure
  Unexpected error
  
  Schema : Result
/account.do?cmd=ListEmailTemplates
- GET /account.do?cmd=ListEmailTemplates
  Account
  
  Summary
  
  List email templates for account
  Description
  List email templates for account.
  
  Access
  
  Contact +
  Parameters
  NA
  Responses
  
  Response Type Description
  
  Success
  Retrieval successfully
  
  Schema : List of email templates
  
  { EmailTemplate }
  
  Failure
  Unexpected error
  
  Schema : Result

/account.do?cmd=ListSummaryFields

GET /account.do?cmd=ListSummaryFields

Account

Summary

List all summary fields.

Description

List all summary fields for particular form type (Project/Campaign).

Access

Contact +

Parameters

Name

Located in

Description

Required

Schema

formType

query

Provide one form type

2 (Project)
3 (Campaign)

Yes

Object

type:"integer"

integer

Responses

Response Type Description

Success

Retrieval successfully

Schema : List of summary fields

{ SummaryField }

Sample JSON


Request Sample :
/account.do
cmd=ListSummaryFields
formType=2
JSESSIONID=394509A41B57989A821511E4890AEA57
Response Sample : [
  {
    "id": 4714,
    "field": {
      "id": 4970,
      "fieldType": {
        "id": 3,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "name": null,
        "description": null
      },
      "globalList": {
        "id": 206,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "state": 0,
        "listType": 27,
        "value": null,
        "displayValue": null,
        "sortOrder": 0
      },
      "account": null,
      "createdBy": 0,
      "createdOn": null,
      "modifiedBy": null,
      "modifiedOn": null,
      "state": 1,
      "objectType": 0,
      "displayName": "Approvals Overdue",
      "maxLength": null,
      "noOfDecimal": null,
      "fieldSize": null,
      "defaultValue": null,
      "fieldOptionJson": null
    },
    "account": null,
    "formType": 2,
    "selectedFlag": 2,
    "sortOrder": 26
  },
  {
    "id": 106185,
    "field": {
      "id": 50035,
      "fieldType": {
        "id": 1,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "name": null,
        "description": null
      },
      "globalList": {
        "id": null,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "state": 0,
        "listType": 0,
        "value": null,
        "displayValue": null,
        "sortOrder": 0
      },
      "account": null,
      "createdBy": 0,
      "createdOn": null,
      "modifiedBy": null,
      "modifiedOn": null,
      "state": 1,
      "objectType": 0,
      "displayName": "Approving Manager",
      "maxLength": null,
      "noOfDecimal": 0,
      "fieldSize": null,
      "defaultValue": null,
      "fieldOptionJson": null
    },
    "account": null,
    "formType": 2,
    "selectedFlag": 2,
    "sortOrder": 216
  },
  {
    "id": 175357,
    "field": {
      "id": 140373,
      "fieldType": {
        "id": 4,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "name": null,
        "description": null
      },
      "globalList": {
        "id": 458,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "state": 0,
        "listType": 13,
        "value": null,
        "displayValue": null,
        "sortOrder": 0
      },
      "account": null,
      "createdBy": 0,
      "createdOn": null,
      "modifiedBy": null,
      "modifiedOn": null,
      "state": 1,
      "objectType": 0,
      "displayName": "Archived On",
      "maxLength": null,
      "noOfDecimal": null,
      "fieldSize": null,
      "defaultValue": null,
      "fieldOptionJson": null
    },
    "account": null,
    "formType": 2,
    "selectedFlag": 2,
    "sortOrder": 228
  },
  {
    "id": 4701,
    "field": {
      "id": 4991,
      "fieldType": {
        "id": 3,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "name": null,
        "description": null
      },
      "globalList": {
        "id": 64,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "state": 0,
        "listType": 13,
        "value": null,
        "displayValue": null,
        "sortOrder": 0
      },
      "account": null,
      "createdBy": 0,
      "createdOn": null,
      "modifiedBy": null,
      "modifiedOn": null,
      "state": 1,
      "objectType": 0,
      "displayName": "Bdgt Expenses",
      "maxLength": null,
      "noOfDecimal": null,
      "fieldSize": null,
      "defaultValue": null,
      "fieldOptionJson": null
    },
    "account": null,
    "formType": 2,
    "selectedFlag": 2,
    "sortOrder": 12
  }
]

Failure

Unexpected error

Schema : Result

/account.do?cmd=UpdateSummaryFields

GET /account.do?cmd=UpdateSummaryFields

Account

Summary

Update summary fields list.

Description

Update summary field list for the account.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

formType

query

Provide one form type

2 (Project)
3 (Campaign)

Yes

Object

type:"integer"

integer

summaryFieldIds

query

Provide comma separated summary field Ids.

Yes

Object

type:"string"

string

Responses

Response Type Description

Success

Update summary fields successfully

Schema : Result

Failure

Unexpected error

Schema : Result

/account.do?cmd=RevertSummaryFields
- GET /account.do?cmd=RevertSummaryFields
  Account
  
  Summary
  
  Reverts summary fields list to default.
  Description
  Reverts summary fields list to default.
  
  Access
  
  Account Admin
  Parameters
  Name Located in Description Required Schema
  
  formType query
  Provide one form type
  
  2 (Project)
  
  3 (Campaign)
  
  Yes
  
  Object
  type:"integer"
  
  integer
  Responses
  
  Response Type Description
  
  Success
  Summary fields reverted successfully.
  
  Schema : Result
  
  Failure
  Unexpected error
  
  Schema : Result

/account.do?cmd=ListDisplaySummaryFields

GET /account.do?cmd=ListDisplaySummaryFields

Account

Summary

Lists displayed summary field list.

Description

Get list of displayed summary fields.

Access

Contact +

Parameters

Name

Located in

Description

Required

Schema

formType

query

Provide one form type

2 (Project)
3 (Campaign)

Yes

Object

type:"integer"

integer

Responses

Response Type Description

Success

Retrieval successfully.

Schema : List of summary fields

{ SummaryField }

Failure

Unexpected error

Schema : Result

/account.do?cmd=ListListColumns

GET /account.do?cmd=ListListColumns

Account

Summary

List all columns (fields).

Description

Get list of all columns (fields) for a form type (Project/Request/Campaign).

Access

Contact +

Parameters

Name

Located in

Description

Required

Schema

formType

query

Provide one form type

1 (Request)
2 (Project)
3 (Campaign)

Yes

Object

type:"integer"

integer

Responses

Response Type Description

Success

Retrieval successfully.

Schema : List of list columns

{ ListColumn }

Sample JSON


Request Sample :
/account.do
cmd=ListListColumns
formType=1
JSESSIONID=394509A41B57989A821511E4890AEA57
Response Sample :[
  {
    "id": 63238,
    "field": {
      "id": 50035,
      "fieldType": null,
      "globalList": {
        "id": null,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "state": 0,
        "listType": 0,
        "value": null,
        "displayValue": null,
        "sortOrder": 0
      },
      "account": null,
      "createdBy": 0,
      "createdOn": null,
      "modifiedBy": null,
      "modifiedOn": null,
      "state": 1,
      "objectType": 0,
      "displayName": "Approving Manager",
      "maxLength": null,
      "noOfDecimal": null,
      "fieldSize": null,
      "defaultValue": null,
      "fieldOptionJson": null
    },
    "account": null,
    "formType": 1,
    "selectedFlag": 2,
    "sortOrder": 318
  },
  {
    "id": 7496,
    "field": {
      "id": 4991,
      "fieldType": null,
      "globalList": {
        "id": 64,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "state": 0,
        "listType": 13,
        "value": null,
        "displayValue": "budgeted_expense",
        "sortOrder": 0
      },
      "account": null,
      "createdBy": 0,
      "createdOn": null,
      "modifiedBy": null,
      "modifiedOn": null,
      "state": 1,
      "objectType": 0,
      "displayName": "Bdgt Expenses",
      "maxLength": null,
      "noOfDecimal": null,
      "fieldSize": null,
      "defaultValue": null,
      "fieldOptionJson": null
    },
    "account": null,
    "formType": 1,
    "selectedFlag": 2,
    "sortOrder": 11
  },
  {
    "id": 7497,
    "field": {
      "id": 4992,
      "fieldType": null,
      "globalList": {
        "id": 65,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "state": 0,
        "listType": 13,
        "value": null,
        "displayValue": "budgeted_labor",
        "sortOrder": 0
      },
      "account": null,
      "createdBy": 0,
      "createdOn": null,
      "modifiedBy": null,
      "modifiedOn": null,
      "state": 1,
      "objectType": 0,
      "displayName": "Bdgt Labor",
      "maxLength": null,
      "noOfDecimal": null,
      "fieldSize": null,
      "defaultValue": null,
      "fieldOptionJson": null
    },
    "account": null,
    "formType": 1,
    "selectedFlag": 2,
    "sortOrder": 12
  },
  {
    "id": 24922,
    "field": {
      "id": 19710,
      "fieldType": null,
      "globalList": {
        "id": 370,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "state": 0,
        "listType": 12,
        "value": null,
        "displayValue": "Campaign",
        "sortOrder": 0
      },
      "account": null,
      "createdBy": 0,
      "createdOn": null,
      "modifiedBy": null,
      "modifiedOn": null,
      "state": 1,
      "objectType": 0,
      "displayName": "Campaign",
      "maxLength": null,
      "noOfDecimal": null,
      "fieldSize": null,
      "defaultValue": null,
      "fieldOptionJson": null
    },
    "account": null,
    "formType": 1,
    "selectedFlag": 2,
    "sortOrder": 306
  },
  {
    "id": 7491,
    "field": {
      "id": 4985,
      "fieldType": null,
      "globalList": {
        "id": 58,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "state": 0,
        "listType": 12,
        "value": null,
        "displayValue": "client_id",
        "sortOrder": 0
      },
      "account": null,
      "createdBy": 0,
      "createdOn": null,
      "modifiedBy": null,
      "modifiedOn": null,
      "state": 1,
      "objectType": 0,
      "displayName": "Client",
      "maxLength": null,
      "noOfDecimal": null,
      "fieldSize": null,
      "defaultValue": null,
      "fieldOptionJson": null
    },
    "account": null,
    "formType": 1,
    "selectedFlag": 1,
    "sortOrder": 1
  },
  {
    "id": 148189,
    "field": {
      "id": 116383,
      "fieldType": null,
      "globalList": {
        "id": null,
        "createdBy": 0,
        "createdOn": null,
        "modifiedBy": null,
        "modifiedOn": null,
        "state": 0,
        "listType": 0,
        "value": null,
        "displayValue": null,
        "sortOrder": 0
      },
      "account": null,
      "createdBy": 0,
      "createdOn": null,
      "modifiedBy": null,
      "modifiedOn": null,
      "state": 1,
      "objectType": 0,
      "displayName": "Color(s) - Brochure/Catalog",
      "maxLength": null,
      "noOfDecimal": null,
      "fieldSize": null,
      "defaultValue": null,
      "fieldOptionJson": null
    },
    "account": null,
    "formType": 1,
    "selectedFlag": 2,
    "sortOrder": 320
  }
]

Failure

Unexpected error

Schema : Result

/account.do?cmd=UpdateListColumns

GET /account.do?cmd=UpdateListColumns

Account

Summary

Update list columns.

Description

Update list columns.

Access

Account Admin

Parameters

Name

Located in

Description

Required

Schema

formType

query

Provide one form type

1 (Request)
2 (Project)
3 (Campaign)

Yes

Object

type:"integer"

integer

listColumnIds

query

Provide comma separated list column Ids.

Yes

Object

type:"string"

string

Responses

Response Type Description

Success

Update list columns successfully

Schema : Result

Failure

Unexpected error

Schema : Result

/account.do?cmd=RevertListColumns
- GET /account.do?cmd=RevertListColumns
  Account
  
  Summary
  
  Reverts list columns to default.
  Description
  Reverts list columns to default.
  
  Access
  
  Account Admin
  Parameters
  Name Located in Description Required Schema
  
  formType query
  Provide one form type
  
  1 (Request)
  
  2 (Project)
  
  3 (Campaign)
  
  Yes
  
  Object
  type:"integer"
  
  integer
  Responses
  
  Response Type Description
  
  Success
  List columns reverted successfully.
  
  Schema : Result
  
  Failure
  Unexpected error
  
  Schema : Result

/account.do?cmd=ListDisplayListColumns

GET /account.do?cmd=ListDisplayListColumns

Account

Summary

List displayed list columns.

Description

List displayed list columns for a given formType.

Access

Contact +

Parameters

Name

Located in

Description

Required

Schema

formType

query

Provide one form type

1 (Request)
2 (Project)
3 (Campaign)

Yes

Object

type:"integer"

integer

Responses

Response Type Description

Success

Retrieval successfully.

Schema : List of list columns

{ ListColumn }

Failure

Unexpected error

Schema : Result

/account.do?cmd=GetAccountTaskRoleList

GET /account.do?cmd=GetAccountTaskRoleList

Account

Summary

List Account Task Roles

Description

List Account Task Roles.

Access

Contact+

Parameters

Name

Located in

Description

Required

Schema

listMode

query

Provide any one mode,

default
listMode

Object

type:"string"

string

sortColumn

query

Provide sort column from your output columns.

Object

type:"string"

string

sortDirection

query

Provide sort direction => (ASC or DESC)

Object

type:"string"

string

limit

query

Provide total records for a page.

Yes

Object

type:"integer"

integer

Responses

Response Type Description

Success

Retrieval successful

Schema : List of Task Role

{ TaskRole }

Failure

Unexpected error

Schema : Result

/account.do?cmd=GetAccountNonProjectTaskList

GET /account.do?cmd=GetAccountNonProjectTaskList

Account

Summary

List Account Non Project Tasks

Description

List Account Non Project Tasks.

Access

Contact+

Parameters

Responses

Response Type Description

Success

Retrieval successful

Schema : List of Non Project Task

{ NonProjectTask }

Failure

Unexpected error

Schema : Result

/account.do?cmd=AddNonProjectTask

GET /account.do?cmd=AddNonProjectTask

Account

Summary

Add a non project task

Description

Add a non project task.

Access

Account Admin+

Parameters

Name

Located in

Description

Required

Schema

taskRoleId

query

Provide task role id.

Object

type:"string"

integer

displayValue

query

Provide display value.

Yes

Object

type:"string"

string

Responses

Response Type Description

Success

Non project task added successfully.

Schema : Result

Response contain customParams, It provide non project task Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_account_success_addNonProjectTask",
  "detailedMessage": "Non project task added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "6155867C0C9EF3AA825AEFFE82",
  "customParams": {
    "nonProjectTaskId": 963
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=UpdateNonProjectTask

GET /account.do?cmd=UpdateNonProjectTask

Account

Summary

Update a non project task

Description

Update a non project task.

Access

Account Admin+

Parameters

Name

Located in

Description

Required

Schema

nonProjectTaskId

query

Provide non project task id.

Object

type:"string"

integer

taskRoleId

query

Provide task role id.

Object

type:"string"

integer

displayValue

query

Provide display value.

Yes

Object

type:"string"

string

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide updated non project task's Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_account_success_updateNonProjectTask",
  "detailedMessage": "Non project task updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "6155867C0C9EF3A09B986A825AEFFE82",
  "customParams": {
    "nonProjectTaskId": 4163
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=DeleteNonProjectTask
- GET /account.do?cmd=DeleteNonProjectTask
  Account
  
  Summary
  
  Delete non project task
  Description
  Delete non project task.
  
  Access
  
  Account Admin+
  Parameters
  
  Name Located in Description Required Schema
  
  nonProjectTaskId query
  Provide non project task id.
  Yes
  
  Object
  type:"string"
  
  integer
  
  Responses
  
  Response Type Description
  
  Success
  Non project task deleted successfully.
  
  Schema : Result
  
  Failure
  Unexpected error
  
  Schema : Result
/account.do?cmd=UpdateNonProjectTaskPriorityOrder
- GET /account.do?cmd=UpdateNonProjectTaskPriorityOrder
  Account
  
  Summary
  
  Update Non Project Task Priority Order
  Description
  Update Non Project Task Priority Order.
  
  Access
  
  Account Admin+
  Parameters
  
  Name Located in Description Required Schema
  
  nonProjectTaskId query
  Provide comma separated non project task ids.
  Yes
  
  Object
  type:"string"
  
  string
  
  Responses
  
  Response Type Description
  
  Success
  Non project task sorted successfully.
  
  Schema : Result
  
  Failure
  Unexpected error
  
  Schema : Result

/account.do?cmd=AddTaskRole

GET /account.do?cmd=AddTaskRole

Account

Summary

Add task role

Description

Add task role.

Access

Account Admin+

Parameters

Name

Located in

Description

Required

Schema

rate

query

Provide task rate value.

Object

type:"string"

integer

displayValue

query

Provide display value.

Yes

Object

type:"string"

string

effectiveDate

query

Provide effective date.

Object

type:"string"

date

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide task role Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_account_success_addTaskRole",
  "detailedMessage": "Task role added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "6155867C0C9EF3A06A82AEFFE82",
  "customParams": {
    "taskRoleId": 56763
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=UpdateTaskRole

GET /account.do?cmd=UpdateTaskRole

Account

Summary

Update task role

Description

Update task role.

Access

Account Admin+

Parameters

Name

Located in

Description

Required

Schema

taskRoleId

query

Provide task role id.

Object

type:"string"

integer

displayValue

query

Provide display value.

Yes

Object

type:"string"

string

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide task role Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_account_success_updateTaskRole",
  "detailedMessage": "Task role updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "6155867C0C9EFB986A825AEFFE82",
  "customParams": {
    "taskRoleId": 85563
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=DeleteTaskRole
- GET /account.do?cmd=DeleteTaskRole
  Account
  
  Summary
  
  Delete task role
  Description
  Delete task role.
  
  Access
  
  Account Admin+
  Parameters
  
  Responses
  
  Name Located in Description Required Schema
  
  taskRoleId query
  Provide task role id.
  Yes
  
  Object
  type:"string"
  
  integer
  
  Response Type Description
  
  Success
  Task role deleted successfully.
  
  Schema : Result
  
  Failure
  Unexpected error
  
  Schema : Result

/account.do?cmd=UpdateTaskRolePriorityOrder

GET /account.do?cmd=UpdateTaskRolePriorityOrder

Account

Summary

Update Task role priority order

Description

Update Task role priority order.

Access

Account Admin+

Parameters

Responses

Name

Located in

Description

Required

Schema

taskRoleId

query

Provide task role id.

Object

type:"string"

integer

displayValue

query

Provide display value.

Yes

Object

type:"string"

string

Response Type Description

Success

Task role sorted successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/account.do?cmd=AddTaskRoleRate

GET /account.do?cmd=AddTaskRoleRate

Account

Summary

Add task role rate

Description

Add task role rate.

Access

Account Admin+

Parameters

Name

Located in

Description

Required

Schema

taskRoleRateId

query

Provide task role rate Id.

Object

type:"integer"

integer

rate

query

Provide rate value.

Yes

Object

type:"integer"

integer

effectiveDate

query

Provide effective date.

Yes

Object

type:"integer"

date

Responses

Response Type Description

Success

Task role rate added successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/account.do?cmd=DeleteTaskRoleRate
- GET /account.do?cmd=DeleteTaskRoleRate
  Account
  
  Summary
  
  Delete task role rate
  Description
  Delete task role rate.
  
  Access
  
  Account Admin+
  Parameters
  
  Name Located in Description Required Schema
  
  taskRoleRateId query
  Provide task role rate Id.
  Yes
  
  Object
  type:"integer"
  
  integer
  
  Responses
  
  Response Type Description
  
  Success
  Task role rate deleted successfully.
  
  Schema : Result
  
  Failure
  Unexpected error
  
  Schema : Result

/account.do?cmd=GetTaskRoleRateDetails

GET /account.do?cmd=GetTaskRoleRateDetails

Account

Summary

Get task role rate details

Description

Get task role rate details.

Access

Account Admin+

Parameters

Name

Located in

Description

Required

Schema

taskRoleId

query

Provide task role id.

Yes

Object

type:"string"

integer

Responses

Response Type Description

Success

Retrieval successful

Schema : Map of List of UserTaskRoleRate

{ UserTaskRoleRate }

Failure

Unexpected error

Schema : Result

/account.do?cmd=GetTaskRoleUsers

GET /account.do?cmd=GetTaskRoleUsers

Account

Summary

Get task role users

Description

Get task role users.

Access

Contact+

Parameters

Name

Located in

Description

Required

Schema

taskRoleId

query

Provide task role id.

Yes

Object

type:"string"

integer

sortColumn

query

Provide sort column from your output columns.

Object

type:"string"

string

sortDirection

query

Provide sort direction => (ASC or DESC)

Object

type:"string"

string

Responses

Response Type Description

Success

Retrieval successful

Schema : List of Users

{ User }

Failure

Unexpected error

Schema : Result

/account.do?cmd=GetAccountSummaryMetrics

GET /account.do?cmd=GetAccountSummaryMetrics

Account

Summary

Get account summary metrics information.

Description

Get account summary metrics information based on selected type (metricTypeId) & date filter (quarter or month)

Access

Project Member+

Parameters

Name

Located in

Description

Required

Schema

metricTypeId

query

Type of the account summary. There are two types of account summary
1) Monthly Account Summary:- metricTypeId=321
2) Quarterly Account Summary:- metricTypeId=322

Yes

Object

type:"string"

integer

date

query

selected Quarter OR Month date.

Yes

Object

type:"string"

string (date)

Responses

Response Type Description

Success

Retrieval successful

Schema : List of Account Summary (Monthly OR Quarterly)

{ MonthlyAccountSummary OR QuarterlyAccountSummary }

Sample JSON


Response Sample : {
  "id": 0,
  "account": null,
  "monthOf": "06/01/2018 12:00 AM  US/Eastern", OR "quarterOf": "04/01/2018 12:00 AM  US/Eastern",
  "projectsCreated": 74,
  "requestsCreated": 0,
  "tasksCreated": 485,
  "reviewsCreated": 0,
  "avgProjectDuration": 157.4,
  "avgTaskDuration": 207.9,
  "avgReqApprovalDuration": 0,
  "avgProjectStartShift": -0.5,
  "avgProjectDueShift": 3.2,
  "avgBudgetVariance": 184960.54,
  "avgActiveDuration": 0,
  "avgTaskStartShift": 1.2,
  "avgTaskDueShift": 0.2,
  "avgTaskStartSlip": 2.8,
  "avgTaskDueSlip": -0.1,
  "avgTaskHoursVariance": 13372.6
}

Failure

Unexpected error

Schema : Result

/account.do?cmd=GetAccountMetricsFilterList

GET /account.do?cmd=GetAccountMetricsFilterList

Account

Summary

Get List of filters for Account Summary Metrics.

Description

Get List of filter(date of Quarter OR Month) for retrieving corresponding Account Summary Metrics Information

Access

Project Member+

Parameters

Name

Located in

Description

Required

Schema

metricTypeId

query

Type of the account summary. There are two types of account summary
1) Monthly Account Summary:- metricTypeId=321
2) Quarterly Account Summary:- metricTypeId=322

Yes

Object

type:"string"

integer

Responses

Response Type Description

Success

Retrieval successful

Schema : List of Account Summary (Monthly OR Quarterly)

{ MonthlyAccountSummary OR QuarterlyAccountSummary }

Sample JSON


Response Sample : [
  {
    "id": 0,
    "account": null,
    "monthOf": "06/01/2018 12:00 AM  US/Eastern", OR "quarterOf": "04/01/2018 12:00 AM  US/Eastern",
    "projectsCreated": null,
    "requestsCreated": null,
    "tasksCreated": null,
    "reviewsCreated": null,
    "avgProjectDuration": null,
    "avgTaskDuration": null,
    "avgReqApprovalDuration": null,
    "avgProjectStartShift": null,
    "avgProjectDueShift": null,
    "avgBudgetVariance": null,
    "avgActiveDuration": null,
    "avgTaskStartShift": null,
    "avgTaskDueShift": null,
    "avgTaskStartSlip": null,
    "avgTaskDueSlip": null,
    "avgTaskHoursVariance": null
  },
  {
    "id": 0,
    "account": null,
    "monthOf": "05/01/2018 12:00 AM  US/Eastern", OR "quarterOf": "04/01/2018 12:00 AM  US/Eastern"
    "projectsCreated": null,
    "requestsCreated": null,
    "tasksCreated": null,
    "reviewsCreated": null,
    "avgProjectDuration": null,
    "avgTaskDuration": null,
    "avgReqApprovalDuration": null,
    "avgProjectStartShift": null,
    "avgProjectDueShift": null,
    "avgBudgetVariance": null,
    "avgActiveDuration": null,
    "avgTaskStartShift": null,
    "avgTaskDueShift": null,
    "avgTaskStartSlip": null,
    "avgTaskDueSlip": null,
    "avgTaskHoursVariance": null
  }
]

Failure

Unexpected error

Schema : Result

/account.do?cmd=ListActiveLinks

GET /account.do?cmd=ListActiveLinks

Account

Summary

Retrieve list of active links.

Description

This method provides implementation to get active link for calendar, external file annotation, external file links with support for sorting and filtering

Access

Application Admin
Account Admin

Parameters

Name

Located in

Description

Required

Schema

linkType

query

provide linkType of integer type.

Yes

Object

type:"integer"

integer

criteria

query

provide criteria of string type.

Yes

Object

type:"string"

string

sortColumn

query

provide sortColumn of string type.

Yes

Object

type:"string"

string

sortDirection

query

provide sort Direction of string type.

Yes

Object

type:"string"

string

page

query

provide page of integer type.

Yes

Object

type:"integer"

integer

start

query

provide start of integer type.

Yes

Object

type:"integer"

integer

limit

query

provide limit of integer type.

Yes

Object

type:"ineger"

integer

Responses

Response Type Description

Success

Retrieval successful.

Schema :Retrive list of active links successfully.

Sample JSON


Response Sample : {
    "limit": 10,
    "page": 1,
    "start": 0,
    "TotalRecords": 155,
    "userFilterId": 0,
    "List": [
        {
            "id": 220,
            "url": "http://interface.rambo.net:8086/map.do?id\u003dXjbRn1Nh1709891979",
            "groupId": null,
            "linkType": 1,
            "objectName": "Projects",
            "sentTo": null,
            "createdOn": "08/03/2024 03:29 PM  Asia/Tokyo",
            "createdBy": null,
            "createdByUser": null,
            "modifiedOn": null,
            "modifiedBy": 0,
            "modifiedByUser": null,
            "expiryDate": null,
            "isExternalUser": null
        },
        {
            "id": 219,
            "url": "http://interface.rambo.net:8086/map.do?id\u003dop4FkxVt1709887648",
            "groupId": null,
            "linkType": 1,
            "objectName": "Projects",
            "sentTo": null,
            "createdOn": "08/03/2024 02:17 PM  Asia/Tokyo",
            "createdBy": null,
            "createdByUser": null,
            "modifiedOn": null,
            "modifiedBy": 0,
            "modifiedByUser": null,
            "expiryDate": null,
            "isExternalUser": null
        },
        {
            "id": 218,
            "url": "http://interface.rambo.net:8086/map.do?id\u003dEwXkeKXQ1709879629",
            "groupId": null,
            "linkType": 1,
            "objectName": "demo 4",
            "sentTo": null,
            "createdOn": "08/03/2024 12:03 PM  Asia/Tokyo",
            "createdBy": null,
            "createdByUser": null,
            "modifiedOn": null,
            "modifiedBy": 0,
            "modifiedByUser": null,
            "expiryDate": null,
            "isExternalUser": null
        }]
		}

Failure

Unexpected error

Schema : Result

/account.do?cmd=ListExpiredLinks

GET /account.do?cmd=ListExpiredLinks

Account

Summary

Retrieve list of expired links.

Description

This method provides implementation to get expired link for calendar/external file annotation/external file links with support for sorting and filtering.

Access

Application Admin
Account Admin

Parameters

Name

Located in

Description

Required

Schema

linkType

query

provide linkType of integer.

Yes

Object

type:"integer"

integer

criteria

query

provide criteria of string type.

Yes

Object

type:"string"

string

sortColumn

query

provide sort Column of string type.

Yes

Object

type:"string"

string

sortDirection

query

provide sort Direction of string type.

Yes

Object

type:"string"

string

page

query

provide page of integer type.

Yes

Object

type:"integer"

integer

start

query

provide start of integer type.

Yes

Object

type:"integer"

integer

limit

query

provide limit of integer.

Yes

Object

type:"ineger"

integer

Responses

Response Type Description

Success

Retrieval successful.

Schema :Retrive list of expired links successfully.

Sample JSON


Response Sample : {
    "limit": 10,
    "page": 1,
    "start": 0,
    "TotalRecords": 39,
    "userFilterId": 0,
    "List": [
        {
            "id": 208,
            "url": "http://interface.rambo.net:8086/map.do?id\u003dOu7peTQQ1709541018",
            "groupId": null,
            "linkType": 1,
            "objectName": "Campaigns",
            "sentTo": null,
            "createdOn": "04/03/2024 02:00 PM  Asia/Tokyo",
            "createdBy": null,
            "createdByUser": null,
            "modifiedOn": "05/03/2024 03:19 PM  Asia/Tokyo",
            "modifiedBy": null,
            "modifiedByUser": null,
            "expiryDate": "06/03/2024 12:00 AM  Asia/Tokyo",
            "isExternalUser": null
        },
        {
            "id": 199,
            "url": "http://interface.rambo.net:8086/map.do?id\u003d4za6aiNn1709292515",
            "groupId": null,
            "linkType": 1,
            "objectName": "Campaigns",
            "sentTo": null,
            "createdOn": "01/03/2024 04:58 PM  Asia/Tokyo",
            "createdBy": null,
            "createdByUser": null,
            "modifiedOn": null,
            "modifiedBy": 0,
            "modifiedByUser": null,
            "expiryDate": "02/03/2024 12:00 AM  Asia/Tokyo",
            "isExternalUser": null
        },
        {
            "id": 198,
            "url": "http://interface.rambo.net:8086/map.do?id\u003dq71AcikA1709292147",
            "groupId": null,
            "linkType": 1,
            "objectName": "Campaigns",
            "sentTo": null,
            "createdOn": "01/03/2024 04:52 PM  Asia/Tokyo",
            "createdBy": null,
            "createdByUser": null,
            "modifiedOn": null,
            "modifiedBy": 0,
            "modifiedByUser": null,
            "expiryDate": "09/03/2024 12:00 AM  Asia/Tokyo",
            "isExternalUser": null
        }]
		}

Failure

Unexpected error

Schema : Result

/account.do?cmd=UpdateLinks

GET /account.do?cmd=UpdateLinks

Account

Summary

Update links Expiry.

Description

This method used to Update link Expiry.

Access

Parameters

Name

Located in

Description

Required

Schema

linkType

query

provide linkType of integer.

Yes

Object

type:"integer"

integer

expiryDateString

query

provide expiryDate String.

Yes

Object

type:"string"

string

linkIds

query

provide linkIds String.

Yes

Object

type:"List<>"

List

Responses

Response Type Description

Success

update successfully.

Schema :update link expiry successfully.

Sample JSON


Response Sample :{
    "returnCode": 0,
    "messageKey": "msg_account_success_updateLinkExpiry",
    "detailedMessage": "Successfully updated link expiration date.",
    "exception": null,
    "browser": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36",
    "sessionId": "64DE473D49241B52BDE542BAC226A573",
    "customParams": null,
    "errorMessages": null,
    "success": true
}

Failure

Unexpected error

Schema : Result