Account

Controller for maintaining user information as well as logon and loggoff />

APIDescription
POST api/Account/Logon2

Logon using either eMail address and password or activity and security number

POST api/Account/Logon?country={country}

Creates a logon ticket for anonymous logon. The only function that accepts an anonymous logon identity is the ActivityController.CreateActivity(CreateActivityArgumentModel) method.

POST api/Account/Logon

Logon a user using an existing ticket, use this method to verify that your ticket is still valid.

POST api/Account/LogOff

Logoff user. This will remove the ticket associated with user regardless of expiration date. Only way to access system is to call Logon once more.

POST api/Account/ChangePassword

Change password for existing user

POST api/Account/ChangePasswordUsingResetToken

No documentation available.

POST api/Account/RequestResetPassword?encryptedData={encryptedData}

No documentation available.

POST api/Account/CreateUser

Creates a new external user

POST api/Account/DeleteUser

Deletes yourself as a user. You will be automatically logged out as well. This method will only be available for external users, if any other user tries to call method you will get an error response.

POST api/Account/UpdateUser

Update user profile information. You will only be allowed update your own profile

POST api/Account/IsRegisteredUser

Use this method to check if an email address already has been used with InfoCare eConnect

ActivitySearch

Contains methods for performing activity search.

APIDescription
POST api/ActivitySearch/FindActivities

Get one or more activities using activity search. Note that the user represented by the TicketId will set implicit restrictions on the search. If ticket represents an anonymous user we will automatically add activity number to the search filter, i.e. you will only get back this one activity no matter what you set in the filter. If the ticket represents a SubContractor you will only get back activities assigned to sub contractor or created by subcontractor. If the ticket represents a partner you will be limited by the contracts set up for the partner, i.e. you will only get back activities belonging to the contracts you have access to.

POST api/ActivitySearch/HasAccessToActivity

No documentation available.

Part

Controller for accessing parts

APIDescription
POST api/Part/GetPart

Gets information about a part

POST api/Part/GetSerialNumberHistory

Gets the serial number history given a requistion number and a requisition line number.

POST api/Part/GetSerialNumberHistory2

Gets the serial number history given a requistion number and a requisition line number.

File

Controller for downloading and uploading files, including reports

APIDescription
GET api/File/DownloadFile?combinedActivityId={combinedActivityId}&verification={verification}&attachmentId={attachmentId}

Gets a report or attachment from server using a get request

POST api/File/DownloadFile

Gets a report or attachment from server.

POST api/File/RemoveFile

Removes a file from the server

POST api/File/UploadFile

Upload a file. Please note that unless added the returned attachment model is added to an activity within 48 hours the file will be removed.

PartSearch

Controller for finding parts

APIDescription
POST api/PartSearch/PartSearch

Search for parts

POST api/PartSearch/PartSearch2

Search for parts

Activity

Controller for handling individual activities

APIDescription
POST api/Activity/GetActivity

Get an activity

POST api/Activity/ChangeCustomer

Change the customer on a given activity. You need to specify the customer and the customer role you want the customer to have on the activity.

POST api/Activity/ChangeContract

Change the contract on a given activity. You need to specify the activity number but all the other fields are optional which means they will only be considered if specified. If it is not possible to change the contract with the provided parameters an exception will be thrown with the reason explaining why the change is not possible.

POST api/Activity/UpdateActivity

Update an activity

POST api/Activity/CreateActivity

Creates a temporary activity. Activity is not saved to database before ActivityController.UpdateActivity(ActivityArgumentModel) is called at least once.

POST api/Activity/CreateAttributeTemplate

This is a helper method you can use to get all the fields required for adding requisition lines, cost lines and comments to an activity. For example if you want to add an requisition line the documentation states that you have to add fields models for RequisitionType, PartNumber and Quantity and that the RequisitionType must be picked from a lookup. By using this method and specifying that you want to create a requisition line we will return an array consisting of fields models for these tree fields. The requisition type field will be set up with correct argument for the LookupController.GetLookupValues(LookupController.GetLookupArgumentModel)

POST api/Activity/DeleteActivity

Request a delete/deactivate for an activity. You will have to either be an InfoCare, SubContractor or Partner user to call this function. If you are a partner user, you must also have the PartnerIntegrator role. If you call this function without the correct permissions, you will get a ReadOnlyHttpResponseException

CostEstimate

APIDescription
POST api/CostEstimate/Get

Get a cost estimate on a activity

POST api/CostEstimate/UpdateCostEstimate

Update a cost estimate on a activity

ContractLineSearch

Defines return argument from ContractLineSearchController.FindContractLines(ContractLineSearchController.ContractLineSearchArgumentModel)

APIDescription
POST api/ContractLineSearch/FindContractLines

Get one or more contract lines. Note that the user represented by the TicketId may set implicit restrictions on the search. A PartnerUser for example will typically have restrictions on which contracts he/she can access.

Calendar

The calendar controll is used to create, update and delete resource calendars. The controller only supports resource calendars for InfoCare and sub-contractor users. As a general rule so can a resource maintain their own calendar. An InfoCare user may control other users if he/she belongs to any of these roles:

  • SFSEC_ResponseCalendarAdministrator
  • SFSEC_Administrator
  • SFSEC_ServiceLeader
  • SFSEC_Controller
  • SFSEC_Manager
A sub contractor user may modify other users belonging to the same company if he/or she has the SFSEC_SubContractorAdministrator role.

APIDescription
POST api/Calendar/GetCalendar

Gets an the resource calendar entries for a given period

POST api/Calendar/GetHolidayCalendars

Get all holiday calendars from all countries available to the calling user.

POST api/Calendar/UpdateCalendar

Updates a resource calendar. Use this method to extend a calendar or to change existing entries.

POST api/Calendar/CreateCalendar

Creates a new calendar. Use this method to create a new calendar.

POST api/Calendar/DeleteCalendar

Deletes a resource calendar

Lookup

Controller for getting lookup values

APIDescription
POST api/Lookup/GetLookupValues

Get generic lookup values. Use this method for getting CodeSets, Sesam status values and so on. Do not use this method to get available cost lines or available requisition functions

POST api/Lookup/GetSearchFields

Gets you a list of fields that can be used from ActivitySearchController.FindActivities(ActivitySearchController.ActivitySearchArgumentModel), ContractLineSearchController.FindContractLines(ContractLineSearchController.ContractLineSearchArgumentModel) or PartSearchController.PartSearch(PartSearchArgumentModel)

POST api/Lookup/GetAvailableCostSetDefinitions

Get available cost set definitions for an activity. Definitions for regular costs will be on a guid format, but definitions for requsitions will have the format RequsitionNumber:RequisitionLine which can be added only once if not already added, and only with quantity set to the same value as defaultQuantity.

POST api/Lookup/GetAvailableCostSetDefinitionsForContract

Get available cost set definitions for a contract. Definitions for regular costs will be on a guid format

POST api/Lookup/GetAvailableFunctions2

Get available functions for a order line

POST api/Lookup/GetAvailableWorkflowSteps

Get a list of available workflow steps for an activity

GET api/Lookup/GetTemplate?mailtemplateId={mailtemplateId}&combinedId={combinedId}&TicketId={TicketId}

Gets a mail template

POST api/Lookup/GetCityFromZip

Gets a city from zip code

POST api/Lookup/GetContractsForUser

Get contracts and cost sets based on user's contract and cost set access

POST api/Lookup/GetOrderTypesForActivity

Gets the available order types for the provided activity. Uses the activity contract / line to find available order types

POST api/Lookup/GetDefaultOrderValues

Gets the default order values for a requisition type. Takes RequisitionType and StockId as arguments. If StockId is not provided, the default stock for requisition type will be used.

POST api/Lookup/GetDefaultDeliveryCustomer

Gets default delivery customer for new requisition

Performance

Use this class to add and retrieve performance timings

APIDescription
POST api/Performance/AddPerformanceTiming

Add performance timing

POST api/Performance/FindPerformanceTimings

Get performance entries