Local Service Information API Content

 

This section lists the potential MoversSuite data that can be set or retrieved through a Local Service Inquiry Request. This data is arranged by anticipated appearance within the returning object. One object returns for each service located by the search criteria specified through the Local Service Inquiry Request call to retrieve/set the data (either in JSON or XML format).

 

NOTES:

For all personnel phone number values (Salesperson, Coordinator, Project Manager, and Driver), the first phone number found that matches the following is returned (the order listed is the order in which the application checks, i.e. a phone type of “Cell” is checked for first):

Cell

Work

Pager

Home

Alternative

 

This type is associated to personnel through the Phone Number Item set within the General tab within their Personnel Setup record.

 

An indicator of (m) next to the specifier indicates that multiple records of that type can exist, such as multiple ServiceNotes.

 

An [] indicates the specifier is an array of fields, i.e. not a single data field.

 

 

Local Service Information API Specifier

Corresponding MoversSuite Field

Commodity

Move Information > Commodity

MoveType

Move Information > Type of Move

OrderServiceType

NOT IN USE

LocalServiceId

LocServ.PriKey

WorkTicketNo

Work Ticket

Status

Dispatch Status

ServiceType

Add Local Service > Service

Dispatch Center > Service

Local Services > Local Service

NOTE: The ServiceDate is returned as the UNIX time converted to local time of the mobile user for 12:00 P.M. on the starting date of the service. This time value was chosen, so that if the time portion of the date is interpreted as local time, the date part is still correct no matter which time zone the mobile user is in.

ServiceDate (in UNIX Time)

Add Local Service > Service Date

Dispatch Center > Date

Local Services > Date

NOTE: The JobStart and JobEnd times are the times in which the service is scheduled to start on and stop on at the site location. These times are not updated to reflect a time zone change from where the service is dispatched from to the service location. So, if a service is scheduled to begin at 8:00 A.M. and the service is downloaded to a mobile device in one time zone, then the job time remains 8:00 A.M. and is not update to reflect any time change.

JobStart

Dispatch Center > Job Start

Set Service Time > (first time entry)

JobEnd

Dispatch Center > Job End

Set Service Time > (second time entry)

OrderNo

Order Number

ShipperName

Name, Address, Phone > Last Name/Company Name

Name, Address, Phone > First Name/MI

ShipperEmail

Name, Address, Phone > Email

NOTE: The application retrieves the highest two ranked phone records set on the order for the shipper.

ShipperPhone1

Name, Address, Phone > Phone Number (highest ranked)

ShipperPhone2

Name, Address, Phone > Phone Number (second highest)

SalesPerson

Name, Address, Phone > Salesperson

SalesPersonEmail

Personnel Setup > General > Email Address

SalesPersonPhone []

Name, Address, Phone > Salesperson

Id

SysUserPhoneNumber.SysUserPhoneNumberID

Sysuser.SysUserID

Type

SysUserPhoneNumber.SysUserPhoneTypeFID

Area

Personnel Setup > General > Phone Number Item 

Local

Ext

Country

Coordinator

Name, Address, Phone > Transportation Coordinator

CoordinatorEmail

Personnel Setup > General > Email Address

CoordinatorPhone []

Name, Address, Phone > Transportation Coordinator

Id

SysUserPhoneNumber.SysUserPhoneNumberID

Sysuser.SysUserID

Type

SysUserPhoneNumber.SysUserPhoneTypeFID

Area

Personnel Setup > General > Phone Number Item 

Local

Ext

Country

Dispatcher

LocServ.ClearedBy

Sysuser.SysUserID

DispatcherEmail

Personnel Setup > General > Email Address

DispatcherPhone

Personnel Setup > General > Phone Number Item

ProjManager

Contacts and Locations > Project Manager  

Sysuser.SysUserID

ProjManagerEmail

Personnel Setup > General > Email Address

ProjManagerPhone

Personnel Setup > General > Phone Number Item

OrigAddress []

OrderAddress.AddressTypeFID = “Origin”

AddressItemId

OrderAddress.OrderAddressID

AddressType

“ORIG”

LocationType

Name, Address, Phone > Moving From > Location Type

Address1

Name, Address, Phone > Moving From > Address (first line)

Address2

Name, Address, Phone > Moving From > Address (second line)

Address3

Name, Address, Phone > Moving From > Address (third line)

City

Name, Address, Phone > Moving From > City

State

Name, Address, Phone > Moving From > State

PostalCode

Name, Address, Phone > Moving From > Postal Code

Country

Name, Address, Phone > Moving From > Country

OrigConsign []

OrderConsign.ConsignTypeFID = “Origin”

LocalServiceConsignId

OrderConsign.OrderConsignID

Contact

Name, Address, Phone > Consignor

Email

NOT AVAILABLE

Phone []

Name, Address, Phone > Consignor > Phone

DestAddress []

OrderAddress.AddressTypeFID = “Destination”

AddressItemId

OrderAddress.OrderAddress.ID

AddressType

“DEST”

LocationType

Name, Address, Phone > Moving To > Location Type

Address1

Name, Address, Phone > Moving To > Address (first line)

Address2

Name, Address, Phone > Moving To > Address (second line)

Address3

Name, Address, Phone > Moving To > Address (third line)

City

Name, Address, Phone > Moving To > City

State

Name, Address, Phone > Moving To > State

PostalCode

Name, Address, Phone > Moving To > Postal Code

Country

Name, Address, Phone > Moving To > Country

DestConsign []

OrderConsign.ConsignTypeFID = “Destination”

LocalServiceConsignId

OrderConsign.OrderConsignID

Contact

Name, Address, Phone > Consignee

Email

NOT AVAILABLE

Phone []

Name, Address, Phone > Consignee > Phone

Special Instructions [] (m)

Move Information > Special Instructions

AssignedCrew [] (m)

LSCrew

CrewMemberId

LSCrew.CrewID

SysuserFid

Sysuser.SysUserID

UserAccountId

MobileAccess.UserID

FirstName

Personnel Setup > General > Last Name

LastName

Personnel Setup > General > First Name

Email

Personnel Setup > General > Email Address

HomePhone []

Personnel Setup > General > Phone Number Item (first record with type of “Home”)

MobilePhone []

Personnel Setup > General > Phone Number Item (first record with type of “SMS”)

UserPicId

SysuserProfilePic.SysuserProfilePicID

ImageUrl

URL to retrieve image file

IsLead

Assign Crew > Crew > Lead (flag)

LaborType

Assign Crew > Crew > Role

StartTime

Assign Crew > Crew > Start

EndTime

Assign Crew > Crew > End

LaborRequested [] (m)

LocalServiceLaborRequest

LaborRequestId

LocalServiceLaborRequest.LocalServiceLaborRequestID

Description

Labor Request > Role

Quantity

Labor Request > Requested Quantity

AssignedEquipment [] (m)

 

EquipmentId

Equip.PriKey

Description

Reserve Equipment > Description

UnitNumber

Reserve Equipment > ID

DispatchByQuantity

Equipment Setup > General > Equipment Type

 

Equipment Type Setup > Dispatch based on quantity (flag)

StartTimeEst

Reserve Equipment > Start

EndTimeEst

Reserve Equipment > End

StartTimeAct

Enter Actuals > Equipment Times > Start Time

EndTimeAct

Enter Actuals > Equipment Times > End Time

QuantityEst

Reserve Equipment > Quantity

QuantityAct

Enter Actuals > Equipment Quantities > Number Returned

EquipmentRequested [] (m)

LocalServiceEquipmentRequest

LaborRequestId

LocalServiceEquipmentRequest.LocalServiceEquipmentRequestID

Description

Equipment Request > Equipment Type

Quantity

Equipment Request > Requested Quantity

Materials [] (m)

LSMaterial

Id

LSMaterial.LSMPriKey

MaterialItemId

Sort count for the record (1, 2, 3, …)

QuantityEst

Update Containers, Packing and Unpacking > Containers Estimate

PackEst

Update Containers, Packing and Unpacking > Packing Estimate

UnpackEst

Update Containers, Packing and Unpacking > Unpacking Estimate

QuantityAct

Enter Actuals > Containers, Packing, Unpacking > Containers Actual

PackAct

Enter Actuals > Containers, Packing, Unpacking > Packing Actual

UnpackAct

Enter Actuals > Containers, Packing, Unpacking > Unpacking Actual

ServiceNotes [] (m)

OrderNoteHeader, OrderNoteDetail

OrderNoteHeaderId

OrderNoteHeader.OrderNoteHeaderID

NoteType

Note > Type

Note Type Setup > Note Type

Subject

Note > Subject

Details []

 

OrderNoteDetailId

OrderNoteDetail.OrderNoteDetailID

CreatedDate

Note > Selected Note Detail > Date

CreatedBy

Note > Selected Note Detail > User Name

Sysuser.SysUserID

Personnel Setup > General > Last Name

Personnel Setup > General > First Name

NoteBody

Note (body)

Documents [] (m)

 

DocumentItemId

MSSDocument.MSSDocumentId

GroupDesc

Document Management Viewer

DocumentType

Properties > Document Properties > Document Type

DocumentDescription

Properties > Document Properties > Description

FileExtension

Properties > Document Properties > Attachment

DocContentUrl

URL to retrieve document

ServicePrimaryKeys []

Array of LocServ.PriKey returns

 

 

Sample JSON

 

The following is a sample in JSON format of the Local Service Information API response.

 

{

    "ErrorInfo": null,

    "Services": [{

        "Commodity": "HHG",

        "MoveType": "COD Local",

        "OrderServiceType": null,

        "LocalServiceId": 45960,

        "WorkTicketNo": "5000000002",

        "Status": "Crew Assigned",

        "ServiceType": "Packing",

        "ServiceDate": 1517342400,

        "JobStart": "08:15 AM",

        "JobEnd": "04:45 PM",

        "OrderNo": "Q05-3139-18",

        "ShipperName": "Natalia Romanova",

        "ShipperEmail": "Natalia@Shipper.fake",

        "ShipperPhone1": null,

        "ShipperPhone2": null,

        "SalesPerson": "Diane Gaskins",

        "SalesPersonEmail": "Diane@JoeMamaMovers.fake",

        "SalesPersonPhone": {

            "Id": 10004,

            "Type": "Cell",

            "Area": "426",

            "Local": "555-8224",

            "Ext": null,

            "Country": "US"

        },

        "Coordinator": "Theresa Whitehead",

        "CoordinatorEmail": "Theresa@JoeMamaMovers.fake",

        "CoordinatorPhone": null,

        "Dispatcher": "Anthony Harris",

        "DispatcherEmail": "Anthony@JoeMamaMovers.fake",

        "DispatcherPhone": null,

        "ProjManager": null,

        "ProjManagerEmail": null,

        "ProjManagerPhone": null,

        "OrigAddress": {

            "AddressItemId": 7812401,

            "AddressType": "ORIG",

            "LocationType": null,

            "Address1": "196 STILLWELL ST",

            "Address2": null,

            "Address3": null,

            "City": "FORT EUSTIS",

            "State": "VA",

            "PostalCode": "23604",

            "Country": "US"

        },

        "OrigConsign": {

            "LocalServiceConsignId": 697801,

            "Contact": "FREEMAN - DRAYAGE",

            "Email": null,

            "Phone": {

                "Id": 128901,

                "Type": "OConsign",

                "Area": "448",

                "Local": "555-1219",

                "Ext": null,

                "Country": "US"

            }

        },

        "DestAddress": {

            "AddressItemId": 7812501,

            "AddressType": "DEST",

            "LocationType": null,

            "Address1": "620 Washington st. S.",

            "Address2": null,

            "Address3": null,

            "City": "Alexandria",

            "State": "VA",

            "PostalCode": null,

            "Country": "US"

        },

        "DestConsign": {

            "LocalServiceConsignId": 697901,

            "Contact": "Zara Fucci",

            "Email": null,

            "Phone": {

                "Id": 129001,

                "Type": "DConsign",

                "Area": "902",

                "Local": "555-3524",

                "Ext": null,

                "Country": "US"

            }

        },

        "SpecialInstructions": "Service instructions for this Packing service would be listed here.",

        "AssignedCrew": [{

            "CrewMemberId": 42511,

            "SysuserFid": 643,

            "UserAccountId": 8,

            "FirstName": "Angel, SR",

            "LastName": "Martis",

            "Email": "Angel, SR@JoeMamaMovers.fake",

            "HomePhone": {

                "Id": 3404,

                "Type": "Home",

                "Area": "910",

                "Local": "555-1638",

                "Ext": null,

                "Country": "US"

            },

            "MobilePhone": null,

            "UserPicId": 26,

            "ImageUrl": "https://ballinatorconnect.cloudapp.net/mobileapi/AccountImage/26",

            "IsLead": false,

            "LaborType": "Packer/Loader",

            "StartTime": "08:15 AM",

            "EndTime": "02:15 PM"

        }, {

            "CrewMemberId": 42512,

            "SysuserFid": 671,

            "UserAccountId": 9,

            "FirstName": "Nathan",

            "LastName": "Mobley",

            "Email": "Nathan@JoeMamaMovers.fake",

            "HomePhone": {

                "Id": 4504,

                "Type": "Home",

                "Area": "910",

                "Local": "555-2198",

                "Ext": null,

                "Country": "US"

            },

            "MobilePhone": null,

            "UserPicId": 27,

            "ImageUrl": "https://ballinatorconnect.cloudapp.net/mobileapi/AccountImage/27",

            "IsLead": true,

            "LaborType": "Packer/Loader",

            "StartTime": "08:15 AM",

            "EndTime": "02:15 PM"

        }, {

            "CrewMemberId": 42521,

            "SysuserFid": 4,

            "UserAccountId": 2,

            "FirstName": "Paul",

            "LastName": "Cirstean",

            "Email": "Paul.Cirstean@tss-yonder.com",

            "HomePhone": {

                "Id": 404,

                "Type": "Home",

                "Area": "702",

                "Local": "555-1111",

                "Ext": null,

                "Country": "US"

            },

            "MobilePhone": {

                "Id": 6204,

                "Type": "SMS",

                "Area": "702",

                "Local": "555-7777",

                "Ext": null,

                "Country": "US"

            },

            "UserPicId": 21,

            "ImageUrl": "https://ballinatorconnect.cloudapp.net/mobileapi/AccountImage/21",

            "IsLead": false,

            "LaborType": "Packer/Loader",

            "StartTime": "08:15 AM",

            "EndTime": "02:15 PM"

        }],

        "LaborRequested": [{

            "LaborRequestId": 1,

            "Description": "Packer",

            "Quantity": 2

        }],

        "AssignedEquipment": [{

            "EquipmentId": 6225,

            "Description": "26\u0027 NCDL Straight",

            "UnitNumber": "219",

            "DispatchByQuantity": false,

            "StartTimeEst": "07:30 AM",

            "EndTimeEst": "03:30 PM",

            "StartTimeAct": null,

            "EndTimeAct": null,

            "QuantityEst": 0,

            "QuantityAct": null

        }, {

            "EquipmentId": 6254,

            "Description": "Handtruck",

            "UnitNumber": "99542",

            "DispatchByQuantity": true,

            "StartTimeEst": null,

            "EndTimeEst": null,

            "StartTimeAct": null,

            "EndTimeAct": null,

            "QuantityEst": 1,

            "QuantityAct": null

        }, {

            "EquipmentId": 6255,

            "Description": "4 Wheeler",

            "UnitNumber": "99541",

            "DispatchByQuantity": true,

            "StartTimeEst": null,

            "EndTimeEst": null,

            "StartTimeAct": null,

            "EndTimeAct": null,

            "QuantityEst": 10,

            "QuantityAct": null

        }, {

            "EquipmentId": 6256,

            "Description": "Cart",

            "UnitNumber": "99543",

            "DispatchByQuantity": true,

            "StartTimeEst": null,

            "EndTimeEst": null,

            "StartTimeAct": null,

            "EndTimeAct": null,

            "QuantityEst": 2,

            "QuantityAct": null

        }],

        "EquipmentRequested": [{

            "EquipmentRequestId": 1,

            "Description": "Pack Van",

            "Quantity": 1

        }],

        "Materials": [{

            "Id": 4596000001,

            "MaterialItemId": 1,

            "QuantityEst": 0,

            "PackEst": 21,

            "UnpackEst": 0,

            "QuantityAct": 0,

            "PackAct": 0,

            "UnpackAct": 0

        }, {

            "Id": 4596000002,

            "MaterialItemId": 2,

            "QuantityEst": 0,

            "PackEst": 27,

            "UnpackEst": 0,

            "QuantityAct": 0,

            "PackAct": 0,

            "UnpackAct": 0

        }, {

            "Id": 4596000003,

            "MaterialItemId": 3,

            "QuantityEst": 0,

            "PackEst": 48,

            "UnpackEst": 0,

            "QuantityAct": 0,

            "PackAct": 0,

            "UnpackAct": 0

        }, {

            "Id": 4596000004,

            "MaterialItemId": 4,

            "QuantityEst": 0,

            "PackEst": 36,

            "UnpackEst": 0,

            "QuantityAct": 0,

            "PackAct": 0,

            "UnpackAct": 0

        }, {

            "Id": 4596000005,

            "MaterialItemId": 5,

            "QuantityEst": 0,

            "PackEst": 1,

            "UnpackEst": 0,

            "QuantityAct": 0,

            "PackAct": 0,

            "UnpackAct": 0

        }, {

            "Id": 4596000006,

            "MaterialItemId": 6,

            "QuantityEst": 0,

            "PackEst": 3,

            "UnpackEst": 0,

            "QuantityAct": 0,

            "PackAct": 0,

            "UnpackAct": 0

        }, {

            "Id": 4596000007,

            "MaterialItemId": 7,

            "QuantityEst": 0,

            "PackEst": 4,

            "UnpackEst": 0,

            "QuantityAct": 0,

            "PackAct": 0,

            "UnpackAct": 0

        }, {

            "Id": 4596000009,

            "MaterialItemId": 9,

            "QuantityEst": 0,

            "PackEst": 4,

            "UnpackEst": 0,

            "QuantityAct": 0,

            "PackAct": 0,

            "UnpackAct": 0

        }, {

            "Id": 4596000010,

            "MaterialItemId": 10,

            "QuantityEst": 0,

            "PackEst": 1,

            "UnpackEst": 0,

            "QuantityAct": 0,

            "PackAct": 0,

            "UnpackAct": 0

        }, {

            "Id": 4596000011,

            "MaterialItemId": 11,

            "QuantityEst": 0,

            "PackEst": 4,

            "UnpackEst": 0,

            "QuantityAct": 0,

            "PackAct": 0,

            "UnpackAct": 0

        }],

        "ServiceNotes": [{

            "OrderNoteHeaderId": 27341,

            "NoteType": "OPTS-Operations Dispatch Comments",

            "Subject": "W/A DUE TO MOLD",

            "Details": [{

                "OrderNoteDetailId": 35372,

                "CreatedDate": 1162507730,

                "CreatedBy": "External Application",

                "NoteBody": "MBW1 - ADVISED HAULING AGENT U457 NOT TO LOAD, ADVISED DUANNE AT M853 THAT SHIPMENT WOULD BE PLACED ON W/A DUE TO MOLD"

            }]

        }, {

            "OrderNoteHeaderId": 27348,

            "NoteType": "SPEC-Special Instructions",

            "Subject": "Special Instructions",

            "Details": [{

                "OrderNoteDetailId": 35379,

                "CreatedDate": 1161846000,

                "CreatedBy": "External Application",

                "NoteBody": "ALERT: ORIGIN PAPERWORK (TO INCLUDE WEIGHT TICKETS, INVENTORIES, AND DD619,\rIF APPLICABLE) MUST BE RETURNED TO THE ORIGIN AGENT WITHIN 5 DAYS. DD\rFORM 1840 MUST BE SIGNED BY THE CUSTOMER AND RETURNED TO THE ORIGIN AGENT\rWITHIN 25 DAYS OF DELIVERY TO RESIDENCE. UNPACKING MUST BE PERFORMED\rUNLESS WAIVED BY THE CUSTOMER. FAILURE TO PERFORM ANY OF THESE FUNCTIONS\rCAN RESULT IN AN ASSESSMENT TO THE HAULER RANGING FROM $50 TO $75.\r----------------------------------------------------------------------------\rALLIANCE U0329 OA CENTRAL KILLEEN, TX 7 2546992654\rDA PATTERSO FAYETTEVILLE, 9104853156"

            }]

        }, {

            "OrderNoteHeaderId": 27352,

            "NoteType": "PACK",

            "Subject": "Items to be packed per 1299",

            "Details": [{

                "OrderNoteDetailId": 35386,

                "CreatedDate": 1161987993,

                "CreatedBy": "Stephanie Bittle",

                "NoteBody": "Shipment includes washer/dryer, 54in TV, home bar, grandfather clock, and china cabinet"

            }]

        }],

        "Documents": [{

            "DocumentItemId": 10,

            "GroupDesc": "Move Documents",

            "DocumentType": "BOL",

            "DocumentDescription": "SimpleReport",

            "FileExtension": "pdf",

            "DocContentUrl": "https://ballinatorconnect.cloudapp.net/mobileapi/DocumentContent/45960/10"

        }, {

            "DocumentItemId": 9,

            "GroupDesc": "Move Documents",

            "DocumentType": "Estimate",

            "DocumentDescription": "TIFF-Image-007",

            "FileExtension": "tif",

            "DocContentUrl": "https://ballinatorconnect.cloudapp.net/mobileapi/DocumentContent/45960/9"

        }, {

            "DocumentItemId": 8,

            "GroupDesc": "Correspondence",

            "DocumentType": "Letter",

            "DocumentDescription": "TestJGifDocument",

            "FileExtension": "gif",

            "DocContentUrl": "https://ballinatorconnect.cloudapp.net/mobileapi/DocumentContent/45960/8"

        }, {

            "DocumentItemId": 11,

            "GroupDesc": "Other",

            "DocumentType": "Picture",

            "DocumentDescription": "JPEG Picture",

            "FileExtension": "jpeg",

            "DocContentUrl": "https://ballinatorconnect.cloudapp.net/mobileapi/DocumentContent/45960/11"

        }]

}