POST api/job/createjob?templateCode={templateCode}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
templateCode

string

Required

Body Parameters

Job
NameDescriptionTypeAdditional information
JobCode

string

None.

JobName

string

None.

RelatedJobCode

string

None.

JobDescription

string

None.

JobInformation

string

None.

SiteAddressCode

string

None.

SiteAddress1

string

None.

SiteAddress2

string

None.

SiteAddress3

string

None.

SiteAddress4

string

None.

SiteAddress5

string

None.

DateEntered

date

None.

DateRequired

date

None.

DateCreated

date

None.

JobStatus

string

None.

JobType

string

None.

Inactive

boolean

None.

Customer

Customer

None.

Group

JobGroup

None.

JobDepartment

Department

None.

JobBranch

Branch

None.

Category1

JobCategory1

None.

Category2

JobCategory2

None.

SalesPerson

SalesPerson

None.

Location

Location

None.

Contact

CustomerContact

None.

StatusName

string

None.

NonWIP

boolean

None.

EstimatedHours

decimal number

None.

PostedHours

decimal number

None.

UnpostedHours

decimal number

None.

QuotedCost

decimal number

None.

OrderNumber

string

None.

Request Formats

application/json, text/json

Sample:
{
  "JobCode": "sample string 1",
  "JobName": "sample string 2",
  "RelatedJobCode": "sample string 3",
  "JobDescription": "sample string 4",
  "JobInformation": "sample string 5",
  "SiteAddressCode": "sample string 6",
  "SiteAddress1": "sample string 7",
  "SiteAddress2": "sample string 8",
  "SiteAddress3": "sample string 9",
  "SiteAddress4": "sample string 10",
  "SiteAddress5": "sample string 11",
  "DateEntered": "2024-12-13T09:44:29.5788459+13:00",
  "DateRequired": "2024-12-13T09:44:29.5788459+13:00",
  "DateCreated": "2024-12-13T09:44:29.5788459+13:00",
  "JobStatus": "sample string 14",
  "JobType": "sample string 15",
  "Inactive": true,
  "Customer": {
    "CustomerCode": "sample string 1",
    "CustomerName": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Address3": "sample string 5",
    "Address4": "sample string 6",
    "Address5": "sample string 7",
    "PostCode": "sample string 8",
    "WebAddress": "sample string 9",
    "EmailAddress": "sample string 10",
    "PhoneNo": "sample string 11",
    "PhoneNo2": "sample string 12",
    "Fax": "sample string 13",
    "Inactive": true,
    "CustomerBranch": {
      "BranchCode": "sample string 1",
      "BranchName": "sample string 2",
      "Inactive": true
    },
    "Group": {
      "GroupCode": "sample string 1",
      "GroupName": "sample string 2",
      "Inactive": true
    },
    "Area": {
      "Code": "sample string 1",
      "Name": "sample string 2",
      "Comment": "sample string 3",
      "Inactive": true
    },
    "SalesPerson": {
      "Code": "sample string 1",
      "Name": "sample string 2",
      "Role": "sample string 3",
      "Phone": "sample string 4",
      "Mobile": "sample string 5",
      "Email": "sample string 6",
      "Comment": "sample string 7",
      "Inactive": true
    },
    "PrimaryContact": {
      "ContactId": 1,
      "FullName": "sample string 2",
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "LastName": "sample string 6",
      "PhoneNo": "sample string 7",
      "MobileNo": "sample string 8",
      "Email": "sample string 9",
      "Comment": "sample string 10",
      "Role": "sample string 11",
      "Inactive": true
    },
    "Contacts": [
      {
        "ContactId": 1,
        "FullName": "sample string 2",
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "MiddleName": "sample string 5",
        "LastName": "sample string 6",
        "PhoneNo": "sample string 7",
        "MobileNo": "sample string 8",
        "Email": "sample string 9",
        "Comment": "sample string 10",
        "Role": "sample string 11",
        "Inactive": true
      },
      {
        "ContactId": 1,
        "FullName": "sample string 2",
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "MiddleName": "sample string 5",
        "LastName": "sample string 6",
        "PhoneNo": "sample string 7",
        "MobileNo": "sample string 8",
        "Email": "sample string 9",
        "Comment": "sample string 10",
        "Role": "sample string 11",
        "Inactive": true
      }
    ],
    "PrimaryDeliveryAddress": {
      "DeliveryCode": "sample string 1",
      "Address1": "sample string 2",
      "Address2": "sample string 3",
      "Address3": "sample string 4",
      "Address4": "sample string 5",
      "Address5": "sample string 6",
      "PostCode": "sample string 7"
    },
    "DeliveryAddresses": [
      {
        "DeliveryCode": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "Address4": "sample string 5",
        "Address5": "sample string 6",
        "PostCode": "sample string 7"
      },
      {
        "DeliveryCode": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "Address4": "sample string 5",
        "Address5": "sample string 6",
        "PostCode": "sample string 7"
      }
    ]
  },
  "Group": {
    "JobGroupCode": "sample string 1",
    "JobGroupName": "sample string 2",
    "Inactive": true
  },
  "JobDepartment": {
    "DepartmentCode": "sample string 1",
    "DepartmentName": "sample string 2",
    "Inactive": true
  },
  "JobBranch": {
    "BranchCode": "sample string 1",
    "BranchName": "sample string 2",
    "Inactive": true
  },
  "Category1": {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Inactive": true
  },
  "Category2": {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Inactive": true
  },
  "SalesPerson": {
    "Code": "sample string 1",
    "Name": "sample string 2",
    "Role": "sample string 3",
    "Phone": "sample string 4",
    "Mobile": "sample string 5",
    "Email": "sample string 6",
    "Comment": "sample string 7",
    "Inactive": true
  },
  "Location": {
    "LocationCode": "sample string 1",
    "LocationName": "sample string 2",
    "DepartmentCode": "sample string 3",
    "BranchCode": "sample string 4",
    "Inactive": true
  },
  "Contact": {
    "ContactId": 1,
    "FullName": "sample string 2",
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "MiddleName": "sample string 5",
    "LastName": "sample string 6",
    "PhoneNo": "sample string 7",
    "MobileNo": "sample string 8",
    "Email": "sample string 9",
    "Comment": "sample string 10",
    "Role": "sample string 11",
    "Inactive": true
  },
  "StatusName": "Unknown",
  "NonWIP": true,
  "EstimatedHours": 18.0,
  "PostedHours": 19.0,
  "UnpostedHours": 20.0,
  "QuotedCost": 21.0,
  "OrderNumber": "sample string 22"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

JobLite
NameDescriptionTypeAdditional information
JobCode

string

None.

JobName

string

None.

CustomerCode

string

None.

CustomerName

string

None.

BranchCode

string

None.

DepartmentCode

string

None.

DefaultLocationCode

string

None.

RelatedJobCode

string

None.

JobGroupCode

string

None.

JobStatus

string

None.

JobType

string

None.

DateRequired

date

None.

DateEntered

date

None.

DateCreated

date

None.

NonWIP

boolean

None.

InActive

boolean

None.

OrderNumber

string

None.

ScheduleStatus

ScheduleStatusEnum

None.

Response Formats

application/json, text/json

Sample:
{
  "JobCode": "sample string 1",
  "JobName": "sample string 2",
  "CustomerCode": "sample string 3",
  "CustomerName": "sample string 4",
  "BranchCode": "sample string 5",
  "DepartmentCode": "sample string 6",
  "DefaultLocationCode": "sample string 7",
  "RelatedJobCode": "sample string 8",
  "JobGroupCode": "sample string 9",
  "JobStatus": "sample string 10",
  "JobType": "sample string 11",
  "DateRequired": "2024-12-13T09:44:29.6257234+13:00",
  "DateEntered": "2024-12-13T09:44:29.6257234+13:00",
  "DateCreated": "2024-12-13T09:44:29.6257234+13:00",
  "NonWIP": true,
  "InActive": true,
  "OrderNumber": "sample string 15",
  "ScheduleStatus": 0
}

application/xml, text/xml

Sample:
<JobLite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.JC">
  <BranchCode>sample string 5</BranchCode>
  <CustomerCode>sample string 3</CustomerCode>
  <CustomerName>sample string 4</CustomerName>
  <DateCreated>2024-12-13T09:44:29.6257234+13:00</DateCreated>
  <DateEntered>2024-12-13T09:44:29.6257234+13:00</DateEntered>
  <DateRequired>2024-12-13T09:44:29.6257234+13:00</DateRequired>
  <DefaultLocationCode>sample string 7</DefaultLocationCode>
  <DepartmentCode>sample string 6</DepartmentCode>
  <InActive>true</InActive>
  <JobCode>sample string 1</JobCode>
  <JobGroupCode>sample string 9</JobGroupCode>
  <JobName>sample string 2</JobName>
  <JobStatus>sample string 10</JobStatus>
  <JobType>sample string 11</JobType>
  <NonWIP>true</NonWIP>
  <OrderNumber>sample string 15</OrderNumber>
  <RelatedJobCode>sample string 8</RelatedJobCode>
  <ScheduleStatus>None</ScheduleStatus>
</JobLite>