Work Order/Scheduling API
      Back to home
      1. Help Center
      2. API
      3. Work Order/Scheduling API

      Service Request API

      Create Service Request
      URL /ServiceRequest/Create
      Method POST
      Body

      {
      "AddressId":9471,
      "CreateDate":"\/Date(1347012968737)\/",
      "CustomId":"100001234",
      "CustomerId":7550,
      "Description":"Test description1",
      "StartDate":"\/Date(1436954400000)\/",
      "EndDate":"\/Date(1436958000000)\/",
      "Summary":"Test summary true",
      "IsTimeSet":true,

        "SalespersonId": 1
      }
      Response
      HTTP/1.1 400 Business rule violation. CustomId should be unique
      HTTP/1.1 200 OK
       

      {
      "AddressId": 9471,
      "CreateDate": "/Date(1347012968737)/",
      "CustomId": "1000012340",
      "CustomerId": 7550,
      "Description": "Test description1",
      "DueDate": "/Date(1436954400000)/",
      "EndDate": "/Date(1436954400000)/",
      "Id": 17979,
      "IsTimeSet": true,

        "SalespersonId": 1,
      "StartDate": "/Date(1436954400000)/",
      "StatusId": 3,
      "Summary": "Test summary true"
      }
      Comments

       
        Update Service Request
      URL /ServiceRequest
      Method PUT
      Body

      {
      "AddressId":9471,
      "CreateDate":"\/Date(1347012968737)\/",
      "CustomId":"1000012340",
      "CustomerId":7550,
      "Description":"Test description1",
      "StartDate":"\/Date(1436954400000)\/",
      "EndDate":"\/Date(1436958000000)\/",
      "Summary":"Test summary true1",
      "IsTimeSet":true,

        "SalespersonId": 1,
      "Id":17979
      }
      Response
      HTTP/1.1 400 Business rule violation.  CustomId should be unique
      HTTP/1.1 200 OK

      {
      "AddressId": 9471,
      "CreateDate": "/Date(1347012968737)/",
      "CustomId": "1000012340",
      "CustomerId": 7550,
      "Description": "Test description1",
      "DueDate": "/Date(1436954400000)/",
      "EndDate": "/Date(1436954400000)/",
      "Id": 17979,
      "IsTimeSet": true,

        "SalespersonId": 1,
      "StartDate": "/Date(1436954400000)/",
      "StatusId": 3,
      "Summary": "Test summary true1"
      }

       
      Comments

       
        Delete Service Request
      URL /ServiceRequest/{id}
      Method DELETE
      Body

       
      Response
      HTTP/1.1 400 Entity not found
      HTTP/1.1 200 OK
      Comments

       
        Get Service Requests
      URL /ServiceRequest/List
      Method POST
      Body

      {
      "FromModifiedDate":"\/Date(1347022800000)\/",
      "ToModifiedDate":"\/Date(1347022800000)\/"
      }
      Response

      [ 

      {
      "AddressId": 9471,
      "CreateDate": "/Date(1347012968737)/",
      "CustomId": "1000012340",
      "CustomerId": 7550,
      "Description": "Test description1",
      "DueDate": "/Date(1436954400000)/",
      "EndDate": "/Date(1436954400000)/",
      "Id": 17979,
      "IsTimeSet": true,

        "SalespersonId": 1,
      "StartDate": "/Date(1436954400000)/",
      "StatusId": 3,
      "Summary": "Test summary true1"
      }

         ]
      Comments

       
        Get Service Request
      URL /ServiceRequest/{id}
      Method GET
      Body

       
      Response

      {
      "AddressId": 9471,
      "CreateDate": "/Date(1347012968737)/",
      "CustomId": "1000012340",
      "CustomerId": 7550,
      "Description": "Test description1",
      "DueDate": "/Date(1436954400000)/",
      "EndDate": "/Date(1436954400000)/",
      "Id": 17979,
      "IsTimeSet": true,

        "SalespersonId": 1,
      "StartDate": "/Date(1436954400000)/",
      "StatusId": 3,
      "Summary": "Test summary true1"
      }
      Comments

       

       

        Service Request Search (as it is implemented on a portal)
      URL /ServiceRequest/Search/{searchText}
      Method GET
      Body

       
      Response
      the same response as for "List" request
      Comments

      if 'searchText' is empty then empty List will be returned;
      Parameter should be URL-encoded

      You can receive maximum of 50 entries. For receiving more results use request with pagination
       
       
      Service Request Search (as it is implemented on a portal) with pagination
      URL 
      ServiceRequest/Search/{searchString}/{page}/{size}
      Method GET
      Body  
      Response the same response as for "List" request
       
      Service Request Search (as it is implemented on a portal)
      URL 
      ServiceRequest/Search
      Method POST
      Body  {

      "SearchString": "ra",
      "Page": "1",
      "Size": "100"
      }
      Response the same response as for "List" request
      Comments Page and Size are optional parameters. Without them you will receive 50 elements of first page.
       
      Update QuickBooks IDs
      URL /ServiceRequest/UpdateQuickBooksJobIds
      Method POST
      Body

      {
      "QuickBooksIds": [
      {
      "ServerId": 1,
      "QuickBooksId": "80000031-1314102902"
      }
      ]
      }
      Response [{"Id":1,"IsSuccess":true,"Message":null}]