List Product Categories

Overview
Retrieve Product Category List defined in product settings of the client

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/product/category/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 product categories defined in product 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="categoryList"/>
      </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="categoryList">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="category"/>
      </xs:sequence>
      <xs:attribute name="type" use="required" type="xs:NCName"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="category">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="categoryId"/>
        <xs:element ref="name"/>
        <xs:element ref="externalId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="categoryId" type="xs:integer"/>
  <xs:element name="name" type="xs:string"/>
  <xs:element name="externalId">
    <xs:complexType/>
  </xs:element>
</xs:schema>

Curl Example

HTTP Method:	POST
Request:	curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/product/category/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml'
Response:	<?xml encoding="UTF-8" ?> <response version="10.0.78" statusCode="1"> <categoryList type="Product"> <category> <categoryId>29</categoryId> <name>Medicine</name> <apiName>Medicine</apiName> </category> <category> <categoryId>32</categoryId> <name>Posters </name> <apiName>Posters </apiName> </category> <category> <categoryId>99</categoryId> <name>Hard Drives</name> <apiName>Hard Drives</apiName> </category> <category> <categoryId>455</categoryId> <name>TV</name> <apiName>TV</apiName> </category> <category> <categoryId>710</categoryId> <name>Computer</name> <apiName>Computer</apiName> </category> <category> <categoryId>964</categoryId> <name>Pipes</name> <apiName>Pipes</apiName> </category> <category> <categoryId>965</categoryId> <name>Copcal Fittings</name> <apiName>Copcal Fittings</apiName> </category> <category> <categoryId>966</categoryId> <name>Conex fittings</name> <apiName>Conex fittings</apiName> </category> <category> <categoryId>979</categoryId> <name>General</name> <apiName>General</apiName> </category> <category> <category> <categoryId>4921</categoryId> <name>Electrical Trucks </name> <apiName>Vehicles</apiName> </category> <category> <categoryId>4923</categoryId> <name>Vans</name> <apiName>Vans</apiName> </category> <category> <categoryId>4924</categoryId> <name>On Highway Trucks</name> <apiName>OnHighwayTrucks</apiName> </category> <category> <categoryId>4925</categoryId> <name>Mini Excavator</name> <apiName>MiniExcavator</apiName> </category> <category> <categoryId>5008</categoryId> <name>Vehicle</name> <apiName>Vehicle</apiName> </category> <category> <categoryId>5009</categoryId> <name>Vehicle</name> <apiName>Vehicle1</apiName> </category> </categoryList> </response>