WorkMobileIntegration Web Service

WorkMobileIntegration

Click here for a complete list of operations.

Entities

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /wmbapi3/workmobileintegration.asmx HTTP/1.1
Host: www.esayworkmobile.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.esayworkmobile.co.uk/Entities"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Entities xmlns="https://www.esayworkmobile.co.uk/">
      <i_objJobHistory Sys_CreatedDateTime="string" JobHistoryId="int" Sys_Archived="boolean" JobId="int" Narrative="string" JobStatusId="int" MobileUserId="int" />
      <i_objJobStatus JobStatusId="int" Sys_Archived="boolean" Name="string" />
      <i_objJob JobId="int" JobLocation_Latitude="string" JobLocation_Longitude="string" JobStatusId="int" XmlData="string" EstimatedJobStartDate="string" ActualJobStartDateTime="string" Duration="int" Description="string" AllocatedUserGroupId="int" JobTypeId="int" LastAllocatedMobileUser="int" Priority="int" />
      <i_objJobAllocate JobAllocateId="int" Sys_Archived="boolean" Status="int" BroadcastUserGroupId="int" JobId="int" MobileUserId="int" SendSMS="boolean" SendEmail="boolean" />
      <i_objJobType XSDSchema="string" JobTypeId="int" Name="string" Description="string" Live="boolean" OnRouteStatus="boolean" UserFormId="int" SummaryField1="string" SummaryField2="string" SummaryField3="string" CustomSummary="string" AllowJobReject="boolean" Duration="int" EnableLocation="boolean">
        <JobTypeFields>string</JobTypeFields>
        <AdditionalSummaryFields>
          <anyType />
          <anyType />
        </AdditionalSummaryFields>
      </i_objJobType>
      <i_objMobileUser MobileUserId="int" EmailAddress="string" UserGroupId="int" Sys_Archived="boolean" Sys_CreatedDateTime="string" Username="string" Password="string" Firstname="string" Surname="string" AddressLine1="string" AddressLine2="string" AddressLine3="string" Town="string" County="string" PostCode="string" Telephone="string" Mobile="string" JobTitle="string" Description="string" UserActive="boolean" DiallingCode="string" Superuser="boolean" Device="string" Platform="string" ApplicationVersion="string" LastLoginDate="string" BackgroundUploadInterval="int" BackgroundUploadEnabled="boolean" SecurityLevel="Low or Medium or High" />
      <i_objUserForm UserFormId="int" AutoUpload="boolean" AllowSaveToDrafts="boolean" Sys_Archived="boolean" Sys_CreatedDateTime="string" Sys_CreatedUserName="string" Sys_ModifDateTime="string" Sys_ModifUserName="string" Name="string" Description="string" TableName="string" UserId="int" Live="boolean" MobileVisible="boolean" LocationAware="boolean" SubForm="boolean" />
      <i_objUserGroup UserGroupId="int" Name="string" Sys_Archived="boolean" MaximumNumberOfJobs="int" JobDeliveryOrder="int" NumberOfDaysPrior="int" LogonUserFormId="int" SentFolderEnabled="boolean" SentItemDuration="int" BackupDeviceData="boolean" AutoLogoutEnabled="boolean" AutoLogoutDuration="int" />
      <i_objDataLinkData Name="string" Data="string" Overwrite="boolean" />
      <i_objUserFormDesigner Script="string" UserFormId="int" FormName="string" Description="string" Published="boolean" LocationAware="boolean" AutoUpload="boolean" AllowSaveToDrafts="boolean" Hidden="boolean" UniqueNameFormulas="boolean" WMConnectEnabled="boolean" WMConnectSQLTableName="string" BasicReport="boolean">
        <UserFormFieldList>string</UserFormFieldList>
      </i_objUserFormDesigner>
      <i_objImage>
        <ImageStream>base64Binary</ImageStream>
        <Name>string</Name>
        <ImageId>int</ImageId>
      </i_objImage>
      <i_objFileAttachment>
        <FileStream>base64Binary</FileStream>
        <Filename>string</Filename>
        <JobId>int</JobId>
      </i_objFileAttachment>
      <i_objFormattedLabel>
        <Name>string</Name>
        <ResourceId>int</ResourceId>
        <HTML>string</HTML>
      </i_objFormattedLabel>
      <i_objUserFormNotification EmailSubject="string" EmailBody="string" EmailSubjectFormatOption="Literal or FieldName" Recipient="string" UserFormId="int" UserFormNotificationId="int" NotificationType="int" NotificationTrigger="int" Report="string" ReportFormat="string" FormatTypeDescription="string" HTMLPostBackAddress="string" HTMLPostBackFormat="string" UserName="string" Password="string" Allocated="boolean" Closed="boolean" Completed="boolean" OnDevice="boolean" Rejected="boolean" Unallocated="boolean" JobTypeId="int" EstimatedJobStartDate="string" EstimatedJobStartTime="string" JobDescription="string" AllocatedTo="string" FormValues="string" EstimatedJobStartDateOffset="string" />
      <i_objMediaManagement MediaId="int" Name="string" Type="string" Date="string" Size="int" FileStream="base64Binary" UsedByJobs="" UsedByForms="" />
      <i_objUserFormUserGroup UserFormUserGroupId="int" UserGroupId="int" UserFormId="int" />
      <i_objDocumentLibrary Description="string" Name="string" DocumentLibraryId="int" />
      <i_objLibraryDocument LibraryDocumentId="int" Filename="string" Description="string" Published="boolean" DocumentLibraryId="int" FileUploadContents="base64Binary" />
      <i_objLibraryDocumentUserForm LibraryDocumentUserFormId="int" LibraryDocumentId="int" UserFormId="int" />
      <i_objLibraryUserGroup LibraryUserGroupId="int" LibraryId="int" UserGroupId="int" />
      <i_objReport ReportId="int" UserFormId="int" UserFormName="string" ReportName="string" ReportDefinition="string" Live="boolean" />
      <i_objUserFormReportModel UserFormId="int" ModelName="string" SemanticModel="string" />
      <i_objPurgeHeader>
        <PurgeHeaderId>int</PurgeHeaderId>
        <PurgeReferenceToken>string</PurgeReferenceToken>
        <Narrative>string</Narrative>
        <Complete>boolean</Complete>
        <Numberofrowstodelete>int</Numberofrowstodelete>
        <Numberofrowscurrentlydeleted>int</Numberofrowscurrentlydeleted>
        <ErrorStatus>boolean</ErrorStatus>
        <ListPurgeData>
          <Purge>
            <JobId>int</JobId>
            <FormId>int</FormId>
            <RowId>int</RowId>
            <CatalogueId>int</CatalogueId>
            <CustomerId>int</CustomerId>
            <LoginId>int</LoginId>
          </Purge>
          <Purge>
            <JobId>int</JobId>
            <FormId>int</FormId>
            <RowId>int</RowId>
            <CatalogueId>int</CatalogueId>
            <CustomerId>int</CustomerId>
            <LoginId>int</LoginId>
          </Purge>
        </ListPurgeData>
      </i_objPurgeHeader>
      <i_objNotification UserFormId="int" UserFormNotificationId="int" Status="Active or Paused or Stopped" />
      <i_objEmailNotification AttachmentFormat="None or CSV or XML or HTML">
        <AttachmentFields>
          <int>int</int>
          <int>int</int>
        </AttachmentFields>
      </i_objEmailNotification>
      <i_objNotificationHTTP URL="string" Username="string" Password="string" Type="Simple or Extended or ExtendedUniqueName" />
      <i_objNewJobNotification JobTypeId="int" JobDescription="string" JobDescriptionFieldId="int" JobDurationFieldId="int" JobDuration="string" JobPriority="int" EstimatedJobStartDate="string" EstimatedJobStartDateFieldId="int" EstimatedJobStartDateOffset="int" EstimatedJobStartTime="string" EstimatedJobStartTimeFieldId="int" AllocatedTo="int" AllocationSource="MobileUser or UserGroup or Field" JobLocation="string" JobLocationId="int" LocationSource="LocationPicker or Field" NotificationTriggerFieldId="int">
        <FormValues DestinationUserFormFieldId="int" SourceUserFormFieldId="int" Value="string" />
        <FormValues DestinationUserFormFieldId="int" SourceUserFormFieldId="int" Value="string" />
      </i_objNewJobNotification>
      <i_objNotificationReport ReportId="int" BasicReport="boolean" ReportFormat="PDF or Word or Excel" />
      <i_objNotificationSMS Recipient="string" RecipientFieldId="int" Body="string" />
      <i_objNotificationTrigger />
      <i_objJobStatusChangeTrigger Unallocated="boolean" Allocated="boolean" OnDevice="boolean" OnRoute="boolean" InProgress="boolean" Completed="boolean" Rejected="boolean" Closed="boolean" />
      <i_objCheckboxNotificationTrigger NotificationTriggerFieldId="int" />
    </Entities>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <EntitiesResponse xmlns="https://www.esayworkmobile.co.uk/">
      <EntitiesResult>boolean</EntitiesResult>
    </EntitiesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /wmbapi3/workmobileintegration.asmx HTTP/1.1
Host: www.esayworkmobile.co.uk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Entities xmlns="https://www.esayworkmobile.co.uk/">
      <i_objJobHistory Sys_CreatedDateTime="string" JobHistoryId="int" Sys_Archived="boolean" JobId="int" Narrative="string" JobStatusId="int" MobileUserId="int" />
      <i_objJobStatus JobStatusId="int" Sys_Archived="boolean" Name="string" />
      <i_objJob JobId="int" JobLocation_Latitude="string" JobLocation_Longitude="string" JobStatusId="int" XmlData="string" EstimatedJobStartDate="string" ActualJobStartDateTime="string" Duration="int" Description="string" AllocatedUserGroupId="int" JobTypeId="int" LastAllocatedMobileUser="int" Priority="int" />
      <i_objJobAllocate JobAllocateId="int" Sys_Archived="boolean" Status="int" BroadcastUserGroupId="int" JobId="int" MobileUserId="int" SendSMS="boolean" SendEmail="boolean" />
      <i_objJobType XSDSchema="string" JobTypeId="int" Name="string" Description="string" Live="boolean" OnRouteStatus="boolean" UserFormId="int" SummaryField1="string" SummaryField2="string" SummaryField3="string" CustomSummary="string" AllowJobReject="boolean" Duration="int" EnableLocation="boolean">
        <JobTypeFields>string</JobTypeFields>
        <AdditionalSummaryFields>
          <anyType />
          <anyType />
        </AdditionalSummaryFields>
      </i_objJobType>
      <i_objMobileUser MobileUserId="int" EmailAddress="string" UserGroupId="int" Sys_Archived="boolean" Sys_CreatedDateTime="string" Username="string" Password="string" Firstname="string" Surname="string" AddressLine1="string" AddressLine2="string" AddressLine3="string" Town="string" County="string" PostCode="string" Telephone="string" Mobile="string" JobTitle="string" Description="string" UserActive="boolean" DiallingCode="string" Superuser="boolean" Device="string" Platform="string" ApplicationVersion="string" LastLoginDate="string" BackgroundUploadInterval="int" BackgroundUploadEnabled="boolean" SecurityLevel="Low or Medium or High" />
      <i_objUserForm UserFormId="int" AutoUpload="boolean" AllowSaveToDrafts="boolean" Sys_Archived="boolean" Sys_CreatedDateTime="string" Sys_CreatedUserName="string" Sys_ModifDateTime="string" Sys_ModifUserName="string" Name="string" Description="string" TableName="string" UserId="int" Live="boolean" MobileVisible="boolean" LocationAware="boolean" SubForm="boolean" />
      <i_objUserGroup UserGroupId="int" Name="string" Sys_Archived="boolean" MaximumNumberOfJobs="int" JobDeliveryOrder="int" NumberOfDaysPrior="int" LogonUserFormId="int" SentFolderEnabled="boolean" SentItemDuration="int" BackupDeviceData="boolean" AutoLogoutEnabled="boolean" AutoLogoutDuration="int" />
      <i_objDataLinkData Name="string" Data="string" Overwrite="boolean" />
      <i_objUserFormDesigner Script="string" UserFormId="int" FormName="string" Description="string" Published="boolean" LocationAware="boolean" AutoUpload="boolean" AllowSaveToDrafts="boolean" Hidden="boolean" UniqueNameFormulas="boolean" WMConnectEnabled="boolean" WMConnectSQLTableName="string" BasicReport="boolean">
        <UserFormFieldList>string</UserFormFieldList>
      </i_objUserFormDesigner>
      <i_objImage>
        <ImageStream>base64Binary</ImageStream>
        <Name>string</Name>
        <ImageId>int</ImageId>
      </i_objImage>
      <i_objFileAttachment>
        <FileStream>base64Binary</FileStream>
        <Filename>string</Filename>
        <JobId>int</JobId>
      </i_objFileAttachment>
      <i_objFormattedLabel>
        <Name>string</Name>
        <ResourceId>int</ResourceId>
        <HTML>string</HTML>
      </i_objFormattedLabel>
      <i_objUserFormNotification EmailSubject="string" EmailBody="string" EmailSubjectFormatOption="Literal or FieldName" Recipient="string" UserFormId="int" UserFormNotificationId="int" NotificationType="int" NotificationTrigger="int" Report="string" ReportFormat="string" FormatTypeDescription="string" HTMLPostBackAddress="string" HTMLPostBackFormat="string" UserName="string" Password="string" Allocated="boolean" Closed="boolean" Completed="boolean" OnDevice="boolean" Rejected="boolean" Unallocated="boolean" JobTypeId="int" EstimatedJobStartDate="string" EstimatedJobStartTime="string" JobDescription="string" AllocatedTo="string" FormValues="string" EstimatedJobStartDateOffset="string" />
      <i_objMediaManagement MediaId="int" Name="string" Type="string" Date="string" Size="int" FileStream="base64Binary" UsedByJobs="" UsedByForms="" />
      <i_objUserFormUserGroup UserFormUserGroupId="int" UserGroupId="int" UserFormId="int" />
      <i_objDocumentLibrary Description="string" Name="string" DocumentLibraryId="int" />
      <i_objLibraryDocument LibraryDocumentId="int" Filename="string" Description="string" Published="boolean" DocumentLibraryId="int" FileUploadContents="base64Binary" />
      <i_objLibraryDocumentUserForm LibraryDocumentUserFormId="int" LibraryDocumentId="int" UserFormId="int" />
      <i_objLibraryUserGroup LibraryUserGroupId="int" LibraryId="int" UserGroupId="int" />
      <i_objReport ReportId="int" UserFormId="int" UserFormName="string" ReportName="string" ReportDefinition="string" Live="boolean" />
      <i_objUserFormReportModel UserFormId="int" ModelName="string" SemanticModel="string" />
      <i_objPurgeHeader>
        <PurgeHeaderId>int</PurgeHeaderId>
        <PurgeReferenceToken>string</PurgeReferenceToken>
        <Narrative>string</Narrative>
        <Complete>boolean</Complete>
        <Numberofrowstodelete>int</Numberofrowstodelete>
        <Numberofrowscurrentlydeleted>int</Numberofrowscurrentlydeleted>
        <ErrorStatus>boolean</ErrorStatus>
        <ListPurgeData>
          <Purge>
            <JobId>int</JobId>
            <FormId>int</FormId>
            <RowId>int</RowId>
            <CatalogueId>int</CatalogueId>
            <CustomerId>int</CustomerId>
            <LoginId>int</LoginId>
          </Purge>
          <Purge>
            <JobId>int</JobId>
            <FormId>int</FormId>
            <RowId>int</RowId>
            <CatalogueId>int</CatalogueId>
            <CustomerId>int</CustomerId>
            <LoginId>int</LoginId>
          </Purge>
        </ListPurgeData>
      </i_objPurgeHeader>
      <i_objNotification UserFormId="int" UserFormNotificationId="int" Status="Active or Paused or Stopped" />
      <i_objEmailNotification AttachmentFormat="None or CSV or XML or HTML">
        <AttachmentFields>
          <int>int</int>
          <int>int</int>
        </AttachmentFields>
      </i_objEmailNotification>
      <i_objNotificationHTTP URL="string" Username="string" Password="string" Type="Simple or Extended or ExtendedUniqueName" />
      <i_objNewJobNotification JobTypeId="int" JobDescription="string" JobDescriptionFieldId="int" JobDurationFieldId="int" JobDuration="string" JobPriority="int" EstimatedJobStartDate="string" EstimatedJobStartDateFieldId="int" EstimatedJobStartDateOffset="int" EstimatedJobStartTime="string" EstimatedJobStartTimeFieldId="int" AllocatedTo="int" AllocationSource="MobileUser or UserGroup or Field" JobLocation="string" JobLocationId="int" LocationSource="LocationPicker or Field" NotificationTriggerFieldId="int">
        <FormValues DestinationUserFormFieldId="int" SourceUserFormFieldId="int" Value="string" />
        <FormValues DestinationUserFormFieldId="int" SourceUserFormFieldId="int" Value="string" />
      </i_objNewJobNotification>
      <i_objNotificationReport ReportId="int" BasicReport="boolean" ReportFormat="PDF or Word or Excel" />
      <i_objNotificationSMS Recipient="string" RecipientFieldId="int" Body="string" />
      <i_objNotificationTrigger />
      <i_objJobStatusChangeTrigger Unallocated="boolean" Allocated="boolean" OnDevice="boolean" OnRoute="boolean" InProgress="boolean" Completed="boolean" Rejected="boolean" Closed="boolean" />
      <i_objCheckboxNotificationTrigger NotificationTriggerFieldId="int" />
    </Entities>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <EntitiesResponse xmlns="https://www.esayworkmobile.co.uk/">
      <EntitiesResult>boolean</EntitiesResult>
    </EntitiesResponse>
  </soap12:Body>
</soap12:Envelope>