Introduction:
Our PlanStreet api follows restful api structure. In client-server communication, Rest suggest to create an object of the data requested by the client and send the values of the object in response to the user.
API Method Types:
• Post• Get
• Put
• Delete
Authentication:
All users must be authenticated if they want to send any request to the PlanStreet endpoint. Successful authentication request would result in a token which will be used to validate the requests. Token validity is 24 hours.
How to authentication:
1- Hit URL in your browser address bar with this string https://apidemo.planstreetinc.com/.2- Use “Generate Token” endpoint to get access token.
3- Copy access token value to use in authorize header.
4- Click on authorize button and in value box type “Bearer {access_token}”. (Note: After bearer you need to add space then write access token value.)
5- Click on endpoint and populate request payload to get results.
Cases:
Case is a main entity around PlanStreet works. You can manage cases, activates of those cases, assign activity to worker, to track worked hours of a worker under each assigned activity to him/her etc.
PlanStreet case management follows agile methodology. A case contains new activities, programs and both have multiple activities. All activities on case dashboard should be of active program.
The API allows you to create case or sprint, delete and update to them. You can retrieve individual case as well as list of all your cases.
ENDPOINTS: GET: api/Case/GetAllCases?WorkerId=int_value GET: api/Case/GetCaseById?CaseId=int_value POST: api/Case/AddCase?WorkerId=int_value&CaseManagementViewModel=obj_value POST: api/Case/UpdateCase?CaseManagementViewModel=obj_value POST: api/Case/DeleteCaseById?CaseId=int_value GET: api/Case/GetCaseProgramsByCaseId?CaseId=int_value POST: api/Case/CreateProgram?ProgramViewModel=obj_val&WorkerId=int_value POST: api/Case/UpdateProgram?WorkerId=int_value&CaseManagementViewModel=obj_value POST: api/Case/DeleteProgram?ProgramId=int_value
Case Object:
API Route Path: A api/Case/GetCaseByIdAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: Unique id of a case per record.
Response:
[{
"hrCalendar": null,
"TaskManagement": [],
"ProjectId": xxxx,
"Budget": null,
"LinkProjectId": null,
"IsArchive": false,
"IncidentDate": null,
"SOL": null,
"SOLSatisfied": false,
"DaysWarning": false,
"ReferredFrom": null,
"ReferredTo": null,
"ContractAmount": null,
"Caption": "xxxx xxxx xxxx",
"Description": "",
"StartDate": "1900-01-01T00:00:00",
"DueDate": null,
"ProjectDueDate": null,
"ProjectTrackingNumber": "xxxx_xxxxxxxxxx",
"ProjectTemplateId": 0,
"TeamId": null,
"CustomerId": null,
"DepartmentId": 0,
"ProjectCategoryId": 0,
"ProjectTypeId": 0,
"ProjectPhaseId": 0,
"ProjectHealthId": 1,
"PublishedFlag": true,
"PercentComplete": 0.00,
"BudgetHours": null,
"BudgetLaborCost": null,
"BudgetCapitalCost": null,
"ForecastHours": null,
"ForecastLaborCost": null,
"ForecastCapitalCost": null,
"ForecastExpenses": null,
"ActualHours": null,
"ActualLaborCost": null,
"ActualCapitalCost": null,
"ActualExpenses": null,
"CreationTime": "1900-01-01T04:18:40.643",
"UpdationTime": "1900-01-01T04:18:40.643",
"Creator": 0000,
"Updater": null,
"RemoteHost": "xxx.xxx.xx.xxx",
"status": true,
"CalendarId": 0
}]
List All Cases:
API Route Path: api/Case/GetAllCasesAPI Method: Get
Parameters:
1 - Name: WorkerId,
Data type: int,
Description: A key to get all case per worker.
Response:
[
{
"ProjectId": 8405,
"ProjectURL": "xxx/xxxx/xxxx",
"ProjectTrackingNumber": "xxx_xxxxxxxxxxxx",
"StartDate": "Jan 01, 1900",
"DueDate": null,
"EndDate": " Jan 01, 1900",
"Team": " xxxx xxxx xxxx",
"NoOfTasks": 0,
"NoOfMilestones": 0,
"NoOfPhases": 0,
"PercentComplete": 0.00,
"ActualBudget": null,
"ForecastBudget": 0.00,
"LinkProjectId": null,
"IsArchive": false,
"LinkProjectCaption": null,
"Customer": "",
"Department": null,
"ProjectCategory": null,
"ProjectType": "Traditional",
"ProjectPhase": null,
"ProjectHealth": "xxxx",
"Caption": "xxx xxx xxxx",
"Description": "",
"ProjectTemplateId": 0,
"TeamId": null,
"DepartmentId": 0,
"ProjectCategoryId": 0,
"ProjectTypeId": 0,
"ProjectPhaseId": 0,
"ProjectHealthId": 0,
"BudgetHours": 0.00,
"BudgetLaborCost": 0.00,
"BudgetCapitalCost": 0.00,
"ForecastHours": 0.00,
"ForecastLaborCost": 0.00,
"ForecastCapitalCost": 0.00,
"ForecastExpenses": 0.00,
"ActualHours": 0.00,
"ActualLaborCost": 0.00,
"ActualCapitalCost": 0.00,
"ActualExpenses": 0.00,
"status": "Active",
"PublishedFlag": "Yes",
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-01-01T00:00:00.000",
"Creator": 0000,
"Updater": null,
"RemoteHost": "xxx.xxx.xx.xxx",
"ImageURL": null,
"SOL": null,
"SOLSatisfied": "No",
"DaysWarning": false,
"ReferredFrom": null,
"ReferredTo": null,
"ClientName": null,
"ClientDOB": null,
"SSN": null,
"Address": null,
"CityName": null,
"StateName": null,
"ZipCode": null,
"Email": null,
"EmergencyContactName": null,
"EmergencyContactNo": null,
"EmergencyContactEmail": null,
"Gender": null,
"MaritalStatus": null,
"PreferredLanguage": null,
"Race": null,
"Ethnicity": null,
"Income": null,
"InsuranceProvider": null,
"PolicyNo": null,
"MedicareNo": null,
"GroupNo": null,
"HolderName": null,
"HolderRelationshipToClient": null,
"ClientDate": null,
"CaseDescription": null,
"Comments": null,
"Replies": null,
"EducationLevel": null,
"Veteran": "No",
"Disabled": "No",
"InsuranceNotes": null,
"MotherName": null,
"MotherContact": null,
"MotherAddress": null,
"FatherName": null,
"FatherContact": null,
"FatherAddress": null,
"GaurdianName": null,
"GaurdianContact": null,
"GaurdianAddress": null,
"ShelterPlusCare": 0.00,
"ESGCountySubsidy": null,
"MISSCovidSubsidy": null,
"HMIS": "No",
"AHP": "No",
"EmergencyContactRelationship": null,
"HouseholdFamilysize": null,
"HouseholdLeasestart": null,
"HouseholdLeaseEnd": null,
"HouseholdBedOrBath": null,
"HouseholdIncome": null,
"HouseholdMarketRent": null,
"HouseholdResidentRent": null,
"HouseholdUtilitiesIncluded": "No",
"SourceOfIncome": null,
"IncomeQualifyLevel": null
},
{
"ProjectId": 8405,
"ProjectURL": "xxx/xxxx/xxxx",
"ProjectTrackingNumber": "xxx_xxxxxxxxxxxx",
"StartDate": "Jan 01, 1900",
"DueDate": null,
"EndDate": " Jan 01, 1900",
"Team": " xxxx xxxx xxxx",
"NoOfTasks": 0,
"NoOfMilestones": 0,
"NoOfPhases": 0,
"PercentComplete": 0.00,
"ActualBudget": null,
"ForecastBudget": 0.00,
"LinkProjectId": null,
"IsArchive": false,
"LinkProjectCaption": null,
"Customer": "",
"Department": null,
"ProjectCategory": null,
"ProjectType": "Traditional",
"ProjectPhase": null,
"ProjectHealth": "xxxx",
"Caption": "xxx xxx xxxx",
"Description": "",
"ProjectTemplateId": 0,
"TeamId": null,
"DepartmentId": 0,
"ProjectCategoryId": 0,
"ProjectTypeId": 0,
"ProjectPhaseId": 0,
"ProjectHealthId": 0,
"BudgetHours": 0.00,
"BudgetLaborCost": 0.00,
"BudgetCapitalCost": 0.00,
"ForecastHours": 0.00,
"ForecastLaborCost": 0.00,
"ForecastCapitalCost": 0.00,
"ForecastExpenses": 0.00,
"ActualHours": 0.00,
"ActualLaborCost": 0.00,
"ActualCapitalCost": 0.00,
"ActualExpenses": 0.00,
"status": "Active",
"PublishedFlag": "Yes",
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-01-01T00:00:00.000",
"Creator": 0000,
"Updater": null,
"RemoteHost": "xxx.xxx.xx.xxx",
"ImageURL": null,
"SOL": null,
"SOLSatisfied": "No",
"DaysWarning": false,
"ReferredFrom": null,
"ReferredTo": null,
"ClientName": null,
"ClientDOB": null,
"SSN": null,
"Address": null,
"CityName": null,
"StateName": null,
"ZipCode": null,
"Email": null,
"EmergencyContactName": null,
"EmergencyContactNo": null,
"EmergencyContactEmail": null,
"Gender": null,
"MaritalStatus": null,
"PreferredLanguage": null,
"Race": null,
"Ethnicity": null,
"Income": null,
"InsuranceProvider": null,
"PolicyNo": null,
"MedicareNo": null,
"GroupNo": null,
"HolderName": null,
"HolderRelationshipToClient": null,
"ClientDate": null,
"CaseDescription": null,
"Comments": null,
"Replies": null,
"EducationLevel": null,
"Veteran": "No",
"Disabled": "No",
"InsuranceNotes": null,
"MotherName": null,
"MotherContact": null,
"MotherAddress": null,
"FatherName": null,
"FatherContact": null,
"FatherAddress": null,
"GaurdianName": null,
"GaurdianContact": null,
"GaurdianAddress": null,
"ShelterPlusCare": 0.00,
"ESGCountySubsidy": null,
"MISSCovidSubsidy": null,
"HMIS": "No",
"AHP": "No",
"EmergencyContactRelationship": null,
"HouseholdFamilysize": null,
"HouseholdLeasestart": null,
"HouseholdLeaseEnd": null,
"HouseholdBedOrBath": null,
"HouseholdIncome": null,
"HouseholdMarketRent": null,
"HouseholdResidentRent": null,
"HouseholdUtilitiesIncluded": "No",
"SourceOfIncome": null,
"IncomeQualifyLevel": null
},
{
"ProjectId": 8405,
"ProjectURL": "xxx/xxxx/xxxx",
"ProjectTrackingNumber": "xxx_xxxxxxxxxxxx",
"StartDate": "Jan 01, 1999",
"DueDate": null,
"EndDate": " Jan 01, 1999",
"Team": " xxxx xxxx xxxx",
"NoOfTasks": 0,
"NoOfMilestones": 0,
"NoOfPhases": 0,
"PercentComplete": 0.00,
"ActualBudget": null,
"ForecastBudget": 0.00,
"LinkProjectId": null,
"IsArchive": false,
"LinkProjectCaption": null,
"Customer": "",
"Department": null,
"ProjectCategory": null,
"ProjectType": "Traditional",
"ProjectPhase": null,
"ProjectHealth": "xxxx",
"Caption": "xxx xxx xxxx",
"Description": "",
"ProjectTemplateId": 0,
"TeamId": null,
"DepartmentId": 0,
"ProjectCategoryId": 0,
"ProjectTypeId": 0,
"ProjectPhaseId": 0,
"ProjectHealthId": 0,
"BudgetHours": 0.00,
"BudgetLaborCost": 0.00,
"BudgetCapitalCost": 0.00,
"ForecastHours": 0.00,
"ForecastLaborCost": 0.00,
"ForecastCapitalCost": 0.00,
"ForecastExpenses": 0.00,
"ActualHours": 0.00,
"ActualLaborCost": 0.00,
"ActualCapitalCost": 0.00,
"ActualExpenses": 0.00,
"status": "Active",
"PublishedFlag": "Yes",
"CreationTime": "1999-01-01T00:00:00.000",
"UpdationTime": "1999-01-01T00:00:00.000",
"Creator": 0000,
"Updater": null,
"RemoteHost": "xxx.xxx.xx.xxx",
"ImageURL": null,
"SOL": null,
"SOLSatisfied": "No",
"DaysWarning": false,
"ReferredFrom": null,
"ReferredTo": null,
"ClientName": null,
"ClientDOB": null,
"SSN": null,
"Address": null,
"CityName": null,
"StateName": null,
"ZipCode": null,
"Email": null,
"EmergencyContactName": null,
"EmergencyContactNo": null,
"EmergencyContactEmail": null,
"Gender": null,
"MaritalStatus": null,
"PreferredLanguage": null,
"Race": null,
"Ethnicity": null,
"Income": null,
"InsuranceProvider": null,
"PolicyNo": null,
"MedicareNo": null,
"GroupNo": null,
"HolderName": null,
"HolderRelationshipToClient": null,
"ClientDate": null,
"CaseDescription": null,
"Comments": null,
"Replies": null,
"EducationLevel": null,
"Veteran": "No",
"Disabled": "No",
"InsuranceNotes": null,
"MotherName": null,
"MotherContact": null,
"MotherAddress": null,
"FatherName": null,
"FatherContact": null,
"FatherAddress": null,
"GaurdianName": null,
"GaurdianContact": null,
"GaurdianAddress": null,
"ShelterPlusCare": 0.00,
"ESGCountySubsidy": null,
"MISSCovidSubsidy": null,
"HMIS": "No",
"AHP": "No",
"EmergencyContactRelationship": null,
"HouseholdFamilysize": null,
"HouseholdLeasestart": null,
"HouseholdLeaseEnd": null,
"HouseholdBedOrBath": null,
"HouseholdIncome": null,
"HouseholdMarketRent": null,
"HouseholdResidentRent": null,
"HouseholdUtilitiesIncluded": "No",
"SourceOfIncome": null,
"IncomeQualifyLevel": null
},
{
"ProjectId": 8405,
"ProjectURL": "xxx/xxxx/xxxx",
"ProjectTrackingNumber": "xxx_xxxxxxxxxxxx",
"StartDate": "Jan 01, 1999",
"DueDate": null,
"EndDate": "Jan 01, 1999",
"Team": " xxxx xxxx xxxx",
"NoOfTasks": 0,
"NoOfMilestones": 0,
"NoOfPhases": 0,
"PercentComplete": 0.00,
"ActualBudget": null,
"ForecastBudget": 0.00,
"LinkProjectId": null,
"IsArchive": false,
"LinkProjectCaption": null,
"Customer": "",
"Department": null,
"ProjectCategory": null,
"ProjectType": "Traditional",
"ProjectPhase": null,
"ProjectHealth": "xxxx",
"Caption": "xxx xxx xxxx",
"Description": "",
"ProjectTemplateId": 0,
"TeamId": null,
"DepartmentId": 0,
"ProjectCategoryId": 0,
"ProjectTypeId": 0,
"ProjectPhaseId": 0,
"ProjectHealthId": 0,
"BudgetHours": 0.00,
"BudgetLaborCost": 0.00,
"BudgetCapitalCost": 0.00,
"ForecastHours": 0.00,
"ForecastLaborCost": 0.00,
"ForecastCapitalCost": 0.00,
"ForecastExpenses": 0.00,
"ActualHours": 0.00,
"ActualLaborCost": 0.00,
"ActualCapitalCost": 0.00,
"ActualExpenses": 0.00,
"status": "Active",
"PublishedFlag": "Yes",
"CreationTime": "1999-01-01T00:00:00.000",
"UpdationTime": "1999-01-01T00:00:00.000",
"Creator": 0000,
"Updater": null,
"RemoteHost": "xxx.xxx.xx.xxx",
"ImageURL": null,
"SOL": null,
"SOLSatisfied": "No",
"DaysWarning": false,
"ReferredFrom": null,
"ReferredTo": null,
"ClientName": null,
"ClientDOB": null,
"SSN": null,
"Address": null,
"CityName": null,
"StateName": null,
"ZipCode": null,
"Email": null,
"EmergencyContactName": null,
"EmergencyContactNo": null,
"EmergencyContactEmail": null,
"Gender": null,
"MaritalStatus": null,
"PreferredLanguage": null,
"Race": null,
"Ethnicity": null,
"Income": null,
"InsuranceProvider": null,
"PolicyNo": null,
"MedicareNo": null,
"GroupNo": null,
"HolderName": null,
"HolderRelationshipToClient": null,
"ClientDate": null,
"CaseDescription": null,
"Comments": null,
"Replies": null,
"EducationLevel": null,
"Veteran": "No",
"Disabled": "No",
"InsuranceNotes": null,
"MotherName": null,
"MotherContact": null,
"MotherAddress": null,
"FatherName": null,
"FatherContact": null,
"FatherAddress": null,
"GaurdianName": null,
"GaurdianContact": null,
"GaurdianAddress": null,
"ShelterPlusCare": 0.00,
"ESGCountySubsidy": null,
"MISSCovidSubsidy": null,
"HMIS": "No",
"AHP": "No",
"EmergencyContactRelationship": null,
"HouseholdFamilysize": null,
"HouseholdLeasestart": null,
"HouseholdLeaseEnd": null,
"HouseholdBedOrBath": null,
"HouseholdIncome": null,
"HouseholdMarketRent": null,
"HouseholdResidentRent": null,
"HouseholdUtilitiesIncluded": "No",
"SourceOfIncome": null,
"IncomeQualifyLevel": null
}]
Create Case:
API Route Path: api/Case/AddCaseAPI Method: Post
Parameters:
1 - Name: WorkerId,
Data type: int,
Description: A key to store case per worker
2 - Name: CaseManagementViewModel,
Data type: object,
Description: An object of case that needs to add into database.
Response:
Response:
[{
"result": true,
"sc": xxxx,
"obj1": 0,
"Message": "Data saved successfully.",
}]
Update Case:
API Route Path: api/Case/UpdateCaseAPI Method: Post
Parameters:
1 - Name: CaseManagementViewModel,
Data type: object,
Description: An object of case that needs to update into database.
Response:
[{
"result": true,
"sc": xxxx,
"obj1": 0,
"Message": "Data updated successfully.",
}]
Delete Case:
API Route Path: api/Case/DeleteCaseByIdAPI Method: Post
Parameters:
1 - Name: CaseId,
Data type: int,
Description: Unique id of a case per record.
Response:
[{
"result": true,
"sc": xxxx,
"obj1": 0,
"Message": "Data deleted successfully.",
}]
List All Programs by Case Id:
API Route Path: api/Case/GetCaseProgramsByCaseIdAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: Unique id of a case per record.
Response:
[
{
"SprintId": xxxx,
"Caption": "xxxx xxxxx"
},
{
"SprintId": xxxx,
"Caption": "xxxx xxxxx"
}
]
Create Program:
API Route Path: api/Case/CreateProgramAPI Method: Post
Parameters:
1 - Name: ProgramViewModel,
Data type: object,
Description: An object of program that needs to add into database.
2 - Name: WorkerId,
Data type: int,
Description: A key to store program per worker
Response:
[{
"isValid": true,
"isProgramNameAlreadyTaken": false,
"screen": xxxx,
"response_program": object,
}]
Update Program:
API Route Path: api/Case/UpdateProgramAPI Method: Post
Parameters:
1 - Name: WorkerId,
Data type: int,
Description: A key to store program per worker
2 - Name: ProgramViewModel,
Data type: object,
Description: An object of program that needs to update into database.
Response:
[{
"result": true,
"sc": xxxx,
"obj1": 0,
"Message": "Data updated successfully.",
}]
Delete Program:
API Route Path: api/Case/DeleteProgramAPI Method: Post
Parameters:
1 - Name: ProgramId,
Data type: int,
Description: Unique id of a program per record.
Response:
[{
"success": true,
"error_message": "",
}]
Activities:
Activity is a particular task on which a worker assumed to work under a specific time span.
At the time of assignment, an activity has “To Do” status. Worker can change status with the progress of that activity.
ENDPOINTS: GET: api/Activity/GetActivityByCaseId?CaseId=int_value GET: api/Activity/GetActivityDetail?ActivityId=int_value GET: api/Activity/GetActivitiesWithNoChildByCaseId?id=int_value GET: api/Activity/GetWorkerAssignedActivity?caseID=int_value&workerId=int_value GET: api/Activity/InsertActivity?Caption=str_value&Date=str_value &ActivityType=str_value&ParentActivityId=int_value&Priority=int_value &Workers=str_value&CaseId=int_value&StartDate=str_value&EndDate=str_value &Description=str_value&Creator=int_value POST: api/Activity/UpdateActivityManagement?AddActivityDto=obj_value POST: api/Activity/DeleteActivity?ActivityId=int_value
Activity Object by Case:
API Route Path: api/Activity/GetActivityByCaseIdAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
Response:
[{
"TaskId": xxxx,
"Caption": xxxx,
"Description": xxxx,
"PlannedStartDate": "Jan 01, 1900",
"PlannedCompletionDate": "Jan 01, 1900",
"ActualStartDate": "Jan 01, 1900",
"ActualCompletionDate": "Jan 01, 1900",
"DueDate": "Jan 01, 1900",
"EndDate": "Jan 01, 1900",
"SequenceNumber": xxxx,
"SubSequenceNumber": xxxx,
"Duration": xxxx,
"FixedCost": xx,xxx.xx,
"FixedRevenue": null,
"ForecastFixedCost": xx,xxx.xx,
"ForecastFixedRevenue": xx,xxx.xx,
"PriorityId": 0,
"TaskStatusId": null,
"TaskCategoryId": null,
"TaskTypeId": 0,
"FrontEndTaskTypeId": 0,
"BackendTaskTypeId": 0,
"TaskConstraintId": 0,
"TaskCostTypeId": 0,
"TaskRevenueTypeId": 0,
"TaskPredecessorsId": 0,
"TaskSuccessorsId": 0,
"BudgetCost": 1,
"HoursBudget": null,
"EstimatedHours": 0.00,
"EstimatedCost": null,
"TaskExpenseTypeId": null,
"Estimated": null,
"Actual": null,
"ManuallyScheduled": null,
"PercentCompleteTask": null,
"ProjectId": null,
"TaskDurationTypeId": null,
"ParentTaskId": null,
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-01-01T00:00:00.00",
"Creator": null,
"Updater": null,
"RemoteHost": "xxx.xxx.xx.xxx",
"status": true,
"IsBillable": false,
"IsImport": false,
"IsBacklog": false,
"IsDelayed": false,
"CostTypeId": 0,
"SprintId": 0,
}]
Activity Object:
API Route Path: api/Activity/GetActivityDetailAPI Method: Get
Parameters:
1 - Name: ActivityId,
Data type: int,
Description: Unique id of an activity per record.
Response:
[{
"TaskId": xxxx,
"Caption": xxxx,
"Description": xxxx,
"PlannedStartDate": "Jan 01, 1900",
"PlannedCompletionDate": "Jan 01, 1900",
"ActualStartDate": "Jan 01, 1900",
"ActualCompletionDate": "Jan 01, 1900",
"DueDate": "Jan 01, 1900",
"EndDate": "Jan 01, 1900",
"SequenceNumber": xxxx,
"SubSequenceNumber": xxxx,
"Duration": xxxx,
"FixedCost": xx,xxx.xx,
"FixedRevenue": null,
"ForecastFixedCost": xx,xxx.xx,
"ForecastFixedRevenue": xx,xxx.xx,
"PriorityId": 0,
"TaskStatusId": null,
"TaskCategoryId": null,
"TaskTypeId": 0,
"FrontEndTaskTypeId": 0,
"BackendTaskTypeId": 0,
"TaskConstraintId": 0,
"TaskCostTypeId": 0,
"TaskRevenueTypeId": 0,
"TaskPredecessorsId": 0,
"TaskSuccessorsId": 0,
"BudgetCost": 1,
"HoursBudget": null,
"EstimatedHours": 0.00,
"EstimatedCost": null,
"TaskExpenseTypeId": null,
"Estimated": null,
"Actual": null,
"ManuallyScheduled": null,
"PercentCompleteTask": null,
"ProjectId": null,
"TaskDurationTypeId": null,
"ParentTaskId": null,
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-01-01T00:00:00.000",
"Creator": null,
"Updater": null,
"RemoteHost": "xxx.xxx.xx.xxx",
"status": true,
"IsBillable": false,
"IsImport": false,
"IsBacklog": false,
"IsDelayed": false,
"CostTypeId": 0,
"SprintId": 0,
}]
List All Activities Without Child Activities:
API Route Path: api/Activity/GetActivitiesWithNoChildByCaseIdAPI Method: Get
Parameters:
1 - Name: id,
Data type: int,
Description: A key to get data per case.
Response:
[
{
"CMS_PLAN_Admin": null,
"CMS_PLAN_Admin1": null,
"Link": [],
"Link1": [],
"ProjectManagement": null,
"RAIDLog": [],
"TaskBacklogTypes": [],
"TaskCheckList": [],
"TaskFavourites": [],
"TaskLinkingStreetBoards": [],
"TaskPredecessor": null,
"TaskPriority": null,
"TaskResource": [],
"TaskSprintHistories": [],
"TaskSprintTypes": [],
"TaskStatus": null,
"TaskType": null,
"TaskType1": null,
"TaskType2": null,
"TimeSheetDetail": [],
"TaskId": xxxx,
"Caption": "xxx",
"Description": "xxx+xxxxxxxxxx==",
"PlannedStartDate": "1900-01-01T00:00:00",
"PlannedCompletionDate": "1900-01-01T00:00:00",
"ActualStartDate": null,
"ActualCompletionDate": null,
"DueDate": null,
"EndDate": null,
"SequenceNumber": xxxxx,
"SubSequenceNumber": null,
"Duration": 0.00,
"FixedCost": null,
"FixedRevenue": null,
"ForeCastFixedCost": null,
"ForeCastFixedRevenue": null,
"PriorityId": 1,
"TaskStatusId": 1,
"TaskCategoryId": 0,
"TaskTypeId": 2,
"FrontEndTaskTypeId": 2,
"BackEndTaskTypeId": 2,
"TaskFrequencyId": 0,
"TaskConstraintId": 0,
"TaskCostTypeId": 0,
"TaskRevenueTypeId": 0,
"TaskPredecessorsId": null,
"TaskSuccessorsId": 0,
"BudgetCost": null,
"HoursBudget": null,
"EstimatedHours": 000.00,
"EstimatedCost": null,
"TaskExpenseTypeId": 0,
"Estimated": null,
"Actual": null,
"ManuallyScheduled": false,
"PercentCompleteTask": 0.00,
"ProjectId": 0000,
"TaskDurationTypeId": null,
"ParentTaskId": 0000,
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-01-01T00:00:00.00",
"Creator": 0000,
"Updater": null,
"RemoteHost": "xxx.xxx.x.xxx",
"status": true,
"IsBillable": true,
"IsImport": false,
"IsBacklog": true,
"IsDelayed": true,
"CostTypeId": 0,
"SprintId": null,
"StoryPoints": 0.00
},
{
"CMS_PLAN_Admin": null,
"CMS_PLAN_Admin1": null,
"Link": [],
"Link1": [],
"ProjectManagement": null,
"RAIDLog": [],
"TaskBacklogTypes": [],
"TaskCheckList": [],
"TaskFavourites": [],
"TaskLinkingStreetBoards": [],
"TaskPredecessor": null,
"TaskPriority": null,
"TaskResource": [],
"TaskSprintHistories": [],
"TaskSprintTypes": [],
"TaskStatus": null,
"TaskType": null,
"TaskType1": null,
"TaskType2": null,
"TimeSheetDetail": [],
"TaskId": xxxx,
"Caption": "xxx",
"Description": "xxx+xxxxxxxxxx==",
"PlannedStartDate": "1900-01-01T00:00:00",
"PlannedCompletionDate": "1900-01-01T00:00:00",
"ActualStartDate": null,
"ActualCompletionDate": null,
"DueDate": null,
"EndDate": null,
"SequenceNumber": xxxxx,
"SubSequenceNumber": null,
"Duration": 0.00,
"FixedCost": null,
"FixedRevenue": null,
"ForeCastFixedCost": null,
"ForeCastFixedRevenue": null,
"PriorityId": 1,
"TaskStatusId": 1,
"TaskCategoryId": 0,
"TaskTypeId": 2,
"FrontEndTaskTypeId": 2,
"BackEndTaskTypeId": 2,
"TaskFrequencyId": 0,
"TaskConstraintId": 0,
"TaskCostTypeId": 0,
"TaskRevenueTypeId": 0,
"TaskPredecessorsId": null,
"TaskSuccessorsId": 0,
"BudgetCost": null,
"HoursBudget": null,
"EstimatedHours": 000.00,
"EstimatedCost": null,
"TaskExpenseTypeId": 0,
"Estimated": null,
"Actual": null,
"ManuallyScheduled": false,
"PercentCompleteTask": 0.00,
"ProjectId": 0000,
"TaskDurationTypeId": null,
"ParentTaskId": 0000,
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-01-01T00:00:00.00",
"Creator": 0000,
"Updater": null,
"RemoteHost": "xxx.xxx.x.xxx",
"status": true,
"IsBillable": true,
"IsImport": false,
"IsBacklog": true,
"IsDelayed": true,
"CostTypeId": 0,
"SprintId": null,
"StoryPoints": 0.00
},
{
"CMS_PLAN_Admin": null,
"CMS_PLAN_Admin1": null,
"Link": [],
"Link1": [],
"ProjectManagement": null,
"RAIDLog": [],
"TaskBacklogTypes": [],
"TaskCheckList": [],
"TaskFavourites": [],
"TaskLinkingStreetBoards": [],
"TaskPredecessor": null,
"TaskPriority": null,
"TaskResource": [],
"TaskSprintHistories": [],
"TaskSprintTypes": [],
"TaskStatus": null,
"TaskType": null,
"TaskType1": null,
"TaskType2": null,
"TimeSheetDetail": [],
"TaskId": xxxx,
"Caption": "xxx",
"Description": "xxx+xxxxxxxxxx==",
"PlannedStartDate": "1900-01-01T00:00:00",
"PlannedCompletionDate": "1900-01-01T00:00:00",
"ActualStartDate": null,
"ActualCompletionDate": null,
"DueDate": null,
"EndDate": null,
"SequenceNumber": xxxxx,
"SubSequenceNumber": null,
"Duration": 0.00,
"FixedCost": null,
"FixedRevenue": null,
"ForeCastFixedCost": null,
"ForeCastFixedRevenue": null,
"PriorityId": 1,
"TaskStatusId": 1,
"TaskCategoryId": 0,
"TaskTypeId": 2,
"FrontEndTaskTypeId": 2,
"BackEndTaskTypeId": 2,
"TaskFrequencyId": 0,
"TaskConstraintId": 0,
"TaskCostTypeId": 0,
"TaskRevenueTypeId": 0,
"TaskPredecessorsId": null,
"TaskSuccessorsId": 0,
"BudgetCost": null,
"HoursBudget": null,
"EstimatedHours": 000.00,
"EstimatedCost": null,
"TaskExpenseTypeId": 0,
"Estimated": null,
"Actual": null,
"ManuallyScheduled": false,
"PercentCompleteTask": 0.00,
"ProjectId": 0000,
"TaskDurationTypeId": null,
"ParentTaskId": 0000,
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-01-01T00:00:00.00",
"Creator": 0000,
"Updater": null,
"RemoteHost": "xxx.xxx.x.xxx",
"status": true,
"IsBillable": true,
"IsImport": false,
"IsBacklog": true,
"IsDelayed": true,
"CostTypeId": 0,
"SprintId": null,
"StoryPoints": 0.00
}
]
List All Worker Assigned Activities:
API Route Path: api/Activity/GetWorkerAssignedActivityAPI Method: Get
Parameters:
1 - Name: caseId,
Data type: int,
Description: A key to get data per case.
2 - Name: workerId,
Data type: int,
Description: A key to get data per worker.
Response:
[
{
"CMS_PLAN_Admin": null,
"CMS_PLAN_Admin1": null,
"Link": [],
"Link1": [],
"ProjectManagement": null,
"RAIDLog": [],
"TaskBacklogTypes": [],
"TaskCheckList": [],
"TaskFavourites": [],
"TaskLinkingStreetBoards": [],
"TaskPredecessor": null,
"TaskPriority": null,
"TaskResource": [],
"TaskSprintHistories": [],
"TaskSprintTypes": [],
"TaskStatus": null,
"TaskType": null,
"TaskType1": null,
"TaskType2": null,
"TimeSheetDetail": [],
"TaskId": xxxx,
"Caption": "xxx",
"Description": "xxx+xxxxxxxxxx==",
"PlannedStartDate": "1900-01-01T00:00:00.000",
"PlannedCompletionDate": "1900-01-01T00:00:00.000",
"ActualStartDate": null,
"ActualCompletionDate": null,
"DueDate": null,
"EndDate": null,
"SequenceNumber": xxxxx,
"SubSequenceNumber": null,
"Duration": 0.00,
"FixedCost": null,
"FixedRevenue": null,
"ForeCastFixedCost": null,
"ForeCastFixedRevenue": null,
"PriorityId": 1,
"TaskStatusId": 1,
"TaskCategoryId": 0,
"TaskTypeId": 2,
"FrontEndTaskTypeId": 2,
"BackEndTaskTypeId": 2,
"TaskFrequencyId": 0,
"TaskConstraintId": 0,
"TaskCostTypeId": 0,
"TaskRevenueTypeId": 0,
"TaskPredecessorsId": null,
"TaskSuccessorsId": 0,
"BudgetCost": null,
"HoursBudget": null,
"EstimatedHours": 000.00,
"EstimatedCost": null,
"TaskExpenseTypeId": 0,
"Estimated": null,
"Actual": null,
"ManuallyScheduled": false,
"PercentCompleteTask": 0.00,
"ProjectId": 0000,
"TaskDurationTypeId": null,
"ParentTaskId": 0000,
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-01-01T00:00:00.000",
"Creator": 0000,
"Updater": null,
"RemoteHost": "xxx.xxx.x.xxx",
"status": true,
"IsBillable": true,
"IsImport": false,
"IsBacklog": true,
"IsDelayed": true,
"CostTypeId": 0,
"SprintId": null,
"StoryPoints": 2.00
},
{
"CMS_PLAN_Admin": null,
"CMS_PLAN_Admin1": null,
"Link": [],
"Link1": [],
"ProjectManagement": null,
"RAIDLog": [],
"TaskBacklogTypes": [],
"TaskCheckList": [],
"TaskFavourites": [],
"TaskLinkingStreetBoards": [],
"TaskPredecessor": null,
"TaskPriority": null,
"TaskResource": [],
"TaskSprintHistories": [],
"TaskSprintTypes": [],
"TaskStatus": null,
"TaskType": null,
"TaskType1": null,
"TaskType2": null,
"TimeSheetDetail": [],
"TaskId": xxxx,
"Caption": "xxx",
"Description": "xxx+xxxxxxxxxx==",
"PlannedStartDate": "1900-01-01T00:00:00.000",
"PlannedCompletionDate": "1900-01-01T00:00:00.000",
"ActualStartDate": null,
"ActualCompletionDate": null,
"DueDate": null,
"EndDate": null,
"SequenceNumber": xxxxx,
"SubSequenceNumber": null,
"Duration": 0.00,
"FixedCost": null,
"FixedRevenue": null,
"ForeCastFixedCost": null,
"ForeCastFixedRevenue": null,
"PriorityId": 1,
"TaskStatusId": 1,
"TaskCategoryId": 0,
"TaskTypeId": 2,
"FrontEndTaskTypeId": 2,
"BackEndTaskTypeId": 2,
"TaskFrequencyId": 0,
"TaskConstraintId": 0,
"TaskCostTypeId": 0,
"TaskRevenueTypeId": 0,
"TaskPredecessorsId": null,
"TaskSuccessorsId": 0,
"BudgetCost": null,
"HoursBudget": null,
"EstimatedHours": 000.00,
"EstimatedCost": null,
"TaskExpenseTypeId": 0,
"Estimated": null,
"Actual": null,
"ManuallyScheduled": false,
"PercentCompleteTask": 0.00,
"ProjectId": 0000,
"TaskDurationTypeId": null,
"ParentTaskId": 0000,
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-01-01T00:00:00.000",
"Creator": 0000,
"Updater": null,
"RemoteHost": "xxx.xxx.x.xxx",
"status": true,
"IsBillable": true,
"IsImport": false,
"IsBacklog": true,
"IsDelayed": true,
"CostTypeId": 0,
"SprintId": null,
"StoryPoints": 2.00
},
{
"CMS_PLAN_Admin": null,
"CMS_PLAN_Admin1": null,
"Link": [],
"Link1": [],
"ProjectManagement": null,
"RAIDLog": [],
"TaskBacklogTypes": [],
"TaskCheckList": [],
"TaskFavourites": [],
"TaskLinkingStreetBoards": [],
"TaskPredecessor": null,
"TaskPriority": null,
"TaskResource": [],
"TaskSprintHistories": [],
"TaskSprintTypes": [],
"TaskStatus": null,
"TaskType": null,
"TaskType1": null,
"TaskType2": null,
"TimeSheetDetail": [],
"TaskId": xxxx,
"Caption": "xxx",
"Description": "xxx+xxxxxxxxxx==",
"PlannedStartDate": "1900-01-01T00:00:00.000",
"PlannedCompletionDate": "1900-01-01T00:00:00.000",
"ActualStartDate": null,
"ActualCompletionDate": null,
"DueDate": null,
"EndDate": null,
"SequenceNumber": xxxxx,
"SubSequenceNumber": null,
"Duration": 0.00,
"FixedCost": null,
"FixedRevenue": null,
"ForeCastFixedCost": null,
"ForeCastFixedRevenue": null,
"PriorityId": 1,
"TaskStatusId": 1,
"TaskCategoryId": 0,
"TaskTypeId": 2,
"FrontEndTaskTypeId": 2,
"BackEndTaskTypeId": 2,
"TaskFrequencyId": 0,
"TaskConstraintId": 0,
"TaskCostTypeId": 0,
"TaskRevenueTypeId": 0,
"TaskPredecessorsId": null,
"TaskSuccessorsId": 0,
"BudgetCost": null,
"HoursBudget": null,
"EstimatedHours": 000.00,
"EstimatedCost": null,
"TaskExpenseTypeId": 0,
"Estimated": null,
"Actual": null,
"ManuallyScheduled": false,
"PercentCompleteTask": 0.00,
"ProjectId": 0000,
"TaskDurationTypeId": null,
"ParentTaskId": 0000,
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-01-01T00:00:00.000",
"Creator": 0000,
"Updater": null,
"RemoteHost": "xxx.xxx.x.xxx",
"status": true,
"IsBillable": true,
"IsImport": false,
"IsBacklog": true,
"IsDelayed": true,
"CostTypeId": 0,
"SprintId": null,
"StoryPoints": 2.00
},
{
"CMS_PLAN_Admin": null,
"CMS_PLAN_Admin1": null,
"Link": [],
"Link1": [],
"ProjectManagement": null,
"RAIDLog": [],
"TaskBacklogTypes": [],
"TaskCheckList": [],
"TaskFavourites": [],
"TaskLinkingStreetBoards": [],
"TaskPredecessor": null,
"TaskPriority": null,
"TaskResource": [],
"TaskSprintHistories": [],
"TaskSprintTypes": [],
"TaskStatus": null,
"TaskType": null,
"TaskType1": null,
"TaskType2": null,
"TimeSheetDetail": [],
"TaskId": xxxx,
"Caption": "xxx",
"Description": "xxx+xxxxxxxxxx==",
"PlannedStartDate": "1900-01-01T00:00:00.000",
"PlannedCompletionDate": "1900-01-01T00:00:00.000",
"ActualStartDate": null,
"ActualCompletionDate": null,
"DueDate": null,
"EndDate": null,
"SequenceNumber": xxxxx,
"SubSequenceNumber": null,
"Duration": 0.00,
"FixedCost": null,
"FixedRevenue": null,
"ForeCastFixedCost": null,
"ForeCastFixedRevenue": null,
"PriorityId": 1,
"TaskStatusId": 1,
"TaskCategoryId": 0,
"TaskTypeId": 2,
"FrontEndTaskTypeId": 2,
"BackEndTaskTypeId": 2,
"TaskFrequencyId": 0,
"TaskConstraintId": 0,
"TaskCostTypeId": 0,
"TaskRevenueTypeId": 0,
"TaskPredecessorsId": null,
"TaskSuccessorsId": 0,
"BudgetCost": null,
"HoursBudget": null,
"EstimatedHours": 000.00,
"EstimatedCost": null,
"TaskExpenseTypeId": 0,
"Estimated": null,
"Actual": null,
"ManuallyScheduled": false,
"PercentCompleteTask": 0.00,
"ProjectId": 0000,
"TaskDurationTypeId": null,
"ParentTaskId": 0000,
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-01-01T00:00:00.000",
"Creator": 0000,
"Updater": null,
"RemoteHost": "xxx.xxx.x.xxx",
"status": true,
"IsBillable": true,
"IsImport": false,
"IsBacklog": true,
"IsDelayed": true,
"CostTypeId": 0,
"SprintId": null,
"StoryPoints": 2.00
}
]
Create Activity:
API Route Path: api/Activity/InsertActivityAPI Method: Get
Parameters:
1 - Name: Caption,
Data type: string,
Description: Name of activity.
2 - Name: Date,
Data type: string,
Description: Date parameter.
3 - Name: ActivityType,
Data type: int,
Description: Type of an activity e.g. milestone, activity, phase etc.
4 - Name: ParentActivityId,
Data type: int,
Description: Unique id of a parent case or activity.
5 - Name: PriorityId,
Data type: int,
Description: Priority e.g. high, low or medium.
6 - Name: Workers,
Data type: int,
Description: String array of worker ids to whom task assigned.
7 - Name: CaseId,
Data type: int,
Description: A key from case records.
8 - Name: StartDate,
Data type: int,
Description: Planned Start date on which worker needs to start activity.
9 - Name: EndDate,
Data type: int,
Description: Planned completion date of activity.
10 - Name: Description,
Data type: int,
Description: Description of an activity.
11 - Name: Creator,
Data type: int,
Description: Work that creates activity.
Response:
[{
"Data": xxxx,
"Message": "Activity Inserted.",
"status": true,
}]
Update Activity:
API Route Path: api/Activity/UpdateActivityManagementAPI Method: Post
Parameters:
1 - Name: ActivityId,
Data type: int,
Description: Unique id of an activity per record.
Response:
[{
"is_error": false,
"message": "success",
"result": object,
}]
Delete Activity:
API Route Path: api/Activity/DeleteActivityAPI Method: Post
Parameters:
1 - Name: ActivityId,
Data type: int,
Description: Unique id of an activity per record.
Response:
[{
"Success ": true,
"GanttChartData": object,
"TaskDeleteStatuses": List < object >,
}]
Workers:
Worker is a laborer can work in one or more than one project. You can calculate their wages, track assigned hours as well as actual worked hours and get to know their payments etc.
You can also create team of workers for a case, make one or more than one case owner or case manager to workers of a particular case.
ENDPOINTS: GET: api/Worker/GetAllWorkers POST: api/Worker/InsertUpdateWorker?WorkerManagementDto=obj_value POST: api/Worker/DeleteWorkerById?WorkerId=int_value&ClientId=Int_value
List All Workers:
API Route Path: api/Worker/GetAllWorkersAPI Method: Get
Parameters: None
Response:
[
{
"ResourceId": xxx,
"FirstName": "xxxx",
"MiddleName": "xxxx",
"LastName": "xxxx",
"DisplayName": "xxxx xxxx",
"Email": "[email protected]",
"ContactWork": "",
"ContactHome": "",
"ContactMobile": "xxxxxxxxxx",
"Description": "",
"ResourceStatus": "Active",
"ResourceTypeId": 0,
"SuperVisorManagerId": xxxx,
"TimesheetApproverId": xxxx,
"ExpenseApproverId": xxxx,
"RateTitleId": 0,
"InternalBillingRateId": 0,
"ClientBillingRateId": 0,
"StartDate": "1900-01-01T00:00:00",
"EndDate": "1900-01-01T00:00:00",
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-10-01T00:00:00.00",
"Creator": null,
"Updater": xxxx,
"RemoteHost": "",
"status": "Active",
"ResourceTypeId1": 0,
"ResourceType": "Administrator",
"DepartmentId": 0,
"Department": null,
"DivisionId": 0,
"Division": null,
"EmploymentTypeId": 1,
"EmploymentType": "Full Time",
"ImageURL": ""
},
{
"ResourceId": xxx,
"FirstName": "xxxx",
"MiddleName": "xxxx",
"LastName": "xxxx",
"DisplayName": "xxxx xxxx",
"Email": "[email protected]",
"ContactWork": "",
"ContactHome": "",
"ContactMobile": "xxxxxxxxxx",
"Description": "",
"ResourceStatus": "Active",
"ResourceTypeId": 0,
"SuperVisorManagerId": xxxx,
"TimesheetApproverId": xxxx,
"ExpenseApproverId": xxxx,
"RateTitleId": 0,
"InternalBillingRateId": 0,
"ClientBillingRateId": 0,
"StartDate": "1900-01-01T00:00:00",
"EndDate": "1900-01-01T00:00:00",
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-10-01T00:00:00.00",
"Creator": null,
"Updater": xxxx,
"RemoteHost": "",
"status": "Active",
"ResourceTypeId1": 0,
"ResourceType": "QA Executive",
"DepartmentId": 0,
"Department": null,
"DivisionId": 0,
"Division": null,
"EmploymentTypeId": 1,
"EmploymentType": "Full Time",
"ImageURL": ""
},
{
"ResourceId": xxx,
"FirstName": "xxxx",
"MiddleName": "xxxx",
"LastName": "xxxx",
"DisplayName": "xxxx xxxx",
"Email": "[email protected]",
"ContactWork": "",
"ContactHome": "",
"ContactMobile": "xxxxxxxxxx",
"Description": "",
"ResourceStatus": "Active",
"ResourceTypeId": 0,
"SuperVisorManagerId": xxxx,
"TimesheetApproverId": xxxx,
"ExpenseApproverId": xxxx,
"RateTitleId": 0,
"InternalBillingRateId": 0,
"ClientBillingRateId": 0,
"StartDate": "1900-01-01T00:00:00",
"EndDate": "1900-01-01T00:00:00",
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-10-01T00:00:00.00",
"Creator": null,
"Updater": xxxx,
"RemoteHost": "",
"status": "Active",
"ResourceTypeId1": 0,
"ResourceType": "Administrator",
"DepartmentId": 0,
"Department": null,
"DivisionId": 0,
"Division": null,
"EmploymentTypeId": 1,
"EmploymentType": "Full Time",
"ImageURL": ""
},
{
"ResourceId": xxx,
"FirstName": "xxxx",
"MiddleName": "xxxx",
"LastName": "xxxx",
"DisplayName": "xxxx xxxx",
"Email": "[email protected]",
"ContactWork": "",
"ContactHome": "",
"ContactMobile": "xxxxxxxxxx",
"Description": "",
"ResourceStatus": "Active",
"ResourceTypeId": 0,
"SuperVisorManagerId": xxxx,
"TimesheetApproverId": xxxx,
"ExpenseApproverId": xxxx,
"RateTitleId": 0,
"InternalBillingRateId": 0,
"ClientBillingRateId": 0,
"StartDate": "1900-01-01T00:00:00",
"EndDate": "1900-01-01T00:00:00",
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-10-01T00:00:00.00",
"Creator": null,
"Updater": xxxx,
"RemoteHost": "",
"status": "Active",
"ResourceTypeId1": 0,
"ResourceType": "Developer",
"DepartmentId": 0,
"Department": null,
"DivisionId": 0,
"Division": null,
"EmploymentTypeId": 1,
"EmploymentType": "Full Time",
"ImageURL": ""
},
{
"ResourceId": xxxx,
"FirstName": "xxxx",
"MiddleName": "xxxx",
"LastName": "xxxx",
"DisplayName": "xxxx xxxx",
"Email": "[email protected]",
"ContactWork": "",
"ContactHome": "",
"ContactMobile": "xxxxxxxxxx",
"Description": "",
"ResourceStatus": "Active",
"ResourceTypeId": 0,
"SuperVisorManagerId": xxxx,
"TimesheetApproverId": xxxx,
"ExpenseApproverId": xxxx,
"RateTitleId": 0,
"InternalBillingRateId": 0,
"ClientBillingRateId": 0,
"StartDate": "1900-01-01T00:00:00",
"EndDate": "1900-01-01T00:00:00",
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-10-01T00:00:00.00",
"Creator": null,
"Updater": xxxx,
"RemoteHost": "",
"status": "Active",
"ResourceTypeId1": 0,
"ResourceType": "Project Manager",
"DepartmentId": 0,
"Department": null,
"DivisionId": 0,
"Division": null,
"EmploymentTypeId": 1,
"EmploymentType": "Full Time",
"ImageURL": ""
}
]
Create Worker:
API Route Path: api/Worker/InsertUpdateWorkerAPI Method: Post
Parameters:
1 - Name: WorkerManagementDto,
Data type: object,
Description: Data object that is require to add/update.
Response:
[{
"newResourceId ": xxxx
}]
Update Worker:
API Route Path: api/Worker/InsertUpdateWorkerAPI Method: Post
Parameters:
1 - Name: WorkerManagementDto,
Data type: object,
Description: Data object that is require to add/update.
Response:
[{
"newResourceId ": xxxx
}]
Delete Worker:
API Route Path: api/Worker/DeleteWorkerByIdAPI Method: Post
Parameters:
1 - Name: WorkerId,
Data type: int,
Description: Unique id of an worker per record.
2 - Name: ClientId,
Data type: int,
Description: A key to access client data.
Response:
[{
"ReturnValue ": xxxx
}]
Documents:
A worker can create drive, add folders and upload documents in the form of word file, pdf, text, audio, video and images of different formats in his/her drive, also upload files for a particular case as well as activity.
Document is a useful feature to share documents within workers. It can be a document of any type, may be a document contains requirements of a case or activity for which it’s uploaded.
ENDPOINTS: GET: api/Document/GetFoldersAndFilesForStreetCenter?WorkerId=int_value &ParentFolderId=int_value&IsShared=int_value&SearchKeyword=str_value &CaseId=int_value&ActivityId=int_value GET: api/Document/SaveFolder?FolderName=str_value&FolderPath=str_value &ParentFolderId=int_value&WorkerId=int_value&UserId=int_value&CaseId=int_value &ActivityId=int_value GET: api/Document/SaveFile?FileNameOnDisk=str_value&FileName=str_value &ContentType=str_value&Path=str_value&FolderId=int_value&WorkerId=int_value &UserId=int_value&ProjectId=int_value&TaskId=int_value&SyFileId=int_value GET: api/Document/RenameFolder?FolderId=int_value&NewFolderName=str_value &NewFolderPathWithFolderName=str_value&ModifiedBy=int_value GET: api/Document/RenameFile?FileId=int_value&NewFileNameWithExtension=str_value &ModifiedBy=int_value GET: api/Document/MoveFileToNewFolder?FolderId=int_value&FileID=int_value &NewPath=str_value GET: api/Document/DeleteFolder?FolderId=int_value&IsShared=int_value GET: api/Document/DeleteFile?FileId=int_value&IsShared=int_value GET: api/Document/SaveSharedFolder?WokerIds=str_value&FolderId=int_value &UserId=int_value GET: api/Document/SaveSharedFile?WokerIds=str_value&FileId=int_value &UserId=int_value
List All Folders and Files:
API Route Path: api/Document/GetFoldersAndFilesForStreetCenterAPI Method: Get
Parameters:
1 - Name: WorkerId,
Data type: int,
Description: A key to get folders and files as per worker.
2 - Name: ParentFolderId,
Data type: int,
Description: A key of a parent record. It can be a folder or a file id.
3 - Name: IsShared,
Data type: int,
Description: If document is shared then it’s value would be 1 else 0.
4 - Name: SearchKeyword,
Data type: string,
Description: It’s an optional parameter and need to provide when search will require.
5 - Name: CaseId,
Data type: int,
Description: A key to get documents per case.
6 - Name: ActivityId,
Data type: int,
Description: A key to get documents per activity.
Response:
[
{
"FolderId": xxxx,
"Caption": "xxxx",
"FolderPath": "xxxx",
"FileId": xxxx,
"FileName": "xxxx xxxx",
"FilePath": "~/xxxx/xxx/xxx",
"ContentType": "",
"FileSize": "xxxx",
"LastUpdated": "1900-01-01T00:00:00.000",
"CreatedBy": "0000",
"Modified": "Active",
"DExternalId": 0,
"FExternalId": 0
},
{
"FolderId": xxxx,
"Caption": "xxxx",
"FolderPath": "xxxx",
"FileId": xxxx,
"FileName": "xxxx xxxx",
"FilePath": "~/xxxx/xxx/xxx",
"ContentType": "",
"FileSize": "xxxx",
"LastUpdated": "1900-01-01T00:00:00.000",
"CreatedBy": "0000",
"Modified": "Active",
"DExternalId": 0,
"FExternalId": 0
},
{
"FolderId": xxxx,
"Caption": "xxxx",
"FolderPath": "xxxx",
"FileId": xxxx,
"FileName": "xxxx xxxx",
"FilePath": "~/xxxx/xxx/xxx",
"ContentType": "",
"FileSize": "xxxx",
"LastUpdated": "1900-01-01T00:00:00.000",
"CreatedBy": "0000",
"Modified": "Active",
"DExternalId": 0,
"FExternalId": 0
},
{
"FolderId": xxxx,
"Caption": "xxxx",
"FolderPath": "xxxx",
"FileId": xxxx,
"FileName": "xxxx xxxx",
"FilePath": "~/xxxx/xxx/xxx",
"ContentType": "",
"FileSize": "xxxx",
"LastUpdated": "1900-01-01T00:00:00.000",
"CreatedBy": "0000",
"Modified": "Active",
"DExternalId": 0,
"FExternalId": 0
}
]
Save Folder:
API Route Path: api/Document/SaveFolderAPI Method: Get
Parameters:
1 - Name: FolderName,
Data type: string,
Description: Name of the folder.
2 - Name: FolderPath,
Data type: string,
Description: Path of the folder that created on server.
3 - Name: ParentFolderId,
Data type: int,
Description: A key of a parent record. It can be a folder id.
4 - Name: WorkerId,
Data type: int,
Description: A key to get folders as per worker.
5 - Name: UserId,
Data type: int,
Description: A key to get folders as per user.
6 - Name: CaseId,
Data type: int,
Description: A key to get folders per case.
7 - Name: ActivityId,
Data type: int,
Description: A key to get folders per activity.
Response:
[{
"ReturnValue ": xxxx
}]
Save Folder:
API Route Path: api/Document/SaveFolderAPI Method: Get
Parameters:
1 - Name: FolderName,
Data type: string,
Description: Name of the folder.
2 - Name: FolderPath,
Data type: string,
Description: Path of the folder that created on server.
3 - Name: ParentFolderId,
Data type: int,
Description: A key of a parent record. It can be a folder id.
4 - Name: WorkerId,
Data type: int,
Description: A key to get folders as per worker.
5 - Name: UserId,
Data type: int,
Description: A key to get folders as per user.
6 - Name: CaseId,
Data type: int,
Description: A key to get folders per case.
7 - Name: ActivityId,
Data type: int,
Description: A key to get folders per activity.
Response:
[{
"ReturnValue ": xxxx
}]
Save File:
API Route Path: api/Document/SaveFileAPI Method: Get
Parameters:
1 - Name: FileNameOnDisk,
Data type: string,
Description: Name of the file on disk.
2 - Name: FileName,
Data type: string,
Description: Name of the file.
3 - Name: ContentType,
Data type: string,
Description: Type of file content e.g. txt, word, pdf etc.
4 - Name: Path,
Data type: string,
Description: Path of the file that uploaded on server.
5 - Name: FolderId,
Data type: int,
Description: A key of a parent folder record.
6 - Name: WorkerId,
Data type: int,
Description: A key to get files as per worker.
7 - Name: UserId,
Data type: int,
Description: A key to get files as per user.
8 - Name: CaseId,
Data type: int,
Description: A key to get files per case.
9 - Name: ActivityId,
Data type: int,
Description: A key to get files per activity.
10 - Name: SyFileId,
Data type: int,
Description: A key to get files as per syFile object.
Response:
[{
"ReturnValue ": xxxx
}]
Rename Folde:
API Route Path: api/Document/RenameFolderAPI Method: Get
Parameters:
1 - Name: FolderId,
Data type: int,
Description: A unique key as per folder.
2 - Name: NewFolderName,
Data type: string,
Description: New name of the folder.
3 - Name: NewFolderPathWithFolderName,
Data type: string,
Description: New folder path.
4 - Name: ModifiedBy,
Data type: int,
Description: A key to folder as per worker whom updated to it.
Response:
[{
"ReturnValue ": xxxx
}]
Rename File:
API Route Path: api/Document/RenameFileAPI Method: Get
Parameters:
1 - Name: FileId,
Data type: int,
Description: A unique key as per file.
2 - Name: NewFileNameWithExtension,
Data type: string,
Description: New name of file with extension.
3 - Name: ModifiedBy,
Data type: int,
Description: A key to folder as per worker whom updated to it.
Response:
[{
"ReturnValue ": xxxx
}]
Move File to New Folder:
API Route Path: api/Document/MoveFileToNewFolderAPI Method: Get
Parameters:
1 - Name: FolderId,
Data type: int,
Description: A unique key as per folder.
2 - Name: FileId,
Data type: int,
Description: A unique key as per file.
3 - Name: NewPath,
Data type: string,
Description: New path of file.
Response:
[{
"ReturnValue ": xxxx
}]
Move File to New Folder:
API Route Path: api/Document/MoveFileToNewFolderAPI Method: Get
Parameters:
1 - Name: FolderId,
Data type: int,
Description: A unique key as per folder.
2 - Name: FileId,
Data type: int,
Description: A unique key as per file.
3 - Name: NewPath,
Data type: string,
Description: New path of file.
Response:
[{
"ReturnValue ": xxxx
}]
Delete Folder:
API Route Path: api/Document/DeleteFolderAPI Method: Get
Parameters:
1 - Name: FolderId,
Data type: int,
Description: A unique key as per folder.
2 - Name: IsShared,
Data type: int,
Description: If document is shared then it’s value would be 1 else 0.
Response:
[{
"ReturnValue ": xxxx
}]
Delete File:
API Route Path: api/Document/DeleteFileAPI Method: Get
Parameters:
1 - Name: FileId,
Data type: int,
Description: A unique key as per file.
2 - Name: IsShared,
Data type: int,
Description: If document is shared then it’s value would be 1 else 0.
Response:
[{
"ReturnValue ": xxxx
}]
Save Shared Folder:
API Route Path: api/Document/SaveSharedFileAPI Method: Get
Parameters:
1 - Name: WokerIds,
Data type: string,
Description: Worker ids comma separated string to share folder.
2 - Name: FolderId,
Data type: int,
Description: A unique key as per folder.
3 - Name: UserId,
Data type: int,
Description: A key to get folders as per user.
Response:
[{
"ReturnValue ": xxxx
}]
GET: api/Document/SaveSharedFolder?WokerIds=str_value&FolderId=int_value
&UserId=int_value
Save Shared File:
API Route Path: api/Document/SaveSharedFolderAPI Method: Get
Parameters:
1 - Name: WokerIds,
Data type: string,
Description: Worker ids comma separated string to share folder.
2 - Name: FileId,
Data type: int,
Description: A unique key as per file.
3 - Name: UserId,
Data type: int,
Description: A key to get files as per user.
Response:
[{
"ReturnValue ": xxxx
}]
Street Financials:
Street financials api allow you to calculate budget, cost and revenue of cases. They can be an actual or forecast.
ENDPOINTS: GET: api/streetfinancial/GetCaseBudgetActualData?CaseId=int_value GET: api/streetfinancial/GetReportByCases?caseId=int_value&isCost=bool_value &isForecast=bool_value&isTimeSheet=bool_value&FromDate=date_value &ToDate=date_value GET: api/streetfinancial/GetReportByWorkers?caseId=int_value&isCost=bool_value &isForecast=bool_value&isTimeSheet&FromDate=date_value&ToDate=date
Case Actual Budget:
API Route Path: api/streetfinancial/GetCaseBudgetActualDataAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
Response:
{
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx",
"image": "xxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx xxx xxxxxx",
"image": "xxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0",
"0.00",
"0.00",
"0.00"
],
"rows": [],
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Forecast Cost (Filter by Activities):
API Route Path: api/streetfinancial/GetReportByCasesAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
2 - Name: isCost,
Data type: bool,
Description: A Flag to check is cost true or false. To get forecast cost, it should be true.
3 - Name: isForecast,
Data type: bool,
Description: A Flag to check is forecast true or false. To get forecast cost, it should be true.
4 - Name: isTimeSheet,
Data type: bool,
Description: A Flag to check is timesheet true or false. To get forecast cost, it should be false.
5 - Name: FromDate,
Data type: Datetime,
Description: Initial date to get report data.
6 - Name: ToDate,
Data type: Datetime,
Description: End date to get report data.
Response:
{
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx xxx xxxxx",
"image": "xxx.xxx"
},
xxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": [],
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Actual Cost (Filter by Activities):
API Route Path: api/streetfinancial/GetReportByCasesAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
2 - Name: isCost,
Data type: bool,
Description: A Flag to check is cost true or false. To get actual cost, it should be true.
3 - Name: isForecast,
Data type: bool,
Description: A Flag to check is forecast true or false. To get actual cost, it should be false.
4 - Name: isTimeSheet,
Data type: bool,
Description: A Flag to check is timesheet true or false. To get actual cost, it should be false.
5 - Name: FromDate,
Data type: Datetime,
Description: Initial date to get report data.
6 - Name: ToDate,
Data type: Datetime,
Description: End date to get report data.
Response:
{
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx",
"image": "xxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx xxx xxxx",
"image": "xxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": [],
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Timesheet of Cost (Filter by Activities):
API Route Path: api/streetfinancial/GetReportByCasesAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
2 - Name: isCost,
Data type: bool,
Description: A Flag to check is cost true or false. To get timesheet, it should be true.
3 - Name: isForecast,
Data type: bool,
Description: A Flag to check is forecast true or false. To get timesheet cost, it should be false.
4 - Name: isTimeSheet,
Data type: bool,
Description: A Flag to check is timesheet true or false. To get forecast cost, it should be true.
5 - Name: FromDate,
Data type: Datetime,
Description: Initial date to get report data.
6 - Name: ToDate,
Data type: Datetime,
Description: End date to get report data.
Response:
{
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx xxx xxxxx",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": [],
"xmlkids": null
},
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx xxxxx xxxxx",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": [],
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Forecast Revenue (Filter by Activities):
API Route Path: api/streetfinancial/GetReportByCasesAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
2 - Name: isCost,
Data type: bool,
Description: A Flag to check is cost true or false. To get forecast cost, it should be false.
3 - Name: isForecast,
Data type: bool,
Description: A Flag to check is forecast true or false. To get forecast cost, it should be true.
4 - Name: isTimeSheet,
Data type: bool,
Description: A Flag to check is timesheet true or false. To get forecast cost, it should be false.
5 - Name: FromDate,
Data type: Datetime,
Description: Initial date to get report data.
6 - Name: ToDate,
Data type: Datetime,
Description: End date to get report data.
Response:
{
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx",
"image": "xxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx xxx xxxx",
"image": "xxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": [],
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Actual Revenue (Filter by Activities):
API Route Path: api/streetfinancial/GetReportByCasesAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
2 - Name: isCost,
Data type: bool,
Description: A Flag to check is cost true or false. To get actual cost, it should be false.
3 - Name: isForecast,
Data type: bool,
Description: A Flag to check is forecast true or false. To get actual cost, it should be false.
4 - Name: isTimeSheet,
Data type: bool,
Description: A Flag to check is timesheet true or false. To get actual cost, it should be false.
5 - Name: FromDate,
Data type: Datetime,
Description: Initial date to get report data.
6 - Name: ToDate,
Data type: Datetime,
Description: End date to get report data.
Response:
{
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx xxx xxxxx",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": [],
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Timesheet of Revenue (Filter by Activities):
API Route Path: api/streetfinancial/GetReportByCasesAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
2 - Name: isCost,
Data type: bool,
Description: A Flag to check is cost true or false. To get timesheet, it should be false.
3 - Name: isForecast,
Data type: bool,
Description: A Flag to check is forecast true or false. To get timesheet cost, it should be false.
4 - Name: isTimeSheet,
Data type: bool,
Description: A Flag to check is timesheet true or false. To get forecast cost, it should be true.
5 - Name: FromDate,
Data type: Datetime,
Description: Initial date to get report data.
6 - Name: ToDate,
Data type: Datetime,
Description: End date to get report data.
Response:
{
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx xxx xxx",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": [],
"xmlkids": null
},
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx xxx xxxxxx",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": [],
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Forecast Cost (Filter by Workers):
API Route Path: api/streetfinancial/GetReportByCasesAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
2 - Name: isCost,
Data type: bool,
Description: A Flag to check is cost true or false. To get forecast cost, it should be true.
3 - Name: isForecast,
Data type: bool,
Description: A Flag to check is forecast true or false. To get forecast cost, it should be true.
4 - Name: isTimeSheet,
Data type: bool,
Description: A Flag to check is timesheet true or false. To get forecast cost, it should be false.
5 - Name: FromDate,
Data type: Datetime,
Description: Initial date to get report data.
6 - Name: ToDate,
Data type: Datetime,
Description: End date to get report data.
Response:
{
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx x xxxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx 0.0",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"200.00",
"200.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"400.00",
"400.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxxx xx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx 0.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"40.00",
"40.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"80.00",
"80.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxxx xxx xxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx 1.1",
"image": "xxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Actual Cost (Filter by Workers):
API Route Path: api/streetfinancial/GetReportByWorkersAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
2 - Name: isCost,
Data type: bool,
Description: A Flag to check is cost true or false. To get actual cost, it should be true.
3 - Name: isForecast,
Data type: bool,
Description: A Flag to check is forecast true or false. To get actual cost, it should be false.
4 - Name: isTimeSheet,
Data type: bool,
Description: A Flag to check is timesheet true or false. To get actual cost, it should be false.
5 - Name: FromDate,
Data type: Datetime,
Description: Initial date to get report data.
6 - Name: ToDate,
Data type: Datetime,
Description: End date to get report data.
Response:
{
"rows": [
{
"id": xxxxxx,
"Index": 0,
"data": [
{
"value": "xxxx x xxxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx 1.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "Client 1",
"image": "folder.gif"
},
xxxx
],
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx 0.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"20.00",
"30.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"50.00",
"50.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx xxxx",
"image": "xxxx.xxx"
},
xxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx 0.5",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx xxxx",
"image": "xxxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx 1.8",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Timesheet of Cost (Filter by Workers):
API Route Path: api/streetfinancial/GetReportByWorkersAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
2 - Name: isCost,
Data type: bool,
Description: A Flag to check is cost true or false. To get timesheet, it should be true.
3 - Name: isForecast,
Data type: bool,
Description: A Flag to check is forecast true or false. To get timesheet cost, it should be false.
4 - Name: isTimeSheet,
Data type: bool,
Description: A Flag to check is timesheet true or false. To get forecast cost, it should be true.
5 - Name: FromDate,
Data type: Datetime,
Description: Initial date to get report data.
6 - Name: ToDate,
Data type: Datetime,
Description: End date to get report data.
Response:
{
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx xx xxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx 0.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxx xxx xxxx",
"image": "xxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxxx x",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx 5.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"150.00",
"30.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"180.00",
"180.00"
],
"rows": null,
"xmlkids": null
},
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx xxx xxxxx",
"image": "xxxx.xxx"
},
xxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxxx xxxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx 5.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx xxxx",
"image": "xxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx 3.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Forecast Revenue (Filter by Workers):
API Route Path: api/streetfinancial/GetReportByWorkersAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
2 - Name: isCost,
Data type: bool,
Description: A Flag to check is cost true or false. To get forecast cost, it should be false.
3 - Name: isForecast,
Data type: bool,
Description: A Flag to check is forecast true or false. To get forecast cost, it should be true.
4 - Name: isTimeSheet,
Data type: bool,
Description: A Flag to check is timesheet true or false. To get forecast cost, it should be false.
5 - Name: FromDate,
Data type: Datetime,
Description: Initial date to get report data.
6 - Name: ToDate,
Data type: Datetime,
Description: End date to get report data.
Response:
{
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx xx xxxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxx 1.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"400.00",
"400.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"800.00",
"800.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxxx x",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx 1.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx xxx xxxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx 1.1",
"image": "xxxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Actual Revenue (Filter by Workers):
API Route Path: api/streetfinancial/GetReportByWorkersAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
2 - Name: isCost,
Data type: bool,
Description: A Flag to check is cost true or false. To get actual cost, it should be false.
3 - Name: isForecast,
Data type: bool,
Description: A Flag to check is forecast true or false. To get actual cost, it should be false.
4 - Name: isTimeSheet,
Data type: bool,
Description: A Flag to check is timesheet true or false. To get actual cost, it should be false.
5 - Name: FromDate,
Data type: Datetime,
Description: Initial date to get report data.
6 - Name: ToDate,
Data type: Datetime,
Description: End date to get report data.
Response:
{
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx x xxxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx 1.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx x",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx 1.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx xxxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxxx 1.1",
"image": "xxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Timesheet of Revenue (Filter by Workers):
API Route Path: api/streetfinancial/GetReportByWorkersAPI Method: Get
Parameters:
1 - Name: CaseId,
Data type: int,
Description: A key to get data per case.
2 - Name: isCost,
Data type: bool,
Description: A Flag to check is cost true or false. To get timesheet, it should be false.
3 - Name: isForecast,
Data type: bool,
Description: A Flag to check is forecast true or false. To get timesheet cost, it should be false.
4 - Name: isTimeSheet,
Data type: bool,
Description: A Flag to check is timesheet true or false. To get forecast cost, it should be true.
5 - Name: FromDate,
Data type: Datetime,
Description: Initial date to get report data.
6 - Name: ToDate,
Data type: Datetime,
Description: End date to get report data.
Response:
{
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx x xxxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx 0.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxx xxx xxxxx",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx x",
"image": "xxxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxx,
"Index": 0,
"data": [
{
"value": "xxx 1.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxx xxxx xxxxx",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
},
{
"id": xxxxx,
"Index": 0,
"data": [
{
"value": "xxxx xxxx",
"image": "xxxx.xxx"
},
xxxx
],
"rows": [
{
"id": xxxxxx,
"Index": 0,
"data": [
{
"value": "xxxx 1.1",
"image": "xxxx.xxx"
},
xxxx,
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00"
],
"rows": null,
"xmlkids": null
}
],
"xmlkids": null
}
]
}
Customers:
Customer object uses to generate invoices. The api allow you to create add, edit, update and delete your customer.
You can retrieve individual as well as list of customers.
ENDPOINTS: GET: api/Customer/AddUpdateCustomer?customer=obj_value POST: api/Customer/GetForEdit?CustomerId=int_value
Create Customer:
API Route Path: api/Customer/AddUpdateCustomerAPI Method: Get
Parameters:
1 - Name: customer,
Data type: object,
Description: Contains data of customer to add or update.
Response:
[{
"result": true,
}]
Update Customer:
API Route Path: api/Customer/AddUpdateCustomerAPI Method: Get
Parameters:
1 - Name: customer,
Data type: object,
Description: Contains data of customer to add or update.
Response:
[{
"result": true,
}]
Customer Object:
API Route Path: api/Customer/GetForEditAPI Method: Get
Parameters:
1 - Name: CustomerId,
Data type: int,
Description: A unique value of customer data row.
Response:
{
"CustomerId": xxxx,
"CustomerTypeId": xxxx,
"Caption": "xxxx xxxx",
"Description": "xxxxx",
"Address": "xxxx xxxx xxxx xxx",
"CreationTime": "1900-01-01T00:00:00.000",
"UpdationTime": "1900-01-01T00:00:00.000",
"Email": "[email protected]",
"Creator": xxxx,
"Updater": null,
"RemoteHost": "xxx.xxx.x.xx",
"status": true,
"ContactPerson": null,
"ContactNo": "xxxxxxxxxx",
"CompanyName": "xxxxx",
"WebsiteURL": null,
"City": "xxxxxx",
"CityId": null,
"CountryId": xxx,
"StateId": null,
"StreetName": "xxxxxx xxx xxxxx xxxxxx",
"ZipCode": "xxxxx"
}
Timesheet:
Timesheet api allows you to generate reports of workers to get to know how many hours he/she worked on a case.
You can create report by individual worker or of group.
ENDPOINTS: POST: api/timesheet/TimesheetReportWorkerWise?data=obj_value POST: api/timesheet/TimesheetReportCaseWise?data=obj_value GET: api/timesheet/GetMyTimeSheetByWorkerId?workerId=int_value&hitFrom=str_value GET: api/timesheet/GetMyTeamTimeSheetByWorkerId?workerId=int_value&hitFrom=str_value GET: api/timesheet/AddEditTimeSheet?entity=obj_value GET: api/timesheet/DeleteTimesheet?entity=int_value
My Timesheet:
API Route Path: api/timesheet/GetMyTimeSheetByWorkerIdAPI Method: Get
Parameters:
1 - Name: workerId,
Data type: int,
Description: A key to get records per worker.
2 - Name: hitFrom,
Data type: string,
Description: Screen name will come within this param.
Response:
{
"is_error": false,
"message": "Success",
"result": [
{
"CreationTime": "1900-01-01T00:00:00.00",
"Creator": xxxx,
"DepartmentId": 0,
"Description": "",
"DurationInDays": 0.00,
"DurationInHours": 0.00,
"EndDate": "1900-01-01T00:00:00.00",
"IsBillable": false,
"RemoteHost": "xxxx.xx.x.xx",
"ResourceCost": 0.00,
"ResourceCostAdditional": 0.00,
"ResourceId": xxxx,
"StartDate": "1900-01-01T00:00:00.00",
"status": true,
"TimeSheetId": xxxx,
"TimeSheetStatusId": 1,
"TimeSheetTypeId": 1,
"Updater": xxxx,
"UpdationTime": "1900-01-01T00:00:00.00",
"IsSubmittable": true,
"TotalHours": 0000.00
},
{
"CreationTime": "1900-01-01T00:00:00.00",
"Creator": xxxx,
"DepartmentId": 0,
"Description": "",
"DurationInDays": 0.00,
"DurationInHours": 0.00,
"EndDate": "1900-01-01T00:00:00.00",
"IsBillable": false,
"RemoteHost": "xxxx.xx.x.xx",
"ResourceCost": 0.00,
"ResourceCostAdditional": 0.00,
"ResourceId": xxxx,
"StartDate": "1900-01-01T00:00:00.00",
"status": true,
"TimeSheetId": xxxx,
"TimeSheetStatusId": 1,
"TimeSheetTypeId": 1,
"Updater": xxxx,
"UpdationTime": "1900-01-01T00:00:00.00",
"IsSubmittable": true,
"TotalHours": 0000.00
}
],
"is_form_linked": false
}
My Team Timesheet:
API Route Path: api/timesheet/GetMyTeamTimeSheetByWorkerIdAPI Method: Get
Parameters:
1 - Name: workerId,
Data type: int,
Description: A key to get records per worker.
2 - Name: hitFrom,
Data type: string,
Description: Screen name will come within this param.
Response:
{
"is_error": false,
"message": "Success",
"result": [
{
"CreationTime": "1900-01-01T00:00:00.00",
"Creator": 1,
"DepartmentId": 0,
"Description": "",
"DurationInDays": 0.00,
"DurationInHours": 0.00,
"EndDate": "1900-01-01T00:00:00.00",
"IsBillable": false,
"RemoteHost": "xxx.xxx.xx.xx",
"ResourceCost": 0.00,
"ResourceCostAdditional": 0.00,
"ResourceId": 1,
"StartDate": "1900-01-01T00:00:00.00",
"status": true,
"TimeSheetId": xxxx,
"TimeSheetStatusId": 3,
"TimeSheetTypeId": 1,
"Updater": xxxx,
"UpdationTime": "1900-01-01T00:00:00.00",
"TotalHours": null,
"ResourceName": "xxx xx xxxx"
},
{
"CreationTime": "1900-01-01T00:00:00.00",
"Creator": 1,
"DepartmentId": 0,
"Description": "",
"DurationInDays": 0.00,
"DurationInHours": 0.00,
"EndDate": "1900-01-01T00:00:00.00",
"IsBillable": false,
"RemoteHost": "xxx.xxx.xxx.xx",
"ResourceCost": 0.00,
"ResourceCostAdditional": 0.00,
"ResourceId": 1,
"StartDate": "1900-01-01T00:00:00.00",
"status": true,
"TimeSheetId": xxxx,
"TimeSheetStatusId": 3,
"TimeSheetTypeId": 1,
"Updater": 1,
"UpdationTime": "1900-01-01T00:00:00.00",
"TotalHours": null,
"ResourceName": "xxx xx xxxx"
},
{
"CreationTime": "1900-01-01T00:00:00.00",
"Creator": 1,
"DepartmentId": 0,
"Description": "",
"DurationInDays": 0.00,
"DurationInHours": 0.00,
"EndDate": "1900-01-01T00:00:00.00",
"IsBillable": false,
"RemoteHost": "xxx.xxx.xx.xx",
"ResourceCost": 0.00,
"ResourceCostAdditional": 0.00,
"ResourceId": 1,
"StartDate": "1900-01-01T00:00:00.00",
"status": true,
"TimeSheetId": xxxx,
"TimeSheetStatusId": 3,
"TimeSheetTypeId": 1,
"Updater": xxxx,
"UpdationTime": "1900-01-01T00:00:00.00",
"TotalHours": null,
"ResourceName": "xxx xx xxxx"
},
{
"CreationTime": "1900-01-01T00:00:00.00",
"Creator": 1,
"DepartmentId": 0,
"Description": "",
"DurationInDays": 0.00,
"DurationInHours": 0.00,
"EndDate": "1900-01-01T00:00:00.00",
"IsBillable": false,
"RemoteHost": "xxx.xxx.xx.xx",
"ResourceCost": 0.00,
"ResourceCostAdditional": 0.00,
"ResourceId": 1,
"StartDate": "1900-01-01T00:00:00.00",
"status": true,
"TimeSheetId": xxxx,
"TimeSheetStatusId": 3,
"TimeSheetTypeId": 1,
"Updater": xxxx,
"UpdationTime": "1900-01-01T00:00:00.00",
"TotalHours": null,
"ResourceName": "xxx xx xxxx"
},
{
"CreationTime": "1900-01-01T00:00:00.00",
"Creator": 1,
"DepartmentId": 0,
"Description": "",
"DurationInDays": 0.00,
"DurationInHours": 0.00,
"EndDate": "1900-01-01T00:00:00.00",
"IsBillable": false,
"RemoteHost": "xxx.xxx.xx.xx",
"ResourceCost": 0.00,
"ResourceCostAdditional": 0.00,
"ResourceId": 1,
"StartDate": "1900-01-01T00:00:00.00",
"status": true,
"TimeSheetId": xxxx,
"TimeSheetStatusId": 3,
"TimeSheetTypeId": 1,
"Updater": xxxx,
"UpdationTime": "1900-01-01T00:00:00.00",
"TotalHours": null,
"ResourceName": "xxx xx xxxx"
}
],
"is_form_linked": false
}
Create Timesheet:
API Route Path: api/timesheet/AddEditTimeSheetAPI Method: Get
Parameters:
1 - Name: entity,
Data type: object,
Description: Data object to create or update timesheet.
Response:
[{
"is_error": false,
"message": "Timesheet added sucessfully",
"result": true,
}]
Update Timesheet:
API Route Path: api/timesheet/AddEditTimeSheetAPI Method: Get
Parameters:
1 - Name: entity,
Data type: object,
Description: Data object to create or update timesheet.
Response:
[{
"is_error": false,
"message": "Timesheet updated sucessfully",
"result": true,
}]
Delete Timesheet:
API Route Path: api/timesheet/DeleteTimesheetAPI Method: Get
Parameters:
1 - Name: entity,
Data type: int,
Description: A unique key of timesheet object.
Response:
[{
"is_error": false,
"message": "Timesheet deleted sucessfully ",
}]
Timesheet Report by Resource:
API Route Path: api/timesheet/DeleteTimesheetAPI Method: Get
Parameters:
1 - Name: data,
Data type: object,
Description: Object record params to get data.
Response:
[{
"WorkerId ": xxxx,
"DisplayName": "xxx xxx xxxx",
"TimesheetApproverId": xxxx,
"ApproverDisplayName": "xxxx xxx xxxx",
"CaseId": xxxx,
"CaseName": "xxx xxx xxxx",
"ActivityId": xxxx,
"ActivityName": "xxx xxx xxxx",
"Total": 00.00,
"Month Day, Year": 00.00,
"Month Day, Year": 00.00,
"Month Day, Year": 00.00,
"Month Day, Year": 00.00,
"Month Day, Year": 00.00,
"Month Day, Year": 00.00,
"Month Day, Year": 00.00,
}]
Timesheet Report by Case:
API Route Path: api/timesheet/TimesheetReportCaseWiseAPI Method: Get
Parameters:
1 - Name: data,
Data type: object,
Description: Object record params to get data.
Response:
[{
"CaseId": xxxx,
"CaseName": "xxx xxx xxxx",
"CaseTotal": 00.00,
"Month Day, Year": 00.00,
"Month Day, Year": 00.00,
"Month Day, Year": 00.00,
"Month Day, Year": 00.00,
"Month Day, Year": 00.00,
"Month Day, Year": 00.00,
"Month Day, Year": 00.00,
}]
Invoices:
Invoice api allows you to generate receipts of customers to track charges against their system usage.
You can get individual as list of customer’s receipts.
ENDPOINTS: GET: api/Invoice/GetAllCustomer GET: api/Invoice/GetCustomerById?customerId=int_value GET: api/Invoice/GetCustomerPaymentData?CustomerId=int_value&Startdate=str_value &EndDate=str_value&Cases=str_value&BillingTypeId=int_value
Comments
0 comments
Article is closed for comments.