List Projects

Overview
Retrieve Project List of the client

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/project/list.html?token=XXXXXXXX&userId={userId}

Arguments

clientId required	MobiWork assigned unique ID of the company
versionNumber required	Version number of MobiWork API SDK release. Current version is: 10.0.78
token required	Part of URL as a request parameter and is required in every call to verify access to API calls
userId optional	If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID

Filter or Search Criteria

projectName	By Project Name
category	By the Category of the Projects
customStatus	By Projects status API names
createdBy	By the created user, accept either name (lastname, firstname) or userId
createdFromDate	By create date range from date
createdToDate	By create date range to date
externalId	By external ID of project
integrationStatus	By integration statuses, accept either name or the ID of the status.

Curl Example
Returns a list of Project Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 projects will be returned. Returns an error if not a valid request

Request Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="request">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="customStatus"/>
        <xs:element ref="projectName"/>
        <xs:element ref="category"/>
        <xs:element ref="createdBy"/>
        <xs:element ref="createdFrom"/>
        <xs:element ref="createdToDate"/>
        <xs:element ref="externalId"/>
        <xs:element ref="integrationStatus"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customStatus" type="xs:NCName" minOccurs="0"/>
  <xs:element name="projectName" type="xs:string" minOccurs="0"/>
  <xs:element name="category" type="xs:string" minOccurs="0"/>
  <xs:element name="createdBy" type="xs:NCName" minOccurs="0"/>
  <xs:element name="createdFrom" type="xs:string" minOccurs="0"/>
  <xs:element name="createdToDate" type="xs:string" minOccurs="0"/>
  <xs:element name="externalId" type="xs:string" minOccurs="0"/>
  <xs:element name="integrationStatus" type="xs:NCName" minOccurs="0"/>
</xs:schema>

Response Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="projectList"/>
      </xs:sequence>
      <xs:attribute name="statusCode" use="required" type="xs:integer"/>
      <xs:attribute name="version" use="required" type="xs:NMTOKEN"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="projectList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="totalAvailableCount"/>
        <xs:element ref="count"/>
        <xs:element maxOccurs="unbounded" ref="project"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="totalAvailableCount" type="xs:integer"/>
  <xs:element name="count" type="xs:integer"/>
  <xs:element name="project">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="projectId"/>
        <xs:element ref="customerId"/>
        <xs:element ref="addressId"/>
        <xs:element ref="description"/>
        <xs:element ref="assignedTo"/>
        <xs:element ref="minNumberOfUsers"/>
        <xs:element ref="maxNumberOfUsers"/>
        <xs:element ref="minNumberOfUsersInCrew"/>
        <xs:element ref="maxNumberOfUsersInCrew"/>
        <xs:element ref="minNumberOfCrews"/>
        <xs:element ref="maxNumberOfCrews"/>
        <xs:element ref="shippingAddressId"/>
        <xs:element ref="externalId"/>
        <xs:element ref="crewList"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="projectId" type="xs:integer"/>
  <xs:element name="customerId" type="xs:integer"/>
  <xs:element name="addressId" type="xs:integer"/>
  <xs:element name="description" type="xs:string"/>
  <xs:element name="assignedTo" type="xs:integer"/>
  <xs:element name="minNumberOfUsers" type="xs:integer"/>
  <xs:element name="maxNumberOfUsers" type="xs:integer"/>
  <xs:element name="minNumberOfUsersInCrew" type="xs:integer"/>
  <xs:element name="maxNumberOfUsersInCrew" type="xs:integer"/>
  <xs:element name="minNumberOfCrews" type="xs:integer"/>
  <xs:element name="maxNumberOfCrews" type="xs:integer"/>
  <xs:element name="shippingAddressId" type="xs:integer"/>
  <xs:element name="externalId" type="xs:string"/>
  <xs:element name="crewList">
    <xs:complexType/>
  </xs:element>
</xs:schema>

Curl Example

HTTP Method:	GET
Request:	curl -k -X GET 'https://www.mobiwork.com/api/rest/17800/10.0.80/project/list.html?token=RBZIRSZDP4XTV6PF5AZI' \ --header 'Content-Type: application/xml' \ --data-raw '<request><customStatus>CustomProjectStatus</customStatus></request> '
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="10.0.80" statusCode="1"> <projectList> <totalAvailableCount>7</totalAvailableCount> <count>7</count> <project> <projectId>2199</projectId> <customerId>3473387</customerId> <addressId>4927219</addressId> <description>Testing Add Project</description> <assignedTo>84330</assignedTo> <minNumberOfUsers>0</minNumberOfUsers> <maxNumberOfUsers>0</maxNumberOfUsers> <minNumberOfUsersInCrew>0</minNumberOfUsersInCrew> <maxNumberOfUsersInCrew>0</maxNumberOfUsersInCrew> <minNumberOfCrews>0</minNumberOfCrews> <maxNumberOfCrews>0</maxNumberOfCrews> <shippingAddressId>0</shippingAddressId> <externalId></externalId> <crewList></crewList> </project> <project> <projectId>2198</projectId> <customerId>3473387</customerId> <addressId>4927218</addressId> <description>Testing Add Project</description> <assignedTo>84330</assignedTo> <minNumberOfUsers>0</minNumberOfUsers> <maxNumberOfUsers>0</maxNumberOfUsers> <minNumberOfUsersInCrew>0</minNumberOfUsersInCrew> <maxNumberOfUsersInCrew>0</maxNumberOfUsersInCrew> <minNumberOfCrews>0</minNumberOfCrews> <maxNumberOfCrews>0</maxNumberOfCrews> <shippingAddressId>0</shippingAddressId> <externalId></externalId> <crewList></crewList> </project> <project> <projectId>2194</projectId> <customerId>3473387</customerId> <addressId>4926268</addressId> <description>Testing Add Project</description> <assignedTo>84330</assignedTo> <minNumberOfUsers>0</minNumberOfUsers> <maxNumberOfUsers>0</maxNumberOfUsers> <minNumberOfUsersInCrew>0</minNumberOfUsersInCrew> <maxNumberOfUsersInCrew>0</maxNumberOfUsersInCrew> <minNumberOfCrews>0</minNumberOfCrews> <maxNumberOfCrews>0</maxNumberOfCrews> <shippingAddressId>0</shippingAddressId> <externalId></externalId> <crewList></crewList> </project> <project> <projectId>2191</projectId> <customerId>3473387</customerId> <addressId>4926033</addressId> <description>Testing Add Project</description> <assignedTo>84330</assignedTo> <minNumberOfUsers>0</minNumberOfUsers> <maxNumberOfUsers>0</maxNumberOfUsers> <minNumberOfUsersInCrew>0</minNumberOfUsersInCrew> <maxNumberOfUsersInCrew>0</maxNumberOfUsersInCrew> <minNumberOfCrews>0</minNumberOfCrews> <maxNumberOfCrews>0</maxNumberOfCrews> <shippingAddressId>0</shippingAddressId> <externalId>null</externalId> <crewList></crewList> </project> <project> <projectId>2189</projectId> <customerId>3473387</customerId> <addressId>4926014</addressId> <description>Testing Add Project</description> <assignedTo>84330</assignedTo> <minNumberOfUsers>0</minNumberOfUsers> <maxNumberOfUsers>0</maxNumberOfUsers> <minNumberOfUsersInCrew>0</minNumberOfUsersInCrew> <maxNumberOfUsersInCrew>0</maxNumberOfUsersInCrew> <minNumberOfCrews>0</minNumberOfCrews> <maxNumberOfCrews>0</maxNumberOfCrews> <shippingAddressId>0</shippingAddressId> <externalId></externalId> <crewList></crewList> </project> <project> <projectId>2187</projectId> <customerId>3473387</customerId> <addressId>4925986</addressId> <description>Testing Add Project</description> <assignedTo>84330</assignedTo> <minNumberOfUsers>0</minNumberOfUsers> <maxNumberOfUsers>0</maxNumberOfUsers> <minNumberOfUsersInCrew>0</minNumberOfUsersInCrew> <maxNumberOfUsersInCrew>0</maxNumberOfUsersInCrew> <minNumberOfCrews>0</minNumberOfCrews> <maxNumberOfCrews>0</maxNumberOfCrews> <shippingAddressId>0</shippingAddressId> <externalId>null</externalId> <crewList></crewList> </project> <project> <projectId>2186</projectId> <customerId>3473387</customerId> <addressId>4925985</addressId> <description>Testing Add Project</description> <assignedTo>84330</assignedTo> <minNumberOfUsers>0</minNumberOfUsers> <maxNumberOfUsers>0</maxNumberOfUsers> <minNumberOfUsersInCrew>0</minNumberOfUsersInCrew> <maxNumberOfUsersInCrew>0</maxNumberOfUsersInCrew> <minNumberOfCrews>0</minNumberOfCrews> <maxNumberOfCrews>0</maxNumberOfCrews> <shippingAddressId>0</shippingAddressId> <externalId>null</externalId> <crewList></crewList> </project> </projectList> </response>