Dateformat option defines the representation of incoming and outgoing date-time values. With this option the API can be used with a date format familiar for caller end. Dateformat supports .Net date format strings. Refer to Microsoft’s documentation for more information about available configurations. For example, information about custom date and time format strings can be found from http://msdn.microsoft.com/en-us/library/8kb3ddd4.aspx..

• Default value: dd.MM.yyyy HH:mm:ss
• Usage: options=dateformat=<.Net DateTime format string>

<Content>
   <Items count="1">
       <Device>
            <WarrantyEndDate>01-20-2014</WarrantyEndDate>
       </Device>
   </Items>
</Content>

Paging can be used to limit the number of items returned by the query. If the query returns lots of items, it might be useful to improve query performance by processing data in smaller pieces. Paging can be set with the following options:

• Rows: Defines the number of items returned per page (default: 100)
• Page: Page number (default: 1)

Example: Usage of paging with rows and page options

For example, if your query returns 550 items, you can request the data in three consecutive queries:

• Query #1: options=rows=250,page=1
• Output: Items from 1 to 250

• Query #2: options=rows=250,page=2
• Output: Items from 251 to 500

• Query #3: options=rows=250,page=3
• Output: Items from 501 to 550

This option can be used to add default namespace declaration to the response documents. See XML payload structure for more information.

• Usage: options= usenamespace

Example: Usage of usenamespace option

• Usage: GET: API/Device/1835?Options=usenamespace&select=InvDevice.IMEI
• Example output:

<Content xmlns="http://www.mdm.gotoresolve.com/xmlns/api/1.0">
    <Items count="1">
        <Device>
            <InvDevice>
                <IMEI>012804006425674</IMEI>
            </InvDevice>
        </Device>
    </Items>
</Content>

Select only WarrantyEndDate, User.LastName and User.FirstName attributes.

• Usage: GET: API/Device?auth=1_asdf&select=WarrantyEndDate,User.LastName,User.FirstName

• Example output:

  <Content>
      <Items count="1">
          <Device>
              <WarrantyEndDate>21.08.2015 03.00.00</WarrantyEndDate>
              <User>
                 <Lastname>John</Lastname>
                 <Firstname>Straw</Firstname>
              </User>
          </Device>
    </Items>
  </Content>

The select setting can be used in conjunction with filters setting (see Filters). Excluding an attribute with the select does not prevent filtering with the attribute.

Select user’s first and last names and warranty end dates of devices which inventoried model name contains word iPhone

• Usage: GET: API/Device?auth=1_asdf&select=User.FirstName,User.LastName,WarrantyEndDate &filters=InvDevice.Model contains iPhone
• Example output:

  <Content>
    <Items count="1">
        <Device>
            <User>
                <Firstname>Jim</Firstname>
                <Lastname>Straw</Lastname>
            </User>
            <WarrantyEndDate>24.08.2014 03.00.00</WarrantyEndDate>
        </Device>
    </Items>
  </Content>

By default, LogMeIn Resolve MDM API returns only default attributes for an item. Select all statement can be used to select all attributes, except inventoried attributes, from an item. ‘*’ must be defined explicitly for each child item if all attributes are wanted to select. I.e. ‘*’ on the root level applies only attributes of the requested item and for child items, only the default set of attributes is selected.

Select all attributes of Device (queried item), all attributes of User child item and Model attribute of InvDevice child item. As you can see from the output, only default attributes for Location and Organization child items are selected because query doesn’t contain explicitly defined select list for them.

• Usage: GET: API/Device?auth=1_asdf&select=*,User.*,InvDevice.Model

• Example output:

  <Content>
      <Items count="1">
          <Device>
              <ID>1008</ID>
              <User>
                  <ID>1024</ID>
                  <Name>Jim Straw</Name>
                  <Email>jim.straw@trestacom.com</Email>
                  <Firstname>Jim</Firstname>
                  <Lastname>Straw</Lastname>
                  <PhoneNumber>+358 50 1234 567</PhoneNumber>
              </User>
              <Location>
                  <ID>2</ID>
                  <Parent>
                      <ID>1</ID>
                  </Parent>
              </Location>
              <Organization>
                  <ID>4</ID>
                  <Parent>
                      <ID>1</ID>
                  </Parent>
              </Organization>
              <Status>AutoGenerated</Status>
              <WarrantyEndDate>24.08.2014 03.00.00</WarrantyEndDate>
              <InvDevice>
                  <Model>Apple iPhone5,2</Model>
              </InvDevice>
          </Device>
      </Items>
  </Content>

Get devices which are purchased since January 1, 2013

• Usage: GET /API/Device?auth=1_asdf&filters=PurchaseDate gt ’01.01.2013 00.00.00’

Brackets can be used to change the precedence of AND and OR logical operators.

Get devices which manufacturer is Nokia or Apple and which are purchased since January 1, 2013 or which warranty ends before January 1, 2015.

• Usage: GET /API/Device?auth=1_asdf&filters=(InvDevice.Manufacturer eq Nokia or

InvDevice.Manufacturer eq Apple) and (PurchaseDate gt ‘01.01.2013 00.00.00’ or WarrantyEndDate lt ‘01.01.2015 00.00.00’)

Filters and filter operators are separated by empty spaces, and therefore, single or double quotation marks are required if the filtered value contains empty spaces.

• Usage: GET /API/Device?auth=1_asdf&filters=Organisation.Name eq 'Research and Development'

If filter string contains single quotation marks double quotation marks must be used around the value and vice versa.

• Usage: GET /API/Device?auth=1_asdf&filters=Organisation.Name eq "Where's My Droid"

Get can be used to get single item with item ID. In this case item ID is defined in the path partition of URL. Another option is to define filters in query string and query returns all items which to filter matches. Refer to URL and query string for information about query options.

<Content>
    <Items count="1">
        <Device>
            <User>
                <Lastname>Straw</Lastname>
                <Firstname>Jim</Firstname>
            </User>
            <InvDevice>
                <Model>LGE Nexus 4</Model>
            </InvDevice>
        </Device>
    </Items>
</Content>

Query returns device which ID is 1 which is defined in URL. Query string contains also auth parameter which is used for authentication and select setting which contains list of selected attributes.

GET: /API/Device/1?auth=1_AaDf234sdf8!4&select=User.LastName,User.FirstName,InvDevice.Model&filters=Location.Name eq Helsinki

<Content>
    <Items count="2">
        <Device>
            <User>
                <Lastname>Straw</Lastname>
                <Firstname>Jim</Firstname>
            </User>
            <InvDevice>
                <Model>samsung GT-I9300</Model>
            </InvDevice>
        </Device>
        <Device>
            <User>
                <Lastname>Straw</Lastname>
                <Firstname>John</Firstname>
            </User>
            <InvDevice>
                <Model>LGE Nexus 4</Model>
            </InvDevice>
        </Device>
    </Items>
</Content>

Query returns devices which location name is Helsinki. This is defined by filters setting in query string. Query string contains also auth parameter which is used for authentication and select setting which contains list of selected attributes.

Get operation returns HTTP status codes defined in Table 6. Response contains found items in XML document. See examples from Request section above.

Create uses HTTP POST method and created item is send in requests body.

Created item must be defined in request XML document within Content/Items element. See following examples and XML payload structure for more information about structure of XML document.

Query string setting select can be used to define which created item’s attributes are returned. Otherwise, empty HTTP response is returned if item is created successfully.

POST: /API/User?auth=1_AaDf234sdf8!4&select=ID,Name

<Content>
    <Items>
        <User>
            <Email>jim.straw@trestacom.com</Email>
            <Firstname>Jim</Firstname>
            <Lastname>Straw</Lastname>
            <PhoneNumber>123456789</PhoneNumber>
        </User>
    </Items>
</Content>

Create operation returns HTTP status codes defined in Table 7. If select clause is added to query, response’s body contains created item with selected attributes. This XML document is formatted same way as responses of get operation.

<Content>
    <Items count="1">
        <User>
            <ID>1055</ID>
            <Name>Straw Jim</Name>
        </User>
    </Items>
</Content>

The Update operation is used with the HTTP PUT method by sending a request XML document to the URL which identifies the item to be updated. The Request XML document must contain the updated values of the item’s attributes. The attributes which are not defined within the request are left unmodified.

An attribute can be reset to empty value by adding an empty attribute element to the request.

The query string setting select can be used to define which updated item’s attributes are returned.

PUT: /API/User/1055?auth=1_AaDf234sdf8!4

<Content>
    <Items>
        <User>
            <Middle>M</Middle>
        </User>
    </Items>
</Content>

The attributes whose type is List, like Device’s ConfigProfileDeployment, are updated with a special method. A new child item is always added to the list when the update command is called. Items can be removed from the list with the Remove command.

The syntax for adding items to the child item list is:

PUT: /API/<Item>/<ItemID>/<ChildItem>/<ChildItemID>

Where:

• <Item> = Target item name
• <ItemID> = Target item’s ID attribute value which uniquely identifies it
• <ChildItem> = Child item attribute name
• <ChildItemID> = Child item’s ID attribute value which uniquely identifies child item In this case, the Update command doesn’t require anything in the HTTP request’s body.

PUT: /API/Device/105/ConfigProfile/5?auth=1_AaDf234sdf8!4

This query will deploy a ConfigProfile with ID = 5 to the Device with ID = 105.

PUT: /API/Device/105/Tag/BYOD Android device?auth=1_AaDf234sdf8!4

This query will add a Tag with Name = BYOD Android device to the Device with ID = 105.

The Update operation’s HTTP status codes are defined in Table 8. If the select clause is added to the query, the response’s body contains the updated item with the selected attributes. This XML document is formatted similarly as the responses of the get operation.

The Remove operation is used with the HTTP DELETE method by sending a request to the URL which identifies the item to be removed.

DELETE: /API/<Item>/<ItemID>/<ChildItem>/<ChildItemID>

DELETE /API/Device/105/ConfigProfile/5

This query will remove the ConfigProfile with ID = 5 from the Device with ID = 105.

All List child items are removed when child item ID is not defined in the request URL. In this case syntax looks this:

DELETE: /API/<Item>/<ItemID>/<ChildItem>

DELETE /API/Device/105/ConfigProfile

This query removes all ConfigProfiles from the device with ID = 105.

DELETE /API/Device/105/Tag/BYOD Android device

This query will remove the Tag with Name = BYOD Android device from the Device with ID = 105.

The Remove operation returns an empty HTTP response with status code 200 if the removal succeeds. Otherwise, it returns a response XML document with Error element.