Interface IExternalHelpdeskServiceContract

Namespace: Evatic.Common.Service.Contract

Assembly: Evatic.Common.dll

Syntax

[IncludeDocumentationInWsdl]
[ServiceContract(Namespace = "http://schema.evatic.com/2012/10/24", Name = "ExternalHelpdeskService")]
public interface IExternalHelpdeskServiceContract

Methods

View Source

AddDocument(ExternalHelpdeskInsertDocumentRequestDataContract)

Declaration

[OperationContract]
ExternalHelpdeskInsertDocumentResponseDataContract AddDocument(ExternalHelpdeskInsertDocumentRequestDataContract attachment)

Parameters

Type	Name	Description
ExternalHelpdeskInsertDocumentRequestDataContract	attachment

Returns

Type	Description
ExternalHelpdeskInsertDocumentResponseDataContract

View Source

CloseTriggerEvent(ExternalHelpdeskTriggerEventsDataContract)

Close open trigger event.
When external system have finished processing an event from the ListTriggerEvents, it needs to be closed.

Declaration

[OperationContract]
int CloseTriggerEvent(ExternalHelpdeskTriggerEventsDataContract triggerEvent)

Parameters

Type	Name	Description
ExternalHelpdeskTriggerEventsDataContract	triggerEvent

Returns

Type	Description
System.Int32	0/1

View Source

CreateOrUpdate(ExternalHelpdeskCreateOrUpdateRequestDataContract)

Import a new a Task or update a exsisting one. It will do an import if TaskGuid is not provided in the request or ExternalProjectNo is not found. It will update existing Task if TaskGuid is provided or ExternalProjectNo is found.

Declaration

[OperationContract]
ExternalHelpdeskCreateOrUpdateResponseDataContract CreateOrUpdate(ExternalHelpdeskCreateOrUpdateRequestDataContract projectTask)

Parameters

Type	Name	Description
ExternalHelpdeskCreateOrUpdateRequestDataContract	projectTask

Returns

Type	Description
ExternalHelpdeskCreateOrUpdateResponseDataContract	Task Guid. Null if the Task was not created.

View Source

Echo(String)

Use to verify that the service is running.

Declaration

[OperationContract]
string Echo(string textToEcho)

Parameters

Type	Name	Description
System.String	textToEcho

Returns

Type	Description
System.String

View Source

Get(Guid, Guid)

Returns a Task that has been imported from an external system.

Declaration

[OperationContract]
ExternalHelpdeskDataContract Get(Guid taskGuid, Guid externalSystemGuid)

Parameters

Type	Name	Description
System.Guid	taskGuid
System.Guid	externalSystemGuid

Returns

Type	Description
ExternalHelpdeskDataContract

View Source

ListTriggerEvents(Guid)

Retives a list of Events for Task that has been update in %Evatic %Service. If triggers is set up it will make an open event, ready for external system to fetch the updated task. The ExternalSystemGuid is used to retrive events for those Tasks that was imported from the same external system.

Declaration

[OperationContract]
IList<ExternalHelpdeskTriggerEventsDataContract> ListTriggerEvents(Guid externalSystemGuid)

Parameters

Type	Name	Description
System.Guid	externalSystemGuid

Returns

Type	Description
System.Collections.Generic.IList<ExternalHelpdeskTriggerEventsDataContract>