Logo
Submit a request
Follow

Assignments

Adding an Assignment

URL

https://app.bluefolder.com/api/2.0/serviceRequests/addAssignment.aspx

Request

<request>
   <serviceRequestAssignmentAdd>
       <serviceRequestId></serviceRequestId>
       <assignedTo>
           <userId></userId>
           ...
       </assignedTo>
       <assignmentComment></assignmentComment>
       <startDate></startDate>
       <endDate></endDate>
       <allDayEvent></allDayEvent>
       <notifyCustomer></notifyCustomer>
   </serviceRequestAssignmentAdd>
</request>
            
  • serviceRequestId - (required) numeric, must match an existing Service Request in your account
  • assignedTo - designates the userIds that are to be assigned to the assignment
    • userId - numeric, must match an existing User Id in your user list
  • assignmentComment - string (no char limit), the comment text
  • startDate - datetime, must be in the format YYYY.MM.DD HH:MM AM
  • endDate - datetime, must be in the format YYYY.MM.DD HH:MM AM
  • allDayEvent - boolean, indicates if appointment is an all-day appointment
  • notifyCustomer - boolean (true/false), indicates if customer should receive an email notification for this action. The value defaults to the preferences that are set for the customer as specified in Customer Notifications. This value is ignored if the company does not allow notification preferences to be overriden or if the user does not have permission to override customer notifications.

Response

<response status="ok">
    <assignmentId>xxxxxx</assignmentId>
</response>
            

Editing an Assignment

URL

https://app.bluefolder.com/api/2.0/serviceRequests/editAssignment.aspx

Request

<request>
   <serviceRequestAssignmentEdit>
       <assignmentId></assignmentId>
       <assignedTo>
           <userId></userId>
           ...
       </assignedTo>
       <assignmentComment></assignmentComment>
       <startDate></startDate>
       <endDate></endDate>
       <allDayEvent></allDayEvent>
       <notifyCustomer></notifyCustomer>
   </serviceRequestAssignmentEdit>
</request>
            
  • assignmentId - (required) numeric, must match an existing Assignment in your account
  • assignedTo - designates the userIds that are to be assigned to the assignment
    • userId - numeric, must match an existing User Id in your user list
  • assignmentComment - string (no char limit), the comment text
  • startDate - datetime, must be in the format YYYY.MM.DD HH:MM AM
  • endDate - datetime, must be in the format YYYY.MM.DD HH:MM AM
  • allDayEvent - boolean, indicates if appointment is an all-day appointment
  • notifyCustomer - boolean (true/false), indicates if customer should receive an email notification for this action. The value defaults to the preferences that are set for the customer as specified in Customer Notifications. This value is ignored if the company does not allow notification preferences to be overriden or if the user does not have permission to override customer notifications.

Response

<response status="ok">
    <assignmentId>xxxxxx</assignmentId>
</response>
            

Completing an Assignment

URL

https://app.bluefolder.com/api/2.0/serviceRequests/completeAssignment.aspx

Request

<request>
   <serviceRequestAssignmentComplete>
       <assignmentId></assignmentId>
       <completionComment></completionComment>
       <completionCommentIsPublic></completionCommentIsPublic>
       <notifyCustomer></notifyCustomer>
   </serviceRequestAssignmentComplete>
</request>
            
  • assignmentId - (required) numeric, must match an existing Assignment in your account
  • completionComment - string (no char limit), the comment text to be associated with the completion event
  • completionCommentIsPublic - boolean, indicates if completion comment is public (viewable by customer)
  • notifyCustomer - boolean (true/false), indicates if customer should receive an email notification for this action. The value defaults to the preferences that are set for the customer as specified in Customer Notifications. This value is ignored if the company does not allow notification preferences to be overriden or if the user does not have permission to override customer notifications.

Response

<response status="ok">
    <assignmentId>xxxxxx</assignmentId>
</response>
            

Retrieving a Single Assignment

URL

https://app.bluefolder.com/api/2.0/serviceRequests/getAssignment.aspx

Request

<request>
    <serviceRequestAssignmentGet>
        <assignmentId>xxxxxx</assignmentId>
        <assignmentToken>xxxxxx</assignmentToken>
    </serviceRequestAssignmentGet>
</request>
            

Response

<response status="ok">
    <serviceRequestAssignment>
        <assignmentId></assignmentId>
        <assignmentToken></assignmentToken>
        <serviceRequestId></serviceRequestId>
        <assignedTo>
            <userId></userId>
        </assignedTo>
        <assignmentComment></assignmentComment>
        <startDate></startDate>
        <endDate></endDate>
        <allDayEvent></allDayEvent>
        <dateTimeCreated></dateTimeCreated>
        <createdByUserId></createdByUserId>
        <isComplete></isComplete>
        <dateTimeCompleted></dateTimeCompleted>
        <completedByUserId></completedByUserId>
        <completionComment></completionComment>
    </serviceRequestAssignment>
</response>
            

Retrieving a List of Assignments

URL

https://app.bluefolder.com/api/2.0/serviceRequests/getAssignmentList.aspx

Request

<request>
    <serviceRequestAssignmentList>
        <serviceRequestId></serviceRequestId>
        <customerId></customerId>
        <dateRangeStart></dateRangeStart>
        <dateRangeEnd></dateRangeEnd>
        <dateRangeType></dateRangeType>
        <assignedTo>
            <userId></userId>
            ...
        </assignedTo>
    </serviceRequestAssignmentList>
</request>
            
  • serviceRequestId - numeric, include the Id of a Service Request to return only it's assignments
  • customerId - numeric, include the If of a Customer to return only assignments for that customer
  • dateRangeStart - datetime, must be in the format YYYY.MM.DD HH:MM AM
  • dateRangeEnd - datetime, must be in the format YYYY.MM.DD HH:MM AM
  • dateRangeType - determines what type of date to filter by (must be one of the following values):
    • 'created' - to search by dateTimeCreated
    • 'completed' - to search by dateTimeCompleted
    • 'scheduled' - to search by when the assignment is scheduled for (this is the default)
  • assignedTo - filter list to only show assignments for specified userId(s)
    • userId - numeric, a userId whose assignments should be included in the results

Response

<response status="ok">
    <serviceRequestAssignment>
        <assignmentId></assignmentId>
        <assignmentToken></assignmentToken>
        <serviceRequestId></serviceRequestId>
        <assignedTo>
            <userId></userId>
        </assignedTo>
        <assignmentComment></assignmentComment>
        <startDate></startDate>
        <endDate></endDate>
        <allDayEvent></allDayEvent>
        <dateTimeCreated></dateTimeCreated>
        <createdByUserId></createdByUserId>
        <isComplete></isComplete>
        <dateTimeCompleted></dateTimeCompleted>
        <completedByUserId></completedByUserId>
        <completionComment></completionComment>
    </serviceRequestAssignment>
</response>
            
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request