RateCardAPI

string

description

query

Provide rate card description.

Object

string

effectiveDate

query

Provide effective date for rate card.

Yes

string (date)

unitCost

query

Provide unit cost.

Yes

integer

Responses

Response Type Description

Response Type	Description
Success	`Schema` : Result Response contain customParams, It provide rate card Id. Sample JSON `Response Sample : { "returnCode": 0, "messageKey": "msg_rateCard_success_addRateCard", "detailedMessage": "Rate card added successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "CADE3D2F4327AE5FA4DC48016F", "customParams": { "rateCardId": 784 }, "errorMessages": null, "success": true }`
Failure	Unexpected error `Schema` : Result

Success

Schema : Result

Response contain customParams, It provide rate card Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_rateCard_success_addRateCard",
  "detailedMessage": "Rate card added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "CADE3D2F4327AE5FA4DC48016F",
  "customParams": {
    "rateCardId": 784
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=GetAccountRateCardList

GET /rateCard.do?cmd=GetAccountRateCardList

Rate Card

Summary

Get account rate card list.

Description

Get account rate card list.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

effectiveDate

query

Provide effective date to get rate card.

Yes

string(date)

rateCardIds

query

Provide comma separated rate card Id's to get rate card's.

Yes

string

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful. `Schema` :List of { RateCard }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successful.

Schema :List of { RateCard }

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=UpdateAccountRateCard

GET /rateCard.do?cmd=UpdateAccountRateCard

Rate Card

Summary

Update rate card.

Description

Update rate card.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

rateCardId

query

Provide rate card id.

integer

title

query

Provide title for rate card.

string

description

query

Provide rate card description.

Object

string

Responses

Response Type Description

Response Type	Description
Success	`Schema` : Result Response contain customParams, It provide updated rate card's Id. Sample JSON `Response Sample : { "returnCode": 0, "messageKey": "msg_rateCard_success_updateRateCard", "detailedMessage": "Rate card updated successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "CADE3D2F43D8EFFA4DC48016F", "customParams": { "rateCardId": 34 }, "errorMessages": null, "success": true }`
Failure	Unexpected error `Schema` : Result

Success

Schema : Result

Response contain customParams, It provide updated rate card's Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_rateCard_success_updateRateCard",
  "detailedMessage": "Rate card updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "CADE3D2F43D8EFFA4DC48016F",
  "customParams": {
    "rateCardId": 34
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=DeleteAccountRateCard

GET /rateCard.do?cmd=DeleteAccountRateCard

Rate Card

Summary

Delete rate card.

Description

Delete rate card.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

rateCardId

query

Provide rate card id.

Yes

integer

Responses

Response Type Description

Response Type	Description
Success	Rate card deleted. `Schema` : Result
Failure	Unexpected error `Schema` : Result

Success

Rate card deleted.

Schema : Result

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=GetAccountRateCardUnitCostDetails

GET /rateCard.do?cmd=GetAccountRateCardUnitCostDetails

Rate Card

Summary

Get account rate card unit cost details.

Description

Get account rate card unit cost details.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

rateCardId

query

Provide rate card id.

Yes

integer

Responses

Response Type Description

Response Type	Description
Success	Response contain current unit cost,old unit cost, future unit cost. Sample JSON Response Sample : { "CurrentUnitCost": { "id": 40, "rateCard": { "id": 36, "account": null, "client": null, "createdBy": 0, "createdOn": null, "modifiedBy": null, "modifiedOn": null, "state": 0, "title": null, "description": null, "sortOrder": null, "effectiveDate": null, "unitCost": null }, "createdBy": 0, "createdOn": null, "modifiedBy": null, "modifiedOn": null, "effectiveDate": "07/24/2018 12:00 AM US/Eastern", "unitCost": 100 }, "OldUnitCost": [ { "id": 40, "rateCard": null, "createdBy": 10000, "createdOn": "07/24/2018 02:20 AM US/Eastern", "modifiedBy": null, "modifiedOn": null, "effectiveDate": "07/24/2018 12:00 AM US/Eastern", "unitCost": 100 } ], "FutureUnitCost": [] }
Failure	Unexpected error `Schema` : Result

Success

Response contain current unit cost,old unit cost, future unit cost.

Sample JSON


Response Sample :
{
  "CurrentUnitCost": {
    "id": 40,
    "rateCard": {
      "id": 36,
      "account": null,
      "client": null,
      "createdBy": 0,
      "createdOn": null,
      "modifiedBy": null,
      "modifiedOn": null,
      "state": 0,
      "title": null,
      "description": null,
      "sortOrder": null,
      "effectiveDate": null,
      "unitCost": null
    },
    "createdBy": 0,
    "createdOn": null,
    "modifiedBy": null,
    "modifiedOn": null,
    "effectiveDate": "07/24/2018 12:00 AM  US/Eastern",
    "unitCost": 100
  },
  "OldUnitCost": [
    {
      "id": 40,
      "rateCard": null,
      "createdBy": 10000,
      "createdOn": "07/24/2018 02:20 AM  US/Eastern",
      "modifiedBy": null,
      "modifiedOn": null,
      "effectiveDate": "07/24/2018 12:00 AM  US/Eastern",
      "unitCost": 100
    }
  ],
  "FutureUnitCost": []
}

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=AddAccountRateCardUnitCost

GET /rateCard.do?cmd=AddAccountRateCardUnitCost

Rate Card

Summary

Add account rate card unit cost.

Description

Add account rate card unit cost.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

rateCardId

query

Provide rate card id.

Yes

integer

effectiveDate

query

Provide effective date for rate card.

Yes

string (date)

unitCost

query

Provide unit cost.

Yes

integer

Responses

Response Type Description

Response Type	Description
Success	Rate card unit cost added. `Schema` : Result
Failure	Unexpected error `Schema` : Result

Success

Rate card unit cost added.

Schema : Result

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=DeleteAccountRateCardUnitCost

GET /rateCard.do?cmd=DeleteAccountRateCardUnitCost

Rate Card

Summary

Delete account rate card unit cost.

Description

Delete account rate card unit cost.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

rateCardUnitCostId

query

Provide rate card unit cost id.

Yes

integer

Responses

Response Type Description

Response Type	Description
Success	Rate card unit cost deleted. `Schema` : Result
Failure	Unexpected error `Schema` : Result

Success

Rate card unit cost deleted.

Schema : Result

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=GetClientRateCardList

GET /rateCard.do?cmd=GetClientRateCardList

Rate Card

Summary

Get client rate card list.

Description

Get client rate card list.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide clientId related to rate card.

Yes

integer

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful. `Schema` : List of { RateCard }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successful.

Schema : List of { RateCard }

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=UpdateClientRateCard

GET /rateCard.do?cmd=UpdateClientRateCard

Rate Card

Summary

Update rate card.

Description

Update rate card.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide clientId related to rate card.

integer

rateCardId

query

Provide rate card id.

integer

title

query

Provide title for rate card.

string

description

query

Provide rate card description.

Object

string

Responses

Response Type Description

Response Type	Description
Success	`Schema` : Result Response contain customParams, It provide updated rate card's Id. Sample JSON `Response Sample : { "returnCode": 0, "messageKey": "msg_rateCard_success_updateRateCard", "detailedMessage": "Rate card updated successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "E94963C5E6FF8AFA666", "customParams": { "rateCardId": 39 }, "errorMessages": null, "success": true }`
Failure	Unexpected error `Schema` : Result

Success

Schema : Result

Response contain customParams, It provide updated rate card's Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_rateCard_success_updateRateCard",
  "detailedMessage": "Rate card updated successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "E94963C5E6FF8AFA666",
  "customParams": {
    "rateCardId": 39
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=GetClientRateCardUnitCostDetails

GET /rateCard.do?cmd=GetClientRateCardUnitCostDetails

Rate Card

Summary

Get client rate card unit cost details.

Description

Get client rate card unit cost details.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide clientId related to rate card.

Yes

integer

rateCardId

query

Provide rate card id.

Yes

integer

Responses

Response Type Description

Response Type	Description
Success	Response contain unit cost of rate card. Sample JSON Response Sample : { "CurrentUnitCost": { "id": 43, "rateCard": { "id": 39, "account": null, "client": null, "createdBy": 0, "createdOn": null, "modifiedBy": null, "modifiedOn": null, "state": 0, "title": null, "description": null, "sortOrder": null, "effectiveDate": null, "unitCost": null }, "createdBy": 0, "createdOn": null, "modifiedBy": null, "modifiedOn": null, "effectiveDate": "07/24/2018 12:00 AM US/Eastern", "unitCost": 100 }, "OldUnitCost": [ { "id": 43, "rateCard": null, "createdBy": 29000, "createdOn": "07/24/2018 03:05 AM US/Eastern", "modifiedBy": null, "modifiedOn": null, "effectiveDate": "07/24/2018 12:00 AM US/Eastern", "unitCost": 100 } ], "FutureUnitCost": [] }
Failure	Unexpected error `Schema` : Result

Success

Response contain unit cost of rate card.

Sample JSON


Response Sample :
{
  "CurrentUnitCost": {
    "id": 43,
    "rateCard": {
      "id": 39,
      "account": null,
      "client": null,
      "createdBy": 0,
      "createdOn": null,
      "modifiedBy": null,
      "modifiedOn": null,
      "state": 0,
      "title": null,
      "description": null,
      "sortOrder": null,
      "effectiveDate": null,
      "unitCost": null
    },
    "createdBy": 0,
    "createdOn": null,
    "modifiedBy": null,
    "modifiedOn": null,
    "effectiveDate": "07/24/2018 12:00 AM  US/Eastern",
    "unitCost": 100
  },
  "OldUnitCost": [
    {
      "id": 43,
      "rateCard": null,
      "createdBy": 29000,
      "createdOn": "07/24/2018 03:05 AM  US/Eastern",
      "modifiedBy": null,
      "modifiedOn": null,
      "effectiveDate": "07/24/2018 12:00 AM  US/Eastern",
      "unitCost": 100
    }
  ],
  "FutureUnitCost": []
}

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=AddClientRateCardUnitCost

GET /rateCard.do?cmd=AddClientRateCardUnitCost

Rate Card

Summary

Add client rate card unit cost.

Description

Add client rate card unit cost.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

rateCardId

query

Provide rate card id.

Yes

integer

clientId

query

Provide clientId related to rate card.

Yes

integer

effectiveDate

query

Provide effective date for rate card.

Yes

string (date)

unitCost

query

Provide unit cost.

Yes

integer

Responses

Response Type Description

Response Type	Description
Success	Rate card unit cost added. `Schema` : Result
Failure	Unexpected error `Schema` : Result

Success

Rate card unit cost added.

Schema : Result

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=DeleteClientRateCardUnitCost

GET /rateCard.do?cmd=DeleteClientRateCardUnitCost

Rate Card

Summary

Delete client rate card unit cost.

Description

Delete client rate card unit cost.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide clientId related to rate card.

Yes

integer

rateCardUnitCostId

query

Provide rate card unit cost id.

Yes

integer

Responses

Response Type Description

Success

Rate card unit cost deleted.

Schema : Result

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=AddClientRateCard

GET /rateCard.do?cmd=AddClientRateCard

Rate Card

Summary

Add client Rate Card.

Description

Add client rate Card.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

title

query

Provide title for rate card.

Yes

string

description

query

Provide rate card description.

Object

string

clientId

query

Provide clientId related to rate card.

Yes

integer

effectiveDate

query

Provide effective date for rate card.

Yes

string (date)

unitCost

query

Provide unit cost.

Yes

integer

Responses

Response Type Description

Success

Schema : Result

Response contain customParams, It provide client rate card Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_rateCard_success_addRateCard",
  "detailedMessage": "Rate card added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "E94963C5A926BFF8AFA666",
  "customParams": {
    "clientRateCardId": 95
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=UpdateAccountRateCardSortOrder

GET /rateCard.do?cmd=UpdateAccountRateCardSortOrder

Rate Card

Summary

Update Account Rate Card Sort Order.

Description

Update Account Rate Card Sort Order.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

rateCardId

query

Provide rate card id.

Yes

integer

Responses

Response Type Description

Success

Rate card sorted.

Schema : Result

Failure

Unexpected error

Schema : Result

/rateCard.do?cmd=UpdateClientRateCardSortOrder.

GET /rateCard.do?cmd=UpdateClientRateCardSortOrder.

Rate Card

Summary

Update Client Rate Card Sort Order.

Description

Update Client Rate Card Sort Order.

Access

Client Admin+

Parameters

Name

Located in

Description

Required

Schema

clientId

query

Provide clientId related to rate card.

Yes

integer

rateCardId

query

Provide rate card id.

Yes