Index

api/v1/projects

Path: api/v1/projects

This API is JSON:API compliant.

This endpoint supports the following methods:
GET POST PATCH

The resource type for this endpoint is Project
The identifier is projectno

The Project resource type attributes are as follows:

{
"projectCode":string
"priority":string
"status":string
"custRef":string
optional
"reqDays":integer
optional
"reqHours":integer
"dateIn":string
"dateOut":string
"billingItemDesc":string
"companyCode":string
"projectTypeName":string
"BranchCode":string
"SubBranchCode":string
"GLDeptCode":string
"groups": [{
"type":string
"id":integer
"name":string
}]
}

Example GET (Return specific)

Path: api/v1/projects/10

Response:

{
  "data": {
    "id": "4",
    "type": "Project",
    "attributes": {
      "projectCode": "CONTRACT.SUB",
      "priority": "Normal",
      "status": "Booked",
      "custRef": "CONTRACT.SUB",
      "reqDays": null,
      "reqHours": null,
      "dateIn": "2025-10-22",
      "dateOut": null,
      "billingItemDesc": "MultiFunction Centre Type 2",
      "companyCode": null,
      "projectTypeName": "Machine",
      "BranchCode": null,
      "SubBranchCode": null,
      "GLDeptCode": null,
      "groups": []
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "CardFile",
          "id": "6"
        }
      },
      "ship": {
        "data": {
          "type": "CardFile",
          "id": "6"
        }
      },
      "billingItem": {
        "data": {
          "type": "Item",
          "id": "6"
        }
      },
      "name": {
        "data": {
          "type": "CardFile",
          "id": "16"
        }
      },
      "accountManager": {
        "data": {
          "type": "CardFile",
          "id": "16"
        }
      },
      "asset": {
        "data": {
          "type": "CardFile",
          "id": "1"
        }
      }
    },
    "links": {
      "self": "/jim_webapi_nonmulticompany/api/v1/project/4"
    }
  }
}

Example POST

Path: api/v1/projects

Request:

{
  "data": {
    "type": "Project",
    "attributes": {
      "projectCode": "TEST-148079",
      "priority": "High",
      "status": "ACTIVE",
      "custRef": "48777",
      "reqDays": null,
      "reqHours": null,
      "dateIn": "2023-10-01",
      "dateOut": "2028-09-30",
      "billingItemDesc": "Master Contract",
      "companyCode": "PERTH",
      "projectTypeName": "Master",
      "BranchCode": null,
      "SubBranchCode": "PERHO",
      "GLDeptCode": null
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "CardFile",
          "id": "4545"
        }
      },
      "ship": {
        "data": {
          "type": "CardFile",
          "id": "2221"
        }
      },
      "billingItem": {
        "data": {
          "type": "Item",
          "id": "4334"
        }
      },
      "accountManager": {
        "data": {
          "type": "CardFile",
          "id": "114705"
        }
      }
    }
  }
}

Response:

{
  "data": {
    "id": "148079",
    "type": "Project",
    "attributes": {
      "projectCode": "TEST-148079",
      "priority": "High",
      "status": "ACTIVE",
      "custRef": "48777",
      "reqDays": null,
      "reqHours": null,
      "dateIn": "2023-10-01",
      "dateOut": "2028-09-30",
      "billingItemDesc": "Master Contract",
      "companyCode": "PERTH",
      "projectTypeName": "Master",
      "BranchCode": null,
      "SubBranchCode": "PERHO",
      "GLDeptCode": null,
      "groups": [
        {
          "type": "Non Report",
          "id": 132,
          "name": "Non Government"
        }
      ]
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "CardFile",
          "id": "4545"
        }
      },
      "ship": {
        "data": {
          "type": "CardFile",
          "id": "2221"
        }
      },
      "billingItem": {
        "data": {
          "type": "Item",
          "id": "4334"
        }
      },
      "accountManager": {
        "data": {
          "type": "CardFile",
          "id": "114705"
        }
      }
    },
    "links": {
      "self": "/jim_webapi_nonmulticompany/api/v1/projects/148079"
    }
  }
}

Example PATCH

Path: api/v1/projects/10

Request:

{
  "data": {
    "id": "148079",
    "type": "Project",
    "attributes": {
      "projectCode": "TEST-148079",
      "priority": "High",
      "dateIn": "2023-10-01",
    },
    "relationships": {
      "ship": {
        "data": {
          "type": "CardFile",
          "id": "2221"
        }
      }
    },
    "links": {
      "self": "/jim_webapi_nonmulticompany/api/v1/projects/148079"
    }
  }
}

Response:

{
  "data": {
    "id": "148079",
    "type": "Project",
    "attributes": {
      "projectCode": "TEST-148079",
      "priority": "High",
      "status": "ACTIVE",
      "custRef": "48777",
      "reqDays": null,
      "reqHours": null,
      "dateIn": "2023-10-01",
      "dateOut": "2028-09-30",
      "billingItemDesc": "Master Contract",
      "companyCode": "PERTH",
      "projectTypeName": "Master",
      "BranchCode": null,
      "SubBranchCode": "PERHO",
      "GLDeptCode": null,
      "groups": [
        {
          "type": "Non Report",
          "id": 132,
          "name": "Non Government"
        }
      ]
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "CardFile",
          "id": "4545"
        }
      },
      "ship": {
        "data": {
          "type": "CardFile",
          "id": "2221"
        }
      },
      "billingItem": {
        "data": {
          "type": "Item",
          "id": "4334"
        }
      },
      "accountManager": {
        "data": {
          "type": "CardFile",
          "id": "114705"
        }
      }
    },
    "links": {
      "self": "/jim_webapi_nonmulticompany/api/v1/projects/148079"
    }
  }
}