Skip to main content

Web Service Specification

Last updated: Thu, 27 Apr 2017 19:09:45 GMT
iOFFICE Knowledge Center

Web Service Specification

Method

The Move Module API will utilize SOAP (Simple Object Access Protocol) objects and methods to communicate between systems. A WSDL will be provided at a later date when available.

Authentication

Security for the API is provided using basic authentication with SSL. An authorization HTTP header with the password provided by iOffice is required to make any calls or connections (including downloading the WSDL).

Web Service Objects

Preliminary documentation of the SOAP objects that will be provided is included as a separate zip called Move Module API DTOs.zip. Unzip the file and open index.html to browse the documentation.

Inbound Methods (to iOffice)

These methods are available to call in iOffice as needed by the customer workflow.

Method Name Arguments Description Result

createRequest

MoveRequest, sendEvent (Boolean)

Used to create a request in the iOffice Move Module. The sendEvent parameter can be used to suppress web service notification events for this call.

The new ticket number.

cancelRequest

iOffice ID (int), sendEvent (Boolean)

Cancels the specified ticket (user profiles are not updated). The sendEvent parameter can be used to suppress web service notification events for this call.

void

archiveRequest

iOffice ID (INT), sendEvent (Boolean)

Archives the specified move request. User profiles are updated according to the move request. The sendEvent parameter can be used to suppress web service notification events for this call.

void

addCommentToRequest

iOffice ID (int), commentby (User), Comment (string), sendEvent (Boolean)

Add a comment to the specified request. The sendEvent parameter can be used to suppress web service notification events for this call.

void

getRequestByID

iOffice ID

Gets the request object for inspection (for example, to read current comments or to see status).

Move Request object

getUserByEmployeeID

EmployeeID (string)

Requests a user object by the identifier (needed to associate the move request)

User object

getRequestTypeByID

iOffice Request Type ID

Gets the request type object by identifier (needed to associate to a move request item)

RequestType object

getRoomByID

iOffice Room ID

Returns the room by the iOffice unique identifier

Room object

getCost CenterByCode

Cost Center Code (string)

Returns a cost center that has the matching cost center code

CostCenter object

getAllRooms

No Arguments

Returns all rooms, floors, and buildings

Room collection

Outbound Methods (to Customer)

The below method should be implemented by the client to be notified when actions occur to the request. It is expected that the customer will then perform actions or call iOffice methods to receive additional information as needed.

 

Method Name Arguments Description Result

notifyRequestEvent

EventType (string). Possible values are:

CREATE/UPDATE/ARCHIVE/CANCEL

iOffice ID (int) the iOffice Identifier

This event is called to signify that at change has occurred to the request. The customer will then perform actions as needed, or the iOffice methods for more information.

void

 

Related Topics

Move Module API

  • Was this article helpful?