POST api/job/details
Request Information
URI Parameters
None.
Body Parameters
Dictionary of string [key] and boolean [value]Request Formats
application/json, text/json
Sample:
{
"sample string 1": true,
"sample string 3": true
}
application/xml, text/xml
Sample:
<ArrayOfKeyValueOfstringboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<KeyValueOfstringboolean>
<Key>sample string 1</Key>
<Value>true</Value>
</KeyValueOfstringboolean>
<KeyValueOfstringboolean>
<Key>sample string 3</Key>
<Value>true</Value>
</KeyValueOfstringboolean>
</ArrayOfKeyValueOfstringboolean>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ValueTupleOfListOfJobLiteAndListOfJob| Name | Description | Type | Additional information |
|---|---|---|---|
| Item1 | Collection of JobLite |
None. |
|
| Item2 | Collection of Job |
None. |
Response Formats
application/json, text/json
Sample:
{
"Item1": [
{
"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:05:50.5892677+13:00",
"DateEntered": "2024-12-13T09:05:50.5892677+13:00",
"NonWIP": true,
"InActive": true,
"OrderNumber": "sample string 14",
"ScheduleStatus": 0
},
{
"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:05:50.5892677+13:00",
"DateEntered": "2024-12-13T09:05:50.5892677+13:00",
"NonWIP": true,
"InActive": true,
"OrderNumber": "sample string 14",
"ScheduleStatus": 0
}
],
"Item2": [
{
"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:05:50.5892677+13:00",
"DateRequired": "2024-12-13T09:05:50.5892677+13:00",
"JobStatus": "sample string 13",
"JobType": "sample string 14",
"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": 17.0,
"PostedHours": 18.0,
"UnpostedHours": 19.0,
"OrderNumber": "sample string 20"
},
{
"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:05:50.5892677+13:00",
"DateRequired": "2024-12-13T09:05:50.5892677+13:00",
"JobStatus": "sample string 13",
"JobType": "sample string 14",
"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": 17.0,
"PostedHours": 18.0,
"UnpostedHours": 19.0,
"OrderNumber": "sample string 20"
}
]
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.