POST api/JobQueue
Request Information
URI Parameters
None.
Body Parameters
JobQueueSearchName | Description | Type | Additional information |
---|---|---|---|
JobStatusCode |
Value from OE_Job_Status table |
string |
String length: inclusive between 0 and 50 |
JobTypeCode |
Value from OE_Job_Type table |
string |
String length: inclusive between 0 and 50 |
InstallCompanyCode |
Value from OE_Install_Company table |
string |
String length: inclusive between 0 and 50 |
InstallerCode |
Value from SY_Employee table |
string |
String length: inclusive between 0 and 50 |
UserCode |
Value from SY_Employee table |
string |
None. |
ProjectManagerCode |
Value from SY_Employee table |
string |
String length: inclusive between 0 and 50 |
CustomerNumber |
Customer Number |
string |
String length: inclusive between 0 and 25 |
SalespersonCode |
Value from SY_Employee table; list of valid options can be retrieved from GET: api/salesperson |
string |
String length: inclusive between 0 and 25 |
Request Formats
application/json, text/json
{ "JobStatusCode": "sample string 1", "JobTypeCode": "sample string 2", "InstallCompanyCode": "sample string 3", "InstallerCode": "sample string 4", "UserCode": "sample string 5", "ProjectManagerCode": "sample string 6", "CustomerNumber": "sample string 7", "SalespersonCode": "sample string 8" }
application/xml, text/xml
<JobQueueSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models"> <CustomerNumber>sample string 7</CustomerNumber> <InstallCompanyCode>sample string 3</InstallCompanyCode> <InstallerCode>sample string 4</InstallerCode> <JobStatusCode>sample string 1</JobStatusCode> <JobTypeCode>sample string 2</JobTypeCode> <ProjectManagerCode>sample string 6</ProjectManagerCode> <SalespersonCode>sample string 8</SalespersonCode> <UserCode>sample string 5</UserCode> </JobQueueSearch>
application/x-www-form-urlencoded
Response Information
Resource Description
Collection of JobQueueResultName | Description | Type | Additional information |
---|---|---|---|
Job_Code |
Abbreviated Job Code |
string |
String length: inclusive between 0 and 25 |
Customer_Number |
Customer Number the customer sees |
string |
Required String length: inclusive between 0 and 15 |
Commercial | string |
None. |
|
Business_Name | string |
None. |
|
Address_1 | string |
None. |
|
Description | string |
None. |
|
Job_Id | integer |
None. |
|
Customer_Site_Id | integer |
None. |
|
Start_Date | date |
None. |
|
Billed_Amount | decimal number |
None. |
|
Amount | decimal number |
None. |
|
TotalLaborUnits | decimal number |
None. |
|
Total_RMR_Amount | decimal number |
None. |
|
Total_billed_rmr_amount | decimal number |
None. |
|
Credit_Amount | decimal number |
None. |
|
Creation_Date | date |
None. |
|
UnitsUsed | decimal number |
None. |
|
Projected_End_Date | date |
None. |
Response Formats
application/json, text/json
[ { "Job_Code": "sample string 1", "Customer_Number": "sample string 2", "Commercial": "sample string 3", "Business_Name": "sample string 4", "Address_1": "sample string 5", "Description": "sample string 6", "Job_Id": 7, "Customer_Site_Id": 8, "Start_Date": "2025-02-08T01:14:00.7263-06:00", "Billed_Amount": 10.0, "Amount": 11.0, "TotalLaborUnits": 12.1, "Total_RMR_Amount": 13.0, "Total_billed_rmr_amount": 14.0, "Credit_Amount": 15.0, "Creation_Date": "2025-02-08T01:14:00.7263-06:00", "UnitsUsed": 17.1, "Projected_End_Date": "2025-02-08T01:14:00.7263-06:00" }, { "Job_Code": "sample string 1", "Customer_Number": "sample string 2", "Commercial": "sample string 3", "Business_Name": "sample string 4", "Address_1": "sample string 5", "Description": "sample string 6", "Job_Id": 7, "Customer_Site_Id": 8, "Start_Date": "2025-02-08T01:14:00.7263-06:00", "Billed_Amount": 10.0, "Amount": 11.0, "TotalLaborUnits": 12.1, "Total_RMR_Amount": 13.0, "Total_billed_rmr_amount": 14.0, "Credit_Amount": 15.0, "Creation_Date": "2025-02-08T01:14:00.7263-06:00", "UnitsUsed": 17.1, "Projected_End_Date": "2025-02-08T01:14:00.7263-06:00" } ]
application/xml, text/xml
<ArrayOfJobQueueResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models"> <JobQueueResult> <Address_1>sample string 5</Address_1> <Amount>11</Amount> <Billed_Amount>10</Billed_Amount> <Business_Name>sample string 4</Business_Name> <Commercial>sample string 3</Commercial> <Creation_Date>2025-02-08T01:14:00.7263-06:00</Creation_Date> <Credit_Amount>15</Credit_Amount> <Customer_Number>sample string 2</Customer_Number> <Customer_Site_Id>8</Customer_Site_Id> <Description>sample string 6</Description> <Job_Code>sample string 1</Job_Code> <Job_Id>7</Job_Id> <Projected_End_Date>2025-02-08T01:14:00.7263-06:00</Projected_End_Date> <Start_Date>2025-02-08T01:14:00.7263-06:00</Start_Date> <TotalLaborUnits>12.1</TotalLaborUnits> <Total_RMR_Amount>13</Total_RMR_Amount> <Total_billed_rmr_amount>14</Total_billed_rmr_amount> <UnitsUsed>17.1</UnitsUsed> </JobQueueResult> <JobQueueResult> <Address_1>sample string 5</Address_1> <Amount>11</Amount> <Billed_Amount>10</Billed_Amount> <Business_Name>sample string 4</Business_Name> <Commercial>sample string 3</Commercial> <Creation_Date>2025-02-08T01:14:00.7263-06:00</Creation_Date> <Credit_Amount>15</Credit_Amount> <Customer_Number>sample string 2</Customer_Number> <Customer_Site_Id>8</Customer_Site_Id> <Description>sample string 6</Description> <Job_Code>sample string 1</Job_Code> <Job_Id>7</Job_Id> <Projected_End_Date>2025-02-08T01:14:00.7263-06:00</Projected_End_Date> <Start_Date>2025-02-08T01:14:00.7263-06:00</Start_Date> <TotalLaborUnits>12.1</TotalLaborUnits> <Total_RMR_Amount>13</Total_RMR_Amount> <Total_billed_rmr_amount>14</Total_billed_rmr_amount> <UnitsUsed>17.1</UnitsUsed> </JobQueueResult> </ArrayOfJobQueueResult>