NAV
Release 1.13

Helm CONNECT API Documentation


API Overview

Helm CONNECT exposes a public API for end users so they can access their data and extend application functionality. The API is a RESTful architecture, which has web resources identified by Uniform Resource Identifiers (URIs). The API endpoints are accessed with standard HTTP communication and verbs. Data returned from the API is in JSON format.

API Authorization

All API HTTP requests must have the following headers attached

API-Key: <key>,
Content-Type: application/json

The key comes from the API key management section of the Users App.

User Defined Fields

Purpose

Data Model

User Defined Field Types

—————Endpoints—————

Activities

Create/Update Activity

URI

api/v1/core/activities/CreateOrUpdateActivity

Supported Verbs

Required Parameters

Data Model

Activity Model

  {
    "Id": <Guid>,
    "VesselId": <GUID>,
    "ActivityTypeId": <GUID>,
    "FromLocationId": <Guid>,
    "ToLocationId": <Guid>,
    "PlannedStartDate": <date>,
    "PlannedEndDate": <date>,
    "StartDate": <date>,
    "EndDate": <date>,
    "RecordedByPersonId": <GUID>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  }

Activity Object Fields

Return Value

Action Accepted

  {
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Find Activities

URI

api/v1/core/activities/FindActivities

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data": 
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data": 
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <Guid>,
          "VesselId": <GUID>,
          "ActivityTypeId": <GUID>,
          "FromLocationId": <Guid>,
          "ToLocationId": <Guid>,
          "PlannedStartDate": <date>,
          "PlannedEndDate": <date>,
          "StartDate": <date>,
          "EndDate": <date>,
          "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
        },
        ...
      ]
    }
  }

Archive Activity

URI

api/v1/core/activities/ArchiveActivity

Supported Verbs

Required Parameters

Data Model

Archive Activity Model

  {
    "Id": <Guid>
  }

Archive Activity Object Fields

Return Value

Action Accepted

  {
    "Action Type": "Archive",
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>
        "Message": <string>
      },
      ...
    ]
  }

Action Rejected

  "Data": <Array>

Create/Update Job Activity

URI

api/v1/jobs/activities/CreateOrUpdateJobActivity

Supported Verbs

Required Parameters

Data Model

Job Activity Model

  {
    "Id": <Guid>,
    "JobId": <GUID>,
    "ActivityTypeId": <GUID>,
    "FromLocationId": <Guid>,
    "ToLocationId": <Guid>,
    "PlannedStartDate": <date>,
    "PlannedEndDate": <date>,
    "StartDate": <date>,
    "EndDate": <date>,
    "IsStartDateAutomatic": <boolean>,
    "IsEndDateAutomatic": <boolean>,
    "RecordedByPersonId": <GUID>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  }

Job Activity Object Fields

Return Value

Action Accepted

  {
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Find Job Activities

URI

api/v1/jobs/activities/FindJobActivities

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data": 
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data": 
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "JobId": <GUID>,
          "ActivityTypeId": <GUID>,
          "FromLocationId": <GUID>,
          "ToLocationId": <GUID>,
          "PlannedStartDate": <date>,
          "PlannedEndDate": <date>,
          "StartDate": <date>,
          "EndDate": <date>,
          "IsStartDateAutomatic": <boolean>,
          "IsEndDateAutomatic": <boolean>,
          "RecordedByPersonId": <GUID>,
          "UserDefined": UserDefinedDataModel (see User Defined Fields section for more details)
        },
        ...
      ]
    }
  }

Assets

Update Asset

URI

api/v1/core/assets/CreateOrUpdateAsset

Supported Verbs

Required Parameters

Data Model

Asset Model

  {
    "Id": <GUID>,
    "Name": <string>,
    "ShortName": <string>,
    "AccountingCode": <string>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  }

Asset Object Fields

Return Value

Action Accepted

  {
    "Data":
    {
      "ActionType": <string>,
      "Id": <GUID>
    }
  }

Find Assets

URI

api/v1/core/assets/FindAssets

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "Name": <string>,
          "ShortName": <string>,
          "AccountingCode": <string>,
          "VesselTypeNames": <string>,
          "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
        }
        ...
      ]
    }
  }

Company

Create/Update Company

URI

api/v1/jobs/companies/CreateOrUpdateCompany

Supported Verbs

Required Parameters

Data Model

Company Model

[
  {
    "Id": <GUID>,
    "Name": <string>,
    "ShortName": <string>,
    "ExternalSystemCode": <string>,
    "IsMyCompany": <boolean>,
    "IsActive": <boolean>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  },
  ....
]

Company Object Fields

Return Value

With errors

  {
    "Data": 
    [
      {
        "Name": <string>,
        "Errors":
        [
          {
            "Message": <string>,
            "Entity": <string>
          },
          ....
        ]
      }
    ]
  }

Without errors

  {
    "Data": 
    {
      "Created": <Integer>,
      "Updated": <Integer>
    }
  }

Create/Update Account

URI

api/v1/jobs/companies/CreateOrUpdateCompanyAccount

Supported Verbs

Required Parameters

Optional Parameters

Data Model

Account Model

  [
    {
      "Id": <GUID>,
      "Name": <string>,
      "Company":
      {
        "Id": <GUID>,
        "Name": <string>,
        "ShortName": <string>,
        "ExternalSystemCode": <string>,
        "IsMyCompany": <boolean>,
        "IsActive": <boolean>,
        "UserDefined":User Defined Data Model (see User Defined Fields section for more details)
      },
      "Division":
      {
        "Id": <GUID>,
        "Name": <string>,
        "ExternalSystemCode": <string>
      },
      "AccountNumber": <string>,
      "AccountType": <string>,
      "IsAR": <boolean>,
      "IsAP": <boolean>,
      "IsBlocked": <boolean>,
      "IsActive": <boolean>
    },
    ....
  ]

Account Object Fields

Return Value

With errors

  {
    "Data":
    [
      {
        "Name": <Array>,
        "Errors":
        [
          {
            "Entity": <string>
          },
          ....
        ]
      }
    ]
  }

Without errors

  {
    "Data":
    {
      "Created": <Integer>,
      "Updated": <Integer>,
      "CompanyCreated": <Integer>
    }
  }

Create/Update Account Address

URI

api/v1/jobs/companies/CreateOrUpdateAccountAddress

Supported Verbs

Required Parameters

Data Model

Account Address Model

  [
    {
      "Id": <GUID>,
      "Account":
      {
        "Id": <GUID>,
        "Name": <string>,
        "AccountNumber": <string>
      },
      "Name": <string>,
      "Address": <string>,
      "City": <string>,
      "Zipcode": <string>,
      "State": <string>,
      "Country": <string>,
      "Email": <string>,
      "Areas":
      [
        {
          "Id": <GUID>,
          "Name": <string>,
          "ExternalSystemCode": <string>
        },
        ....
      ]
    },
    ....
  ]

Account Address Object Fields

Return Value

With errors

  {
    "Data":
    [
      {
        "Name": <Array>,
        "Errors":
        [
          {
            "Entity": <string>
          },
          ....
        ]
      }
    ]
  }

Without errors

  {
    "Data":
    {
      "Created": <Integer>,
      "Updated": <Integer>
    }
  }

Find Companies

URI

api/v1/jobs/companies/FindCompanies

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "Name": <string>,
          "ShortName": <string>,
          "ExternalSystemCode": <string>,
          "IsMyCompany": <boolean>,
          "IsActive": <boolean>,
          "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
          "AccountingTerm":
          {
            "Name": <string>,
            "NumberOfDays": <integer>,
            "ExternalSystemCode": <string>
          },
          "Accounts": <Array>
          [
            {
              "Id": <GUID>,
              "Name": <string>,
              "Division":
              {
                "Id": <GUID>,
                "Name": <string>,
                "ExternalSystemCode": <string>
              },
              "AccountNumber": <string>,
              "AccountType": <string>,
              "IsAR": <boolean>,
              "IsAP": <boolean>,
              "IsBlocked": <boolean>,
              "IsActive": <boolean>,
              "IsRequested": <boolean>,
              "AccountingTerm":
              {
                "Name": <string>,
                "NumberOfDays": <integer>,
                "ExternalSystemCode": <string>
              },
              "Addresses": <Array>
              [
                {
                  "Id": <GUID>,
                  "Name": <string>,
                  "Address": <string>,
                  "City": <string>,
                  "Zipcode": <string>,
                  "State": <string>,
                  "Country": <string>,
                  "Email": <string>,
                  "Areas":
                  [
                    {
                      "Id": <GUID>,
                      "Name": <string>,
                      "ExternalSystemCode": <string>
                    },
                    ....
                  ]
                },
                ....
              ]
            },
            ....
          ]
        },
        ....
      ]
    }
  }

Currency Exchange Rate

Create/Update Currency Exchange Rate

URI

api/v1/jobs/billing/CreateOrUpdateCurrencyExchangeRate

Supported Verbs

Required Parameters

Data Model

Currency Exchange Rate Model

  {
    "CurrencyType":
    {
      "Id": <GUID>,
      "Name": <string>,
    },
    "EffectiveDate": <date>,
    "ExchangeRate": <decimal>
  }

User Object Fields

Return Value

Action Accepted

  "Data":
  {
    "CurrencyTypeId": <Guid>,
    "LogMessages":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Delete Currency Exchange Rate

URI

api/v1/jobs/billing/DeleteCurrencyExchangeRate

Supported Verbs

Required Parameters

Data Model

Currency Exchange Rate Model

  {
    "CurrencyType":
    {
      "Id": <GUID>,
      "Name": <string>,
    },
    "EffectiveDate": <date>
  }

User Object Fields

Return Value

Action Accepted

  "Data":
  {
    "CurrencyTypeId": <Guid>,
    "ExchangeRatesDeleted": <integer>,
    "LogMessages":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Divisions

Find Divisions

URI

api/v1/jobs/Divisions/FindDivisions

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "Name": <string>,
          "ShortName": <string>,
          "ExternalSystemCode": <string>,
          "AccountingCode": <string>,
          "DivisionType":
          {
            "Id": <GUID>,
            "Name": <string>  
          },
        },
        ...
      ]
    }
  }

Earning Code

Create/Update Earning Code

URI

api/v1/Personnel/EarningCodes/CreateOrUpdateEarningCode

Supported Verbs

Required Parameters

Data Model

Earning Code Model

  {
    "Id": <GUID>,
    "Name": <string>,
    "AccountingCode": <string>,
    "QuantityType": <string>,
    "DoArchive": <boolean>
  }

Earning Code Object Fields

Return Value

Action Accepted

  Data:
  {
    "ActionType": <string>,
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Find Earning Code

URI

api/v1/Personnel/EarningCodes/FindEarningCodes

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page":
      [
        {
          "Id": <GUID>,
          "Name": <string>,
          "AccountingCode": <string>,
          "QuantityType": <string>
        },
        ....
      ]
    }
  }

Action Rejected

  "Data": <Array>

Event

Create/Update Event

URI

api/v1/core/events/CreateOrUpdateEvent

Supported Verbs

Required Parameters

Data Model

Event Model

  {
    "Id": <GUID>,
    "Description": <string>,
    "EventDate": <date>,
    "EventTypeId": <GUID>,
    "VesselId": <GUID>,
    "SpaceId": <GUID>,
    "LocationId": <GUID>,
    "RecordedByPersonId": <GUID>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  }

Event Object Fields

Return Value

Action Accepted

  Data:
  {
    "ActionType":  <string>,
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Find Events

URI

api/v1/core/events/FindEvents

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data": 
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data": 
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "Description": <string>,
          "EventDate": <date>,
          "EventTypeId": <GUID>,
          "AssetId": <GUID>,
          "SpaceId": <GUID>,
          "LocationId": <GUID>,
          "RecordedByPersonId": <GUID>,
          "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
        },
        ...
      ]
    }
  }

Archive Event

URI

api/v1/core/events/ArchiveEvent

Supported Verbs

Required Parameters

Data Model

Archive Event Model

  {
    "Id": <Guid>
  }

Archive Event Object Fields

Return Value

Action Accepted

  {
    "Action Type": "Archive",
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>
        "Message": <string>
      },
      ...
    ]
  }

Action Rejected

  "Data": <Array>

Create/Update Trip Event

URI

api/v1/jobs/events/CreateOrUpdateTripEvent

Supported Verbs

Required Parameters

Data Model

Trip Event Model

  {
    "Id": <Guid>,
    "TripId": <GUID>,
    "EventTypeId": <GUID>,
    "Description": <string>,
    "EventDate": <date>,
    "LocationId": <GUID>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  }

Trip Event Object Fields

Return Value

Action Accepted

  {
    "Action Type": <string>,
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Find Trip Events

URI

api/v1/jobs/events/FindTripEvents

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data": 
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data": 
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "TripId": <GUID>,
          "EventTypeId": <GUID>,
          "Description": <string>,
          "EventDate": <date>,
          "LocationId": <Guid>,
          "UserDefined": UserDefinedDataModel (see User Defined Fields section for more details)
        },
        ...
      ]
    }
  }

Create/Update Job Event

URI

api/v1/jobs/events/CreateOrUpdateJobEvent

Supported Verbs

Required Parameters

Data Model

Job Event Model

  {
    "Id": <Guid>, 
    "JobId": <GUID>, 
    "EventTypeId": <GUID>, 
    "Description": <string>,
    "PlannedEventDate": <date>,
    "EventDate": <date>, 
    "LocationId": <GUID>, 
    "RecordedByPersonId": <GUID>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  }

Job Event Object Fields

Return Value

Action Accepted

  {
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Find Job Events

URI

api/v1/jobs/events/FindJobEvents

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data": 
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data": 
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "JobId": <GUID>,
          "EventTypeId": <GUID>,
          "Description": <string>,
          "PlannedEventDate": <date>,
          "EventDate": <date>,
          "LocationId": <GUID>,
          "RecordedByPersonId": <GUID>,
          "UserDefined": UserDefinedDataModel (see User Defined Fields section for more details)
        },
        ...
      ]
    }
  }

Order

Create Order

URI

api/v1/jobs/orders/CreateOrder

Supported Verbs

Required Parameters

Optional Parameters

Data Model

Order Model

  {
    "Division":
    {
      "Id": <GUID>,
      "Name": <string>,
      "ExternalSystemCode": <string>
    },
    "Area":
    {
      "Id": <GUID>,
      "Name": <string>,
      "ExternalSystemCode": <string>
    },
    "Ship":
    {
      "Id": <GUID>,
      "ShipTypeId": <GUID>,
      "Name": <string>,
      "IMONumber": <string>,
      "MMSI": <string>,
      "Nation": <string>,
      "CallSign": <string>,
      "Height": <decimal>,
      "Deadweight": <decimal>,
      "GT": <decimal>,
      "LOA": <decimal>,
      "Beam": <decimal>,
      "TEU": <decimal>,
      "NT": <decimal>,
      "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
    },
    "CustomerAccount":
    {
      "Id": <GUID>,
      "Name": <string>,
      "AccountNumber": <string>
    },
    "AgentAccount":
    {
      "Id": <GUID>,
      "Name": <string>,
      "AccountNumber": <string>
    },
    "AwardedToAccount":
    {
      "Id": <GUID>,
      "Name": <string>,
      "AccountNumber": <string>
    },
    "OrderDate": <date>,
    "CustomerPONumber": <string>,
    "VoyageNumber": <string>,
    "IsBillable": <boolean>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
    "Trips": <Array>
    [
      <TripModel>,
      ....
    ]
  }

Trip Model

  {
    "TripType":
    {
      "Id": <GUID>,
      "Name": <string>
    },
    "FromLocation":
    {
      "Id": <GUID>,
      "Name": <string>,
      "ExternalSystemCode": <string>
    },
    "ToLocation":
    {
      "Id": <GUID>,
      "Name": <string>,
      "ExternalSystemCode": <string>
    },
    "Status": <string>,
    "RequestedDate": <date>,
    "StartDate": <date>,
    "EndDate": <date>,
    "IsRequestedDateFirm": <boolean>,
    "EstimatedDuration": <decimal>,
    "NumberRequiredResources": <integer>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
    "Jobs": <Array>
    [
      <JobModel>,
      ....
    ]
  }

Job Model

  {
    "RequiredResourceType":
    {
      "Id": <GUID>,
      "Name": <string>
    },
    "StartDate": <date>,
    "EndDate": <date>,
    "PlannedStartDate": <date>,
    "PlannedEndDate": <date>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  }

Order Object Fields

Trip Object Fields

Job Object Fields

Return Value

With no results

  {
    "Data":
    {
      "LogMessages": <Array>
      [
        {
          "Message": <string>,
          "Entity": <string>
        },
        ....
      ]
    }
  }

With results

  {
    "Data":
    {
      "OrderId": <GUID>,
      "NewShipId": <GUID>,
      "LogMessages": <Array>
      [
        {
           "Message": <string>,
           "Entity": <string>
        },
        ....
      ]
    }
  }

Update Order

URI

api/v1/jobs/orders/UpdateOrder

Supported Verbs

Note

Required Parameters

Optional Parameters

Data Model

In the above model, the Order is being updated (Id is supplied). The first Trip is being updated (Id is supplied). The second Trip (which has no Id given), is being inserted for this Order.

Return Value

Find Orders

URI

api/v1/jobs/orders/FindOrders

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
  "Data":
  {
    "TotalCount": <integer>,
    "Page": <Array>
    [
      {
        "Id": <GUID>,
        "OrderNumber": <string>,
        "CustomerPONumber": <string>,
        "VoyageNumber": <string>,
        "OrderDate": <date>,
        "IsRequest": <boolean>,
        "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
        "Division":
        {
          "Id": <GUID>,
          "Name": <string>,
          "ExternalSystemCode": <string>
        },
        "Ship":
        {
          "Id": <GUID>,
          "Name": <string>,
          "IMONumber": <string>
        },
        "CustomerAccount":
        {
          "Id": <GUID>,
          "Name": <string>,
          "AccountNumber": <string>
        },
        "AgentAccount":
        {
          "Id": <GUID>,
          "Name": <string>,
          "AccountNumber": <string>
        },
        "AwardedToAccount":
        {
          "Id": <GUID>,
          "Name": <string>,
          "AccountNumber": <string>
        },
        "Trips": <Array>
        [
          {
            "Id": <GUID>,
            "OrderId": <GUID>,
            "TripNumber": <string>,
            "StartDate": <date>,
            "EndDate": <date>,
            "RequestedDate": <date>,
            "EstimatedDuration": <decimal>,
            "Status": <string>,
            "IsRequest": <boolean>,
            "OriginalTripId": <GUID>,
            "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
            "TripType":
            {
              "Id": <GUID>,
              "Name": <string>
            },
            "FromLocation":
            {
              "Id": <GUID>,
              "Name": <string>,
              "ExternalSystemCode": <string>
            },
            "ToLocation":
            {
              "Id": <GUID>,
              "Name": <string>,
              "ExternalSystemCode": <string>
            }
            "Jobs": <Array>
            [
              {
                "Id": <GUID>,
                "TripId": <GUID>,
                "RequiredResourceType": 
                {
                  "Id": <GUID>,
                  "Name": <string>
                },
                "StartDate": <date>,
                "EndDate": <date>,
                "PlannedStartDate": <date>,
                "PlannedEndDate": <date>,
                "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
                "IsRquest": <boolean>
              }
            ]
          },
          ....
        ]
      },
      ....
    ]
  }

Part

Create/Update Part

URI

api/v1/hsqe/parts/CreateOrUpdatePart

Supported Verbs

Required Parameters

Optional Parameters

Data Model

Part Model

  {
    "Id": <GUID>,
    "PartNumber": <string>,
    "CrossReferenceNumber": <string>,
    "Description": <string>,
    "Info": <string>,
    "PartUnit": <string>,
    "PartCategory": <string>,
    "IsActive": <boolean>,
    "IsCriticalSpare": <boolean>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  }

Part Object Fields

Return Value

Action Accepted

  Data:
  {
    "ActionType": <string>,
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>


Part Contract

Create/Update Part Contract

URI

api/v1/hsqe/parts/CreateOrUpdatePartContract

Supported Verbs

Required Parameters

Optional Parameters

Data Model

Part Contract Model

  {
    "Id": <GUID>,
    "VendorId": <GUID>,
    "PartId": <GUID>,
    "VendorPartNumber": <string> [max. 100 char],
    "Price": <decimal>,
    "StartDate": <datetime>,
    "EndDate": <datetime>,
    "Info": <string>
  }

Part Contract Object Fields

Return Value

Action Accepted

  Data:
  {
    "ActionType": <string>,
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Payroll

Find Payroll

URI

api/v1/Personnel/Payroll/FindPayroll

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "PersonId": <GUID>,
          "PayrollPeriodId": <GUID>,
          "DivisionId": <GUID>,
          "Payroll Group": {
              "Id": <GUID>,
              "Name": <string>,
              "AccountingCode": <string>
          },
          "TransactionLines":
          [
            "Id": <GUID>,
            "Rate": <decimal>,
            "Quantity": <decimal>,
            "Factor": <decimal>,
            "Amount": <decimal>,
            "StartDate": <date>,
            "EndDate": <date>,
            "AccountingCodes":
            {
              <string(ReferenceType)>:
              {
                "Id": <GUID>,
                "AccountingCode": <string>,
                "EntityName": <string>,
                "ReferenceType": <string>
              },
              ....
            }
          ],
          "PersonBankRecords":
          [
            {
              "Id": <GUID>,
              "Rate": <decimal>,
              "Quantity": <decimal>,
              "Factor": <decimal>,
              "Amount": <decimal>,
              "Date": <date>,
              "IsWithdrawal": <boolean>,
              "AccountingCodes":
              {
                <string(ReferenceType)>:
                {
                  "Id": <GUID>,
                  "AccountingCode": <string>,
                  "EntityName": <string>,
                  "ReferenceType": <string>
                },
                ....
              }
            }
          ]
        }
      ]
    }
  }

Bank Balance

URI

api/v1/Personnel/Payroll/BankBalance

Supported Verbs

Required Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "BankId": <GUID>,
          "BankName": <string>,
          "BankAccountingCode": <string>,
          "PersonId": <GUID>,
          "Balances": <Array>
          [
            {
              "PayrollClassId": <GUID>,
              "EarningCodeId": <GUID>,
              "AssetId": <GUID>,
              "CostCenterId": <GUID>,
              "Rate": <decimal>,
              "Factor": <decimal>,
              "DivisionId": <GUID>,
              "OpeningBalance": <decimal>,
              "OpeningQuantity": <decimal>,
              "ClosingBalance": <decimal>,
              "ClosingQuantity": <decimal>
            },
            ...
          ]
        }
      ]
    }
  }

Find Payroll Periods

URI

api/v1/Personnel/PayrollPeriods/FindPayrollPeriods

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "StartDate": <date>,
          "EndDate": <date>, 
          "PayrollGroup": {
              "Id": <GUID>,
              "Name": <string>, 
              "AccountingCode": <string>
          }
        }
      ]
    }
  }

Set Payroll Period Exported

URI

api/v1/Personnel/PayrollPeriods/SetPayrollPeriodExported

Supported Verbs

Required Parameters

Data Model

Payroll Class Model

  {
    "Id": <GUID>,
    "ExportDate": <date>,
    "ResetExportDate": <boolean>
  }

Payroll Class Object Fields

Return Value

Action Accepted

  Data:
  {
    "ActionType": <string>,
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Payroll Class

Create/Update Payroll Class

URI

api/v1/Personnel/PayrollClasses/CreateOrUpdatePayrollClass

Supported Verbs

Required Parameters

Data Model

Payroll Class Model

  {
    "Id": <GUID>,
    "Name": <string>,
    "AccountingCode": <string>,
    "DoArchive": <boolean>
  }

Payroll Class Object Fields

Return Value

Action Accepted

  Data:
  {
    "ActionType": <string>,
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Create/Update Payroll Class Earning Code

URI

api/v1/Personnel/PayrollClasses/CreateOrUpdatePayrollClassEarningCode

Supported Verbs

Required Parameters

Data Model

Payroll Class Earning Code Model

  {
    "Id": <GUID>,
    "PayrollClassId": <GUID>,
    "QuantityType": <string>,
    "EarningCode": {
        "Id": <GUID>,
        "Name": <string>
    },
    "Factor": <decimal>,
    "Rate": <decimal>,
    "AccrualFactor": <decimal>,
    "EffectiveDate": <date>,
    "DoArchive": <boolean>
  }

Payroll Class Earning Code Object Fields

Return Value

Action Accepted

  Data:
  {
    "ActionType": <string>,
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Find Payroll Class

URI

api/v1/Personnel/PayrollClasses/FindPayrollClasses

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "Name": <string>,
          "AccountingCode": <string>,
          "EarningCodes" [
              {
                  "Id": <GUID>,
                  "PayrollClassId": <GUID>,
                  "QuantityType": <string>,
                  "EarningCode": {
                      "Id": <GUID>,
                      "Name": <string>
                  },
                  "Factor": <decimal>,
                  "Rate": <decimal>,
                  "AccrualFactor": <decimal>,
                  "EffectiveDate": <date>
              }, ...
          ]
        },
        ...
      ]
    }
  }

Requisition

Update Requisition

URI

api/v1/hsqe/Requisitions/UpdateRequisition

Supported Verbs

Required Parameters

Optional Parameters

Data Model

Requisition Model

  {
    "Id": <GUID>,
    "Name": <string> [max. 100 char],
    "Status": <string> ["New", "Confirmed", "Ordered", "Received On Shore", "Received On Asset", "Closed", "Canceled"],
    "DueDate": <datetime>,
    "Priority": <string> ["Low", "Medium", "High"],
    "LinkedItemType": <string> ["Inspection", "Maintenance", "Inventory", "Form", "Task", "Corrective Action"],
    "LinkedItemId": <GUID>
  }

Requisition Object Fields

Return Value

Action Accepted

  "Data":
  {
    "ActionType": <string>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Update Line Item

URI

api/v1/hsqe/Requisitions/UpdateLineItem

Supported Verbs

Required Parameters

Optional Parameters

Data Model

Line Item Model

  {
    "Id": <GUID>,
    "PartId": <GUID>,
    "VesselComponentId": <GUID>,
    "Description": <string> [max. 100 char],
    "Quantity": <integer> or <decimal>
    "EstPrice": <decimal>,
    "VendorId": <GUID>,
    "Status": <string> ["New", "Confirmed", "Ordered", "Received On Shore", "Received On Asset", "Closed", "Canceled"],
    "Type": <string> ["Labor", "Part"]
  }

Line Item Object Fields

Return Value

Action Accepted

  "Data":
  {
    "ActionType": <string>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Find Requisitions

URI

api/v1/hsqe/Requisitions/FindRequisitions

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "Created": <datetime>,
          "DueDate": <datetime>,
          "Name": <string>,
          "Space": <string>,
          "Priority": <string>,
          "ExternalNumber": <string>,
          "LineItemCount": <integer>,
          "Status": <string>,
          "DivisionId": <GUID>,
          "CreatedById": <GUID>,
          "CreatedBy" : {
              "FirstName": <string>,
              "MiddleName": <string>,
              "LastName": <string>
          },
          "Asset": <string>,
          "EstCost": <decimal>,
          "LinkedItemType": <string>,
          "LinkedItemId": <GUID>,
          "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
        },
        ...
      ]
    }
  }

Find Line Items

URI

api/v1/hsqe/Requisitions/FindLineItems

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "Created": <datetime>,
          "Description": <string>,
          "ExternalNumber": <string>,
          "RequisitionId": <GUID>,
          "Space": <string>,
          "DueDate": <datetime>,
          "Priority": <string>,
          "VendorName": <string>,
          "Quantity": <decimal>,
          "EstPrice": <decimal>,
          "PartId": <GUID>,
          "PartDescription": <string>,
          "PartNumber": <string>,
          "PartUnit": <string>,
          "PartCategory": <string>,
          "Status": <string>,
          "Type": <string>,
          "Asset": <string>,
          "CreatedById": <GUID>,
          "CreatedBy" : {
              "FirstName": <string>,
              "MiddleName": <string>,
              "LastName": <string>
          },
          "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
        },
        ...
      ]
    }
  }

Ship

Create/Update Ship

URI

api/v1/jobs/ships/CreateOrUpdateShip

Supported Verbs

Required Parameters

Optional Parameters

Data Model

Ship Model

  {
    "Name": <string>,
    "MMSI": <string>,
    "IMONumber": <string>,
    "CallSign": <string>,
    "Nation": <string>,
    "ShipType": <string>,
    "Beam": <decimal>,
    "Deadweight": <decimal>,
    "GT": <decimal>,
    "Height": <decimal>,
    "NT": <decimal>,
    "Length": <decimal>,
    "LOA": <decimal>,
    "TEU": <decimal>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  }

Ship Object Fields

Return Value

Action Accepted

  "Data":
  {
    "ActionType": <string>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Note: ImoNumber, MMSI, CallSign are not required fields when updating. However, one of them needs to be present when inserting.


Tax Types

Create/Update Tax Type

URI

api/v1/jobs/TaxTypes/CreateOrUpdateTaxType

Supported Verbs

Required Parameters

Data Model

Tax Type Model

  {
    "Id": <GUID>,
    "Name": <string>,
    "ExternalSystemCode": <string>,
    "AccountingCode": <string>,
    "UsesExternalSystem": <boolean>
  }

Tax Type Object Fields

Return Value

Action Accepted

  Data:
  {
    "ActionType": <string>,
    "Id": <Guid>,
    "ErrorMsgs": <Array>
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ...
    ]
  }

Action Rejected

  "Data": <Array>

Find Tax Types

URI

api/v1/jobs/TaxTypes/FindTaxTypes

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data": 
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data": 
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "Name": <string>,
          "ExternalSystemCode": <string>,
          "AccountingCode": <string>,
          "UsesExternalSystem": <boolean>
        },
        ...
      ]
    }
  }

Action Rejected

  "Data": <Array>

Transaction

Transaction Counts by Division

URI

api/v1/jobs/transactions/TransactionCountsByDivision

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "DivisionCounts": []
    }
  }

With results

  {
    "Data":
    {
      "DivisionCounts": <Array>
      [
        {
          "DivisionId": <GUID>,
          "TransactionCount": <integer>
        }
      ]
    }
  }

Set Posted

URI

api/v1/jobs/Transactions/SetPosted

Supported Verbs

Required Parameters

Data Model

model

  {
    "Assignments": <Array>
    [
      {
        "TransactionId": <GUID>,
        "PostedDate": <date>,
        "ExternalTransactionNumber": <string>
      },
      ....
    ]
  }

Example

  api/v1/Jobs/Transactions/SetPosted
  {
    "Assignments":
    [
      {
        "TransactionId": "e0adc10c-e0d6-11e5-829b-b8ca3ad26410",
        "PostedDate": "2016-03-10T12:39:31-08:00"
      },
      {
        "TransactionId": "e0adc10d-e0d6-11e5-829b-b8ca3ad26410",
        "PostedDate": "2016-03-10T12:39:31-08:00"
      },
      ....
    ]
  }

Return Value

Details

URI

api/v1/jobs/Transactions/Details

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": [ ]
    }
  }

With Results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "ParentTransactionId": <GUID>,
          "ReversedTransactionId": <GUID>,
          "OriginalTransactionId": <GUID>,
          "GroupId": <GUID>,
          "TransactionNumber": <string>,
          "TransactionDate": <date>,
          "DueDate": <date>,
          "DivisionName": <string>,
          "DivisionShortName": <string>,
          "DivisionAccountingCode": <string>,
          "AccountName": <string>,
          "AccountNumber": <string>,
          "CompanyName": <string>,
          "CompanyShortName": <string>,
          "Note": <string>,
          "IsAR": <boolean>,
          "IsAP": <boolean>,
          "IsInvoice": <boolean>,
          "ExchangeRate": <decimal>,
          "AccountingTerm":
          {
            "Name": <string>,
            "NumberOfDays", <integer>,
            "ExternalSystemCode", <string>
          },
          "Area":
          {
            "Name": <string>,
            "ShortName": <string>,
            "ExternalSystemCode": <string>
          },
          "Order":
          {
              "OrderNumber": <string>,
              "ShipName": <string>,
              "CustomerAccount": <string>,
              "CustomerPONumber": <string>,
              "VoyageNumber": <string>,
              "AgentAccountName": <string>,
              "AgentAccountNumber": <string>,
              "Trips": <Array>
              [
                {
                  "StartDate": <date>,
                  "EndDate": <date>                        
                }
              ]
          },
          "CurrencyType": 
          {
              "Id": <GUID>,
              "Name": <string>,
              "ShortName": <string>,
              "Symbol": <string>,
              "ExternalSystemCode": <string>
          },
          "TransactionType":
          {
              "Id": <GUID>,
              "Name": <string>
          },
          "TransactionLines": <Array>
          [
            {
              "Id": <GUID>,
              "Rate": <decimal>,
              "Quantity": <decimal>,
              "Amount": <decimal>,
              "DetailDescription": <string>,
              "RevenueAllocations": <Array>
              [
                {
                  "Id": <GUID>,
                  "ReferenceTransactionLineId": <GUID>,
                  "Debit": <decimal>,
                  "Credit": <decimal>,
                  "DivisionId": <GUID>,
                  "AccountingCodes": <Array>
                  [
                    {
                      "Id": <GUID>,
                      "AccountingCode": <string>,
                      "EntityName": <string>,
                      "ReferenceType": <string>
                    }
                  ]
                }
              ]   
            }
          ]
        }
      ]
    }
  }

Trip

Create Trip

URI

api/v1/jobs/trips/CreateTrip

Supported Verbs

Required Parameters

Optional Parameters

Data Model

Trip Model

  {
    "Order":
    {
      "Id": <GUID>,
      "OrderNumber": <string>
    },
    "TripType":
    {
      "Id": <GUID>,
      "Name": <string>
    },
    "FromLocation":
    {
      "Id": <GUID>,
      "Name": <string>,
      "ExternalSystemCode": <string>
    },
    "ToLocation":
    {
      "Id": <GUID>,
      "Name": <string>,
      "ExternalSystemCode": <string>
    },
    "Status": <string>,
    "RequestedDate": <date>,
    "StartDate": <date>,
    "EndDate": <date>,
    "IsRequestedDateFirm": <boolean>,
    "EstimatedDuration": <decimal>,
    "NumberRequiredResources": <int>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
    "Jobs": <Array>
    [
      <JobModel>,
      ....
    ]
  }

Job Model

  {
    "RequiredResourceType":
    {
      "Id": <GUID>,
      "Name": <string>
    },
    "StartDate": <date>,
    "EndDate": <date>,
    "PlannedStartDate": <date>,
    "PlannedEndDate": <date>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  }

Trip Object Fields

Job Object Fields

Return Value

With no results

  {
    "Data":
    {
      "LogMessages": <Array>
      [
        {
          "Message": <string>,
          "Entity": <string>
        },
        ....
      ]
    }
  }

With results

  {
    "Data":
    {
      "TripId": <GUID>,
      "LogMessages": <Array>
      [
        {
          "Message": <string>,
          "Entity": <string>
        },
        ....
      ]
    }
  }

Update Trip

URI

api/v1/jobs/trips/UpdateTrip

Supported Verbs

Required Parameters

Optional Parameters

Data Model

Trip Model

  {
    "Id": <GUID>,
    "TripType":
    {
      "Id": <GUID>,
      "Name": <string>
    },
    "FromLocation":
    {
      "Id": <GUID>,
      "Name": <string>,
      "ExternalSystemCode": <string>
    },
    "ToLocation":
    {
      "Id": <GUID>,
      "Name": <string>,
      "ExternalSystemCode": <string>
    },
    "Status": <string>,
    "RequestedDate": <date>,
    "StartDate": <date>,
    "EndDate": <date>,
    "IsRequestedDateFirm": <boolean>,
    "EstimatedDuration": <decimal>,
    "NumberRequiredResources": <int>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
    "Jobs": <Array>
    [
      <JobModel>,
      ....
    ]
  }

Job Model

  {
    "Id": <GUID>,
    "RequiredResourceType":
    {
      "Id": <GUID>,
      "Name": <string>
    },
    "StartDate": <date>,
    "EndDate": <date>,
    "PlannedStartDate": <date>,
    "PlannedEndDate": <date>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  }

Trip Object Fields

Job Object Fields

Return Value

With no results

  {
    "Data":
    {
      "LogMessages": <Array>
      [
        {
          "Message": <string>,
          "Entity": <string>
        },
        ....
      ]
    }
  }

With results

  {
    "Data":
    {
      "TripId": <GUID>,
      "LogMessages": <Array>
      [
        {
          "Message": <string>,
          "Entity": <string>
        },
        ....
      ]
    }
  }

User

Create/Update User

URI

api/v1/jobs/users/CreateOrUpdateUser

Supported Verbs

Required Parameters

Data Model

User Model

  {
    "Id": <GUID>,
    "FirstName": <string>,
    "MiddleName": <string>,
    "LastName": <string>,
    "Suffix": <string>,
    "PreferredName": <string>,
    "LdapName": <string>,
    "Email": <string>,
    "EmployeeNumber": <string>,
    "HomePhoneNumber": <string>,
    "CellPhoneNumber": <string>,
    "Birthday": <date>,
    "CanLogIn": <boolean>,
    "CanLogInToBoat": <boolean>,
    "IsActiveEmployee": <boolean>,
    "Division":
    {
      "Id": <GUID>,
      "Name": <string>,
      "ExternalSystemCode": <string>
    },
    "SecondaryDivisions":    
    [
      {
        "Id": <GUID>,
        "Name": <string>,
        "ExternalSystemCode": <string>
      },
      ....
    ]    
    "Roles":
    [
      {
        "Id": <GUID>,
        "Name": <string>
      },
      ....
    ]    
    "Positions":
    [
      {
        "Id": <GUID>,
        "Name": <string>,
        "EffectivePositions":
        [
         {
           "Id": <GUID>,
           "HireDate": <date>,
           "TerminateDate": <date>
         },    
         ....
        ]
      },
      ....
    ]    
    "Department":
    {
      "Id": <GUID>,
      "Name": <string>
    },
    "RotationType":
    {
      "Id": <GUID>,
      "Name": <string>
    },
    "PayrollGroup":
    {
      "Id": <GUID>,
      "Name": <string>
    },
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
    "PayrollClassHistory": 
    {
      "Upsert":
      [
        {
            "Id": <GUID>,
            "PayrollClass": {
                "Id": <GUID>,
                "Name": <string>
            },
            "EffectiveDate": <date>
        },
        ...
      ],
      "Delete": [
          <GUID>,
          ...
      ]
    }
  }

User Object Fields

Return Value

Action Accepted

  Data:
  {
    "ActionType": <string>,
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Create/Update User Image

URI

api/v1/jobs/users/CreateOrUpdateUserImage

Supported Verbs

Required Parameters

Return Value

Action Accepted

  Data:
  {
    "ActionType": <string>
  }

Action Rejected

  "Data": <Array>

Find Users

URI

api/v1/jobs/users/FindUsers

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "FirstName": <string>,
          "PreferredName": <string>,
          "MiddleName": <string>,
          "LastName": <string>,
          "Suffix": <string>,
          "LdapName": <string>,
          "Email": <string>,
          "EmployeeNumber": <string>,
          "HomePhoneNumber": <string>,
          "CellPhoneNumber": <string>,
          "Birthday": <date>,
          "CanLogIn": <boolean>,
          "CanLogInToBoat": <boolean>,
          "IsActiveEmployee": <boolean>,
          "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
          "PayrollClassHistory": <Array>
          [
            {
              "Id": <GUID>,
              "PayrollClass":
              {
                  "Id": <GUID>,
                  "Name": <string>  
              },
              "EffectiveDate": <data>
            },
            ....
          ],
          "RotationType":
          {
            "Id": <GUID>,
            "Name": <string>
          },
          "PayrollGroup":
          {
            "Id": <GUID>,
            "Name": <string>
          },
          "Division":
          {
            "Id": <GUID>,
            "Name": <string>,
            "ExternalSystemCode": <string>
          },
          "SecondaryDivisions":
          [
            {
              "Id": <GUID>,
              "Name": <string>,
              "ExternalSystemCode": <string>
            },
            ....
          ],
          "AssignedAsset":
          {
            "Id": <GUID>,
            "Name": <string>
          },
          "Roles":
          [
            {
              "Id": <GUID>,
              "Name": <string>
            },
            ....
          ],
          "Positions":
          [
            {
              "Id": <GUID>,
              "Name": <string>,
              "EffectivePositions":
              [
               {
                 "Id": <GUID>,
                 "HireDate": <date>,
                 "TerminateDate": <date>
               },
               ....
              ]
            },
            ....
          ],
          "Department":
          {
            "Id": <GUID>,
            "Name": <string>
          }
        },
        ....
      ]
    }
  }

Vendor

Create/Update Vendor

URI

api/v1/hsqe/vendors/CreateOrUpdateVendor

Supported Verbs

Required Parameters

Data Model

Vendor Model

  {
    "Id": <GUID>,
    "Name": <string>,
    "ShortName": <string>,
    "CrossReferenceNumber": <string>,
    "IsActive": <boolean>,
    "UserDefined": User Defined Data Model (see User Defined Fields section for more details)
  }

Vendor Object Fields

Return Value

Action Accepted

  Data:
  {
    "ActionType": <string>,
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Find Vendors

URI

api/v1/hsqe/Vendors/FindVendors

Supported Verbs

Required Parameters

Optional Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "Id": <GUID>,
          "Name": <string>,
          "ShortName": <string>,
          "CrossReferenceNumber": <string>,
          "IsActive": <boolean>,
          "UserDefined": User Defined Data Model (see User Defined Fields section for more details),
          "Contacts": [
              {
                  "Id": <GUID>,
                  "Name": <string>,
                  "Position": <string>,
                  "Description": <string>,
                  "PhoneNumbers": <string> (comma separated),
                  "Emails": <string> (comma separated),
                  "AddressLine": <string>,
                  "City": <string>,
                  "StateProvince": <string>,
                  "PostalCode": <string>,
                  "Country": <string>
              }, ...
          ],
          "PartContracts": [
              {
                  "Id": <GUID>,
                  "PartId": <GUID>,
                  "PartName": <string>,
                  "PartIsActive": <boolean>,
                  "PartIsCriticalSpare": <boolean>,
                  "VendorPartNumber": <string>,
                  "Price": <decimal>,
                  "StartDate": <date>,
                  "EndDate": <date>,
                  "AdditionalInfo": <string>
              }, ...
          ],
          "Archived": <date>
        },
        ...
      ]
    }
  }

Certifications

Find Certifications

URI

api/v1/hsqe/certifications/FindCertifications

Supported Verbs

Required Parameters

Return Value

With no results

  {
    "Data":
    {
      "TotalCount": 0,
      "Page": []
    }
  }

With results

  {
    "Data":
    {
      "TotalCount": <integer>,
      "Page": <Array>
      [
        {
          "TypeId": <GUID>,
          "Type": <string>,
          "TargetId": <GUID>,
          "Target": <string>,
          "PositionId": <GUID>,
          "AssetTypeId": <GUID>,
          "RequiredToOperate": <boolean>,
          "DocumentRequired": <boolean>,
          "RequireExpiration": <boolean>,
          "Category": <string>,
          "CurrentCertification":
              {
                  "Id": <GUID>,
                  "Obtained": <date>,
                  "Expires": <date>,
                  "ReferenceNumber": <string>,
                  "Updated": <date>,
                  "Attachments": [
                      {
                          "Name": <string>
                      }, ...
                  ]
              },
          "HistoricalCertifications": [
              {
                  "Id": <GUID>,
                  "Obtained": <date>,
                  "Expires": <date>,
                  "ReferenceNumber": <string>,
                  "Updated": <date>,
                  "Attachments": [
                      {
                          "Name": <string>
                      }, ...
                  ]
              }, ...
          ],
        },
        ...
      ]
    }
  }

Create/Update Certification

URI

api/v1/hsqe/certifications/CreateCertification

Supported Verbs

Required Parameters

Data Model

Certificate Model

  {
    "TypeId": <GUID>,
    "AssetId": <GUID>,
    "PersonId": <GUID>, 
    "Obtained": <date>,
    "Expires": <date>,
    "ReferenceNumber": <string>
  }

Certification Object Fields

Return Value

Action Accepted

  Data:
  {
    "ActionType": <string>,
    "Id": <GUID>,
    "ErrorMsgs":
    [
      {
        "Entity": <string>,
        "Message": <string>
      },
      ....
    ]
  }

Action Rejected

  "Data": <Array>

Add Certification Attachment

URI

api/v1/hsqe/certifications/AddCertificationAttachment

Supported Verbs

Required Parameters

Return Value

Action Accepted

  Data: 
  {
    "ActionType": "Insert"
  }

Action Rejected

"Message": Error Message