Interface ICaseManagement
Methods for creating, updating, reading journalized cases.
Namespace: Integration.ServiceContracts.CaseManagement
Syntax
[ServiceContract(Namespace = "http://Formpipe.Integration.Services/PlatinaStandardAPI")]
public interface ICaseManagementMethods
CreateJournalizedCase(CreateJournalizedCaseRequest)
Creates a journalized case
Declaration
[OperationContract]
CreateJournalizedCaseResponse CreateJournalizedCase(CreateJournalizedCaseRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| CreateJournalizedCaseRequest | req |
Returns
| Type | Description |
|---|---|
| CreateJournalizedCaseResponse | A response message of the newly created journalized case |
FinishCase(FinishJournalizedCaseRequest)
Finishes (finilizes) a journalized case
Declaration
[OperationContract]
FinishJournalizedCaseResponse FinishCase(FinishJournalizedCaseRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| FinishJournalizedCaseRequest | req |
Returns
| Type | Description |
|---|---|
| FinishJournalizedCaseResponse | A response message containing the result of the request. |
GetJournalizedCase(GetJournalizedCaseRequest)
Gets a detailed view of a specific journalized case, provided in request.
Declaration
[OperationContract]
GetJournalizedCaseResponse GetJournalizedCase(GetJournalizedCaseRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| GetJournalizedCaseRequest | req | The request message identifying a specific journalized case to be returned. |
Returns
| Type | Description |
|---|---|
| GetJournalizedCaseResponse | The response message containing detailed information about a specific journalized case. |
GetJournalizedCases(GetJournalizedCasesRequest)
Fetches the journalized cases of the specified diary.
Declaration
[OperationContract]
GetJournalizedCasesResponse GetJournalizedCases(GetJournalizedCasesRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| GetJournalizedCasesRequest | req | The request message to be sent when requesting journalized cases |
Returns
| Type | Description |
|---|---|
| GetJournalizedCasesResponse | A response message with journalized cases. |
GetJournalizedCasesByParams(GetJournalizedCasesByParamsRequest)
Fetches the journalized cases by specified parameters.
Declaration
[OperationContract]
GetJournalizedCasesResponse GetJournalizedCasesByParams(GetJournalizedCasesByParamsRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| GetJournalizedCasesByParamsRequest | req | The request message to be sent when requesting journalized cases |
Returns
| Type | Description |
|---|---|
| GetJournalizedCasesResponse | A response message with journalized cases. |
SearchCaseByDiaryNumber(SearchJournalizedCaseRequest)
Searches the journalized cases by case diary number.
Declaration
[OperationContract]
GetJournalizedCaseResponse SearchCaseByDiaryNumber(SearchJournalizedCaseRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| SearchJournalizedCaseRequest | req | The request message containing case diary number. |
Returns
| Type | Description |
|---|---|
| GetJournalizedCaseResponse | A response message containing the result of the request. |
UpdateJournalizedCase(UpdateJournalizedCaseRequest)
Updates metadata information associated with a provided journalized case.
Declaration
[OperationContract]
UpdateJournalizedCaseResponse UpdateJournalizedCase(UpdateJournalizedCaseRequest req)Parameters
| Type | Name | Description |
|---|---|---|
| UpdateJournalizedCaseRequest | req | The request message containing the metadata to be updated |
Returns
| Type | Description |
|---|---|
| UpdateJournalizedCaseResponse | A response message containing the result of the request. |
Remarks
All metadata must be (apart from the lists structures) must be provided in the request.