List Schedule Constraints

Overview
Retrieve Schedule Constraints List defined in customer view recurrent routes tab of the client

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

Arguments

clientIdrequired	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
customerId required	The identifier of the customer to get schedule constraints
userId optional	If provided, this User ID will be taken as a logged in user

Return
Returns a list of customer defined in customer view recurrent routes tab of a client 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="scheduleConstraints"/>
      </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="scheduleConstraints">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="customerId"/>
        <xs:element maxOccurs="unbounded" ref="scheduleConstraint"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="customerId" type="xs:integer"/>
  <xs:element name="scheduleConstraint">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="scheduleConstraintId"/>
        <xs:element ref="typeId"/>
        <xs:element ref="typeName"/>
        <xs:element ref="allDayFlag"/>
        <xs:element ref="dayOfWeek"/>
        <xs:element ref="fromTime"/>
        <xs:element ref="toTime"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="scheduleConstraintId" type="xs:integer"/>
  <xs:element name="typeId" type="xs:integer"/>
  <xs:element name="typeName" type="xs:string"/>
  <xs:element name="allDayFlag" type="xs:boolean"/>
  <xs:element name="dayOfWeek" type="xs:NCName"/>
  <xs:element name="fromTime" type="xs:NMTOKEN"/>
  <xs:element name="toTime" type="xs:NMTOKEN"/>
</xs:schema>

Example

HTTP Method:	POST
Request:	curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/customer/40378/scheduleConstraint/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml'
Response:	<?xml encoding="UTF-8" ?> <response version="10.0.78" statusCode="1"> <scheduleConstraints> <customerId>40873</customerId> <scheduleConstraint> <scheduleConstraintId>286</scheduleConstraintId> <typeId>1</typeId> <typeName>CUSTOMER_CAN_BE_SERVICED_FROM_TO_DAY_TIME_RANGE</typeName> <allDayFlag>false</allDayFlag> <dayOfWeek>MONDAY</dayOfWeek> <fromTime>10:30</fromTime> <toTime>12:30</toTime> </scheduleConstraint> <scheduleConstraint> <scheduleConstraintId>287</scheduleConstraintId> <typeId>1</typeId> <typeName>CUSTOMER_CAN_BE_SERVICED_FROM_TO_DAY_TIME_RANGE</typeName> <allDayFlag>true</allDayFlag> <dayOfWeek>TUESDAY</dayOfWeek> <fromTime>0:0</fromTime> <toTime>0:0</toTime> </scheduleConstraint> </scheduleConstraints> </response>