List Project Custom Status

Overview
Retrieve Project Custom Status List defined in customer settings of the client

URL Format
https://{domain}/api/rest/{clientId}/{versionNumber}/project/customStatus/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

Return
Returns a list of project custom status defined in customer settings if valid arguments are provided. Returns an error if 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="customStatusList"/>
      </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="customStatusList">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="customStatus"/>
      </xs:sequence>
      <xs:attribute name="type" use="required" type="xs:NCName"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="customStatus">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="name"/>
        <xs:element ref="apiName"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="name" type="xs:string"/>
  <xs:element name="apiName" type="xs:NCName"/>
</xs:schema>

Curl Example

HTTP Method:	GET
Request:	curl -k -X GET 'https://www.mobiwork.com/api/rest/17800/10.0.80/project/customStatus/list.html?token=RBZIRSZDP4XTV6PF5AZI'
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="10.0.80" statusCode="1"> <customStatusList type="Project"> <customStatus> <name>Open</name> <apiName>Open</apiName> </customStatus> <customStatus> <name>In Progress</name> <apiName>InProgress</apiName> </customStatus> <customStatus> <name>Pending</name> <apiName>Pending</apiName> </customStatus> <customStatus> <name>On Hold</name> <apiName>OnHold</apiName> </customStatus> <customStatus> <name>Completed</name> <apiName>Completed</apiName> </customStatus> <customStatus> <name>Cancelled</name> <apiName>Cancelled</apiName> </customStatus> <customStatus> <name>CustomProjectStatus</name> <apiName>CustomProjectStatus</apiName> </customStatus> </customStatusList> </response>