ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

Tasks

API	Description
GET api/Tasks/mso-related-tasks?msoGuid={msoGuid}&userid={userid}	No documentation available.
GET api/Tasks/mso-user-tasks/{userid}	No documentation available.
GET api/Tasks/List?processName={processName}&onlyCount={onlyCount}&pageNum={pageNum}&pageSize={pageSize}	LIST all tasks by process name
GET api/Tasks/events-to-approve?userid={userid}&pageNum={pageNum}&pageSize={pageSize}	LIST all events to approval
GET api/Tasks/Count?processName={processName}	No documentation available.
GET api/Tasks/CountAll	No documentation available.
GET api/Tasks/ListByCategory?categoryname={categoryname}&onlyCount={onlyCount}	LIST all tasks by category name
GET api/Tasks/CountByCategory?categoryname={categoryname}	No documentation available.
GET api/Tasks/ListPending?onlyCount={onlyCount}	No documentation available.
GET api/Tasks/CountPending	No documentation available.
GET api/Tasks/FindTask?serialNumber={serialNumber}	GET task by serial number
POST api/Tasks/Complete	Complete task
POST api/Tasks/CompleteTask	Complete dispatch task
POST api/Tasks/CompleteTaskExtend	Complete task Extend Deadline
POST api/Tasks/CompleteTaskParecerPr	Complete 'Parecer PR' task
POST api/Tasks/SetTaskPending?serialNumber={serialNumber}	Set task to pending
POST api/Tasks/UpdateTaskStatus?FolderId={FolderId}	This method change Expedient status.
GET api/Tasks/ListExpediente	LIST Expediente
GET api/Tasks/FindExpedienteDocId?serialNumber={serialNumber}	GET document id from Expedient
POST api/Tasks/DelegateTask	Delegate your task to other user
POST api/Tasks/EditEventTask	Update event
POST api/Tasks/EditEventTaskAttachments	No documentation available.
GET api/Tasks/Pages?processName={processName}&pageNum={pageNum}&pageSize={pageSize}	No documentation available.
GET api/Tasks/ListKnowledge?processName={processName}&pageNum={pageNum}&pageSize={pageSize}	No documentation available.
POST api/Tasks/AttachDocImage	No documentation available.
POST api/Tasks/AttachListDocImage	No documentation available.
POST api/Tasks/KnowledgeTask	No documentation available.
GET api/Tasks/MyApp	No documentation available.
GET api/Tasks/MyModel	No documentation available.

UserAuthentication

API	Description
GET api/userauthentication/me	No documentation available.
GET api/userauthentication/list/{id}	No documentation available.
GET api/userauthentication/single?id={id}	No documentation available.
GET api/userauthentication/list?namefilter={namefilter}&domain={domain}	No documentation available.
GET api/userauthentication/list/all?namefilter={namefilter}&domain={domain}	No documentation available.
GET api/userauthentication/list/site?siteId={siteId}&organicEntityId={organicEntityId}	No documentation available.
PUT api/userauthentication/update	No documentation available.
GET api/userauthentication/roles	No documentation available.
GET api/userauthentication/roles/{id}	No documentation available.
GET api/userauthentication/sharedCalendars	No documentation available.
GET api/userauthentication/myExchangeCalendars	No documentation available.
GET api/ping	No documentation available.
GET api/userauthentication/RegenereChatToken	No documentation available.
GET api/servicesConnected	No documentation available.
GET api/userauthentication/{userId}/groups	No documentation available.
GET api/userauthentication/{userId}/ProcessesAllowed	No documentation available.
POST api/userauthentication/ProcessesAllowed	No documentation available.
PUT api/userauthentication/ProcessesAllowed	No documentation available.
DELETE api/userauthentication/ProcessesAllowed?userId={userId}&processTypeId={processTypeId}	No documentation available.
GET api/userauthentication/{userId}/Exceptions	No documentation available.
GET api/userauthentication/{userId}/Exceptions/Send	No documentation available.
POST api/userauthentication/Exceptions	No documentation available.
DELETE api/userauthentication/Exceptions?exceptionId={exceptionId}	No documentation available.
GET api/userauthentication/{userId}/Absence	No documentation available.
POST api/userauthentication/Absence	No documentation available.
GET api/UserAuthentication/GetValidateAuth	No documentation available.
POST api/UserAuthentication/Login	No documentation available.
POST api/UserAuthentication/LoginJwt	No documentation available.
POST api/UserAuthentication/AddPhoto	No documentation available.
GET api/UserAuthentication/GetPhoto?UserPhoto={UserPhoto}	No documentation available.
GET api/UserAuthentication/GetUserSignatureImage	No documentation available.
POST api/UserAuthentication/GetSID	No documentation available.

Search

API	Description
GET api/search?assunto={assunto}&applicationType={applicationType}&data={data}&remetente={remetente}&entidadeOrganica={entidadeOrganica}&docTypeId={docTypeId}&listOnlyFolders={listOnlyFolders}	Searches simple and advance
GET api/search/top?size={size}	Get the word more searched
GET api/search/documents?docid={docid}&applicationId={applicationId}	SEARCH dispatch and Correspondence
GET api/search/attachment?assunto={assunto}&applicationType={applicationType}&data={data}&remetente={remetente}&entidadeOrganica={entidadeOrganica}&docTypeId={docTypeId}	SEARCH attachable documents
GET api/search/dispatch?Assunto={Assunto}&DataStart={DataStart}&DataEnd={DataEnd}&RemetenteId={RemetenteId}&RemetenteName={RemetenteName}&DispatchNumber={DispatchNumber}&Status={Status}&Nature={Nature}	SEARCH dispatch
GET api/search/dispatchControl?Assunto={Assunto}&DataStart={DataStart}&DataEnd={DataEnd}&RemetenteId={RemetenteId}&RemetenteName={RemetenteName}&DispatchNumber={DispatchNumber}&Status={Status}&Nature={Nature}&pageNumber={pageNumber}&PageSize={PageSize}	SEARCH dispatch
GET api/search/dispatch/{folderId}	No documentation available.

Groups

API	Description
GET api/Groups	No documentation available.
GET api/GroupsBySite?siteId={siteId}	No documentation available.
GET api/Groups/{id}	No documentation available.
POST api/Groups	No documentation available.
PUT api/Groups	No documentation available.
DELETE api/Groups?id={id}	No documentation available.
GET api/Groups/{groupId}/users	No documentation available.
POST api/Groups/{groupId}/users/add?userId={userId}	No documentation available.
POST api/Groups/{groupId}/users/remove?userId={userId}	No documentation available.

ExternalContacts

API	Description
GET api/ExternalContacts/List?pageNum={pageNum}&pageSize={pageSize}	No documentation available.
GET api/ExternalContacts/ListAll	No documentation available.
POST api/ExternalContacts/create	No documentation available.
PUT api/ExternalContacts/update	No documentation available.
DELETE api/ExternalContacts/remove/{id}	No documentation available.
GET api/ExternalContacts/country/List	No documentation available.
GET api/ExternalContacts/countryPrefix/List	No documentation available.

EventNotifications

API	Description
GET api/eventNotifications/list?pageNum={pageNum}&pageSize={pageSize}	No documentation available.
GET api/eventNotifications/{EventCommunicationID}	No documentation available.
GET api/eventNotifications/attachmentinstance?userAttachmentInstance={userAttachmentInstance}	No documentation available.
POST api/eventNotifications/create	No documentation available.
POST api/eventNotifications/requestauthorizationview	No documentation available.
POST api/eventNotifications/validateauthorizationview	No documentation available.
POST api/eventNotifications/takeknowledge?notificationId={notificationId}	No documentation available.

Processes

API	Description
POST api/Processes/CreateDispatch	CREATE dispatch process
POST api/Processes/CreateInnvitation	No documentation available.
POST api/Processes/CreateParecer	CREATE 'Parecer' process
POST api/Processes/CreateDeferimento	CREATE 'Deferimento' process
POST api/Processes/CreateExpediente	CREATE 'Expediente' process
POST api/Processes/CreateDispatchDelegate	No documentation available.
POST api/Processes/CreatePreDispatch	No documentation available.
POST api/Processes/CreateEvent/md?calendarName={calendarName}	Create Event MD
POST api/Processes/CreateEvent/pr?calendarName={calendarName}	Create Event PR
POST api/Processes/CreateEvent?calendarName={calendarName}	No documentation available.
GET api/Processes/Get/{id}	GET process
GET api/Processes/List?onlyCount={onlyCount}	LIST processes or count processes
POST api/Processes/Start	START or CREATE a new process
POST api/Processes/CreateDispatchPR	CREATE Dispatch PR process
POST api/Processes/CreateParecerPR	CREATE 'Parecer PR' process
POST api/Processes/CreateExpedientePR	CREATE 'Expediente PR' process
POST api/Processes/CallMeeting	Call meeting through a document
POST api/Processes/ExtendDeadline	No documentation available.
POST api/Processes/RemoveProcess	No documentation available.
POST api/Processes/RemoveEvent	No documentation available.
POST api/Processes/ListProcesses	No documentation available.
GET api/Processes/GetUsersInDispash?folderId={folderId}	GET users in dispatch by folder id
GET api/Processes/GetHitsByUserId?userId={userId}	GET hits by user id

AppPermition

API	Description
GET api/permissions?serviceId={serviceId}
GET api/permissions/users?serviceId={serviceId}
GET api/permissions/services	Get all Services
POST api/permissions/user	add a permission to user
DELETE api/permissions/{permId}/user/{userId}/services/{serviceId}	delete a permission to user

Calendar

API	Description
GET api/config/calendars	List calendars
GET api/config/calendars/{id}	Get a calendar by id
POST api/config/calendars	Create a new calendar
PUT api/config/calendars	Edit calendar
DELETE api/config/calendars/{id}	Delete calendar
GET api/config/calendars/{id}/share	List shared calendars
POST api/config/calendars/share	Share calendar
DELETE api/config/calendars/share?usercalendarId={usercalendarId}&sharedUserId={sharedUserId}&calendarId={calendarId}	No documentation available.
PUT api/config/calendars/share	No documentation available.
PUT api/calendar/pr?conflictResolutionMode={conflictResolutionMode}&sendInvitationsOrCancellationsMode={sendInvitationsOrCancellationsMode}	UPDATE a PR event
PUT api/calendar/md?conflictResolutionMode={conflictResolutionMode}&sendInvitationsOrCancellationsMode={sendInvitationsOrCancellationsMode}	UPDATE a MDGPR event
GET api/calendar/pr?start={start}&end={end}	GET PR events between two dates. Must inclue CalendarId and CalendarRoleId header in request
GET api/calendar/md?start={start}&end={end}	GET MDGPR events between two dates Must inclue CalendarId and CalendarRoleId header in request
POST api/calendar/pr?CalendarName={CalendarName}	CREATE a PR event. Must inclue CalendarId and CalendarRoleId header in request
POST api/calendar/md?CalendarName={CalendarName}	CREATE a MDGPR event. Must inclue CalendarId and CalendarRoleId header in request
GET api/calendar/categories	No documentation available.
POST api/calendar/categories?category={category}	No documentation available.
GET api/calendar/categories/{id}	No documentation available.
POST api/calendar/acceptevent?eventId={eventId}	No documentation available.
POST api/calendar/checkconflict	No documentation available.
POST api/calendar?DocId={DocId}&SerialNumber={SerialNumber}&applicationID={applicationID}	CREATE event through expedient
POST api/calendar/expediente?DocId={DocId}&SerialNumber={SerialNumber}&applicationID={applicationID}	CREATE event through expedient
POST api/calendar/md/event?DocId={DocId}&SerialNumber={SerialNumber}&applicationID={applicationID}	CREATE MDGPR event through expedient
POST api/calendar/pr/event?DocId={DocId}&SerialNumber={SerialNumber}&applicationID={applicationID}	CREATE PR event through expedient
POST api/calendar/pr/dispatch?FolderId={FolderId}&SerialNumber={SerialNumber}&applicationID={applicationID}	CREATE PR event through dispatch
POST api/calendar/md/dispatch?FolderId={FolderId}&SerialNumber={SerialNumber}&applicationID={applicationID}	CREATE MDGPR event through dispatch
POST api/calendar/dispatch?FolderId={FolderId}&SerialNumber={SerialNumber}&applicationID={applicationID}	CREATE MDGPR event through dispatch
POST api/calendar/event/file	Add file in an existing event
DELETE api/calendar/event/file?fileId={fileId}	DELETE file in an event
DELETE api/calendar/event/filebyevent?eventId={eventId}	DELETE all files in an event
POST api/Calendar/PostEvent?CalendarName={CalendarName}&notifyUsers={notifyUsers}	Creates a new event. Must inclue CalendarId and CalendarRoleId header in request
PUT api/Calendar/PutEvent?conflictResolutionMode={conflictResolutionMode}&sendInvitationsOrCancellationsMode={sendInvitationsOrCancellationsMode}&notifyUsers={notifyUsers}	Updates an event. Must inclue CalendarId and CalendarRoleId header in request
GET api/Calendar/GetValidateAuth	Validates the auth credentials. Must inclue Basic Authorization header in request.
GET api/Calendar/GetAllEvents?StartDate={StartDate}&EndDate={EndDate}	Get events from all calendars of the user. Must inclue CalendarId and CalendarRoleId header in request
GET api/Calendar/GetEvents?StartDate={StartDate}&EndDate={EndDate}	Get events from filter data. Must inclue CalendarId and CalendarRoleId header in request
GET api/Calendar/GetEventsAllDetails?StartDate={StartDate}&EndDate={EndDate}	Get events from filter data. Must inclue CalendarId and CalendarRoleId header in request
GET api/Calendar/GetEvent?EventId={EventId}	Gets a event data. Must inclue CalendarId and CalendarRoleId header in request
POST api/Calendar/FindEvent?EventId={EventId}	Gets a event data. Must inclue CalendarId and CalendarRoleId header in request.
DELETE api/Calendar/DeleteEvent?EventId={EventId}&eventDeleteType={eventDeleteType}	Deletes the event. Must inclue CalendarId and CalendarRoleId header in request
POST api/Calendar/MoveEvent	Move an event to another calendar
GET api/Calendar/RecurrenceTypes	No documentation available.
GET api/Calendar/GetEventsPages?start={start}&end={end}&pageNum={pageNum}&pageSize={pageSize}	Get events from filter data. Must inclue CalendarId and CalendarRoleId header in request
GET api/Calendar/GetFolderId?name={name}	No documentation available.

Notifications

API	Description
GET api/notifications/token	List all Token
GET api/notifications/user/{id}	Get token by User Id
GET api/notifications/token/{id}	Get token by Id
POST api/notifications/token	Create a token
PUT api/notifications/token	Update token
DELETE api/notifications/token?userId={userId}&tokenId={tokenId}	Delete token by User Id and Token Id
POST api/notifications/send?userId={userId}&title={title}&body={body}	This method send a notification for all active device from a user
POST api/notifications/sendbyUsername?username={username}&title={title}&body={body}	This method send a notification for all active device from a user
POST api/notifications/sendbydevice?title={title}&body={body}	This method send a notification to a specific device
POST api/notifications/sendByUsernames?title={title}&body={body}	This method send a notification to a specific device
POST api/notifications/sendShort?userId={userId}&title={title}&body={body}	Send notification simple
POST api/notifications/sms/send?phoneNumber={phoneNumber}&message={message}	No documentation available.
POST api/notifications/sms/pdf	No documentation available.

PresidentialActions

API	Description
GET api/presidentialActions/{id}	Get Publication by id
GET api/presidentialActions	List publications
POST api/presidentialActions	Create publication
PUT api/presidentialActions	Update publication
DELETE api/presidentialActions/{id}	Delete publication
GET api/presidentialActions/{folderId}/posts/{id}	Get Post by folder and id
GET api/presidentialActions/posts/{id}	Get Post by id
GET api/presidentialActions/posts/{id}/img	Get Image from a post by id
GET api/presidentialActions/{folderId}/posts	List Posts by folder
GET api/presidentialActions/{folderId}/posts/ids	List all Posts ids by folder
GET api/presidentialActions/{folderId}/posts/nonimg	List Posts without its image by folder id.
POST api/presidentialActions/{folderId}/posts	Create Post in a folder
POST api/presidentialActions/{folderId}/postquick	No documentation available.
PUT api/presidentialActions/{folderId}/posts	Update post
DELETE api/presidentialActions/{folderId}/posts/{id}	Delete Post
DELETE api/presidentialActions/{folderId}/posts/{id}/deleteImage	Delete post image by docId
POST api/presidentialActions/{folderId}/posts/{id}/addImage	Add new image to post.
POST api/presidentialActions/signature	presidentialActions/signature post
GET api/PresidentialActions/GetImage/{id}	Get Image by post/doc id

ECM

API	Description
GET api/ecm/documentype	No documentation available.
GET api/ecm/organic/{id}	GET organic entity
GET api/ecm/organic	LIST organics entities
GET api/ecm/organic/site/{id}	No documentation available.
GET api/ecm/organic/site	No documentation available.
GET api/ecm/nad/{id}	GET NAD
GET api/ecm/nad	LIST all NAD's
GET api/ecm/series/{id}	GET series
GET api/ecm/series	LIST series
GET api/ecm/document/viewrequest?docid={docid}&applicationId={applicationId}&userid={userid}&messageid={messageid}&activitylink={activitylink}&foriFrame={foriFrame}	ViewerRequest create a link to open a document
GET api/ecm/document/viewrequestshort?docid={docid}&applicationId={applicationId}	ViewerRequest create a link to open a document
GET api/ecm/document/file?docid={docid}	Get File in base 64 by doc id
GET api/ecm/document/viewfile?docid={docid}&applicationId={applicationId}	No documentation available.
GET api/ecm/SubjectType/{id}	GET subject type
GET api/ecm/SubjectType	LIST all subjects types
GET api/ecm/ActionType/{id}	GET action type
GET api/ecm/ActionType	LIST actions types
GET api/ecm/ExternalEntity/{id}	GET external entity
GET api/ecm/ExternalEntity	LIST all external entities
GET api/ecm/Applications/{id}	GET application
GET api/ecm/Applications	LIST all applications
GET api/ecm/processPriorities/{id}	GET Priority
GET api/ecm/processPriorities	LIST all priorities
GET api/ecm/TypeofDispatch	LIST all TypeofDispatch
GET api/ecm/Properties/{id}	Get Propertiy
GET api/ecm/Properties	LIST all Properties
GET api/ecm/Properties/type/{id}	List Properties by typeId
GET api/ecm/Propertytypes	List Properties types
GET api/ecm/sites	LIST all sites
GET api/ecm/sites/{id}	GET a site by id
GET api/ecm/initelink	No documentation available.
GET api/ecm/initelink/userpw	No documentation available.
GET api/ECM/Schema?externalAppId={externalAppId}&applicationId={applicationId}&objectType={objectType}	GET schema
GET api/ECM/Entity?externalAppId={externalAppId}&applicationId={applicationId}&entityType={entityType}&filter={filter}	GET any entity
GET api/ECM/GetDocument?externalAppId={externalAppId}&applicationId={applicationId}&docId={docId}&sourceLocation={sourceLocation}	GET document
POST api/ECM/AddPagesToDoc?CopydocId={CopydocId}	No documentation available.
GET api/ECM/GetDocumentFile?applicationId={applicationId}&docId={docId}&sourceLocation={sourceLocation}	GET files in a document
POST api/ECM/CreateDocument?externalAppId={externalAppId}&sourceLocation={sourceLocation}	CREATE a document
POST api/ECM/AddFile	Add new file in a document
POST api/ECM/UpdateDocument?externalAppId={externalAppId}&sourceLocation={sourceLocation}	UPDATE document
POST api/ECM/CreateFolder?externalAppId={externalAppId}&sourceLocation={sourceLocation}	CREATE folder
GET api/ECM/GetFileByPath?filePath={filePath}	GET files in a document
POST api/ECM/WriteFile	Write File
GET api/ECM/GetDocHistoric?docId={docId}&applicatonId={applicatonId}&pageNumber={pageNumber}&pageSize={pageSize}	No documentation available.

EventCommunications

API	Description
GET api/eventCommunications/list?pageNum={pageNum}&pageSize={pageSize}	Method responsible for List the events that already was communications
GET api/eventCommunications/checkeventcomunication?EventComunicationId={EventComunicationId}	Method responsible for check if some event was announcement.
POST api/eventCommunications/byIDevent	Descrição do método ou tipo.
GET api/eventCommunicationsAttendeesattachs/list?pageNum={pageNum}&pageSize={pageSize}	Method responsible for List the Attachments.
GET api/eventCommunicationsAttendeesattachsby/list?EventComunicationId={EventComunicationId}&EventCAttendeesId={EventCAttendeesId}	Metodo responsavel por listar as informações de um anexo que já foi comunicado .
GET api/eventComunicationAttendees/list?pageNum={pageNum}&pageSize={pageSize}	Method responsible for List the Attendees
GET api/eventComunicationAttendees/externalcontacts/{EventComunicationId}	Descrição do método ou tipo.
GET api/eventCommunications/securitype	Metodo responsavel por listar os tipos de segurança de visualização.
GET api/eventCommunications/sharewith	Metodo sharewith responsavel por listar os tipos de partilha com.
GET api/eventCommunications/sharedtype	Metodo sharewith responsavel por listar os tipos de partilha de anexos.
POST api/EventComunications/create	No documentation available.
POST api/eventComunicationAttendees/v2/addinviteattendees	Metodo responsavel por adicionar por comunicar evento adicionando convidados, anexos e notificações.
POST api/eventComunicationAttendees/viewdocument?AttachId={AttachId}	Descrição do método ou tipo.
DELETE api/eventComunicationAttendees/remove/{id}	Descrição do método ou tipo.
DELETE api/eventComunications/remove/{id}	Descrição do método ou tipo.
POST api/eventCommunicationsAttendeesattachs/create	Descrição do método ou tipo.
PUT api/eventCommunicationsAttendeesattachs/update	Descrição do método ou tipo.

Ics

API	Description
POST api/Ics/create	No documentation available.

Testes

API	Description
GET api/Testes/GetChatAdmin	No documentation available.
POST api/Testes/UserExist?username={username}	No documentation available.
POST api/Testes/CreateUser	No documentation available.

Attachments

API	Description
GET api/Attachments/GetAttachments?SerialNumber={SerialNumber}	Get Attachments by Serial Number
GET api/Attachments/GetAttachmentsByEventId?ParentId={ParentId}	Get Attachments by Event Id
POST api/Attachments/Create	Create attachment
PUT api/Attachments/Update	Update attachment
DELETE api/Attachments/Delete?attachmentId={attachmentId}	Delete an attachment
GET api/Attachments/List	List all attachments
GET api/Attachments/GetSourceName?source={source}	No documentation available.
POST api/Attachments/CreateAttachmentProcess	No documentation available.

ObjectServer

API	Description
POST api/ObjectServer/UploadFiles	No documentation available.
GET api/ObjectServer/StreamFiles?path={path}	No documentation available.

Contacts

API	Description
GET api/Contacts/Get?namefilter={namefilter}&domain={domain}	No documentation available.