Class ProjectAgent
Namespace: SuperOffice.WebApi.AgentsAssembly: SuperOffice.WebApi.dll Collection of all services that works with Project data.
Inheritance
object ← AgentBase ← ProjectAgentImplements
IProjectAgent, IAgentBase, IDisposableInherited Members
AgentBase._json, AgentBase._binary, AgentBase._config, AgentBase._client, AgentBase._disposeClient, AgentBase.Merge(RequestOptions), AgentBase.BuildRequestFromObject(HttpMethod, string, object, WebApiOptions, string), AgentBase.BuildRequestFromStream(HttpMethod, string, Stream, WebApiOptions, string), AgentBase.BuildRequestFromObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string), AgentBase.ParseAuthorization(IAuthorization), AgentBase.CancelRequest(), AgentBase.SendRequestObject(HttpMethod, string, object, WebApiOptions, string), AgentBase.SendRequestObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string), AgentBase.SendRequest(HttpRequestMessage, RequestOptions), AgentBase.ThrowOnResponseErrorAsync(HttpRequestMessage, HttpResponseMessage), AgentBase.ParseResponse<T>(HttpResponseMessage), AgentBase.Finally(RequestOptions), AgentBase.Dispose(), AgentBase.Configuration, AgentBase.Client, AgentBase.HasRunningRequest, AgentBase.ClientCancellationTokenSource, AgentBase.ProgressListener, AgentBase.UploadProgressListener, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()Examples
<pre><code class=“lang-csharp”>using SuperOffice.WebApi; using SuperOffice.WebApi.Agents; var mySession = new WebApiOptions(“http://example.com/super/api”); mySession.Authorization = new AuthorizationUsernamePassword(“user”, “pass”); using (ProjectAgent agent = new ProjectAgent(mySession)) { // call methods on agent here… }</code></pre>Constructors
ProjectAgent(HttpClient)
Constructor: Collection of all services that works with Project data.Parameters
httpClient HttpClient
Use this HTTP client instead of making own HttpClient instance.
ProjectAgent(WebApiOptions, HttpClient)
Constructor: Collection of all services that works with Project data.Parameters
options WebApiOptions
Base URL and authentication values.
httpClient HttpClient
Optional: Use this HTTP client instead of making a new one.
Methods
AddProjectMembersAsync(int, ProjectMember[], RequestOptions)
Add multiple project members to a projectParameters
projectEntityId int
Project to add members to
projectMembers ProjectMember[]
Project members to add
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskCreateDefaultProjectEntityAsync(RequestOptions)
Set default values into a new ProjectEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEntity> A blank ProjectEntityCreateDefaultProjectEventEntityAsync(RequestOptions)
Set default values into a new ProjectEventEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEventEntity> A blank ProjectEventEntityCreateDefaultProjectMemberAsync(RequestOptions)
Set default values into a new ProjectMember. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectMember> A blank ProjectMemberCreateNewEntryAsync(DuplicateEntry, RequestOptions)
Creates a new project based on external duplicateParameters
duplicate DuplicateEntry
The duplicate to create a new entry based upon
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<int> The database identity of the newly created entryDeleteProjectEntityAsync(int, RequestOptions)
Deletes the ProjectEntityParameters
projectEntityId int
The identity of the ProjectEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteProjectEventEntityAsync(int, RequestOptions)
Deletes the ProjectEventEntityParameters
projectEventEntityId int
The identity of the ProjectEventEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteProjectEventEntityFromProjectIdAsync(int, RequestOptions)
Delete a project event based on a project id. Does not delete the project, but does delete the published and ExternalEvent and AudienceVisibility records.Parameters
projectId int
The project id of the external event to delete.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task NothingDeleteProjectMemberAsync(int, RequestOptions)
Deletes the ProjectMemberParameters
projectMemberId int
The identity of the ProjectMember
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteProjectMemberByIdsAsync(int[], RequestOptions)
Deletes projectmembers rows.Parameters
projectMemberIds int[]
An Array of projectmember ids.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskDeleteProjectMembersAsync(int, int[], RequestOptions)
Delete the given project members from a projectParameters
projectEntityId int
Project to remove members from
memberIds int[]
Project member ids
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskGetDuplicateRulesAsync(RequestOptions)
Retrieve all available duplicate rules for projectParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DuplicateRule[]> All available duplicate rulesGetDuplicatesAsync(string, RequestOptions)
Get duplicates(exact or similar in the database) based on the nameParameters
name string
Name used for lookup
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DuplicateEntry[]> Any records matching the specified nameGetMyMemberProjectsAsync(RequestOptions)
Returning the projects where an user is project member.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Project[]> The list of projects.GetMyProjectEventsAsync(RequestOptions)
Gets all project events that belongs to the currently logged on user. The list of events are filtered by the Audience Visibility restrictions set when the project event is created.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEvent[]> Array of project eventsGetMyProjectsAsync(bool, RequestOptions)
Returning the projects belonging to an associate. If memberProjects is false only the projects where the associate is project responsible is returned, otherwise both the projects where the associate is project responsible and project member is returned.Parameters
includeMemberProjects bool
True to include projects where the user is project member.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Project[]> The list of projectsGetMyPublishedProjectsAsync(RequestOptions)
Get published projects from the logged in user.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Project[]> ProjectsGetNextMilestoneAsync(int, RequestOptions)
Next upcoming milestone appointmentParameters
projectId int
Project id - primary key
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Appointment> Upcoming milestone appointmentGetNextProjectStatusAsync(int, RequestOptions)
Parameters
projectId int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<int>GetProjectAsync(int, RequestOptions)
Gets a specific Project object.Parameters
projectId int
The identifier of the Project object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Project> ProjectGetProjectEntityAsync(int, RequestOptions)
Gets a specific ProjectEntity object.Parameters
projectEntityId int
The identifier of the ProjectEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEntity> ProjectEntityGetProjectEntityWithoutMembersAsync(int, RequestOptions)
Get a project entity with no project members. Project members property is always an empty array.Parameters
projectId int
The project id of the project.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEntity> Project entity with the specified id. The project members property is always an empty array.GetProjectEventAsync(int, RequestOptions)
Gets a specific ProjectEvent object.Parameters
projectEventId int
The identifier of the ProjectEvent object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEvent> ProjectEventGetProjectEventEntityAsync(int, RequestOptions)
Gets a specific ProjectEventEntity object.Parameters
projectEventEntityId int
The identifier of the ProjectEventEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEventEntity> ProjectEventEntityGetProjectEventEntityFromProjectIdAsync(int, RequestOptions)
Get a ProjectEventEntity based on a projectId.Parameters
projectId int
The projectId to get a ProjectEventEntity for
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEventEntity> ProjectEventEntityGetProjectEventListAsync(int[], RequestOptions)
Gets an array of specific ProjectEvent objects.Parameters
projectEventIds int[]
The identifiers of the ProjectEvent object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEvent[]> Array of ProjectEvent objectsGetProjectEventOnPersonAsync(int, int, RequestOptions)
Gets a ProjectEvent object from a project and a person.Parameters
projectId int
The project Id
personId int
Id of the person the project events belong to.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEvent>GetProjectEventsOnPersonAsync(int, RequestOptions)
Gets all project events that belongs to the person specified. The list of events are filtered by the Audience Visibility restrictions set when the project event is created.Parameters
personId int
Id of the person the project events belong to.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEvent[]> Array of project eventsGetProjectFencingInfoAsync(RequestOptions)
Get the current project fencing status for the tenantParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<FencingInfo> Current fencing status including count, maximum, and warning stateGetProjectImageAsync(int, string, RequestOptions)
Returns the project image that is displayed in the CRM application.Parameters
projectId int
The project id of the project the image belongs to.
returnContentType string
Accept content-type. Default “application/octet-stream”. Could also be “application/pdf”, “text/plain”, “text/html”, or “multipart/related”
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<byte[]> The project image.GetProjectListAsync(int[], RequestOptions)
Gets an array of specific Project objects.Parameters
projectIds int[]
The identifiers of the Project object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Project[]> Array of Project objectsGetProjectMemberAsync(int, RequestOptions)
Gets a specific ProjectMember object.Parameters
projectMemberId int
The identifier of the ProjectMember object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectMember> ProjectMemberGetProjectMembersAsync(int, RequestOptions)
Returns an array of project membersParameters
projectId int
The project id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectMember[]> An array of project membersGetProjectMembersByIdAsync(int[], RequestOptions)
Returns an array of project membersParameters
projectMemberIds int[]
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectMember[]> An array of project membersGetProjectsFromContactAsync(int, RequestOptions)
Returns all projects where the given contact has projectmembers.Parameters
contactId int
The contact id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Project[]> ProjectListEntityGetProjectsFromPersonAsync(int, RequestOptions)
Return all projects where the person is project member.Parameters
personId int
The person id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Project[]> ProjectListEntityGetPublishedProjectAsync(int, RequestOptions)
Get published project by project id.Parameters
projectId int
The project id.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Project> ProjectGetPublishedProjectsAsync(int[], RequestOptions)
Get published projects by project ids.Parameters
projectIds int[]
The array of project ids
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Project[]> ProjectsGetPublishedProjectsOnPersonIdAsync(int, RequestOptions)
Get published projects where person is a memberParameters
personId int
The person id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Project[]> Array of projectHasGuideActivitiesAsync(int, RequestOptions)
Parameters
projectId int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool>HasGuideAsync(int, RequestOptions)
Does this project have a guide associated with its project type?Parameters
projectId int
Project id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool> True if the project has a guideIsNumberValidAsync(int, string, RequestOptions)
Checks if the number is unique or required. The setting is configured from admin under system options.Parameters
contactId int
The Project id
number string
The number to check for uniqueness and validity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool> True if the number is validMergeAsync(int, int, bool, RequestOptions)
Merge two projects into one, removing the source project in the processParameters
sourceProjectId int
Id of source project for merge. This project is removed after the merge is completed.
destinationProjectId int
Id of destination project to merge to. This project is updated with info from the source.
replaceEmptyFieldsOnDestination bool
Fill in empty fields on destination from source?
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskOfferAutoNextStatusOnApppointmentCompletedAsync(int, RequestOptions)
Parameters
appointmentId int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool>SaveProjectEntityAsync(ProjectEntity, RequestOptions)
Updates the existing ProjectEntity or creates a new ProjectEntity if the id parameter is 0.Parameters
projectEntity ProjectEntity
The ProjectEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEntity> New or updated ProjectEntitySaveProjectEntityWithoutMembersAsync(ProjectEntity, RequestOptions)
Save a project entity, the project members are ignored.Parameters
projectEntity ProjectEntity
The project entity to save. Any set project members are ignored.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEntity> The saved project entity without any project members. The project members property is always an empty array.SaveProjectEventEntityAsync(ProjectEventEntity, RequestOptions)
Updates the existing ProjectEventEntity or creates a new ProjectEventEntity if the id parameter is 0.Parameters
projectEventEntity ProjectEventEntity
The ProjectEventEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectEventEntity> New or updated ProjectEventEntitySaveProjectMemberAsync(ProjectMember, RequestOptions)
Updates the existing ProjectMember or creates a new ProjectMember if the id parameter is 0.Parameters
projectMember ProjectMember
The ProjectMember that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectMember> New or updated ProjectMemberSaveProjectMembersFunctionAndCommentAsync(int[], int, string, RequestOptions)
Saves role and comment on an array of projectmembers represented by idsParameters
projectMemberIds int[]
roleId int
comment string
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSetCompletedAsync(int, bool, RequestOptions)
Set the completed flag on the projectParameters
projectId int
isCompleted bool
True if the project is completed, false if it is not
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueSetDuplicateRulesStatusAsync(DuplicateRule[], RequestOptions)
Set which duplicate rules should be active or notParameters
rules DuplicateRule[]
Duplicate rules to update active status for
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskSetProjectImageAsync(int, byte[], RequestOptions)
Stores the project image that is displayed in the CRM application.Parameters
projectId int
The project id of the project the image belongs to.
image byte[]
The project image.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
TaskUpdateProjectMemberAsync(ProjectMember, RequestOptions)
Updates a ProjectMember row.Parameters
projectMember ProjectMember
ProjectMember to update
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<ProjectMember> The Updated ProjectMemberUpdateProjectMembersAsync(int, ProjectMember[], RequestOptions)
Update existing project members. Not creating new (only projectmember_id > 0 accepted)Parameters
projectId int
Project of which members will be updated
projectMembers ProjectMember[]
Project members to update
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task This method has no return valueValidateProjectEntityAsync(ProjectEntity, RequestOptions)
Check that entity is ready for saving, return error messages by field.Parameters
projectEntity ProjectEntity
Entity to be checked for errors.
requestOptions RequestOptions
Override language/culture codes on this request.