View Project By External ID

Overview
Retrieve a Project's information of the client using externalID of the project

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

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
externalId required	Specified in URL as a parameter, is the ExternalID of the project to be retrieved
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

Return
Returns a Project Object if valid arguments are provided. Returns an error if it was not a valid request

Request Body XSD
None

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="project"/>
      </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="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:element ref="customFields"/>
      </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:element name="customFields">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="customField"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customField">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="fieldType"/>
        <xs:element ref="apiName"/>
        <xs:element ref="index"/>
        <xs:element ref="value"/>
        <xs:element ref="name"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="fieldType" type="xs:integer"/>
  <xs:element name="apiName" type="xs:NCName"/>
  <xs:element name="index" type="xs:integer"/>
  <xs:element name="value">
    <xs:complexType/>
  </xs:element>
  <xs:element name="name" type="xs:string"/>
</xs:schema>

Curl Example

HTTP Method:	GET
Request:	curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/project/2200/view.html?token=COJL8X2FKSLMMRTYCH2B&externalId=externalid123"
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="10.0.80" statusCode="1"> <project> <projectId>2193</projectId> <customerId>3473387</customerId> <addressId>4926049</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>External Id 12311</externalId> <crewList></crewList> <customFields> <customField> <fieldType>1</fieldType> <apiName>ProjectCustomField</apiName> <index>0</index> <value></value> <name>Project Custom Field</name> </customField> <customField> <fieldType>1</fieldType> <apiName>AnotherCustomField</apiName> <index>0</index> <value></value> <name>Another Custom Field</name> </customField> </customFields> </project> </response>