Documents

Endpoint

You can query the Documents via the following endpoint:

https://[subdomain].manageworkonline.com/awt/api/documents/[type]

The following type parameters are available:

• Reports
• Photo
• MainPhoto
• Certificate
• Drawing
• Others
• MainDrawing
• ToDoPhoto
• ToDoDrawing

Methods

[type : enum]
* Reports
* Photo
* MainPhoto
* Certificate
* Drawing
* Others
* MainDrawing
* ToDoPhoto
* ToDoDrawing

{
   Success: bool,
   ErrorMessage: string,
   Data: Array<object>
}

[type : enum]
* Reports
* Photo
* MainPhoto
* Certificate
* Drawing
* Others
* MainDrawing
* ToDoPhoto
* ToDoDrawing

File

Schema

Document Schema Definition:

JSON Example

{
    "Id": 528,
    "Reference": "400abc-2016-11-28-8ba0b",
    "Description": "old-house-photo",
    "JobId": 156,
    "PropertyId": 400,
    "Uprn": "400abc",
    "CreatedBy": "tomas tomas",
    "ModifiedBy": null,
    "DateOfModification": null,
    "DateOfCreation": "/Date(1480329768330+0000)/",
    "IsApproved": true
}

Request Example

function getDocuemnts(){
   var success = function(loginResponse) {
      if(loginResponse.Success){
         $.ajax({
            type: "GET",
            url: 'https://[subdomain].manageworkonline.com/awt/api/documents/photo',
            crossDomain: true,
            xhrFields: { withCredentials: true },
            success: function(response){
               if(response.Success){
                  alert(response.Data.length);
               }
            },
            dataType: "json"
         });
      }
   };
   window.login(success);
}